write-package
Version:
Write a package.json file
188 lines (108 loc) • 4.42 kB
Markdown
> 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.
```sh
npm install write-package
```
```js
import path from 'node:path';
import {writePackage} from 'write-package';
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.
```js
import {updatePackage} from 'write-package';
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.
```js
import {writePackage, addPackageDependencies} from 'write-package';
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.
```js
import {writePackage, removePackageDependencies} from 'write-package';
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.
- [read-pkg](https://github.com/sindresorhus/read-pkg) - Read a `package.json` file
- [write-json-file](https://github.com/sindresorhus/write-json-file) - Stringify and write JSON to a file atomically