Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remcohaszing/eslint-config-remcohaszing
A strict ESLint configuration
https://github.com/remcohaszing/eslint-config-remcohaszing
eslint eslint-config eslintconfig javascript typescript
Last synced: 21 days ago
JSON representation
A strict ESLint configuration
- Host: GitHub
- URL: https://github.com/remcohaszing/eslint-config-remcohaszing
- Owner: remcohaszing
- License: mit
- Created: 2020-08-06T19:13:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-06T20:37:11.000Z (7 months ago)
- Last Synced: 2024-05-02T05:14:22.568Z (6 months ago)
- Topics: eslint, eslint-config, eslintconfig, javascript, typescript
- Language: JavaScript
- Homepage:
- Size: 2.01 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# eslint-config-remcohaszing
> A strict ESLint configuration
[](https://github.com/remcohaszing/eslint-config-remcohaszing/actions)
[](https://codecov.io/gh/remcohaszing/eslint-config-remcohaszing)
[](https://www.npmjs.com/package/eslint-config-remcohaszing)
[](https://prettier.io)
This is a strict shareable ESLint configuration. All ESLint core rules and a variety of ESLint
plugins have been carefully considered. Overrides are used to apply rules based on context.
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Settings](#settings)
- [TypeScript](#typescript)
- [JSX](#jsx)
- [Markdown](#markdown)
- [Ignored files](#ignored-files)
- [Warnings](#warnings)
- [License](#license)
## Installation
Install `eslint-config-remcohaszing` using `npm`.
```sh
npm install --save-dev \
eslint \
eslint-config-remcohaszing \
prettier
```
## Configuration
First [configure Prettier](https://prettier.io/docs/en/configuration.html). For example, create a
`.editorconfig` with the following content:
```ini
root = true
[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
max_line_length = 100
trim_trailing_whitespace = true
```
And create a `.prettierrc.yaml` with the following content:
```yaml
proseWrap: always
singleQuote: true
trailingComma: all
```
The configuration may be tweaked to your liking. Beware `eslint-config-remcohaszing` bases some rule
configurations on the Prettier configuration, but doesn’t support
[overrides](https://prettier.io/docs/en/configuration.html#configuration-overrides).
Next, create `.eslintrc.yaml` with the following content:
```yaml
root: true
extends:
- remcohaszing
```
### Settings
Most ESLint settings are tweaked to have a proper default. There is one setting that needs to be
configured if your project uses a build process and provides an executable command:
`node.convertPath`. See
[`n/no-unpublished-import`](https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-unpublished-import.md#shared-settings)
for details.
```yaml
settings:
node:
convertPath:
'src/**':
- 'src/(.+?)\.tsx?$'
- dist/$1.js
```
### TypeScript
This configuration enabled ESLint for TypeScript automatically.
Some rules from `@typescript-eslint/eslint-plugin` require TypeScript type checking features to be
enabled. Unfortunately, this makes ESLint slow. Enabling these rules is recommended for small
projects only. To enable this, add the following to `.eslintrc.yaml`:
```yaml
root: true
extends:
- remcohaszing
- remcohaszing/typechecking
```
This sets the project configuration to `tsconfig.json`. To change it, see
[`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser#parseroptionsproject)
### JSX
JSX syntax is supported by default in `.jsx` and `.tsx` files. This requires some additional
dependencies to be installed:
```sh
npm install --save-dev \
eslint-plugin-jsx-a11y \
eslint-plugin-react
```
The pragma is set to `h` by default.
#### React / Preact
For React and Preact some special configurations are recommended.
An additional dependency is required:
```sh
npm install --save-dev eslint-plugin-react-hooks
```
The configurations can be applied by extending `remcohaszing/react` or `remcohaszing/preact`
respectively. The `extends` may be on the top level of the ESLint configuration or in an override.
React example:
```yaml
root: true
extends:
- remcohaszing
overrides:
- files:
- 'src/**'
extends:
- remcohaszing/react
```
Preact example:
```yaml
root: true
extends:
- remcohaszing
overrides:
- files:
- 'src/**'
extends:
- remcohaszing/preact
```
### Markdown
Code blocks in Markdown are linted by default using
[`eslint-plugin-markdown`](https://github.com/eslint/eslint-plugin-markdown).
`prettier/prettier` is disabled, because it doesn’t play nice with `eslint-plugin-markdown`.
The type checking rules from `@typescript-eslint/eslint-plugin` don’t work with
`eslint-plugin-markdown`. To work around this, tag TypeScript code blocks with `typescript`, not
`ts` or `tsx`.
Other rules have been turned off, because these rules may conflict with the purpose of the
documentation.
To not lint Markdown files, ignore them.
```yaml
ignorePatterns:
- '*.md'
```
## Ignored files
By default ESLint ignores `node_modules/` and all dotfiles. This ESLint configuration unignores
dotfiles and passes the patterns from `.gitignore` to ESLint in addition to those in
`.eslintignore`. Typically this means you won’t need a `.eslintignore` file.
## Warnings
All ESLint that are turned on will trigger error, not warnings. The notable exceptions are the
following rules:
- `import-x/no-deprecated`
- `react/no-deprecated`
This is to allow a smooth migration if a dependency decides to deprecate an API. To turn make
warnings cause ESLint to exit with exit code 1, run:
```sh
eslint --max-warnings 0 .
```
## License
[MIT](./LICENSE.md) © [Remco Haszing](https://github.com/remcohaszing)