@haochuan9421/urm/lib/pm-config/npm.js

Universal Registry Manager, manage npm and yarn registry easily.

const os = require("os");
const fs = require("fs");
const path = require("path");
const npm = require("npm");
const ini = require("ini");
const { eachSeries } = require("async");
const { unset } = require("lodash");
const { Table } = require("console-table-printer");

class npmConfig {
  constructor() {
    this.configFileTypes = ["project", "user", "global"];
  }

  // 获取当前生效的全部 registry 配置
  async getCurRegistries() {
    await npm.load();
    const configFiles = await this.getConfigFiles();
    const { data: npmCliConfig } = npm.config.data.get("cli");
    const registryKeys = ["registry"];
    // 沿着原型链查找，https://github.com/npm/config/blob/v2.3.0/lib/index.js#L134
    for (const key in npmCliConfig) {
      // 筛选出 “scope registry”（如：@myscope:registry）
      if (/(?<=@[\s\S]+:)registry/.test(key)) {
        registryKeys.push(key);
      }
    }
    const curRegistries = registryKeys.map((key) => {
      const whereType = npm.config.find(key);
      let wherePath;
      if (this.configFileTypes.indexOf(whereType) !== -1) {
        wherePath = configFiles.find((file) => file.type === npm.config.find(key)).path;
      }
      return {
        registry: npmCliConfig[key],
        // registry 的作用范围
        scope: key === "registry" ? "" : key.substr(0, key.lastIndexOf(":")),
        // 配置项来源，同一个配置在多个地方存在时，cli > env > project > user > global > builtin > default
        where: {
          whereType,
          wherePath,
        },
      };
    });

    return curRegistries;
  }

  // 以表格的形式展示当前的 registry 配置
  async printCurRegistriesTable() {
    return this.getCurRegistries().then((curRegistries) => {
      const currentRegistriesTable = new Table({
        title: i18n.A060,
        columns: [
          { name: "registry", alignment: "left" },
          { name: "scope", alignment: "left" },
          { name: "where", alignment: "left" },
        ],
      });
      currentRegistriesTable.addRows(
        curRegistries.map((v) => ({
          ...v,
          where: v.where.whereType || v.where.wherePath,
        })),
        { color: "crimson" }
      );
      currentRegistriesTable.printTable();
      return curRegistries;
    });
  }

  // 设置 registry
  async setRegistry(scope, value, { whereType, wherePath }) {
    if (!wherePath) {
      const configFiles = await this.getConfigFiles();
      wherePath = configFiles.find((file) => file.type === whereType).path;
    }
    const key = scope ? `${scope}:registry` : "registry";
    if (process.cwd() === os.homedir() && whereType === "project") {
      whereType = "user";
    }
    npm.config.set(key, value, whereType);
    // 一个补丁，save global 配置时，会出现保存失败但实际却成功的情况，这是因为 npm 代码里的 chmod 在某些情况下是无意义的
    return npm.config.save(whereType).catch((err) => (whereType === "global" && err.syscall === "chmod" && err.code === "EPERM" ? null : Promise.reject(err)));
  }

  // 删除 registry
  async delRegistry(scope, { whereType, wherePath }) {
    if (!wherePath) {
      const configFiles = await this.getConfigFiles();
      wherePath = configFiles.find((file) => file.type === whereType).path;
    }
    await fs.promises.access(wherePath, fs.constants.W_OK);
    const key = scope ? `${scope}:registry` : "registry";
    npm.config.delete(key, whereType);
    await npm.config.save(whereType).catch((err) => (whereType === "global" && err.syscall === "chmod" && err.code === "EPERM" ? null : Promise.reject(err)));
    // 一个补丁，save global 配置时，会出现保存成功但实际却失败的情况，这是因为 npm 的代码里忽略了 unlink 的报错
    if (whereType === "global" && fs.existsSync(wherePath)) {
      const newConfig = ini.parse(fs.readFileSync(wherePath, { encoding: "utf8" }));
      if (newConfig[key]) {
        unset(newConfig, key);
        fs.writeFileSync(wherePath, `${ini.stringify(newConfig)}\n`, "utf8");
      }
    }
  }

  // 获取全部可以删除的 registry
  async getRemovableRegistries() {
    return this.getCurRegistries().then((curRegistries) => curRegistries.filter(({ where }) => Boolean(where.wherePath)));
  }

  // 清空全部 registry
  async clearRegistry() {
    let removeMaxNeedCount = this.configFileTypes.length;
    const remove = (registries) => {
      if (!registries.length) {
        return;
      }
      if (removeMaxNeedCount <= 0) {
        // 即使有高优先级配置文件覆盖了低优先级的的情况，每次至少也可以移除一种配置文件的全部配置，执行次数超出文件总数，既为异常
        return Promise.reject(new Error("fail to clear registry"));
      }
      removeMaxNeedCount--;
      return eachSeries(registries, async ({ scope, where }) => this.delRegistry(scope, where))
        .then(() => this.getRemovableRegistries()) // 递归删除，直到获取不到可删除的 registry 为止
        .then(remove);
    };

    return this.getRemovableRegistries().then(remove);
  }

  // 获取配置文件的完整路径
  async getConfigFiles() {
    return npm.load().then(() => [
      {
        type: "project",
        path: path.join(npm.config.localPrefix, ".npmrc"),
      },
      {
        type: "user",
        path: npm.config.get("userconfig"),
      },
      {
        type: "global",
        path: path.join(npm.config.globalPrefix, "etc/npmrc"),
      },
    ]);
  }
}

module.exports = npmConfig;