googleapis / googleapis/google-cloud-node

Option to eliminate transitive production dependency on jsdoc

Aperta
#7,752 3 commenti 1 reazione 0 assegnatari Vedi su GitHub
library: google-cloud-node-core priority: p3 type: question
Lingua principale
TypeScript
Stelle
3.2k
Fork
712
Merge medio
2g 9h
PR unite (30g)
104

Descrizione

Hi, our security tools are complaining about jsdoc; so, I am trying to eliminate our transitive dependency on jsdoc.
```
$ npm ls --omit=dev jsdoc

└─┬ @google-cloud/secret-manager@4.2.0
└─┬ google-gax@3.5.3
└─┬ protobufjs-cli@1.1.0
└── jsdoc@4.0.0
```
I can effectively accomplish that with a postinstall script that removes jsdoc from node_modules, since our app doesn't use any of the features that require jsdoc. However, I have been asked to query about the possibility of eliminating jsdoc as a prod dependency.

Could it make sense for google-gax to provide multiple packages, including one that is jsdoc-free, so that dependent modules could have only a dev dependency on jsdoc?

Thanks.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia riproducendo la catena delle dipendenze con `npm ls --omit=dev jsdoc`, quindi esamina come google-gax e protobufjs-cli pacchettizzano jsdoc. Il lavoro dovrebbe considerarsi completato quando sarà fornito un percorso di dipendenze di produzione supportato e privo di jsdoc, senza rimuovere funzionalità che richiedono jsdoc.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
nodejs, typescript
Ambito
tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
18/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.