package.json 生成ツール
ガイド
package.json 生成ツール
有効な package.json 構造化フォームから生成する代わりに、すべてのフィールドを暗記する必要はない。パッケージ名、バージョン、ライセンス、モジュールシステム(ESMまたはCommonJS)、ノードエンジン、スクリプト、依存関係を設定し、ツールはクリーンで適切に並べられたマニフェストを生成し、プロジェクトに直接投入できる。
フォーマッタが既存のファイルを再配置するのとは異なり、この生成器はマニフェストを完全に再構築し、空のフィールドをスキップするため、最小限の、公開可能なファイルを生成し、npmが使用するコンベンションにすでに従っている。 npm init.
使用方法
- パッケージ名、バージョン、および(オプション)説明と著者を入力。
- ライセンスを選択し、 ESモジュール または CommonJS モジュールシステムを選択。
- エントリーファイル(例:
index.js)およびengines.node範囲(例:>=18. - )を設定。
dev,build,test,start実際に使用するスクリプト( - )を入力してください。フィールドを空白にすると省略されます。
name@range、1行またはコンマ区切りで。 - インデント(2スペース、4スペース、またはタブ)を選択し、生成された
package.json.
機能
- フォームドライブン – すべてのフィールド名や順序を暗記する必要はない。一般的なキーは自動で埋め込まれる。
- ESMまたはCommonJS – モジュールシステムを切り替え、ツールは
"type": "module"およびmoduleエントリを設定する。 - スマートスクリプト – 空のスクリプトフィールドは、
""プレースホルダーとして残されず削除される。 - 依存関係解析 – リストの
package@^1.2.3エントリを貼り付け、それらは整ったdependenciesオブジェクトに変換される。 - リポジトリヘルパー – GitHub URLを貼り付け、生成器が自動で埋め込む。
repository,bugsと、homepageを埋め込む。 - プライベートフラグ – 1クリックでパッケージをプライベートに設定し、誤った
npm publish. - インデントで進める – 出力は2スペース、4スペース、またはタブで、リポジトリの既存スタイルに合わせる。
- コピーまたはダウンロード – 結果をテキストとして取得またはダウンロード
package.json直接。
よくある質問
-
dependenciesとdevDependenciesの違いは?
dependenciesは、コードが実行時にインポートし、あなたのパッケージの消費者もインストールするパッケージです。devDependenciesは、開発またはプロジェクトのビルド時に必要なツール(バンドラー、テストランナー、タイプチェックツール)であり、誰かがあなたのパッケージを自分のプロジェクトに追加するときにインストールされません。 -
typeをmoduleに設定すると何が起こるか?
設定
"type": "module"Node.jsがパッケージ内のファイルをESモジュールとして扱うようにするため、.jsはネイティブで動作します。設定がない場合、NodeはimportとexportをCommonJSとして扱い、.jsを使用する必要があります。ESモジュールはトップレベルのrequire/module.exportsおよび厳格なファイル解決を可能にします。awaitなぜpackage.jsonは意味論的バージョンを用いるのか? -
意味論的バージョン(MAJOR.MINOR.PATCH)は消費者に契約を提供します:PATCHのアップデートは安全なバグ修正、MINORはバックワード互換の機能追加、MAJORは破壊的な変更を示します。範囲演算子(
)はこの契約に依存し、npmが互換性のあるアップデートをインストールできるようにし、あなたのビルドを壊さない。
^と~enginesフィールドの目的は? -
フィールドは、あなたのパッケージがサポートするNode.js(またはその他のランタイム)バージョンを宣言します。npmおよび多くのツールは、インストーラーがサポートされていないバージョンの場合に警告を表示し、一部のプラットフォームは完全にインストールを拒否します。明示的な
の
engines範囲は、新しいNodeバージョンに存在するAPIによって引き起こされる微妙なバグを防ぎます。nodemy-package
