https://github.com/sebastianwd/eslint-config
Custom eslint config for my projects. Using flat config.
https://github.com/sebastianwd/eslint-config
eslint eslint-config
Last synced: 5 months ago
JSON representation
Custom eslint config for my projects. Using flat config.
- Host: GitHub
- URL: https://github.com/sebastianwd/eslint-config
- Owner: sebastianwd
- Created: 2024-10-26T21:28:53.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-12-13T23:02:42.000Z (5 months ago)
- Last Synced: 2024-12-13T23:08:34.357Z (5 months ago)
- Topics: eslint, eslint-config
- Language: TypeScript
- Homepage:
- Size: 94.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# swd-eslint-config
This is a custom eslint config for my projects. It uses the latest flat config version of eslint.
- Usage:
- Install: `pnpm add -D eslint prettier typescript-eslint swd-eslint-config`
- In your `eslint.config.mjs`:
```ts
import swdEslintPlugin from "swd-eslint-config";
import tseslint from "typescript-eslint";
export default tseslint.config(
{
languageOptions: {
parserOptions: {
// Important for typed linting
parser: tseslint.parser,
tsconfigRootDir: import.meta.dirname,
project: ["./tsconfig.json"],
},
},
},
...swdEslintPlugin.configs.base,
// if using React:
...swdEslintPlugin.configs.react(
{ framework: "next" } // optional
)
);
```
or the flat config with classic syntax:
```ts
export default tseslint.config({
languageOptions: {
parserOptions: {
// Important for typed linting
parser: tseslint.parser,
tsconfigRootDir: import.meta.dirname,
project: ["./tsconfig.json"],
},
},
extends: [
...swdEslintPlugin.configs.base,
// if using React:
...swdEslintPlugin.configs.react(
{ framework: "next" } // optional
),
],
});
```
- Create a prettier config. Example:
`prettier.config.mjs`
```js
/** @type {import("prettier").Config} */
export default {
endOfLine: "lf", // consistency between windows and linux
semi: false,
singleQuote: true,
jsxSingleQuote: true,
tabWidth: 2,
trailingComma: "es5",
lineWidth: 120,
};
```
- If using Expo, `eslint-config-expo` uses outdated versions, so you need to add the following to your `package.json`:
```json
"pnpm": {
"overrides": {
"eslint-plugin-react-hooks": "^5.0.0"
}
}
```
### Plugins included:
- [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react)
- [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
- [eslint-plugin-tailwindcss](https://github.com/tailwindlabs/eslint-plugin-tailwindcss)
- [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier)
- [eslint-plugin-simple-import-sort](https://github.com/lydell/eslint-plugin-simple-import-sort)
- [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin)
### Commands
- `pnpm build` - Builds the package
- `pnpm release` - Creates a new release, should be used before committing
- `pnpm release:publish` - Publishes the release, shouldn't be used manually