Type checking for ESLint configs.
_If I should maintain this repo, please ⭐️_
_DM me on [Twitter](https://twitter.com/bconnorwhite) if you have questions or suggestions._
---
This package uses [zod](https://www.npmjs.com/package/zod) to type check ESLint configs.
## Installation
```sh
yarn add types-eslintrc
```
```sh
npm install types-eslintrc
```
```sh
pnpm add types-eslintrc
```
## Usage
### Types
```ts
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](https://www.npmjs.com/package/types-json): Type checking for JSON objects
- [zod](https://www.npmjs.com/package/zod): TypeScript-first schema declaration and validation library with static type inference
Dev Dependencies
- [autorepo](https://www.npmjs.com/package/autorepo): Autorepo abstracts away your dev dependencies, providing a single command to run all of your scripts.
License 
[MIT](https://opensource.org/licenses/MIT) - _MIT License_
## Related Projects
- [types-json](https://www.npmjs.com/package/types-json): Type checking for JSON objects
- [types-tsconfig](https://www.npmjs.com/package/types-tsconfig): Type checking for tsconfig.json
- [types-pkg-json](https://www.npmjs.com/package/types-pkg-json): Type checking for package.json
