write-pkg
Write a package.json file
Writes atomically and creates directories for you as needed. Sorts dependencies when writing. Preserves the indentation if the file already exists.
Install
npm install write-pkg
Usage
import path from 'node:path';
import {writePackage} from 'write-pkg';
await writePackage({foo: true});
console.log('done');
await writePackage(path.join('unicorn', 'package.json'), {foo: true});
console.log('done');
API
writePackage(path?, data, options?)
Returns a Promise that resolves when the package.json file has been written.
writePackageSync(path?, data, options?)
path
Type: string
Default: process.cwd()
The path to where the package.json file should be written or its directory.
data
Type object
JSON data to write to the package.json file.
options
Type: object
See Options.
updatePackage(path?, data, options?)
Returns a Promise that resolves when the package.json file has been updated.
updatePackageSync(path?, data, options?)
import {updatePackage} from 'write-pkg';
await updatePackage({foo: true});
//=> { "foo": true }
await updatePackage({foo: false, bar: true});
//=> { "foo": false, "bar": true }
path
Type: string
Default: process.cwd()
The path to where the package.json file should be written or its directory.
data
Type object
JSON data to write to the package.json file. If the file already exists, existing fields will be merged with the values in data.
options
Type: object
See Options.
addPackageDependencies(path?, dependencies, options?)
Returns a Promise that resolves when the package.json file has been written.
addPackageDependenciesSync(path?, dependencies, options?)
import {writePackage, addPackageDependencies} from 'write-pkg';
await writePackage({foo: true});
//=> { "foo": true }
await addPackageDependencies({foo: '1.0.0'});
//=> { "foo": true, "dependencies": { "foo": "1.0.0" } }
await addPackageDependencies({dependencies: {foo: '1.0.0'}, devDependencies: {bar: '1.0.0'}});
//=> { "foo": true, "dependencies": { "foo": "1.0.0" }, "devDependencies": { "bar": "1.0.0" } }
path
Type: string
Default: process.cwd()
The path to where the package.json file should be written or its directory.
dependencies
Type: Record<string, string> | Partial<Record<'dependencies' | 'devDependencies' | 'optionalDependencies' | 'peerDependencies', Record<string, string>>>
Dependencies to add to the package.json file.
options
Type: object
See Options.
removePackageDependencies(path?, dependencies, options?)
Returns a Promise that resolves when the package.json file has been written. Does not throw if the file does not exist.
removePackageDependenciesSync(path?, dependencies, options?)
import {writePackage, removePackageDependencies} from 'write-pkg';
await writePackage({foo: true, dependencies: {foo: '1.0.0'}, devDependencies: {bar: '1.0.0'}});
//=> { "foo": true, "dependencies": { "foo": "1.0.0" }, "devDependencies": { "bar": "1.0.0" } }
await removePackageDependencies(['foo']);
//=> { "foo": true, "devDependencies": { "bar": "1.0.0" } }
await removePackageDependencies({devDependencies: ['bar']});
//=> { "foo": true }
path
Type: string
Default: process.cwd()
The path to where the package.json file should be written or its directory.
dependencies
Type string[] | Partial<Record<'dependencies' | 'devDependencies' | 'optionalDependencies' | 'peerDependencies', string[]>>
Dependencies to remove from the package.json file.
options
Type: object
See Options.
Options
indent
Type: string | number
Default: Auto-detected or '\t'
The indentation to use for new files.
Accepts '\t' for tab indentation or a number of spaces.
If the file already exists, the existing indentation will be used.
normalize
Type: boolean
Default: true
Remove empty dependencies, devDependencies, optionalDependencies and peerDependencies objects.
write-pkg for enterprise
Available as part of the Tidelift Subscription.
The maintainers of write-pkg and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
Related
