pkg-types

pkg-types

Node.js utilities and TypeScript definitions for package.json and tsconfig.json

＼⍩⃝／

Install

# npm
npm i pkg-types

# yarn
yarn add pkg-types

Usage

readPackageJSON

import { readPackageJSON } from 'pkg-types'

const pkg = await readPackageJSON('path/to/package.json')

writePackageJSON

import { writePackageJSON } from 'pkg-types'

await writePackageJSON('path/to/package.json', pkg)

readTSConfig

import { readTSConfig } from 'pkg-types'

const pkg = await readTSConfig('path/to/tsconfig.json')

writeTSConfig

import { writeTSConfig } from 'pkg-types'

await writeTSConfig('path/to/tsconfig.json', tsconfig)

Types

Note: In order to make types working, you need to install typescript as a devDependency.

You can directly use typed interfaces:

import type { TSConfig, PackageJSON } from 'pkg-types'

You can also use define utils for type support for using in plain .js files and auto-complete in IDE.

import type { definePackageJSON } from 'pkg-types'

const pkg = definePackageJSON({})

import type { defineTSConfig } from 'pkg-types'

const pkg = defineTSConfig({})

License

MIT - Made with 💛

Changelog

0.1.4 (2021-10-14)

Features

• add package.json type (8c5dfca)
• add runtime utilities (37c5ab1)

Bug Fixes

• default to any (resolves key signature issue) (a0563e4)
• prevent TS enums from polluting type (403686d)