Instale dependências globalmente e localmente usando package.json

Usando o npm, podemos instalar os módulos globalmente usando a -gopção Como podemos fazer isso no arquivo package.json?

Suponha, essas são minhas dependências no arquivo package.json

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

Quando eu executo npm install, quero apenas node.ioser instalado globalmente, o restante deve ser instalado localmente. Existe uma opção para isso?

Nova nota: você provavelmente não quer ou precisa fazer isso. O que você provavelmente quer fazer é apenas colocar esses tipos de dependências de comando para compilar / testar etc. na devDependenciesseção do seu package.json. Sempre que você usa algo do scriptspackage.json, os comandos devDependencies (em node_modules / .bin) agem como se estivessem no seu caminho.

Por exemplo:

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

Em seguida, em package.json:

// devDependencies has mocha and babel now

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

Em seguida, no prompt de comando, você pode executar:

npm run build # finds babel
npm test # finds mocha

npm publish # will run babel first

Mas se você realmente deseja instalar globalmente, pode adicionar uma pré-instalação na seção de scripts do pacote.json:

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

Então, na verdade, o meu npm install executa o npm install novamente .. o que é estranho, mas parece funcionar.

Nota: você pode ter problemas se estiver usando a configuração mais comum para npmonde o pacote global do Node é necessário sudo. Uma opção é alterar sua npmconfiguração para que isso não seja necessário:

npm config set prefix ~/npm, adicione $ HOME / npm / bin a $ PATH, anexando export PATH=$HOME/npm/bin:$PATHao seu ~/.bashrc.

Devido às desvantagens descritas abaixo, eu recomendaria seguir a resposta aceita:

Use npm install --save-dev [package_name]e execute scripts com:

$ npm run lint
$ npm run build
$ npm test

Minha resposta original, mas não recomendada, segue.

Em vez de usar uma instalação global, você pode adicionar o pacote ao seu devDependencies( --save-dev) e depois executar o binário de qualquer lugar dentro do seu projeto:

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

No seu caso:

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

Este engenheiro forneceu um npm-execalias como atalho. Este engenheiro usa um shellscript chamado env.sh. Mas eu prefiro usar $(npm bin)diretamente, para evitar qualquer arquivo ou configuração extra.

Embora torne cada chamada um pouco maior, deve funcionar , impedindo:

• conflitos de dependência em potencial com pacotes globais (@nalply)
• a necessidade de sudo
• a necessidade de configurar um prefixo npm (apesar de eu recomendar o uso de qualquer maneira)

Desvantagens:

• $(npm bin) não funcionará no Windows.
• Ferramentas mais profundas na sua árvore de desenvolvimento não aparecerão na npm binpasta. (Instale npm-run ou npm-which para encontrá-los.)

Parece que uma solução melhor é colocar tarefas comuns (como compilar e minificar) na seção "scripts" do seu package.json, como Jason demonstra acima.

Isso é um pouco antigo, mas me deparei com o requisito, então aqui está a solução que eu criei.

O problema:

Nossa equipe de desenvolvimento mantém muitos produtos de aplicativos da Web .NET que estamos migrando para o AngularJS / Bootstrap. O VS2010 não se presta facilmente a processos de criação personalizados e meus desenvolvedores estão trabalhando rotineiramente em várias versões de nossos produtos. Nosso VCS é o Subversion (eu sei, eu sei. Estou tentando mudar para o Git, mas minha péssima equipe de marketing é muito exigente) e uma única solução de VS incluirá vários projetos separados. Eu precisava que minha equipe tivesse um método comum para inicializar seu ambiente de desenvolvimento sem precisar instalar os mesmos pacotes Node (gulp, bower etc.) várias vezes na mesma máquina.

TL; DR:

1. É necessário "npm install" para instalar o ambiente de desenvolvimento global do Node / Bower, bem como todos os pacotes necessários localmente para um produto .NET.

2. Pacotes globais devem ser instalados apenas se ainda não estiverem instalados.

3. Links locais para pacotes globais devem ser criados automaticamente.

A solução:

Já temos uma estrutura de desenvolvimento comum compartilhada por todos os desenvolvedores e todos os produtos, por isso criei um script NodeJS para instalar os pacotes globais quando necessário e criar os links locais. O script reside em ".... \ SharedFiles" relativo à pasta base do produto:

/*******************************************************************************
* $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"                      :                      "[email protected]", 
  "event-stream"               :               "[email protected]",
  "gulp"                       :                       "[email protected]",
  "gulp-angular-templatecache" : "[email protected]",
  "gulp-clean"                 :                 "[email protected]", 
  "gulp-concat"                :                "[email protected]",
  "gulp-debug"                 :                 "[email protected]",
  "gulp-filter"                :                "[email protected]",
  "gulp-grep-contents"         :         "[email protected]",
  "gulp-if"                    :                    "[email protected]", 
  "gulp-inject"                :                "[email protected]", 
  "gulp-minify-css"            :            "[email protected]",
  "gulp-minify-html"           :           "[email protected]",
  "gulp-minify-inline"         :         "[email protected]",
  "gulp-ng-annotate"           :           "[email protected]",
  "gulp-processhtml"           :           "[email protected]",
  "gulp-rev"                   :                   "[email protected]",
  "gulp-rev-replace"           :           "[email protected]",
  "gulp-uglify"                :                "[email protected]",
  "gulp-useref"                :                "[email protected]",
  "gulp-util"                  :                  "[email protected]",
  "lazypipe"                   :                   "[email protected]",
  "q"                          :                          "[email protected]",
  "through2"                   :                   "[email protected]",

  /*---------------------------------------------------------------*/
  /* 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();
  };

Agora, se eu quiser atualizar uma ferramenta global para nossos desenvolvedores, atualizo o objeto "packages" e faço check-in no novo script. Meus desenvolvedores fazem check-out e executam-no com "node npm-setup.js" ou por "npm install" de qualquer um dos produtos em desenvolvimento para atualizar o ambiente global. A coisa toda leva 5 minutos.

Além disso, para configurar o ambiente para um novo desenvolvedor, primeiro é necessário instalar o NodeJS e o GIT for Windows, reiniciar o computador, verificar a pasta "Arquivos compartilhados" e todos os produtos em desenvolvimento e começar a trabalhar.

O "package.json" para o produto .NET chama esse script antes da instalação:

{ 
"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": {}
}

Notas

• Observe que a referência de script requer barras, mesmo em um ambiente Windows.

• "npm ls" dará "npm ERR! estranhas:" mensagens para todos os pacotes vinculados localmente porque não estão listados nas "dependências" "package.json".

Editar 29/1/16

O npm-setup.jsscript atualizado acima foi modificado da seguinte maneira:

• O pacote "version" in var packagesagora é o valor do "package" passado para npm installa linha de comando. Isso foi alterado para permitir a instalação de pacotes de algum lugar que não seja o repositório registrado.

• Se o pacote já estiver instalado, mas não o solicitado, o pacote existente será removido e o pacote correto, instalado.

• Por motivos desconhecidos, o npm lançará periodicamente um erro EBUSY (-4082) ao executar uma instalação ou link. Este erro está interceptado e o comando é executado novamente. O erro raramente acontece uma segunda vez e parece sempre esclarecer.

Você pode usar um arquivo separado, como npm_globals.txt, em vez de package.json. Esse arquivo conteria cada módulo em uma nova linha como esta,

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

Em seguida, na linha de comando, execute

< npm_globals.txt xargs npm install -g

Verifique se eles foram instalados corretamente com,

npm list -g --depth=0

Quanto a saber se você deve fazer isso ou não, eu acho que tudo depende do caso de uso. Para a maioria dos projetos, isso não é necessário; e ter o seu projeto package.jsonencapsular essas ferramentas e dependências é muito preferido.

Atualmente, porém, acho que estou sempre instalando create-react-appe outras CLIs globalmente quando pulo em uma nova máquina. É bom ter uma maneira fácil de instalar uma ferramenta global e suas dependências quando o controle de versão não importa muito.

E hoje em dia, eu estou usando npx, um corredor pacote npm , em vez de instalar pacotes globalmente.

Todos os módulos do package.json estão instalados em ./node_modules/

Não foi possível encontrar isso explicitamente, mas esta é a referência package.json para o NPM .

Crie seu próprio script para instalar dependências globais. Não é preciso muito. O package.json é bastante expansível.

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

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

Usando o exposto acima, você pode torná-lo inline, abaixo!

Veja a pré-instalação abaixo:

{
  "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": [
    "[email protected]",
    "ionic",
    "potato"
  ],
  "author": "author",
  "license": "MIT",
  "devDependencies": {
    "chai": "^4.2.0",
    "mocha": "^5.2.0"
  },
  "bin": {
    "app": "app.js"
  }
}

Os autores do nó podem não admitir package.json é um arquivo de projeto. Mas isso é.