@vp-tw/eslint-config

ViPro's ESLint configuration.

• Built on top of antfu/eslint-config.
• Integrates with:
  • eslint-config-prettier
  • eslint-mdx
  • eslint-plugin-storybook
  • eslint-plugin-react-compiler
  • eslint-plugin-package-json
• Fine-tuned to provide an opinionated, optimal DX. Please copy the VSCode settings from eslint-config.code-workspace.

Check here to preview the ESLint inspection.

Installation

pnpm i -D eslint @antfu/eslint-config @vp-tw/eslint-config

Usage

Simlar to antfu/eslint-config but with additional options:

// eslint.config.ts
import { fileURLToPath } from "node:url";

import { includeIgnoreFile } from "@eslint/compat";
import { vdustr } from "@vp-tw/eslint-config";
import path from "pathe";

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const prettierignorePath = path.resolve(__dirname, ".prettierignore");

export default vdustr(
  {
    // By default, we disable `stylistic` and use `prettier` instead.
    // stylistic: true,
    storybook: true,
    mdx: true,
  },
  includeIgnoreFile(prettierignorePath),
);

Release

pnpm -w v:patch # or
pnpm -w v:minor # or
pnpm -w v:major

pnpm -r publish

License

MIT © ViPro vdustr@gmail.com (http://vdustr.dev)