¿Por qué, por ejemplo, un complemento de Grunt define su dependencia de grunt como " dependencias de pares "?

¿Por qué el complemento no puede tener Grunt como su propia dependencia en grunt-plug / node_modules ?

Las dependencias entre pares se describen aquí: https://nodejs.org/en/blog/npm/peer-dependencies/

Pero realmente no lo entiendo.

Ejemplo

Estoy trabajando con AppGyver Steroids en este momento, que usa tareas de Grunt para construir mis archivos fuente en una carpeta / dist / para ser servidos en un dispositivo local. Soy bastante nuevo en npm y gruño, así que quiero comprender completamente lo que está sucediendo.

Hasta ahora entiendo esto:

[carpeta raíz] /package.json le dice a npm que depende del grunt-steroidspaquete npm para el desarrollo:

  "devDependencies": {
    "grunt-steroids": "0.x"
  },

Bueno. La ejecución de npm install en [carpeta raíz] detecta la dependencia e instala grunt-steroids en [carpeta raíz] / node_modules / grunt-steroids .

Npm luego lee [carpeta raíz] /node_modules/grunt-steroids/package.json para que pueda instalar sus grunt-steroidspropias dependencias:

"devDependencies": {
    "grunt-contrib-nodeunit": "0.3.0",
    "grunt": "0.4.4"
  },
"dependencies": {
    "wrench": "1.5.4",
    "chalk": "0.3.0",
    "xml2js": "0.4.1",
    "lodash": "2.4.1"
  },
"peerDependencies": {
    "grunt": "0.4.4",
    "grunt-contrib-copy": "0.5.0",
    "grunt-contrib-clean": "0.5.0",
    "grunt-contrib-concat": "0.4.0",
    "grunt-contrib-coffee": "0.10.1",
    "grunt-contrib-sass": "0.7.3",
    "grunt-extend-config": "0.9.2"
  },

Los paquetes de " dependencias " se instalan en [carpeta raíz] / node_modules / grunt-steroids / node_modules, lo cual es lógico para mí.

Las " devDependencies " no están instaladas, lo cual estoy seguro está controlado por npm detectando que solo estoy tratando de usar grunt-steroidsy no desarrollar en él.

Pero luego tenemos las " peerDependencies ".

Estos están instalados en [rootfolder] / node_modules , y no entiendo por qué allí y no en [rootfolder] / node_modules / grunt-steroids / node_modules para evitar conflictos con otros complementos de grunt (o lo que sea).

TL; DR: peerDependencies son para las dependencias que están expuestas (y se espera que las use) el código consumidor, en contraposición a las dependencias "privadas" que no están expuestas, y son solo un detalle de implementación.

El problema que resuelven las dependencias entre pares

El sistema de módulos de NPM es jerárquico. Una gran ventaja para escenarios más simples es que cuando instala un paquete npm, ese paquete trae consigo sus propias dependencias para que funcione de inmediato.

Pero surgen problemas cuando:

• Tanto su proyecto como algún módulo que esté utilizando dependen de otro módulo.
• Los tres módulos tienen que comunicarse entre sí.

Por ejemplo

Digamos que está construyendo YourCoolProjecty está usando ambos JacksModule 1.0y JillsModule 2.0. Y supongamos que eso JacksModuletambién depende JillsModule, pero de una versión diferente, digamos 1.0. Mientras esas 2 versiones no se cumplan, no hay problema. El hecho de que JacksModulese use JillsModuledebajo de la superficie es solo un detalle de implementación. Estamos agrupando JillsModuledos veces, pero ese es un pequeño precio a pagar cuando obtenemos software estable listo para usar.

Pero ahora, ¿y si JacksModuleexpone su dependencia de JillsModulealguna manera? Acepta una instancia de, JillsClasspor ejemplo ... ¿Qué sucede cuando creamos una new JillsClassversión 2.0de uso de la biblioteca y se la pasamos jacksFunction? ¡Todo el infierno se desatará! Cosas simples como jillsObject instanceof JillsClassvolverán repentinamente falseporque en jillsObjectrealidad es una instancia de otra JillsClass , la 2.0versión.

Cómo las dependencias entre pares resuelven esto

Ellos dicen npm

Necesito este paquete, pero necesito la versión que es parte del proyecto, no una versión privada de mi módulo.

Cuando npm ve que su paquete se está instalando en un proyecto que no tiene esa dependencia, o que tiene una versión incompatible , advertirá al usuario durante el proceso de instalación.

¿Cuándo debería utilizar las dependencias entre pares?

• Cuando está construyendo una biblioteca para ser utilizada por otros proyectos, y
• Esta biblioteca está usando alguna otra biblioteca, y
• Espera / necesita que el usuario trabaje con esa otra biblioteca también

Los escenarios comunes son complementos para marcos más grandes. Piense en cosas como Gulp, Grunt, Babel, Mocha, etc. Si escribe un complemento de Gulp, quiere que ese complemento funcione con el mismo Gulp que usa el proyecto del usuario, no con su propia versión privada de Gulp.

Le recomendaría que lea el artículo nuevamente primero. Es un poco confuso, pero el ejemplo con winston-mail muestra la respuesta por qué:

Por ejemplo, supongamos que se [email protected]especifica "winston": "0.5.x"en su "dependencies"objeto porque esa es la última versión con la que se probó. Como desarrollador de aplicaciones, desea lo último y lo mejor, por lo que busca las últimas versiones de winstony de winston-maily las coloca en su package.json como

{
  "dependencies": {  
    "winston": "0.6.2",  
    "winston-mail": "0.2.3"  
  }  
}

Pero ahora, ejecutar npm install da como resultado el gráfico de dependencia inesperado de

├── [email protected]  
└─┬ [email protected]                
  └── [email protected]

En este caso, es posible tener varias versiones de un paquete que causarían algunos problemas. Las dependencias de pares permiten a los desarrolladores de npm asegurarse de que el usuario tenga el módulo específico (en la carpeta raíz). Pero tiene razón en el punto de que describir una versión específica de un paquete daría lugar a problemas con otros paquetes que utilizan otras versiones. Este problema tiene que ver con los desarrolladores de npm, como dicen los artículos

Un consejo : los requisitos de dependencia entre pares, a diferencia de los de las dependencias regulares, deben ser indulgentes . No debe bloquear las dependencias de sus pares en versiones de parche específicas.

Por lo tanto, los desarrolladores deben seguir semver para definir peerDependencies. Debería abrir un problema para el paquete grunt-steroids en GitHub ...

peerDependencies explicado con el ejemplo más simple posible:

{
  "name": "myPackage",
  "dependencies": {
    "foo": "^4.0.0",
    "react": "^15.0.0"
  }
}


{
  "name": "foo"
  "peerDependencies": {
    "react": "^16.0.0"
  }
}

ejecutar npm install en myPackage arrojará un error porque está intentando instalar la versión de React ^15.0.0Y fooque solo es compatible con React ^16.0.0.

peerDependencies NO están instaladas.