Skip to content package
write-pkg v4.0.0 Write a package.json file
node >=8 3 deps cjs open source
overview readme
license MIT
deps 3
unpacked 6.4 kB
files 5
node >=8 $ npm install write-pkg@4.0.0n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
keywords Tagged topics.
json write stringify file fs graceful package
versions Latest published Nov 4, 2023
maintainers Registry package owners.
contents Install Usage API writePackage(path?, data, options?) writePackageSync(path?, data, options?) updatePackage(path?, data, options?) updatePackageSync(path?, data, options?) addPackageDependencies(path?, dependencies, options?) addPackageDependenciesSync(path?, dependencies, options?) removePackageDependencies(path?, dependencies, options?) removePackageDependenciesSync(path?, dependencies, options?) Options write-pkg for enterprise Related 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 copy
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 });
install size Estimated unpacked size across 20 packages.
1.2 MB
Includes dependencies.
dependencies 5 direct · 5 outdated
console. log ( 'done' );
copy
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 JSON data to write to the package.json file.
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 } copy
path Type: string
Default: process.cwd()
The path to where the package.json file should be written or its directory.
data 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
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" } } copy
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
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 } copy
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
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.