为嵌套文件夹运行 npm install 的最佳方式？

Question

在嵌套子文件夹中安装npm packages 最正确的方法是什么？

my-app
  /my-sub-module
  package.json
package.json

当npm install 在my-app 中运行时，自动安装/my-sub-module 中的packages 的最佳方法是什么？

Answer 1

如果您知道嵌套子目录的名称，我更喜欢使用安装后。在package.json:

"scripts": {
  "postinstall": "cd nested_dir && npm install",
  ...
}

Answer 2

根据@Scott 的回答，只要知道子目录名称， install|postinstall 脚本就是最简单的方法。这就是我为多个子目录运行它的方式。例如，假设我们在 monorepo 根目录中有 api/、web/ 和 shared/ 子项目：

// In monorepo root package.json
{
...
 "scripts": {
    "postinstall": "(cd api && npm install); (cd web && npm install); (cd shared && npm install)"
  },
}

在 Windows 上，将括号之间的 ; 替换为 &&。

// In monorepo root package.json
{
...
 "scripts": {
    "postinstall": "(cd api && npm install) && (cd web && npm install) && (cd shared && npm install)"
  },
}

Answer 3

用例 1：如果您希望能够从每个子目录（每个 package.json 所在的位置）中运行 npm 命令，则需要使用 postinstall。

反正我经常使用npm-run-all，我用它来保持它的美观和简短（安装后的部分）：

{
    "install:demo": "cd projects/demo && npm install",
    "install:design": "cd projects/design && npm install",
    "install:utils": "cd projects/utils && npm install",

    "postinstall": "run-p install:*"
}

这有一个额外的好处，我可以一次安装，也可以单独安装。如果您不需要这个或不希望 npm-run-all 作为依赖项，请查看 demisx 的答案（在安装后使用子shell）。

用例 2：如果您将从根目录运行所有 npm 命令（例如，不会在子目录中使用 npm 脚本），您可以简单地安装每个子目录，例如你会有任何依赖：

npm install path/to/any/directory/with/a/package-json

在后一种情况下，您在子目录中找不到任何node_modules 或package-lock.json 文件不要感到惊讶——所有软件包都将安装在根目录node_modules 中，这就是为什么您将无法从您的任何子目录运行您的 npm 命令（需要依赖项）。

如果您不确定，用例 1 始终有效。

Answer 4

如果你想运行一个命令来在嵌套的子文件夹中安装 npm 包，你可以在你的根目录中通过 npm 和 main package.json 运行一个脚本。该脚本将访问每个子目录并运行npm install。

下面是一个.js 脚本，它将达到预期的结果：

var fs = require('fs');
var resolve = require('path').resolve;
var join = require('path').join;
var cp = require('child_process');
var os = require('os');
    
// get library path
var lib = resolve(__dirname, '../lib/');
    
fs.readdirSync(lib).forEach(function(mod) {
    var modPath = join(lib, mod);
    
    // ensure path has package.json
    if (!fs.existsSync(join(modPath, 'package.json'))) {
        return;
    }

    // npm binary based on OS
    var npmCmd = os.platform().startsWith('win') ? 'npm.cmd' : 'npm';

    // install folder
    cp.spawn(npmCmd, ['i'], {
        env: process.env,
        cwd: modPath,
        stdio: 'inherit'
    });
})

请注意，这是取自 StrongLoop 文章的示例，该文章专门针对模块化 node.js 项目结构（包括嵌套组件和 package.json 文件）。

按照建议，您也可以使用 bash 脚本实现相同的目的。

编辑：使代码在 Windows 中工作

Answer 5

仅供参考，以防人们遇到这个问题。您现在可以：

• 将 package.json 添加到子文件夹中
• 将此子文件夹作为参考链接安装在主 package.json 中：

npm install --save path/to/my/subfolder

Answer 6

我的解决方案非常相似。 纯 Node.js

以下脚本检查所有子文件夹（递归），只要它们有package.json 并在每个子文件夹中运行npm install。 可以为其添加例外：允许没有package.json 的文件夹。在下面的示例中，一个这样的文件夹是“packages”。 可以将其作为“预安装”脚本运行。

const path = require('path')
const fs = require('fs')
const child_process = require('child_process')

const root = process.cwd()
npm_install_recursive(root)

// Since this script is intended to be run as a "preinstall" command,
// it will do `npm install` automatically inside the root folder in the end.
console.log('===================================================================')
console.log(`Performing "npm install" inside root folder`)
console.log('===================================================================')

// Recurses into a folder
function npm_install_recursive(folder)
{
    const has_package_json = fs.existsSync(path.join(folder, 'package.json'))

    // Abort if there's no `package.json` in this folder and it's not a "packages" folder
    if (!has_package_json && path.basename(folder) !== 'packages')
    {
        return
    }

    // If there is `package.json` in this folder then perform `npm install`.
    //
    // Since this script is intended to be run as a "preinstall" command,
    // skip the root folder, because it will be `npm install`ed in the end.
    // Hence the `folder !== root` condition.
    //
    if (has_package_json && folder !== root)
    {
        console.log('===================================================================')
        console.log(`Performing "npm install" inside ${folder === root ? 'root folder' : './' + path.relative(root, folder)}`)
        console.log('===================================================================')

        npm_install(folder)
    }

    // Recurse into subfolders
    for (let subfolder of subfolders(folder))
    {
        npm_install_recursive(subfolder)
    }
}

// Performs `npm install`
function npm_install(where)
{
    child_process.execSync('npm install', { cwd: where, env: process.env, stdio: 'inherit' })
}

// Lists subfolders in a folder
function subfolders(folder)
{
    return fs.readdirSync(folder)
        .filter(subfolder => fs.statSync(path.join(folder, subfolder)).isDirectory())
        .filter(subfolder => subfolder !== 'node_modules' && subfolder[0] !== '.')
        .map(subfolder => path.join(folder, subfolder))
}

Answer 7

如果您的系统上有find 实用程序，您可以尝试在应用程序根目录中运行以下命令：
find . ! -path "*/node_modules/*" -name "package.json" -execdir npm install \;

基本上，找到所有package.json 文件并在该目录中运行npm install，跳过所有node_modules 目录。

Answer 8

接受的答案有效，但您可以使用 --prefix 在选定位置运行 npm 命令。

"postinstall": "npm --prefix ./nested_dir install"

--prefix 适用于任何 npm 命令，而不仅仅是 install。

你也可以用

查看当前前缀

npm prefix

并将您的全局安装 (-g) 文件夹设置为

npm config set prefix "folder_path"

也许是 TMI，但你明白了……

Answer 9

EDIT 正如 fgblomqvist 在 cmets 中提到的，npm 现在也支持workspaces。

---

有些答案已经很老了。我认为现在我们有一些新选项可用于设置monorepos。

1. 我建议使用yarn workspaces:

工作区是一种设置包架构的新方法，从 Yarn 1.0 开始默认可用。它允许您设置多个包，只需运行一次yarn install 即可一次安装所有包。

1. 如果您喜欢或必须留在 npm，我建议您查看lerna：

Lerna 是一种工具，可优化使用 git 和 npm 管理多包存储库的工作流程。

lerna 也适用于 yarn 工作区 - article。我刚刚建立了一个 monorepo 项目 - example。

这是一个配置为使用 npm + lerna - MDC Web 的多包项目的示例：它们使用 package.json 的 postinstall 运行 lerna bootstrap。

Answer 10

将 Windows 支持添加到 snozza's 答案，以及跳过 node_modules 文件夹（如果存在）。

var fs = require('fs')
var resolve = require('path').resolve
var join = require('path').join
var cp = require('child_process')

// get library path
var lib = resolve(__dirname, '../lib/')

fs.readdirSync(lib)
  .forEach(function (mod) {
    var modPath = join(lib, mod)
    // ensure path has package.json
    if (!mod === 'node_modules' && !fs.existsSync(join(modPath, 'package.json'))) return

    // Determine OS and set command accordingly
    const cmd = /^win/.test(process.platform) ? 'npm.cmd' : 'npm';

    // install folder
    cp.spawn(cmd, ['i'], { env: process.env, cwd: modPath, stdio: 'inherit' })
})

Answer 11

受此处提供的脚本的启发，我构建了一个可配置的示例：

• 可以设置为使用yarn 或npm
• 可以设置为根据锁定文件确定要使用的命令，这样如果您将其设置为使用yarn，但一个目录只有package-lock.json，它将对该目录使用npm（默认为true） .
• 配置日志记录
• 使用cp.spawn 并行运行安装
• 可以进行试运行，让您先看看它会做什么
• 可以作为函数运行或使用环境变量自动运行
  • 作为函数运行时，可选择提供要检查的目录数组
• 返回一个完成后解决的承诺
• 如果需要，允许设置查看的最大深度
• 知道在找到带有yarn workspaces 的文件夹时停止递归（可配置）
• 允许使用逗号分隔的 env var 或通过向配置传递要匹配的字符串数组或接收文件名、文件路径和 fs.Dirent obj 并期望布尔结果的函数来跳过目录。李>

const path = require('path');
const { promises: fs } = require('fs');
const cp = require('child_process');

// if you want to have it automatically run based upon
// process.cwd()
const AUTO_RUN = Boolean(process.env.RI_AUTO_RUN);

/**
 * Creates a config object from environment variables which can then be
 * overriden if executing via its exported function (config as second arg)
 */
const getConfig = (config = {}) => ({
  // we want to use yarn by default but RI_USE_YARN=false will
  // use npm instead
  useYarn: process.env.RI_USE_YARN !== 'false',
  // should we handle yarn workspaces?  if this is true (default)
  // then we will stop recursing if a package.json has the "workspaces"
  // property and we will allow `yarn` to do its thing.
  yarnWorkspaces: process.env.RI_YARN_WORKSPACES !== 'false',
  // if truthy, will run extra checks to see if there is a package-lock.json
  // or yarn.lock file in a given directory and use that installer if so.
  detectLockFiles: process.env.RI_DETECT_LOCK_FILES !== 'false',
  // what kind of logging should be done on the spawned processes?
  // if this exists and it is not errors it will log everything
  // otherwise it will only log stderr and spawn errors
  log: process.env.RI_LOG || 'errors',
  // max depth to recurse?
  maxDepth: process.env.RI_MAX_DEPTH || Infinity,
  // do not install at the root directory?
  ignoreRoot: Boolean(process.env.RI_IGNORE_ROOT),
  // an array (or comma separated string for env var) of directories
  // to skip while recursing. if array, can pass functions which
  // return a boolean after receiving the dir path and fs.Dirent args
  // @see https://nodejs.org/api/fs.html#fs_class_fs_dirent
  skipDirectories: process.env.RI_SKIP_DIRS
    ? process.env.RI_SKIP_DIRS.split(',').map(str => str.trim())
    : undefined,
  // just run through and log the actions that would be taken?
  dry: Boolean(process.env.RI_DRY_RUN),
  ...config
});

function handleSpawnedProcess(dir, log, proc) {
  return new Promise((resolve, reject) => {
    proc.on('error', error => {
      console.log(`
----------------
  [RI] | [ERROR] | Failed to Spawn Process
  - Path:   ${dir}
  - Reason: ${error.message}
----------------
  `);
      reject(error);
    });

    if (log) {
      proc.stderr.on('data', data => {
        console.error(`[RI] | [${dir}] | ${data}`);
      });
    }

    if (log && log !== 'errors') {
      proc.stdout.on('data', data => {
        console.log(`[RI] | [${dir}] | ${data}`);
      });
    }

    proc.on('close', code => {
      if (log && log !== 'errors') {
        console.log(`
----------------
  [RI] | [COMPLETE] | Spawned Process Closed
  - Path: ${dir}
  - Code: ${code}
----------------
        `);
      }
      if (code === 0) {
        resolve();
      } else {
        reject(
          new Error(
            `[RI] | [ERROR] | [${dir}] | failed to install with exit code ${code}`
          )
        );
      }
    });
  });
}

async function recurseDirectory(rootDir, config) {
  const {
    useYarn,
    yarnWorkspaces,
    detectLockFiles,
    log,
    maxDepth,
    ignoreRoot,
    skipDirectories,
    dry
  } = config;

  const installPromises = [];

  function install(cmd, folder, relativeDir) {
    const proc = cp.spawn(cmd, ['install'], {
      cwd: folder,
      env: process.env
    });
    installPromises.push(handleSpawnedProcess(relativeDir, log, proc));
  }

  function shouldSkipFile(filePath, file) {
    if (!file.isDirectory() || file.name === 'node_modules') {
      return true;
    }
    if (!skipDirectories) {
      return false;
    }
    return skipDirectories.some(check =>
      typeof check === 'function' ? check(filePath, file) : check === file.name
    );
  }

  async function getInstallCommand(folder) {
    let cmd = useYarn ? 'yarn' : 'npm';
    if (detectLockFiles) {
      const [hasYarnLock, hasPackageLock] = await Promise.all([
        fs
          .readFile(path.join(folder, 'yarn.lock'))
          .then(() => true)
          .catch(() => false),
        fs
          .readFile(path.join(folder, 'package-lock.json'))
          .then(() => true)
          .catch(() => false)
      ]);
      if (cmd === 'yarn' && !hasYarnLock && hasPackageLock) {
        cmd = 'npm';
      } else if (cmd === 'npm' && !hasPackageLock && hasYarnLock) {
        cmd = 'yarn';
      }
    }
    return cmd;
  }

  async function installRecursively(folder, depth = 0) {
    if (dry || (log && log !== 'errors')) {
      console.log('[RI] | Check Directory --> ', folder);
    }

    let pkg;

    if (folder !== rootDir || !ignoreRoot) {
      try {
        // Check if package.json exists, if it doesnt this will error and move on
        pkg = JSON.parse(await fs.readFile(path.join(folder, 'package.json')));
        // get the command that we should use.  if lock checking is enabled it will
        // also determine what installer to use based on the available lock files
        const cmd = await getInstallCommand(folder);
        const relativeDir = `${path.basename(rootDir)} -> ./${path.relative(
          rootDir,
          folder
        )}`;
        if (dry || (log && log !== 'errors')) {
          console.log(
            `[RI] | Performing (${cmd} install) at path "${relativeDir}"`
          );
        }
        if (!dry) {
          install(cmd, folder, relativeDir);
        }
      } catch {
        // do nothing when error caught as it simply indicates package.json likely doesnt
        // exist.
      }
    }

    if (
      depth >= maxDepth ||
      (pkg && useYarn && yarnWorkspaces && pkg.workspaces)
    ) {
      // if we have reached maxDepth or if our package.json in the current directory
      // contains yarn workspaces then we use yarn for installing then this is the last
      // directory we will attempt to install.
      return;
    }

    const files = await fs.readdir(folder, { withFileTypes: true });

    return Promise.all(
      files.map(file => {
        const filePath = path.join(folder, file.name);
        return shouldSkipFile(filePath, file)
          ? undefined
          : installRecursively(filePath, depth + 1);
      })
    );
  }

  await installRecursively(rootDir);
  await Promise.all(installPromises);
}

async function startRecursiveInstall(directories, _config) {
  const config = getConfig(_config);
  const promise = Array.isArray(directories)
    ? Promise.all(directories.map(rootDir => recurseDirectory(rootDir, config)))
    : recurseDirectory(directories, config);
  await promise;
}

if (AUTO_RUN) {
  startRecursiveInstall(process.cwd());
}

module.exports = startRecursiveInstall;

---

随着它的使用：

const installRecursively = require('./recursive-install');

installRecursively(process.cwd(), { dry: true })

Answer 12

find . -maxdepth 1 -type d \( ! -name . \) -exec bash -c "cd '{}' && npm install" \;

Answer 13

要在每个子目录上运行 npm install，您可以执行以下操作：

"scripts": {
  ...
  "install:all": "for D in */; do npm install --cwd \"${D}\"; done"
}

在哪里

install:all 只是脚本的名字，你可以随意命名

D是当前迭代的目录名

*/ 指定要查找子目录的位置。 directory/*/ 将列出directory/ 中的所有目录，directory/*/*/ 将列出所有目录中的两个级别。

npm install -cwd 在给定文件夹中安装所有依赖项

您还可以运行多个命令，例如：

for D in */; do echo \"Installing stuff on ${D}\" && npm install --cwd \"${D}\"; done

将在每次迭代时打印“Installing stuff on your_subfolder/”。

这也适用于yarn

Answer 14

[对于 macOS、Linux 用户]：

我创建了一个 bash 文件来安装项目和嵌套文件夹中的所有依赖项。

find . -name node_modules -prune -o -name package.json -execdir npm install \;

说明：在根目录中，排除node_modules文件夹（即使在嵌套文件夹中），找到有package.json文件的目录然后运行npm install命令。

如果您只想在指定文件夹（例如：abc123、def456 文件夹）上查找，请按以下方式运行：

find ./abc123/* ./def456/* -name node_modules -prune -o -name package.json -execdir npm install \;

Answer 15

任何可以获取目录列表并运行 shell 命令的语言都可以为您执行此操作。

我知道这不是 OP 想要的确切答案，但它始终有效。您需要创建一个子目录名称数组，然后遍历它们并运行npm i，或者您需要运行的任何命令。

作为参考，我尝试了npm i **/，它只是安装了父目录中所有子目录中的模块。这非常不直观，但不用说这不是您需要的解决方案。