Type checking for package.json.

Derived from type-fest with a focus on package.json types.

Installation

1yarn add types-pkg-json

1npm install types-pkg-json

API

Types

1import { PackageJSON, fileName, PackageJSONFileName } from "types-pkg-json"; // Type for NPM's package.json file
2
3console.log(fileName); // "package.json"

Field Types

1import {
2  BugsLocation, // Used by the `bugs` field.
3  LicenseID, // Used by the `license` and `licenses.type` fields.
4  Person, // Used by the `author`, `contributors`, and `maintainers` fields.
5  DirectoryLocations, // Used by the `directories` field.
6  Repository, // Used by the `repository` field.
7  Scripts, // Used by the `scripts` field.
8  Dependencies // Used by the `dependencies`, `devDependencies`, `optionalDependencies`, and `peerDependencies` fields.
9} from "types-pkg-json";

Configuration Types

1import {
2  NonStandardEntryPoints, // module, esnext, browser, sideEffects
3  TypeScriptConfiguration, // types, typings
4  WorkspaceConfig, // packages, nohoist
5  YarnConfiguration, // workspaces, flat, resolutions
6  JSPMConfiguration, // jspm
7  ESLintConfiguration // eslintConfig
8} from "types-pkg-json";

Utility Types

1import {
2  isJSONObject
3  JSONObject,
4  JSONValue,
5  JSONArray,
6  Primitive,
7  LiteralUnion
8} from "types-pkg-json";
9
10function isJSONObject(object?: JSONValue): object is JSONObject;

Dependencies

• types-json: Type checking for JSON objects
• types-eslintrc: Type checking for .eslintrc.json

Dev Dependencies

• @bconnorwhite/bob: Bob is a toolkit for TypeScript projects

License

MIT

Related Projects

• types-json: Type checking for JSON objects
• types-tsconfig: Type checking for tsconfig.json
• types-eslintrc: Type checking for .eslintrc.json