write-pkg

WebJar for write-pkg

License	MIT
GroupId	org.webjars.npm
ArtifactId	write-pkg
Last Version	3.2.0
Release Date	Apr 5, 2021
Type	jar
Description	write-pkg WebJar for write-pkg
Project URL	https://www.webjars.org
Source Code Management	https://github.com/sindresorhus/write-pkg

Download write-pkg

Filename	Size
write-pkg-3.2.0.pom
write-pkg-3.2.0.jar	4 KB
write-pkg-3.2.0-sources.jar	22 bytes
write-pkg-3.2.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/write-pkg/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>write-pkg</artifactId>
    <version>3.2.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/write-pkg/
implementation 'org.webjars.npm:write-pkg:3.2.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/write-pkg/
implementation ("org.webjars.npm:write-pkg:3.2.0")

Apache Buildr

'org.webjars.npm:write-pkg:jar:3.2.0'

Apache Ivy

<dependency org="org.webjars.npm" name="write-pkg" rev="3.2.0">
  <artifact name="write-pkg" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='write-pkg', version='3.2.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "write-pkg" % "3.2.0"

Leiningen

[org.webjars.npm/write-pkg "3.2.0"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : sort-keys	jar	[2.0.0,3)
org.webjars.npm : write-json-file	jar	[2.2.0,3)

Project Modules

There are no modules declared in this project.

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

const path = require('path');
const writePackage = require('write-pkg');

(async () => {
	await writePackage({foo: true});
	console.log('done');

	await writePackage(__dirname, {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.

writePackage.sync(path?, data, options?)

path

Type: string
Default: process.cwd()

Path to where the package.json file should be written or its directory.

options

Type: object

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

• read-pkg - Read a package.json file
• write-json-file - Stringify and write JSON to a file atomically

Versions

Version
3.2.0 Apr 5, 2021