Лучший способ запустить npm для вложенных папок?

Каков наиболее правильный способ установки npm packages во вложенные подпапки?

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

Каков наилучший способ установки packages в /my-sub-module автоматически, когда npm install работает в my-app?

ОТВЕТЫ

Ответ 1

Если вы хотите запустить одну команду для установки пакетов 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

Ответ 2

Я предпочитаю использовать post-install, если вы знаете имена вложенного subdir. В package.json:

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

Ответ 3

Мое решение очень похоже. Чистый Node.js

Следующий script рассматривает все вложенные папки (рекурсивно), если они имеют package.json, и запускает npm install в каждом из них. К нему можно добавить исключения: папкам разрешено не иметь package.json. В приведенном ниже примере одна такая папка представляет собой "пакеты". Его можно запустить как "preinstall" script.

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 no `package.json` in this folder and it 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))
}

Ответ 4

Просто для справки, если люди сталкиваются с этим вопросом. Ты можешь сейчас:

  • Добавить package.json в подпапку
  • Установите эту подпапку как ссылку-ссылку в основном package.json:

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

Ответ 5

Добавление поддержки Windows в ответ snozza

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 (!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' })
})

Ответ 6

Я предпочитаю использовать 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:*"
}

Ответ 7

Вдохновленный сценариями, представленными здесь, я создал настраиваемый пример, который:

  • можно настроить для использования yarn или npm
  • может быть настроен для определения команды, используемой на основе файлов блокировки, так что, если вы установите для нее использование yarn но в каталоге есть только package-lock.json он будет использовать npm для этого каталога (по умолчанию true).
  • настроить ведение журнала
  • параллельно запускает инсталляцию cp.spawn
  • может делать пробные прогоны, чтобы вы увидели, что он будет делать в первую очередь
  • может быть запущен как функция или автоматический запуск с помощью env vars
    • при запуске в качестве функции, необязательно, предоставить массив каталогов для проверки
  • возвращает обещание, которое разрешается после завершения
  • позволяет установить максимальную глубину, чтобы посмотреть, если это необходимо
  • знает, чтобы остановить повторение, если он находит папку с yarn workspaces (настраивается)
  • позволяет пропускать каталоги, используя разделенную запятыми переменную env var или передавая config массив строк для сопоставления или функцию, которая получает имя файла, путь к файлу и объект fs.Dirent и ожидает логический результат.
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 })

Ответ 8

Согласно ответу @Scott, скрипт install | postinstall является самым простым способом, если известны имена подкаталогов. Вот как я запускаю его для нескольких вложенных папок. Например, представьте, что у нас есть api/, web/ и shared/ в корне monorepo:

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