types-eslintrc

types-eslintrc

Type checking for ESLint configs.

If I should maintain this repo, please ⭐️

DM me on Twitter if you have questions or suggestions.

This package uses zod to type check ESLint configs.

Installation

yarn add types-eslintrc

npm install types-eslintrc

pnpm add types-eslintrc

Usage

Types

import {
  ESLintConfig,
  isESLintConfig,
  parseESLintConfig
} from "types-eslintrc";

const myConfig = {
  // ...
};

if(isESLintConfig(myConfig)) {
  // myConfig is now typed as ESLintConfig
}

const myConfig = parseESLintConfig(myConfig);
// If myConfig is valid, it will return as ESLintConfig. Otherwise, it will return undefined.

Dependencies

• types-json: Type checking for JSON objects
• zod: TypeScript-first schema declaration and validation library with static type inference

Dev Dependencies

• autorepo: Autorepo abstracts away your dev dependencies, providing a single command to run all of your scripts.

License

MIT - MIT License

Related Projects

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