pakag
TypeScript icon, indicating that this package has built-in type declarations

3.1.4 • Public • Published

pakag

Format package.json contents when working with it in node.

Features

  • Compatible with npm formatting
  • Sorts properties

Usage

import { readFileSync, writeFileSync } from 'fs'
import { join } from 'path'
import { formatPackageJson } from 'pakag'

const packageJsonPath = join(process.cwd(), 'package.json')

const packageContents = readFileSync(packageJsonPath, 'utf8')

const formattedContents = await formatPackageJson(packageContents)

writeFileSync(packageJsonPath, formattedContents)

To format the package.json in the current folder from the CLI run the following:

npx pakag
bunx pakag

Options

Options can be provided as the second parameter.

await formatPackageJson(packageContents, {
  // Sort properties using sort-package-json, default true.
  sort: false,
  // Customize sort order for package.json keys, default order see index.js.
  sortOrder: ['version'],
})

Readme

Keywords

Package Sidebar

Install

npm i pakag

Weekly Downloads

39

Version

3.1.4

License

MIT

Unpacked Size

13.5 kB

Total Files

8

Last publish

Collaborators

  • tobua