Add functions to update a package.json file, target Node.js 16, bump deps

[tommy-mitchell]

Closes #13. Bumps dependencies / Node.js version (and adds Node.js 18/20 to CI), and adds new functions for updating a package.json file. Source/test files have been separated by function.

updatePackage, updatePackageSync

Updates/creates a package.json file. Uses deepmerge-ts to merge properties.

await writePackage({name: 'foo', version: '1.0.0'});
await updatePackage({version: '1.1.0', license: 'MIT'});

{
	"name": "foo",
	"version": "1.1.0",
	"license": "MIT"
}

addPackageDependences, addPackageDependencesSync

Adds dependencies to a package.json file. Uses updatePackage internally, so it will create a package.json file if one doesn't exist.

await writePackage({foo: true});

{
	"name": "foo"
}

await addPackageDependencies({foo: '1.0.0'});

{
	"name": "foo",
	"dependencies": {
		"foo": "1.0.0"
	}
}

await addPackageDependencies({dependencies: {foo: '1.1.0'}, devDependencies: {bar: '1.0.0'}});

{
	"name": "foo",
	"dependencies": {
		"foo": "1.1.0"
	},
	"devDependencies": {
		"bar": "1.0.0"
	}
}

removePackageDependences, removePackageDependencesSync

Removes dependencies from a package.json file. If the package.json file doesn't exist, it does not throw.

await writePackage({foo: true, dependencies: {foo: '1.0.0'}, devDependencies: {bar: '1.0.0'}});

{
	"name": "foo",
	"dependencies": {
		"foo": "1.0.0"
	},
	"devDependencies": {
		"bar": "1.0.0"
	}
}

await removePackageDependences(['foo']);

{
	"name": "foo",
	"devDependencies": {
		"bar": "1.0.0"
	}
}

await removePackageDependencies({devDependencies: ['bar']});

{
	"name": "foo"
}

[sindresorhus]

The current names are addPackageDependencies and addPackageDependenciesSync. Are these too verbose?

Looks good to me.

If addPackageDependencies is called in a directory without a package.json, should it create one or error?

I think it would be nice if it created. It should be clearly documented though. If someone actually wants it to throw, it could be added as an option later.

Am I missing any test cases? I think it's covered well, but I'm not sure

Some more ideas (you may have them already, didn't look too close):

• package.json doesn't exist
• package.json is invalid JSON

[tommy-mitchell]

Updated per #13 (comment).

Still need to update the readme. Should probably add a note that writePackage will overwrite properties.

[tommy-mitchell]

@sindresorhus that should be everything. There may be some inconsistencies between the readme and the descriptions in index.d.ts, but I think I've been staring at the words "package" and "dependencies" for too long now to notice.

[sindresorhus]

It would be useful to include the code examples from the TS types for each of these methods.

https://github.com/sindresorhus/write-pkg/pull/21/files#diff-7aa4473ede4abd9ec099e87fec67fd57afafaf39e05d493ab4533acc38547eb8R137-R147

[tommy-mitchell]

Added.

[sindresorhus]

Thanks :)

[tommy-mitchell]

@sindresorhus just noticed I didn’t add the source directory to the files field in package.json

[sindresorhus]

np caught that mistake :)