nodejs / nodejs/node

Warn when package.json contains an invalid "type" value

Offen
#60,085 12 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature request never-stale
Vorherrschende Sprache
JavaScript
Sterne
122k
Forks
37.3k
Ø Merge
4 T. 2 Std.
Gemergte PRs (30 T.)
283

Beschreibung

What is the problem this feature will solve?

Valid (meaningful) values are:

  • commonjs
  • module

I had set CommonJS, and it behaves the same as if type was unset, which is so close to the actual commonjs behavior, that I thought I had set it correctly. But I kept having cases resulting in the MODULE_TYPELESS_PACKAGE_JSON warning, instead of failing hard.

Note that while tsconfig.js ignores case, the canonical version is CommonJS, so I never considered that I was using incorrect case.

What is the feature you are proposing to solve the problem?

Raise warning/error if "type" is set, but value is none of commonjs or module.

What alternatives have you considered?

No response

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit nachzuverfolgen, wo Node.js das type-Feld von package.json verarbeitet und die Warnung MODULE_TYPELESS_PACKAGE_JSON ausgibt; das Issue nennt keine Quelldatei und keinen Test, daher sollte dieser Pfad und seine bestehende Abdeckung zuerst ermittelt werden. Definiere und teste das gewählte Warnungs- oder Fehlerverhalten für andere Werte als commonjs und module, wobei diese kanonischen Werte erhalten bleiben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
backend
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

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