write-pkg
Advanced tools
Readme
Write a
package.jsonfile
Writes atomically and creates directories for you as needed. Sorts dependencies when writing. Preserves the indentation if the file already exists.
npm install write-pkg
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');
Returns a Promise that resolves when the package.json file has been written.
Type: string
Default: process.cwd()
The path to where the package.json file should be written or its directory.
Type object
JSON data to write to the package.json file.
Type: object
See Options.
Returns a Promise that resolves when the package.json file has been updated.
import {updatePackage} from 'write-pkg';
await updatePackage({foo: true});
//=> { "foo": true }
await updatePackage({foo: false, bar: true});
//=> { "foo": false, "bar": true }
Type: string
Default: process.cwd()
The path to where the package.json file should be written or its directory.
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.
Type: object
See Options.
Returns a Promise that resolves when the package.json file has been written.
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" } }
Type: string
Default: process.cwd()
The path to where the package.json file should be written or its directory.
Type: Record<string, string> | Partial<Record<'dependencies' | 'devDependencies' | 'optionalDependencies' | 'peerDependencies', Record<string, string>>>
Dependencies to add to the package.json file.
Type: object
See Options.
Returns a Promise that resolves when the package.json file has been written. Does not throw if the file does not exist.
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 }
Type: string
Default: process.cwd()
The path to where the package.json file should be written or its directory.
Type string[] | Partial<Record<'dependencies' | 'devDependencies' | 'optionalDependencies' | 'peerDependencies', string[]>>
Dependencies to remove from the package.json file.
Type: object
See Options.
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.
Type: boolean
Default: true
Remove empty dependencies, devDependencies, optionalDependencies and peerDependencies objects.
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.
package.json fileFAQs
Write a package.json file
The npm package write-pkg receives a total of 1,006,553 weekly downloads. As such, write-pkg popularity was classified as popular.
We found that write-pkg demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.