@dklages/eslint-config
v0.0.3
Published
A shareable ESLint config for TypeScript and JavaScript projects, using stylistic rules and TypeScript support.
Readme
@dklages/eslint-config
A shareable ESLint config for TypeScript and JavaScript projects, using stylistic rules and TypeScript support.
Installation
- Install this config and required peer dependencies:
npm install --save-dev @dklages/eslint-config eslint @stylistic/eslint-plugin typescript-eslint typescriptNote: You may also need other peer dependencies listed in
package.json:
@eslint/jseslint-config-prettiereslint-plugin-importeslint-plugin-prettier
- Create an ESLint config in your project root:
For modern ESLint (v9+), create an eslint.config.js or eslint.config.ts:
import config from '@dklages/eslint-config';
export default config;Or for CommonJS:
module.exports = require('@dklages/eslint-config');- Ensure you have a
tsconfig.jsonat your project root.
This config expects a tsconfig.json in the root directory. If your TypeScript config is elsewhere, you may need to extend or override the parser options.
Usage
Run ESLint as usual:
npx eslint .Customization
You can extend or override rules by modifying your own ESLint config file.
