pkg-def
v0.0.7
Published
🔧 Enhance your Node.js development experience with powerful utilities and TypeScript definitions for managing your `package.json` and `tsconfig.json files`.
Downloads
42
Readme
🔧 Enhance your Node.js development experience with powerful utilities and TypeScript definitions for managing your
package.json
andtsconfig.json files
.
Install
# nyxi
nyxi pkg-def
# pnpm
pnpm add pkg-def
# npm
npm i pkg-def
# yarn
yarn add pkg-def
Usage
readPackageJSON
import { readPackageJSON } from 'pkg-def'
const localPackageJson = await readPackageJSON()
// or
const packageJson = await readPackageJSON('/fully/resolved/path/to/folder')
writePackageJSON
import { writePackageJSON } from 'pkg-def'
await writePackageJSON('path/to/package.json', pkg)
resolvePackageJSON
import { resolvePackageJSON } from 'pkg-def'
const filename = await resolvePackageJSON()
// or
const packageJson = await resolvePackageJSON('/fully/resolved/path/to/folder')
readTSConfig
import { readTSConfig } from 'pkg-def'
const tsconfig = await readTSConfig()
// or
const tsconfig = await readTSConfig('/fully/resolved/path/to/folder')
writeTSConfig
import { writeTSConfig } from 'pkg-def'
await writeTSConfig('path/to/tsconfig.json', tsconfig)
resolveTSConfig
import { resolveTSConfig } from 'pkg-def'
const filename = await resolveTSConfig()
// or
const tsconfig = await resolveTSConfig('/fully/resolved/path/to/folder')
resolveFile
import { resolveFile } from 'pkg-def'
const filename = await resolveFile('README.md', {
startingFrom: id,
rootPattern: /^node_modules$/,
matcher: filename => filename.endsWith('.md'),
})
resolveLockFile
Find path to the lock file (yarn.lock
, package-lock.json
, pnpm-lock.yaml
, npm-shrinkwrap.json
) or throws an error.
import { resolveLockFile } from 'pkg-def'
const lockfile = await resolveLockFile('.')
findWorkspaceDir
Try to detect workspace dir by in order:
- Nearest
.git
directory - Farthest lockfile
- Farthest
package.json
file
If fails, throws an error.
import { findWorkspaceDir } from 'pkg-def'
const workspaceDir = await findWorkspaceDir('.')
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-def'
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-def'
const pkg = definePackageJSON({})
import type { defineTSConfig } from 'pkg-def'
const pkg = defineTSConfig({})
License
MIT - Made with 💞