edit-package-json^0.1.37

Edit package.json without parsing, as string, to keep the formatting intact

Install via npm

npm i edit-package-json

Consume via a require():

const { set, del } = require("edit-package-json");

or as an ES Module:

import { set, del } from "edit-package-json";

Install as a script, via CDN

Put this in your HTML:

<script src="https://cdn.jsdelivr.net/npm/edit-package-json/dist/edit-package-json.umd.js">

Then, you’ll get a global variable editPackageJson in your Global object and you consume it like this:

const { set, del } = editPackageJson;

Trivia

This program has 12,149 assertions in its unit tests. That's more than all unit test assertions' median (52) and more than geometric mean (71).

In monorepo, one other package, edit-package-json, consumes this package.

§ Quick Take

import { strict as assert } from "assert";
import { set, del } from "dist/edit-package-json.esm";

// edit JSON as string
assert.equal(
  set(
    `{
  "name": "test",
  "dependencies": {
    "ranges-apply": "^2.0.0",
    "string-left-right": "^2.3.30"
  },
  "devDependencies": {}
}`,
    "dependencies.ranges-apply", // path to amend
    "^3.2.2" // new value
  ),
  `{
  "name": "test",
  "dependencies": {
    "ranges-apply": "^3.2.2",
    "string-left-right": "^2.3.30"
  },
  "devDependencies": {}
}`
);

// edit from JSON string
assert.equal(
  del(
    `{
  "name": "test",
  "dependencies": {
    "ranges-apply": "^2.0.0",
    "string-left-right": "^2.3.30"
  },
  "devDependencies": {}
}`,
    "devDependencies" // path to delete
  ),
  `{
  "name": "test",
  "dependencies": {
    "ranges-apply": "^2.0.0",
    "string-left-right": "^2.3.30"
  }
}`
);

⬆ back to top

§ Examples

⬆ back to top

§ Purpose

Edit JSON contents as strings to guarantee the formatting will be intact.

API uses object-path notation to set values on any (for now, only already-existing) paths in JSON.

It's powering the update-versions CLI.

⬆ back to top

§ API

There are two methods: set() and del():

§ .set()

set(source, path, val)

Input argument	Type	Obligatory?	Description
`str`	String	yes	JSON file contents
`path`	String	yes	Desired EXISTING path in the object, must follow object-path notation
`valToInsert`	Whatever	yes	What to insert at the given path

You can't create new paths, only amend existing-ones.

Output

An amended string is returned.

To repeat, set() can't create new paths yet, it's still in a baby state. set() can only edit existing paths in JSON.

⬆ back to top

§ .del()

del(source, path)

Input argument	Type	Obligatory?	Description
`str`	String	yes	JSON file contents
`path`	String	yes	Desired path in the object to delete, must follow object-path notation

Output

An amended string is returned.

⬆ back to top

§ Testing

Besides regular unit tests, we went great lengths to ensure this program works as intended. We took all `package.json's in this monorepo (115 in total), then took every single leaf path in every package.json and amended and deleted it two ways: