1.0.0-alpha.3 • Published 2 years ago
@rainstormy/preset-eslint-preact v1.0.0-alpha.3
Preact Preset for ESLint
This package provides a predefined, opinionated ESLint configuration suitable for any web project with Preact components.
Installation
Install the @rainstormy/preset-eslint-preact package and its peer dependencies:
npm install --save-dev @rainstormy/preset-eslint-preact eslintpnpm install --save-dev @rainstormy/preset-eslint-preact eslintyarn add --dev @rainstormy/preset-eslint-preact eslintThis preset configures a subset of rules from the following plugins, which are installed along with the preset package:
- eslint-plugin-jsx-a11y (with rule names prefixed by
jsx-a11y/) - eslint-plugin-react (with rule names prefixed by
react/) - eslint-plugin-react-hooks (with rule names prefixed by
react-hooks/)
Usage
Create or extend a flat ESLint configuration file (eslint.config.js) to target JSX component files in TypeScript.
For example:
import {
eslintAmbientTypeScriptModules,
eslintBase
} from "@rainstormy/preset-eslint-base"
import { eslintPreact } from "@rainstormy/preset-eslint-preact"
export default [
eslintBase({ files: ["**/*.+(js|ts|tsx)"] }),
// `eslintAmbientTypeScriptModules` and `eslintPreact` must follow `eslintBase` to take effect.
eslintAmbientTypeScriptModules({ files: ["**/*.d.ts"] }),
eslintPreact({ files: ["**/*.tsx"] }),
]