Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/himynameisdave/eslint-config-himynameisdave
🗒️ An opinionated eslint config by and for himynameisdave
https://github.com/himynameisdave/eslint-config-himynameisdave
code-quality eslint eslint-config formatter himynameisdave linter linter-config linting-rules
Last synced: 2 months ago
JSON representation
🗒️ An opinionated eslint config by and for himynameisdave
- Host: GitHub
- URL: https://github.com/himynameisdave/eslint-config-himynameisdave
- Owner: himynameisdave
- License: mit
- Created: 2017-12-04T02:28:52.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-15T16:07:18.000Z (4 months ago)
- Last Synced: 2024-09-19T18:47:50.137Z (4 months ago)
- Topics: code-quality, eslint, eslint-config, formatter, himynameisdave, linter, linter-config, linting-rules
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-config-himynameisdave
- Size: 1.94 MB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
---
A modular, opinionated, and well-maintained `eslint` config made by and for [`himynameisdave`](https://github.com/himynameisdave). Made of small configs which can be composed together to achieve a linting setup that is project-aware.
### Contents
- [Requirements](#Requirements)
- [Installation](#Installation)
- [Configurations](#Configurations)
- [base](#Base)
- [core](#Core)
- [node](#Node)
- [typescript](#Typescript)
- [react](#React)
- [svelte](#Svelte)
- [import](#Import)
- [jest](#jest)
- [off](#off)
- [Rules](#Rules)
- [Releases](#Releases)
- [Inspiration](#Inspiration)
- [Neat ESLint Stuff](#Some-neat-ESLint-stuff)
### Requirements
Requires at least:
- Node v16.x+
- ESLint v8.x+
### Installation
Install this `eslint` and this config:
```bash
yarn add -D eslint eslint-config-himynameisdave
```
You don't need to install `eslint` or any additional plugins to being using this package.
### Configurations
This package provides various configurations which you can extend from.
#### Base
The base config turns enables the core `eslint` rules only. No additional plugins are required to use this config. Great for small projects.
```js
// Extend your .eslintrc
{
"extends": ["himynameisdave/configurations/base"]
}
```
#### Core
This includes `base` as well as turns on `promise` and `unicorn` rules as well.
```js
// Extend your .eslintrc
{
"extends": ["himynameisdave/configurations/core"]
}
```
#### Node
Extend this config with additional rules for Node projects. Useful for CLI/Node-only projects, although it _should_ be compatible with the browser-based configurations listed below.
```js
// Extend your .eslintrc
{
"extends": [
"himynameisdave/configurations/core",
"himynameisdave/configurations/node"
]
}
```
#### Typescript
Extend this config for Typescript support. Requires type information, so you'll need to configure ESLint to be aware of your TS setup. You can read more about doing that [here](https://typescript-eslint.io/linting/typed-linting). You don't need to install `@typescript-eslint/parser` as it is included like the other plugins.
```js
// Extend your .eslintrc
{
"extends": [
"himynameisdave/configurations/core",
"himynameisdave/configurations/typescript"
],
"parserOptions": {
"sourceType": 'module',
"tsconfigRootDir": __dirname,
"project": './tsconfig.json'
},
"settings": {
'import/parsers': {
'@typescript-eslint/parser': [
'.ts',
'.tsx', // Only needed if using React
]
},
'import/extensions': [
'.ts',
'.tsx', // Only needed if using React
],
'import/resolver': {
typescript: {
'alwaysTryTypes': true,
},
},
},
// If you are also using the node or import configurations, you'll want these rules off:
rules: {
'import/extensions': 'off',
'n/file-extension-in-import': 'off',
'n/no-unsupported-features/es-syntax': 'off',
}
}
```
#### React
Extends the base config with React support. This config may conflict with the Node config, so should be placed after it if using both.
```js
// Extend your .eslintrc
{
"extends": [
"himynameisdave/configurations/core",
"himynameisdave/configurations/react",
"himynameisdave/configurations/typescript" // If using Typescript, it should come last.
]
}
```
#### Svelte
Extends the base config with Svelte support. This config may conflict with the Node config, so should be placed after it if using both.
```js
// Extend your .eslintrc
{
"extends": [
"himynameisdave/configurations/core",
"himynameisdave/configurations/svelte"
]
}
```
You may need to [read more about configuring your editor](https://sveltejs.github.io/eslint-plugin-svelte/) for this plugin to work.
#### Import
Extends the base config with [`import`](https://github.com/benmosher/eslint-plugin-import) plugin rules.
```js
// Extend your .eslintrc
{
"extends": [
"himynameisdave/configurations/core",
"himynameisdave/configurations/import"
]
}
```
#### Jest
Extends the base config with [`jest`](https://github.com/jest-community/eslint-plugin-jest) plugin rules.
```js
// Extend your .eslintrc
{
"extends": [
"himynameisdave/configurations/core",
"himynameisdave/configurations/jest"
]
}
```
#### Off
In addition to all of these, there is an `off` config which you can use to turn off all rules. Not sure there are a ton of use-cases for this, but it would allow you to extend from individual rulesets, like so:
```js
// .eslintrc
{
"extends": [
"himynameisdave/configurations/off",
"himynameisdave/rules/promises/on",
"himynameisdave/rules/unicorn/on"
]
}
```
### Rules
Note that in addition to extending a configuration, you can also extend various rulesets. This gives you very granular control of your project.
As an example, let's assume we are using React but don't care about the `jsx-a11y` rules:
```js
// .eslintrc
{
"extends": [
"himynameisdave/configurations/core",
"himynameisdave/rules/promises/on",
"himynameisdave/rules/unicorn/on",
"himynameisdave/rules/react/on",
"himynameisdave/rules/react-hooks/on",
"himynameisdave/rules/jsx-a11y/off", // We don't technically need to add this, but note that there are `off` versions for each.
]
}
```
### Releases
Read more about the release guidelines for this project [over here](https://github.com/himynameisdave/eslint-config-himynameisdave/blob/main/.github/RELEASING.md).
### Inspiration
Inspired very heavily by the (now-dead) [`eslint-config-7geese`](https://github.com/7Geese/eslint-config-7geese), which was in turn inspired by [`eslint-config-walmart`](https://github.com/walmartlabs/eslint-config-walmart), [`eslint-config-formidable`](https://github.com/FormidableLabs/eslint-config-formidable), and many others.
### Some neat ESLint stuff
- [`eslint-rule-documentation`](https://github.com/jfmengels/eslint-rule-documentation) - Tool to find the url for the documentation of an ESLint rule.
- [`eslint-nibble`](https://github.com/IanVS/eslint-nibble) - When you/your team don't have time to fix all the ESLint violations in your codebase, you should just nibble them.
- [`eslint-multiplexer`](https://github.com/pimlie/eslint-multiplexer) - When you have multiple of the same error in the same file, this groups them in the output.
- [`eslint-plugin-svelte3`](https://github.com/sveltejs/eslint-plugin-svelte3) - Because [Svelte](https://svelte.dev).
