Installieren Sie Abhängigkeiten global und lokal mit package.json

Mit npm können wir die Module mithilfe der -gOption global installieren . Wie können wir dies in der Datei package.json tun?

Angenommen, dies sind meine Abhängigkeiten in der Datei package.json

"dependencies": {
    "mongoose": "1.4.0",
    "node.io" : "0.3.3",
    "jquery"  : "1.5.1",
    "jsdom"   : "0.2.0",
    "cron"    : "0.1.2"
  }

Wenn ich laufe npm install, möchte ich nur node.ioglobal installiert werden, der Rest andere sollten lokal installiert werden. Gibt es dafür eine Option?

Neuer Hinweis: Sie möchten oder müssen dies wahrscheinlich nicht tun. Was Sie wahrscheinlich tun möchten, ist, diese Arten von Befehlsabhängigkeiten für Build / Test usw. in den devDependenciesAbschnitt Ihrer package.json einzufügen. Jedes Mal, wenn Sie etwas aus scriptspackage.json verwenden, verhalten sich Ihre devDependencies-Befehle (in node_modules / .bin) so, als ob sie sich in Ihrem Pfad befinden.

Beispielsweise:

npm i --save-dev mocha # Install test runner locally
npm i --save-dev babel # Install current babel locally

Dann in package.json:

// devDependencies has mocha and babel now

"scripts": {
  "test": "mocha",
  "build": "babel -d lib src",
  "prepublish": "babel -d lib src"
}

Dann können Sie an Ihrer Eingabeaufforderung Folgendes ausführen:

npm run build # finds babel
npm test # finds mocha

npm publish # will run babel first

Aber wenn Sie wirklich global installieren möchten, können Sie eine Preinstall in der Skripte Abschnitt des package.json hinzu:

"scripts": {
  "preinstall": "npm i -g themodule"
}

Also führt meine npm-Installation die npm-Installation erneut aus. Das ist seltsam, scheint aber zu funktionieren.

Hinweis: Möglicherweise treten Probleme auf, wenn Sie das am häufigsten verwendete Setup für die npmInstallation des globalen Knotenpakets verwenden sudo. Eine Möglichkeit besteht darin, Ihre npmKonfiguration so zu ändern , dass dies nicht erforderlich ist:

npm config set prefix ~/npmFügen Sie $ PATH $ HOME / npm / bin hinzu, indem Sie export PATH=$HOME/npm/bin:$PATHan Ihren anhängen ~/.bashrc.

Aufgrund der unten beschriebenen Nachteile würde ich empfehlen, der akzeptierten Antwort zu folgen:

Verwenden Sie npm install --save-dev [package_name]dann Skripte mit:

$ npm run lint
$ npm run build
$ npm test

Meine ursprüngliche, aber nicht empfohlene Antwort folgt.

Anstatt eine globale Installation zu verwenden, können Sie das Paket zu Ihrem devDependencies( --save-dev) hinzufügen und dann die Binärdatei von einer beliebigen Stelle in Ihrem Projekt aus ausführen:

"$(npm bin)/<executable_name>" <arguments>...

In deinem Fall:

"$(npm bin)"/node.io --help

Dieser Ingenieur hat einen npm-execAlias ​​als Verknüpfung bereitgestellt . Dieser Ingenieur verwendet ein Shellscript namens env.sh. Ich bevorzuge jedoch die $(npm bin)direkte Verwendung , um zusätzliche Dateien oder Einstellungen zu vermeiden.

Obwohl es jeden Anruf etwas größer macht, sollte es einfach funktionieren und Folgendes verhindern:

• Mögliche Abhängigkeitskonflikte mit globalen Paketen (@nalply)
• der Bedarf an sudo
• die Notwendigkeit, ein npm-Präfix einzurichten (obwohl ich die Verwendung eines Präfixes trotzdem empfehle)

Nachteile:

• $(npm bin) funktioniert nicht unter Windows.
• Werkzeuge, die sich tiefer in Ihrem Entwicklungsbaum befinden, werden nicht im npm binOrdner angezeigt. (Installieren Sie npm-run oder npm-which , um sie zu finden.)

Es scheint eine bessere Lösung zu sein, allgemeine Aufgaben (wie das Erstellen und Minimieren) im Abschnitt "Skripte" von Ihnen zu platzieren package.json, wie Jason oben demonstriert.

Das ist ein bisschen alt, aber ich bin auf die Anforderung gestoßen. Hier ist die Lösung, die ich gefunden habe.

Das Problem:

Unser Entwicklungsteam verwaltet viele .NET-Webanwendungsprodukte, die wir auf AngularJS / Bootstrap migrieren. VS2010 eignet sich nicht einfach für benutzerdefinierte Build-Prozesse, und meine Entwickler arbeiten routinemäßig an mehreren Releases unserer Produkte. Unser VCS ist Subversion (ich weiß, ich weiß. Ich versuche, zu Git zu wechseln, aber meine lästigen Marketingmitarbeiter sind so anspruchsvoll) und eine einzige VS-Lösung wird mehrere separate Projekte enthalten. Ich brauchte meine Mitarbeiter, um eine gemeinsame Methode zum Initialisieren ihrer Entwicklungsumgebung zu haben, ohne dieselben Knotenpakete (gulp, bower usw.) mehrmals auf demselben Computer installieren zu müssen.

TL; DR:

1. Benötigen Sie "npm install", um die globale Node / Bower-Entwicklungsumgebung sowie alle lokal erforderlichen Pakete für ein .NET-Produkt zu installieren.

2. Globale Pakete sollten nur installiert werden, wenn sie noch nicht installiert sind.

3. Lokale Links zu globalen Paketen müssen automatisch erstellt werden.

Die Lösung:

Wir haben bereits ein gemeinsames Entwicklungsframework, das von allen Entwicklern und allen Produkten gemeinsam genutzt wird. Daher habe ich ein NodeJS-Skript erstellt, um die globalen Pakete bei Bedarf zu installieren und die lokalen Links zu erstellen. Das Skript befindet sich in ".... \ SharedFiles" relativ zum Produktbasisordner:

/*******************************************************************************
* $Id: npm-setup.js 12785 2016-01-29 16:34:49Z sthames $
* ==============================================================================
* Parameters: 'links' - Create links in local environment, optional.
* 
* <p>NodeJS script to install common development environment packages in global
* environment. <c>packages</c> object contains list of packages to install.</p>
* 
* <p>Including 'links' creates links in local environment to global packages.</p>
* 
* <p><b>npm ls -g --json</b> command is run to provide the current list of 
* global packages for comparison to required packages. Packages are installed 
* only if not installed. If the package is installed but is not the required 
* package version, the existing package is removed and the required package is 
* installed.</p>.
*
* <p>When provided as a "preinstall" script in a "package.json" file, the "npm
* install" command calls this to verify global dependencies are installed.</p>
*******************************************************************************/
var exec = require('child_process').exec;
var fs   = require('fs');
var path = require('path');

/*---------------------------------------------------------------*/
/* List of packages to install and 'from' value to pass to 'npm  */
/* install'. Value must match the 'from' field in 'npm ls -json' */
/* so this script will recognize a package is already installed. */
/*---------------------------------------------------------------*/
var packages = 
  {
  "bower"                      :                      "bower@1.7.2", 
  "event-stream"               :               "event-stream@3.3.2",
  "gulp"                       :                       "gulp@3.9.0",
  "gulp-angular-templatecache" : "gulp-angular-templatecache@1.8.0",
  "gulp-clean"                 :                 "gulp-clean@0.3.1", 
  "gulp-concat"                :                "gulp-concat@2.6.0",
  "gulp-debug"                 :                 "gulp-debug@2.1.2",
  "gulp-filter"                :                "gulp-filter@3.0.1",
  "gulp-grep-contents"         :         "gulp-grep-contents@0.0.1",
  "gulp-if"                    :                    "gulp-if@2.0.0", 
  "gulp-inject"                :                "gulp-inject@3.0.0", 
  "gulp-minify-css"            :            "gulp-minify-css@1.2.3",
  "gulp-minify-html"           :           "gulp-minify-html@1.0.5",
  "gulp-minify-inline"         :         "gulp-minify-inline@0.1.1",
  "gulp-ng-annotate"           :           "gulp-ng-annotate@1.1.0",
  "gulp-processhtml"           :           "gulp-processhtml@1.1.0",
  "gulp-rev"                   :                   "gulp-rev@6.0.1",
  "gulp-rev-replace"           :           "gulp-rev-replace@0.4.3",
  "gulp-uglify"                :                "gulp-uglify@1.5.1",
  "gulp-useref"                :                "gulp-useref@3.0.4",
  "gulp-util"                  :                  "gulp-util@3.0.7",
  "lazypipe"                   :                   "lazypipe@1.0.1",
  "q"                          :                          "q@1.4.1",
  "through2"                   :                   "through2@2.0.0",

  /*---------------------------------------------------------------*/
  /* fork of 0.2.14 allows passing parameters to main-bower-files. */
  /*---------------------------------------------------------------*/
  "bower-main"                 : "git+https://github.com/Pyo25/bower-main.git" 
  }

/*******************************************************************************
* run */
/**
* Executes <c>cmd</c> in the shell and calls <c>cb</c> on success. Error aborts.
* 
* Note: Error code -4082 is EBUSY error which is sometimes thrown by npm for 
* reasons unknown. Possibly this is due to antivirus program scanning the file 
* but it sometimes happens in cases where an antivirus program does not explain 
* it. The error generally will not happen a second time so this method will call 
* itself to try the command again if the EBUSY error occurs.
* 
* @param  cmd  Command to execute.
* @param  cb   Method to call on success. Text returned from stdout is input.
*******************************************************************************/
var run = function(cmd, cb)
  {
  /*---------------------------------------------*/
  /* Increase the maxBuffer to 10MB for commands */
  /* with a lot of output. This is not necessary */
  /* with spawn but it has other issues.         */
  /*---------------------------------------------*/
  exec(cmd, { maxBuffer: 1000*1024 }, function(err, stdout)
    {
    if      (!err)                   cb(stdout);
    else if (err.code | 0 == -4082) run(cmd, cb);
    else throw err;
    });
  };

/*******************************************************************************
* runCommand */
/**
* Logs the command and calls <c>run</c>.
*******************************************************************************/
var runCommand = function(cmd, cb)
  {
  console.log(cmd);
  run(cmd, cb);
  }

/*******************************************************************************
* Main line
*******************************************************************************/
var doLinks  = (process.argv[2] || "").toLowerCase() == 'links';
var names    = Object.keys(packages);
var name;
var installed;
var links;

/*------------------------------------------*/
/* Get the list of installed packages for   */
/* version comparison and install packages. */
/*------------------------------------------*/
console.log('Configuring global Node environment...')
run('npm ls -g --json', function(stdout)
  {
  installed = JSON.parse(stdout).dependencies || {};
  doWhile();
  });

/*--------------------------------------------*/
/* Start of asynchronous package installation */
/* loop. Do until all packages installed.     */
/*--------------------------------------------*/
var doWhile = function()
  {
  if (name = names.shift())
    doWhile0();
  }

var doWhile0 = function()
  {
  /*----------------------------------------------*/
  /* Installed package specification comes from   */
  /* 'from' field of installed packages. Required */
  /* specification comes from the packages list.  */
  /*----------------------------------------------*/
  var current  = (installed[name] || {}).from;
  var required =   packages[name];

  /*---------------------------------------*/
  /* Install the package if not installed. */
  /*---------------------------------------*/
  if (!current)
    runCommand('npm install -g '+required, doWhile1);

  /*------------------------------------*/
  /* If the installed version does not  */
  /* match, uninstall and then install. */
  /*------------------------------------*/
  else if (current != required)
    {
    delete installed[name];
    runCommand('npm remove -g '+name, function() 
      {
      runCommand('npm remove '+name, doWhile0);
      });
    }

  /*------------------------------------*/
  /* Skip package if already installed. */
  /*------------------------------------*/
  else
    doWhile1();
  };

var doWhile1 = function()
  {
  /*-------------------------------------------------------*/
  /* Create link to global package from local environment. */
  /*-------------------------------------------------------*/
  if (doLinks && !fs.existsSync(path.join('node_modules', name)))
    runCommand('npm link '+name, doWhile);
  else
    doWhile();
  };

Wenn ich nun ein globales Tool für unsere Entwickler aktualisieren möchte, aktualisiere ich das Objekt "packages" und checke das neue Skript ein. Meine Entwickler checken es aus und führen es entweder mit "node npm-setup.js" oder mit "npm install" von einem der in der Entwicklung befindlichen Produkte aus, um die globale Umgebung zu aktualisieren. Das Ganze dauert 5 Minuten.

Um die Umgebung für einen neuen Entwickler zu konfigurieren, müssen diese zunächst nur NodeJS und GIT für Windows installieren, ihren Computer neu starten, den Ordner "Freigegebene Dateien" und alle in der Entwicklung befindlichen Produkte überprüfen und mit der Arbeit beginnen.

Die Datei "package.json" für das .NET-Produkt ruft dieses Skript vor der Installation auf:

{ 
"name"                    : "Books",
"description"             : "Node (npm) configuration for Books Database Web Application Tools",
"version"                 : "2.1.1",
"private"                 : true,
"scripts":
  {
  "preinstall"            : "node ../../SharedFiles/npm-setup.js links",
  "postinstall"           : "bower install"
  },
"dependencies": {}
}

Anmerkungen

• Beachten Sie, dass die Skriptreferenz auch in einer Windows-Umgebung Schrägstriche erfordert.

• "npm ls" gibt "npm ERR! extraneous:" Nachrichten für alle lokal verknüpften Pakete aus, da sie nicht in den "package.json" "Abhängigkeiten" aufgeführt sind.

Bearbeiten 29.01.16

Das oben aktualisierte npm-setup.jsSkript wurde wie folgt geändert:

• Paket "Version" in var packagesist jetzt der Wert für "Paket", der npm installin der Befehlszeile übergeben wird. Dies wurde geändert, um die Installation von Paketen von einem anderen Ort als dem registrierten Repository zu ermöglichen.

• Wenn das Paket bereits installiert ist, aber nicht angefordert wird, wird das vorhandene Paket entfernt und das richtige installiert.

• Aus unbekannten Gründen gibt npm bei der Installation oder Verknüpfung regelmäßig einen EBUSY-Fehler (-4082) aus. Dieser Fehler wird abgefangen und der Befehl erneut ausgeführt. Der Fehler tritt selten ein zweites Mal auf und scheint sich immer zu klären.

Sie können npm_globals.txtstattdessen eine separate Datei verwenden package.json. Diese Datei würde jedes Modul in einer neuen Zeile wie dieser enthalten:

mongoose@1.4.0
node.io@0.3.3
jquery@1.5.1
jsdom@0.2.0
cron@0.1.2

Dann in der Kommandozeile ausführen,

< npm_globals.txt xargs npm install -g

Überprüfen Sie, ob sie ordnungsgemäß installiert wurden mit,

npm list -g --depth=0

Ob Sie dies tun sollten oder nicht, hängt meiner Meinung nach vom Anwendungsfall ab. Für die meisten Projekte ist dies nicht erforderlich. Es package.jsonwird sehr bevorzugt, wenn Ihre Projekte diese Tools und Abhängigkeiten zusammenfassen.

Aber heutzutage stelle ich fest, dass ich immer create-react-appandere CLIs global installiere, wenn ich auf einen neuen Computer springe. Es ist schön, eine einfache Möglichkeit zu haben, ein globales Tool und seine Abhängigkeiten zu installieren, wenn die Versionierung keine große Rolle spielt.

Und heute, ich verwende npx, ein npm Paket Läufer , statt Pakete global installieren.

Alle Module aus package.json werden unter ./node_modules/ installiert.

Ich konnte dies nicht explizit angeben, aber dies ist die package.json-Referenz für NPM .

Erstellen Sie Ihr eigenes Skript, um globale Abhängigkeiten zu installieren. Es braucht nicht viel. package.json ist ziemlich erweiterbar.

const {execSync} = require('child_process');

JSON.parse(fs.readFileSync('package.json'))
     .globalDependencies.foreach(
         globaldep => execSync('npm i -g ' + globaldep)
     );

Mit dem oben genannten können Sie es sogar unten inline machen!

Schauen Sie sich die Vorinstallation unten an:

{
  "name": "Project Name",
  "version": "0.1.0",
  "description": "Project Description",
  "main": "app.js",
  "scripts": {
    "preinstall": "node -e \"const {execSync} = require('child_process'); JSON.parse(fs.readFileSync('package.json')).globalDependencies.foreach(globaldep => execSync('npm i -g ' + globaldep));\"",
    "build": "your transpile/compile script",
    "start": "node app.js",
    "test": "./node_modules/.bin/mocha --reporter spec",
    "patch-release": "npm version patch && npm publish && git add . && git commit -m \"auto-commit\" && git push --follow-tags"
  },
  "dependencies": [
  },
  "globalDependencies": [
    "cordova@8.1.2",
    "ionic",
    "potato"
  ],
  "author": "author",
  "license": "MIT",
  "devDependencies": {
    "chai": "^4.2.0",
    "mocha": "^5.2.0"
  },
  "bin": {
    "app": "app.js"
  }
}

Die Autoren von node geben möglicherweise nicht zu, dass package.json eine Projektdatei ist. Aber es ist.