跳到主要内容

.pnpmfile.cjs

2024年05月17日
柏拉文
越努力，越幸运

一、认识​

.pnpmfile.cjs 是 pnpm 特有的配置文件，用于自定义和扩展 pnpm 的行为，特别是在包的安装和处理过程中。这个文件可以用来修改依赖项的解析、添加自定义的逻辑和处理包的行为。

二、语法​

.pnpmfile.cjs 文件使用 CommonJS 模块语法 (.cjs 扩展名) 来编写

module.exports = {
  hooks: {
    readPackage(pkg) {
      if (pkg.dependencies) {
        // 将所有的 'lodash' 依赖重定向到特定版本
        if (pkg.dependencies['lodash']) {
          pkg.dependencies['lodash'] = '^4.17.21';
        }
      }
      return pkg;
    }
  }
};

三、用法​

3.1 重定向包​

你可以通过 .pnpmfile.cjs 文件中的 hooks API 来重定向包。例如，将某个依赖项重定向到一个特定的版本或源：

// .pnpmfile.cjs
module.exports = {
  hooks: {
    readPackage(pkg) {
      if (pkg.dependencies) {
        // 将所有的 'lodash' 依赖重定向到特定版本
        if (pkg.dependencies['lodash']) {
          pkg.dependencies['lodash'] = '^4.17.21';
        }
      }
      return pkg;
    }
  }
};

3.2 自定义解析依赖​

你可以自定义如何解析依赖，添加特定的逻辑来处理依赖项的安装

// .pnpmfile.cjs
module.exports = {
  hooks: {
    readPackage(pkg) {
      // 例如，添加一个自定义字段
      pkg.customField = 'customValue';
      return pkg;
    }
  }
};

3.3 添加额外的依赖​

// .pnpmfile.cjs
module.exports = {
  hooks: {
    readPackage(pkg) {
      // 修改依赖项
      if (pkg.dependencies && pkg.dependencies['some-package']) {
        pkg.dependencies['some-package'] = '^1.2.3';
      }
      return pkg;
    }
  }
};

四、场景​

4.1 解决依赖版本冲突，确保依赖项的一致性​

在 基于 PNPM 的 Monorepo 中，如果遇到了同一个依赖，在不同的工作区中有不同的版本，导致了一些问题, 在我们的项目中， 因为 ukit-lang 版本不一致，导致registerConfig 之后仍旧无法访问到多语。

.pnpmfile.cjs 是 pnpm 提供的自定义配置文件，可以用来实现更复杂的依赖处理逻辑，如动态覆盖版本、调整依赖结构等。

const packageJson = require('./package.json');

// 列出需要覆盖版本的依赖包名称
const packagesToOverride = ['lodash'，'ukit-lang'];

/**
 * 构建需要覆盖版本的依赖映射
 * @returns {Object} 包含需要覆盖版本的依赖映射
 */
function createDependencyOverrides() {
  const overrides = {};

  // 从 dependencies 中添加需要覆盖的包
  for (const [pkgName, pkgVersion] of Object.entries(packageJson.dependencies)) {
    if (packagesToOverride.includes(pkgName)) {
      overrides[pkgName] = pkgVersion;
    }
  }

  // 从 devDependencies 中添加需要覆盖的包
  for (const [pkgName, pkgVersion] of Object.entries(packageJson.devDependencies)) {
    if (packagesToOverride.includes(pkgName)) {
      overrides[pkgName] = pkgVersion;
    }
  }

  return overrides;
}

const dependencyOverrides = createDependencyOverrides();

/**
 * 根据配置覆盖包的依赖版本
 * @param {Object} pkg - 当前处理的包
 * @param {Object} context - 钩子上下文
 * @returns {Object} 修改后的包
 */
function applyVersionOverrides(pkg, context) {
  // 遍历 dependencies 并覆盖版本
  Object.entries(pkg.dependencies).forEach(([depName, depVersion]) => {
    if (dependencyOverrides[depName]) {
      pkg.dependencies[depName] = dependencyOverrides[depName];
      context.log(`Overridden ${depName} to version ${dependencyOverrides[depName]}`);
    }
  });

  // 遍历 devDependencies 并覆盖版本
  Object.entries(pkg.devDependencies).forEach(([depName, depVersion]) => {
    if (dependencyOverrides[depName]) {
      pkg.devDependencies[depName] = dependencyOverrides[depName];
      context.log(`Overridden ${depName} to version ${dependencyOverrides[depName]}`);
    }
  });

  return pkg;
}

module.exports = {
  hooks: {
    readPackage: applyVersionOverrides,
  },
};

.pnpmfile.cjs 允许在处理依赖时应用复杂的逻辑，如动态调整、条件覆盖等。可以根据包名、版本、上下文等条件实现不同的版本覆盖策略。同时提供了更细粒度的控制，可以在日志中记录覆盖信息，帮助调试问题。

因此，.pnpmfile.cjs 适用于需要复杂逻辑、条件覆盖或动态版本处理的情况。当你的项目需要根据不同的工作区或其他条件应用不同的依赖版本时，.pnpmfile.cjs 提供了更大的灵活性。