cheers-mp-service/lib/PluginAPI.js

提供插件化的零配置小程序脚手架服务

const path = require("path");
const hash = require("hash-sum");
const { matchesPluginId } = require("../utils/pluginResolution");

module.exports = class PluginAPI {
  /**
   * @param {string} id - 插件ID
   * @param {Service} service - 一个cheers-mp-service 实例.
   */
  constructor(id, service) {
    this.id = id;
    this.service = service;
  }

  /**
   * 当前工作目录
   */
  getCwd() {
    return this.service.context;
  }

  /**
   * 获取项目 package.json 文件内容
   */
  getPkg() {
    return this.service.pkg;
  }

  /**
   * 根据相对路径获取绝对路径地址
   *
   * @param {string} _path - 相对于项目根目录的相对路径
   * @return {string} 绝对路径
   */
  resolve(_path) {
    return path.resolve(this.service.context, _path);
  }

  /**
   * 检查项目是否有给定的插件
   *
   * @param {string} id - 插件id, 会忽略掉 (@megalo/|megalo-|@scope/megalo)-cli-plugin- 这些前缀
   * @return {boolean}
   */
  hasPlugin(id) {
    if (id === "router") id = "vue-router";
    if (["vue-router", "vuex"].includes(id)) {
      const pkg = this.service.pkg;
      return (pkg.dependencies && pkg.dependencies[id]) || (pkg.devDependencies && pkg.devDependencies[id]);
    }
    return this.service.plugins.some((p) => matchesPluginId(id, p.id));
  }

  /**
   * 检查项目是否有给定的包名
   * @param {String} packageName
   * @return {boolean}
   */
  hasPackage(packageName) {
    const pkg = this.service.pkg;
    return (
      (pkg.dependencies && pkg.dependencies[packageName]) || (pkg.devDependencies && pkg.devDependencies[packageName])
    );
  }

  /**
   * 注册一个命令，形式类似于  `cheers-mp-service [name]`.
   *
   * @param {string} name
   * @param {object} [opts]
   *   {
   *     description: string,
   *     usage: string,
   *     options: { [string]: string }
   *   }
   * @param {function} fn
   *   (args: { [string]: string }, rawArgs: string[]) => ?Promise
   */
  registerCommand(name, opts, fn) {
    if (typeof opts === "function") {
      fn = opts;
      opts = null;
    }
    this.service.commands[name] = { fn, opts: opts || {} };
  }

  /**
   * 根据相关变量生成缓存标志
   */
  genCacheConfig(id, partialIdentifier, configFiles = []) {
    const fs = require("fs");
    const cacheDirectory = this.resolve(`node_modules/.cache/${id}`);

    const variables = {
      partialIdentifier,
      service: require("../package.json").version,
      env: process.env.NODE_ENV,
    };

    if (!Array.isArray(configFiles)) {
      configFiles = [configFiles];
    }
    configFiles = configFiles.concat(["package-lock.json", "yarn.lock", "pnpm-lock.yaml"]);

    const readConfig = (file) => {
      const absolutePath = this.resolve(file);
      if (!fs.existsSync(absolutePath)) {
        return;
      }

      if (absolutePath.endsWith(".js")) {
        // should evaluate config scripts to reflect environment variable changes
        try {
          return JSON.stringify(require(absolutePath));
        } catch (e) {
          return fs.readFileSync(absolutePath, "utf-8");
        }
      } else {
        return fs.readFileSync(absolutePath, "utf-8");
      }
    };
    for (const file of configFiles) {
      const content = readConfig(file);
      if (content) {
        variables.configFiles = content.replace(/\r\n?/g, "\n");
        break;
      }
    }

    const cacheIdentifier = hash(variables);
    return { cacheDirectory, cacheIdentifier };
  }
};