pkg-types

Node.js utilities and TypeScript definitions for package.json, tsconfig.json, and other configuration files.

Install

1# ✨ Auto-detect
2npx nypm install pkg-types
3
4# npm
5npm install pkg-types
6
7# yarn
8yarn add pkg-types
9
10# pnpm
11pnpm install pkg-types
12
13# bun
14bun install pkg-types
15
16# deno
17deno install pkg-types

Usage

Package Configuration

readPackage

Reads any package file format (package.json, package.json5, or package.yaml) with automatic format detection.

1import { readPackage } from "pkg-types";
2const localPackage = await readPackage();
3// or
4const package = await readPackage("/fully/resolved/path/to/folder");

writePackage

Writes package data with format detection based on file extension.

1import { writePackage } from "pkg-types";
2
3await writePackage("path/to/package.json", pkg);
4await writePackage("path/to/package.json5", pkg);
5await writePackage("path/to/package.yaml", pkg);

findPackage

Finds the nearest package file (package.json, package.json5, or package.yaml).

1import { findPackage } from "pkg-types";
2const filename = await findPackage();
3// or
4const filename = await findPackage("/fully/resolved/path/to/folder");

readPackageJSON

1import { readPackageJSON } from "pkg-types";
2const localPackageJson = await readPackageJSON();
3// or
4const packageJson = await readPackageJSON("/fully/resolved/path/to/folder");

writePackageJSON

1import { writePackageJSON } from "pkg-types";
2
3await writePackageJSON("path/to/package.json", pkg);

resolvePackageJSON

1import { resolvePackageJSON } from "pkg-types";
2const filename = await resolvePackageJSON();
3// or
4const packageJson = await resolvePackageJSON("/fully/resolved/path/to/folder");

TypeScript Configuration

readTSConfig

1import { readTSConfig } from "pkg-types";
2const tsconfig = await readTSConfig();
3// or
4const tsconfig2 = await readTSConfig("/fully/resolved/path/to/folder");

writeTSConfig

1import { writeTSConfig } from "pkg-types";
2
3await writeTSConfig("path/to/tsconfig.json", tsconfig);

resolveTSConfig

1import { resolveTSConfig } from "pkg-types";
2const filename = await resolveTSConfig();
3// or
4const tsconfig = await resolveTSConfig("/fully/resolved/path/to/folder");

File Resolution

resolveFile

1import { resolveFile } from "pkg-types";
2const filename = await resolveFile("README.md", {
3  startingFrom: id,
4  rootPattern: /^node_modules$/,
5  matcher: (filename) => filename.endsWith(".md"),
6});

resolveLockFile

Find path to the lock file (yarn.lock, package-lock.json, pnpm-lock.yaml, npm-shrinkwrap.json, bun.lockb, bun.lock, deno.lock) or throws an error.

1import { resolveLockFile } from "pkg-types";
2const lockfile = await resolveLockFile(".");

findWorkspaceDir

Try to detect workspace dir by in order:

1. Farthest workspace file (pnpm-workspace.yaml, lerna.json, turbo.json, rush.json, deno.json, deno.jsonc)
2. Closest .git/config file
3. Farthest lockfile
4. Farthest package.json file

If fails, throws an error.

1import { findWorkspaceDir } from "pkg-types";
2const workspaceDir = await findWorkspaceDir(".");

Git Configuration

resolveGitConfig

Finds closest .git/config file.

1import { resolveGitConfig } from "pkg-types";
2
3const gitConfig = await resolveGitConfig(".")

readGitConfig

Finds and reads closest .git/config file into a JS object.

1import { readGitConfig } from "pkg-types";
2
3const gitConfigObj = await readGitConfig(".")

writeGitConfig

Stringifies git config object into INI text format and writes it to a file.

1import { writeGitConfig } from "pkg-types";
2
3await writeGitConfig(".git/config", gitConfigObj)

parseGitConfig

Parses a git config file in INI text format into a JavaScript object.

1import { parseGitConfig } from "pkg-types";
2
3const gitConfigObj = parseGitConfig(gitConfigINI)

stringifyGitConfig

Stringifies a git config object into a git config file INI text format.

1import { stringifyGitConfig } from "pkg-types";
2
3const gitConfigINI = stringifyGitConfig(gitConfigObj)

Types

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

You can directly use typed interfaces:

1import type { TSConfig, PackageJSON, GitConfig } from "pkg-types";

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

1import type { definePackageJSON } from 'pkg-types'
2
3const pkg = definePackageJSON({})

1import type { defineTSConfig } from 'pkg-types'
2
3const pkg = defineTSConfig({})

1import type { defineGitConfig } from 'pkg-types'
2
3const gitConfig = defineGitConfig({})

Alternatives

• dominikg/tsconfck

License

Published under the MIT license. Made by @pi0, @danielroe and community 💛