Comment puis-je décider si @types/* doit aller dans `dependencies` ou `devDependencies` ?

Question

J'utilise TypeScript 2 dans mon projet. J'aimerais utiliser une bibliothèque js, mais aussi les typings pour cette bibliothèque. Je peux installer les types avec simplement npm install @types/some-library. Je ne suis pas sûr si je devrais les --save ou --save-dev. Il me semble que même le readme de DefinetelyTyped GitHub mentionne les deux versions, mais ne les explique jamais. Je penserais que @types devrait être dans devDependencies, car les types sont nécessaires pour le développement et ne sont pas utilisés en runtime, mais j'ai vu de nombreuses fois @types dans simplement dependencies. Je suis confus.

Comment devrais-je décider si @types/* doit aller dans les dependencies ou les devDependencies? Y a-t-il en fait des instructions officielles plus ou moins officielles?

Answer 1

Supposons que vous développez un package "A" qui inclut le package @types/some-module dans devDependencies. Pour une raison quelconque, vous exportez le type de @types/some-module

import {SomeType} from 'some-module';
export default class APackageClass {
     constructor(private config: SomeType) {

     }
}

Actuellement, les consommateurs de Typescript du package "A" ne peuvent pas deviner ce qu'est SomeType, car les devDependencies du package "A" ne sont PAS installées.

Dans ce cas particulier, vous DEVEZ placer le package @types/* avec les "dependencies" régulières. Pour d'autres cas, les "devDependencies" sont suffisants.

Answer 2

Si vous ne faites que générer un bundle, il peut ne pas être nécessaire de faire la distinction entre dependencies et devDependencies. Cette fonctionnalité de npm est généralement utile lors de la publication d'un package pouvant être utilisé par d'autres et que vous ne voulez pas les submerger de dépendances redondantes.

Il peut y avoir d'autres cas d'utilisation où la division des dépendances peut être utile, mais à moins d'avoir un besoin spécifique, mon conseil est de simplement choisir l'un ou l'autre et de tout placer là. Il n'est pas difficile de les diviser par la suite si le besoin se fait sentir.

Un exemple bien connu de cette pratique IRL est create-react-app, par défaut le boilerplate non-éjecté qu'il crée place tout dans dependencies, voir ce thread et cette réponse

Answer 3

Dans le cas particulier du déploiement d'une application Node.js en production, on veut installer uniquement les dépendances nécessaires pour exécuter l'application.

npm install --production ou

npm ci --production ou

yarn --production

Dans ce cas, les types devraient être dans les devDependencies, pour éviter qu'ils ne surchargent l'installation.

Remarque : Je suis conscient que cela a été mentionné dans un commentaire de Brad Wilson à une autre réponse. Ce point mérite cependant d'être une réponse à part entière.