नेस्टेड फ़ोल्डरों के लिए npm इंस्टॉल चलाने का सबसे अच्छा तरीका है?


128

npm packagesनेस्टेड उप फ़ोल्डर्स में स्थापित करने का सबसे सही तरीका क्या है ?

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

सबसे अच्छा तरीका है करने के लिए क्या है packagesमें /my-sub-moduleजब अपने आप स्थापित कर npm installमें चला my-app?


मुझे लगता है कि सबसे मुहावरेदार बात यह है कि आपके प्रोजेक्ट के पास एक ही पैकेज है।
रॉबर्ट मोस्कल

एक विचार एक npm स्क्रिप्ट का उपयोग करना होगा जो एक bash फ़ाइल चलाता है।
डेविन ट्रिनटन

यह कैसे स्थानीय पथ काम के लिए एक modificaiton के साथ नहीं किया जा सकता है ?: stackoverflow.com/questions/14381898/…
इवांस

जवाबों:


26

यदि आप नेस्टेड सबफ़ोल्डर्स में एनपीएम पैकेज स्थापित करने के लिए एकल कमांड चलाना चाहते हैं, तो आप अपनी रूट डायरेक्टरी में स्क्रिप्ट को npmमुख्य रूप से चला सकते हैं 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' })
})

ध्यान दें कि यह एक स्ट्रॉन्ग्लूप लेख से लिया गया एक उदाहरण है जो विशेष रूप से एक मॉड्यूलर node.jsप्रोजेक्ट संरचना (नेस्टेड घटकों और package.jsonफ़ाइलों सहित ) को संबोधित करता है ।

जैसा कि सुझाव दिया गया है, आप भी बैश स्क्रिप्ट के साथ एक ही चीज हासिल कर सकते हैं।

EDIT: विंडोज में कोड काम करता है


1
हालांकि, जटिल करने के लिए लेख लिंक के लिए धन्यवाद।
WHITECOLOR

हालांकि 'कंपोनेंट' आधारित संरचना नोड ऐप को सेटअप करने का एक आसान तरीका है, यह संभवत: अलग-अलग पैकेज.जॉसन फ़ाइलों आदि को तोड़ने के लिए ऐप के शुरुआती चरणों में ओवरकिल है। यह विचार तब बढ़ता है जब ऐप बढ़ता है और आप वैध रूप से अलग मॉड्यूल / सेवाएं चाहते हैं। लेकिन हाँ, निश्चित रूप से बहुत जटिल हो यदि आवश्यक न हो।
स्नोजा

3
हालांकि हां एक बैश स्क्रिप्ट होगी, लेकिन मैं विंडोज के बीच अधिकतम पोर्टेबिलिटी के लिए नोड्ज तरीका करना पसंद करता हूं जिसमें एक डॉस शेल और लिनक्स / मैक है जिसमें यूनिक्स शेल है।
०१ पर truthadjustr

270

मैं पोस्ट-इंस्टाल का उपयोग करना पसंद करता हूं, यदि आप नेस्टेड सबडिर के नाम जानते हैं। इन package.json:

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

10
कई फ़ोल्डर्स के बारे में क्या? "cd nested_dir && npm install && cd .. & cd nested_dir2 && npm"?
एमेर

1
@ ईमरे हां - यही है।
गाइ

2
@ तो क्या आप अगले पैकेज को अंदर के पैकेज में नहीं रख सकते हैं "postinstall": "cd nested_dir2 && npm install"?
एरोन

1
@ यदि आप मूल नाम निर्देशिका के भीतर दो उपनिर्देशिका चाहते हैं तो क्या होगा?
एलेक

29
@Emre जो काम करना चाहिए, सब-क्लीयर थोड़े साफ हो सकते हैं: "(cd nested_dir &&pm install); (cd nested_dir2 && npm install); ..."
एलेक

49

@ स्कॉट के जवाब के अनुसार, इंस्टॉल करें। पोस्ट-स्क्रिप्ट स्क्रिप्ट तब तक सबसे सरल तरीका है जब तक उप-निर्देशिका नामों को जाना जाता है। यह है कि मैं इसे कई उप डायर के लिए कैसे चलाता हूं। उदाहरण के लिए, नाटक हमारे पास api/, web/और shared/एक monorepo जड़ में उप-परियोजनाओं:

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

1
सही समाधान। साझा करने के लिए धन्यवाद :-)
राहुल सोनी 10

1
जवाब के लिए धन्यवाद। मेरे लिए काम करना।
AMIC MING

5
( )उप-समूह बनाने और बचने के लिए अच्छा उपयोग cd api && npm install && cd ..
कैमरन हडसन

4
वह चयनित उत्तर होना चाहिए!
tmos

3
npm installशीर्ष स्तर पर दौड़ने पर मुझे यह त्रुटि मिलती है:"(cd was unexpected at this time."
श्री पॉलीविरल

22

मेरा समाधान बहुत समान है। शुद्ध Node.js

निम्नलिखित स्क्रिप्ट सभी सबफ़ोल्डर्स (पुनरावर्ती) की जाँच करता है जब तक कि उनके पास है package.jsonऔर npm installउनमें से प्रत्येक में चलता है। कोई इसमें अपवाद जोड़ सकता है: फ़ोल्डर्स को अनुमति नहीं है package.json। नीचे दिए गए उदाहरण में एक ऐसा फ़ोल्डर "पैकेज" है। कोई इसे "प्रीइंस्टॉल" स्क्रिप्ट के रूप में चला सकता है।

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))
}

3
आपकी पटकथा अच्छी है। हालाँकि, अपने व्यक्तिगत उद्देश्यों के लिए मैं एक गहरी नेस्टेड 'npm इंस्टॉल' प्राप्त करने के लिए पहले 'if कंडीशन' को हटाना पसंद करता हूँ!
गुइलहर्मे कैरासीलो

21

बस इस मामले में लोग इस सवाल के संदर्भ में आते हैं। अब तुम यह कर सकते हो:

  • एक सबफ़ोल्डर में एक पैकेज जोड़ें
  • मुख्य पैकेज में संदर्भ-लिंक के रूप में इस सबफ़ोल्डर को स्थापित करें। json:

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


2
ध्यान दें कि रूट फ़ोल्डर में निर्भरताएँ स्थापित हैं। मुझे संदेह है कि अगर आप इस पैटर्न पर विचार कर रहे हैं, तो आप उप-निर्देशिका पैकेज की निर्भरता चाहते हैं। उप-निर्देशिका में।
कोडी एलन टेलर

आपका क्या अर्थ है? सबफ़ोल्डर-पैकेज के लिए निर्भरताएँ पैकेज में हैं। सबफ़ोल्डर में।
जेलेर जेलेमा

(npm v6.6.0 और नोड v8.15.0 का उपयोग करते हुए) - अपने लिए एक उदाहरण सेट करें। mkdir -p a/b ; cd a ; npm init ; cd b ; npm init ; npm install --save through2 ;अब प्रतीक्षा करें ... आप बस "बी" में मैन्युअल रूप से निर्भरता स्थापित करते हैं, यह तब नहीं होता है जब आप एक ताजा प्रोजेक्ट क्लोन करते हैं। rm -rf node_modules ; cd .. ; npm install --save ./b। अब नोड_मॉड्यूल्स को सूचीबद्ध करें, फिर सूची बी।
कोडी एलन टेलर

1
आह आप मॉड्यूल का मतलब है हां, b के लिए node_modules एक / nad_modules में इंस्टॉल किए जाएंगे। जो समझ में आता है, क्योंकि आपको मुख्य कोड के हिस्से के रूप में मॉड्यूल की आवश्यकता होगी / शामिल है, न कि "वास्तविक" नोड मॉड्यूल के रूप में। तो एक "आवश्यकता ('throug2')" एक / नोड_मॉड्यूल्स में 2 के माध्यम से खोज करेगा।
जेलेमर जेलेमा

मैं कोड जनरेशन करने की कोशिश कर रहा हूं और एक सबफ़ोल्डर-पैकेज चाहता हूं, जो चलाने के लिए पूरी तरह से तैयार है, जिसमें उसके खुद के नोड_मॉड्यूल्स भी शामिल हैं। अगर मुझे समाधान मिल गया, तो मैं अपडेट करना सुनिश्चित करूँगा!
ओह्सुली

19

केस 1 का उपयोग करें : यदि आप प्रत्येक उपनिर्देशिका (जहाँ प्रत्येक पैकेज.जसन है) के भीतर से एनपीएम कमांड चलाने में सक्षम हैं, तो आपको उपयोग करने की आवश्यकता होगी 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निर्भरता के रूप में नहीं चाहते हैं , तो डेमिसक्स के उत्तर की जांच करें (पोस्ट-इंस्टॉलेशन में उपखंड का उपयोग करके)।

केस 2 का उपयोग करें : यदि आप रूट डायरेक्टरी से सभी npm कमांड्स चला रहे होंगे (और, उदाहरण के लिए, सब-डायरेक्ट्रीज़ में npm स्क्रिप्ट्स का उपयोग नहीं कर रहे होंगे), तो आप बस प्रत्येक उपनिर्देशिका को स्थापित कर सकते हैं जैसे कि आप किसी भी भरोसेमंद हैं:

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

बाद के मामले में, आश्चर्यचकित न हों कि आपको उप-निर्देशिकाओं में कोई फ़ाइल node_modulesया package-lock.jsonफ़ाइल नहीं मिलती है - सभी पैकेज रूट में स्थापित किए जाएंगे node_modules, यही वजह है कि आप अपने npm कमांड को चलाने में सक्षम नहीं होंगे (कि आपके किसी भी उपनिर्देशिका से निर्भरता की आवश्यकता है)।

यदि आप निश्चित नहीं हैं, तो केस 1 हमेशा काम करता है।


यह अच्छा है कि प्रत्येक सबमॉड्यूल की अपनी स्वयं की स्थापित स्क्रिप्ट है और फिर उन सभी को पोस्ट-इंस्टॉलेशन में निष्पादित करें। run-pआवश्यक नहीं है, लेकिन यह तब अधिक क्रिया है"postinstall": "npm run install:a && npm run install:b"
क्वर्टी

हाँ, आप &&बिना उपयोग कर सकते हैं run-p। लेकिन जैसा कि आप कहते हैं, यह कम पठनीय है। एक और दोष (जो रन-पी सॉल्व करता है क्योंकि इंस्टॉल समानांतर में चलता है) यह है कि यदि कोई विफल होता है, तो कोई अन्य स्क्रिप्ट प्रभावित नहीं होती है
डॉन वॉन

3

स्नोज़्ज़ा के उत्तर के लिए विंडोज समर्थन जोड़ना , साथ ही साथ 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' })
})

आपको यकीन है। मैंने नोड_मॉडल फ़ोल्डर को छोड़ने के लिए अपना समाधान अपडेट किया है।
भूतयंत्र

2

यहाँ प्रदान की गई लिपियों से प्रेरित होकर, मैंने एक विन्यास योग्य उदाहरण बनाया है:

  • उपयोग करने के लिए सेटअप किया जा सकता है yarn याnpm
  • लॉक फ़ाइलों के आधार पर उपयोग करने के लिए आदेश का निर्धारण करने के लिए सेटअप किया जा सकता है ताकि यदि आप इसे उपयोग करने के लिए सेट करें yarnलेकिन एक निर्देशिका केवल एक हैpackage-lock.json इसका उपयोग npmउस निर्देशिका के लिए होगा (सत्य के लिए चूक)।
  • लॉगिंग कॉन्फ़िगर करें
  • समानांतर उपयोग में संस्थापन चलाता है cp.spawn
  • सूखा रन बनाने के लिए आप देख सकते हैं कि यह पहले क्या करेगा
  • env vars का उपयोग करके फंक्शन या ऑटो रन के रूप में चलाया जा सकता है
    • जब एक फ़ंक्शन के रूप में चलाया जाता है, तो वैकल्पिक रूप से चेक करने के लिए डायरेक्टरी की सरणी प्रदान करें
  • एक वादा लौटाता है जो पूरा होने पर हल हो जाता है
  • यदि आवश्यक हो तो अधिकतम गहराई सेट करने की अनुमति देता है
  • अगर यह एक फ़ोल्डर के साथ मिल जाए तो उसे रोकना जानता है yarn workspaces कॉन्फ़िगर करने योग्य है,
  • अल्पविराम से अलग की गई एनवी वर्जन का उपयोग करके या किसी फ़ंक्शन से मेल करने के लिए स्ट्रिंग्स की एक सरणी को पास करके या फ़ाइल नाम, फ़ाइल पथ, और 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 })

1

यदि आपके पास findअपने सिस्टम पर उपयोगिता है, तो आप अपने एप्लिकेशन रूट डायरेक्टरी में निम्नलिखित कमांड चलाने की कोशिश कर सकते हैं:
find . ! -path "*/node_modules/*" -name "package.json" -execdir npm install \;

मूल रूप से, सभी package.jsonफ़ाइलों को ढूंढें और npm installउस निर्देशिका में सभी node_modulesनिर्देशिकाओं को छोड़ दें ।


1
बहुत बढ़िया जवाब। बस एक ध्यान दें कि आप अतिरिक्त रास्तों को छोड़ सकते हैं:find . ! -path "*/node_modules/*" ! -path "*/additional_path/*" -name "package.json" -execdir npm install \;
इवान मोरन
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.