googleapis / googleapis/google-cloud-node

Option to eliminate transitive production dependency on jsdoc

Offen
#7,752 3 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
library: google-cloud-node-core priority: p3 type: question
Vorherrschende Sprache
TypeScript
Sterne
3.2k
Forks
712
Ø Merge
2 T. 9 Std.
Gemergte PRs (30 T.)
104

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die Abhängigkeitskette mit `npm ls --omit=dev jsdoc` zu reproduzieren, und untersuche dann, wie google-gax und protobufjs-cli jsdoc paketieren. Als abgeschlossen sollte gelten, dass ein unterstützter jsdoc-freier Produktionsabhängigkeitspfad bereitgestellt wird, ohne Funktionalität zu entfernen, die jsdoc erfordert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
nodejs, typescript
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
18/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.