package json

@npmcli/package-json

package.jsonファイルを更新するプログラマティックAPI。 NPM CLIがそれらを処理するのと同じ方法でファイルを更新および保存します。

インストール

npm install @npmcli/package-json

使用法：

 const PackageJson = require ( '@npmcli/package-json' )
const pkgJson = await PackageJson . load ( path )
// $ cat package.json
// {
//   "name": "foo",
//   "version": "1.0.0",
//   "dependencies": {
//     "a": "^1.0.0",
//     "abbrev": "^1.1.1"
//   }
// }

pkgJson . update ( {
  dependencies : {
    a : '^1.0.0' ,
    b : '^1.2.3' ,
  } ,
  workspaces : [
    './new-workspace' ,
  ] ,
} )

await pkgJson . save ( )
// $ cat package.json
// {
//   "name": "foo",
//   "version": "1.0.0",
//   "dependencies": {
//     "a": "^1.0.0",
//     "b": "^1.2.3"
//   },
//   "workspaces": [
//     "./new-workspace"
//   ]
// }

また、追加の正規化や機能を保存することなく、package.jsonファイルを開くためにエクスポートされるヘルパー関数もあります。

 const { readPackage } = require ( '@npmcli/package-json/lib/read-package' )
const rawData = await readPackage ( './package.json' )
// rawData will now have the package.json contents with no changes or normalizations 

API：

constructor()

PackageJsonの新しい空のインスタンスを作成します。

---

async PackageJson.create(path)

指定されたパスで空のpackage.jsonを作成します。すでに存在する場合は上書きされます。

---

async PackageJson.load(path, opts = {})

指定されたパスにpackage.jsonをロードします。

• opts ： Objectに含めることができます：
  • create ： Boolean trueの場合、新しいpackage.jsonがまだ存在しない場合は作成されます。解析できない既存のpackage.jsonをclobberしません。

例：

./にあるpackage.jsonファイルのコンテンツをロードします。

 const PackageJson = require ( '@npmcli/package-json' )
const pkgJson = new PackageJson ( )
await pkgJson . load ( './' )

package.jsonファイルが欠落している場合、または内容が無効な場合にエラーが発生します。

---

静的async PackageJson.load(path)

新しいインスタンスを返し、その場所からpackage.jsonファイルのコンテンツをロードするコンビニエンス静的メソッド。

• path ： package.jsonを読む場所からフォルダを指すString

例：

./にあるpackage.jsonファイルのコンテンツをロードします。

 const PackageJson = require ( '@npmcli/package-json' )
const pkgJson = await PackageJson . load ( './' )

---

async PackageJson.normalize()

node_modulesツリー内のpackage.jsonファイルを正規化することを目的としています。 @npmcli/arboristで使用できるようにするために、いくつかの軽い正規化が行われます

• path ： package.jsonを読む場所からフォルダを指すString
• opts ： Objectに含めることができます：
  • strict ： Boolean normalizeDataステップを適用するときにオプションの厳密なモードを有効にします
  • steps ： package.jsonファイルに適用されるオプションArray正規化手順、デフォルトの手順を置き換える
  • root ： gitHeadステップを適用するときに提供するPathオプションのgitルート
  • changes ： Arrayが提供されれば、パックメントに行われた各変更に関するメッセージがこの配列に追加されます

---

static async PackageJson.normalize(path, opts = {})

normalize前にload呼び出すコンビニエンス静的

• path ： package.jsonを読む場所からフォルダを指すString
• opts ： Objectに含めることができます：
  • strict ： Boolean normalizeDataステップを適用するときにオプションの厳密なモードを有効にします
  • steps ： package.jsonファイルに適用されるオプションArray正規化手順、デフォルトの手順を置き換える
  • root ： gitHeadステップを適用するときに提供するPathオプションのgitルート
  • changes ： Arrayが提供されれば、パックメントに行われた各変更に関するメッセージがこの配列に追加されます

---

async PackageJson.prepare()

normalizeと同様ですが、Package.jsonファイルを公開用に準備することを目的としています。

---

static async PackageJson.prepare(path, opts = {})

prepare前にload呼び出すための静的な便利さ

• path ： package.jsonを読む場所からフォルダを指すString
• opts ： Objectに含めることができます：
  • strict ： Boolean normalizeDataステップを適用するときにオプションの厳密なモードを有効にします
  • steps ： package.jsonファイルに適用されるオプションArray正規化手順、デフォルトの手順を置き換える
  • root ： gitHeadステップを適用するときに提供するPathオプションのgitルート
  • changes ： Arrayが提供されれば、パックメントに行われた各変更に関するメッセージがこの配列に追加されます

---

async PackageJson.fix()

normalizeと同様ですが、 npm pkg fixコマンドを対象としています。

---

PackageJson.update(content)

package.jsonのコンテンツをcontentを提供して更新します。

• content ： package.jsonファイルで更新/置き換えるプロパティを含むObject 。

dependencies 、 devDependencies 、 optionalDependencies 、 peerDependencies関係などの特別な特性には、ソートや重複排除など、これらのオプションの更新を処理するための特別なロジックがあります。

例：

new-scriptという名前の新しいスクリプトをpackage.json scriptsプロパティに追加します。

 const PackageJson = require ( '@npmcli/package-json' )
const pkgJson = await PackageJson . load ( './' )
pkgJson . update ( {
  scripts : {
    ... pkgJson . content . scripts ,
    'new-script' : 'echo "Bom dia!"'
  }
} )

注：依存関係を操作する場合、更新ロジックにはこれらのプロパティ間にある程度の相互依存性があるため、すべての既知の依存関係タイプに値を提供することが重要です。

例：

devDependencyを追加し、既存のpackage.jsonのすべてのピア依存関係を削除する安全な方法：JSON：

 const PackageJson = require ( '@npmcli/package-json' )
const pkgJson = await PackageJson . load ( './' )
pkgJson . update ( {
  dependencies : pkgJson . content . dependencies ,
  devDependencies : {
    ... pkgJson . content . devDependencies ,
    foo : '^[email protected]' ,
  } ,
  peerDependencies : { } ,
  optionalDependencies : pkgJson . content . optionalDependencies ,
} )

---

PackageJson.contentを取得します

ロードされたpackage.jsonファイルから読み取られた正規化されたObjectを取得するゲッター。

例：

 const PackageJson = require ( '@npmcli/package-json' )
const pkgJson = await PackageJson . load ( './' )
pkgJson . content
// -> {
//   name: 'foo',
//   version: '1.0.0'
// }

---

async PackageJson.save()

load()呼び出すときに使用される同じ場所に現在のcontent保存します。

ライセンス

ISC