package.json-Generator
Fülle das Formular aus und erhalte schon beim Tippen eine saubere, gültige package.json. Name, Version, Versionsbereiche der Abhängigkeiten und Repository werden anhand der npm-Regeln geprüft, und du kannst mit einer Vorlage starten oder eine vorhandene Datei importieren.
Zuletzt aktualisiert:
package.json
Speichere die Datei im Stammverzeichnis deines Projekts und führe npm install (oder pnpm install / yarn) aus, um die Lock-Datei zu erstellen.
Anleitung: package.json-Generator
- Wähle eine Vorlage (optional) wie Node-Bibliothek, Express-API oder Vite-React-App, um sinnvolle Standardwerte einzutragen.
- Fülle die Grundlagen aus: Paketname, Version, Beschreibung, Autor, Lizenz und Modultyp (CommonJS oder ES-Module).
- Füge Scripts hinzu mit den Schnellschaltflächen oder gib eigene Paare aus Name und Befehl ein.
- Liste die Abhängigkeiten auf, eine pro Zeile als
name@range, zum Beispielexpress@^4.21.2. - Prüfe den Validierungsbereich, kopiere dann das JSON oder lade die package.json herunter und führe
npm installaus.
package.json-Felder auf einen Blick
| Feld | Was es bewirkt | Beispiel |
|---|---|---|
name | Paketname auf npm und in import/require. Kleinbuchstaben, URL-sicher, max. 214 Zeichen. | "@acme/utils" |
version | Semantische Version MAJOR.MINOR.PATCH, mit optionalen Pre-Release- und Build-Tags. | "2.1.0-beta.1" |
private | Bei true verweigert npm publish die Veröffentlichung des Pakets. | true |
type | "module" macht .js-Dateien zu ES-Modulen; "commonjs" (Standard) behält require bei. | "module" |
main | Einstiegsdatei, die von require('pkg') geladen wird, wenn kein exports-Feld existiert. | "./dist/index.js" |
exports | Moderne Zuordnung der Einstiegspunkte. Sie verbirgt außerdem jede Datei, die nicht exportiert wird. | "./index.js" |
types | TypeScript-Deklarationsdatei für den Haupteinstieg. | "./dist/index.d.ts" |
bin | Befehle, die im PATH installiert werden. Die Datei braucht #!/usr/bin/env node als erste Zeile. | {"mycli": "./bin/cli.js"} |
files | Positivliste der Dateien, die beim Veröffentlichen enthalten sind. package.json, README und LICENSE sind immer enthalten. | ["dist"] |
scripts | Befehle für npm run <name>. start und test funktionieren auch als npm start und npm test. | {"dev": "vite"} |
engines | Unterstützte Node.js-Versionen. Bei anderen warnt npm (oder bricht mit engine-strict ab). | {"node": ">=18"} |
packageManager | Exakte Version des Paketmanagers, wird von Corepack verwendet. | "[email protected]" |
Spickzettel für Versionsbereiche
| Bereich | Passt auf |
|---|---|
4.21.2 | Genau 4.21.2 |
^4.21.2 | >=4.21.2 und <5.0.0 (Minor- und Patch-Updates) |
^0.3.1 | >=0.3.1 und <0.4.0 (bei 0.x erlaubt das Caret nur Patch-Updates) |
~4.21.2 | >=4.21.2 und <4.22.0 (nur Patch-Updates) |
4.x oder 4 | Jede Version 4.y.z |
>=18 <23 | Beide Bedingungen (UND) |
^16 || ^18 | Einer der Bereiche (ODER) |
1.2.0 - 1.4.5 | Inklusiver Bindestrich-Bereich |
* oder latest | Beliebige Version / die als latest getaggte Version (nicht reproduzierbar, in Apps vermeiden) |
workspace:*, file:../lib, github:user/repo | Monorepo-Workspace, lokaler Ordner oder Git-Abhängigkeit |
Tipps für eine saubere package.json
- Anwendungen und Websites sollten
"private": truesetzen und die Lock-Datei committen, damit jede Installation identische Versionen erhält. - Bibliotheken sollten die Laufzeit-
dependenciesklein halten, Tooling indevDependenciespacken undpeerDependenciesfür Frameworks verwenden, die die Host-App bereits hat, etwa React. - Verwende
files(oder eine.npmignore), damit Tests, Quellen und Konfigurationen nicht veröffentlicht werden. Prüfe mitnpm pack --dry-run, was ausgeliefert wird. - Lifecycle-Scripts laufen automatisch:
prepareläuft nachnpm installund vor dem Veröffentlichen,prepublishOnlynur vornpm publish, undpre<name>/post<name>umschließen jedes Script. - Erhöhe Versionen mit
npm version patch|minor|major, das auch einen Git-Tag erstellt.
Häufige Fragen
Welche Felder braucht eine package.json?
Nur name und version sind erforderlich, wenn du das Paket auf npm veröffentlichst. Für eine private Anwendung ist streng genommen nichts erforderlich, aber name, version, private: true, scripts und dependencies sind üblich. Description, license, repository und author helfen anderen, das Projekt zu verstehen.
Welche Regeln gelten für einen npm-Paketnamen?
Der Name darf einschließlich Scope höchstens 214 Zeichen lang sein, muss kleingeschrieben und URL-sicher sein (Buchstaben, Ziffern, -, ., _ und ~) und darf weder mit einem Punkt oder Unterstrich beginnen noch Leerzeichen enthalten. Namen mit Scope sehen aus wie @scope/name. Namen von Node-Kernmodulen wie http oder fs sind nicht erlaubt.
Was bewirkt "type": "module"?
Es weist Node.js an, .js-Dateien im Paket als ES-Module zu behandeln, sodass du import und export statt require und module.exports verwendest. Ohne diese Angabe oder mit "type": "commonjs" sind .js-Dateien CommonJS. Mit den Endungen .mjs oder .cjs kannst du ein Format jederzeit erzwingen.
Was ist der Unterschied zwischen ^ und ~ bei Versionen?
Ein Caret-Bereich wie ^4.21.2 erlaubt jede spätere Version mit derselben Major-Nummer (4.x.x, mindestens 4.21.2). Ein Tilde-Bereich wie ~4.21.2 erlaubt nur Patch-Updates (4.21.x). Eine exakte Version wie 4.21.2 legt ein Release fest. Bei 0.x-Versionen ist das Caret strenger und erlaubt nur Patch-Updates innerhalb derselben Minor-Version.
dependencies vs. devDependencies vs. peerDependencies?
dependencies werden zur Laufzeit benötigt und für alle installiert, die dein Paket installieren. devDependencies werden nur beim Entwickeln oder Bauen gebraucht (Test-Runner, Linter, Bundler). peerDependencies deklarieren ein Paket, das das Host-Projekt bereitstellen muss, etwa react für eine React-Komponentenbibliothek.
Warum "private": true setzen?
Es verhindert, dass npm publish das Paket jemals versehentlich veröffentlicht. Verwende es für Anwendungen, Websites und Monorepo-Wurzeln, die nicht in die npm-Registry gehören.
Werden meine Daten hochgeladen?
Nein. Die package.json wird vollständig in deinem Browser erstellt und geprüft. Dein letzter Formularzustand wird nur im lokalen Speicher dieses Browsers gespeichert.
Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?
Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.