Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evelynhathaway/eslint-plugin-evelyn
🔮🧹 ESLint plugin for my projects with my preferred code style and bugfixes
https://github.com/evelynhathaway/eslint-plugin-evelyn
eslint eslint-config eslint-plugin
Last synced: 26 days ago
JSON representation
🔮🧹 ESLint plugin for my projects with my preferred code style and bugfixes
- Host: GitHub
- URL: https://github.com/evelynhathaway/eslint-plugin-evelyn
- Owner: evelynhathaway
- License: mit
- Created: 2019-03-23T22:25:51.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-05-31T18:46:38.000Z (over 1 year ago)
- Last Synced: 2024-09-20T11:06:29.105Z (about 2 months ago)
- Topics: eslint, eslint-config, eslint-plugin
- Language: JavaScript
- Homepage: https://npmjs.com/package/eslint-plugin-evelyn
- Size: 3.89 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ESLint Plugin Evelyn
**ESLint plugin for my projects with my preferred code style**
[](https://www.npmjs.com/package/eslint-plugin-evelyn)
[](https://github.com/evelynhathaway/eslint-plugin-evelyn/actions)
[](#configs)
[](/LICENSE)
## Description
These are my configs and code related to maintaining ESLint scripts.
My code style is very opinionated, so I only use this package on my projects. However, others are welcome to use, copy, or fork this project.
## Installation
Save this project to your dev dependencies. If you are using an version on npm older than v7.0.0, you will have to
install peer dependencies manually.
```bash
npm install --save-dev eslint-plugin-evelyn
```
### Peer Dependencies
npm may warn about any missing peer dependencies when installing this plugin.
```bash
npm WARN [email protected] requires a peer of eslint-plugin-xxxxx@^x.x.x but none is installed. You must install peer dependencies yourself.
```
If you are using and loading a [config](#configs) that requires one of the mentioned dependencies, add the plugin as a dev dependency that satisfies the specified version range. Otherwise, you can safely ignore these messages.
ESLint always resolves and loads plugins when the configs are extended in the top-level config, but only resolves plugins in an override once a file matches its glob pattern.
## Usage
Include as many configs as you'd like to use in your config. Extend them in the order that they should be applied, in order of importance, lowest to highest.
### Configs Applied to All Files
**`.eslintrc`**
```json
{
"plugins": [
"evelyn"
],
"extends": [
"plugin:evelyn/default",
"plugin:evelyn/node"
]
}
```
### Configs applied to a specific path
Requires eslint `>=6.0.0`.
**`.eslintrc`**
```json
{
"plugins": [
"evelyn"
],
"extends": [
"plugin:evelyn/default"
],
"overrides": [
{
"files": [
"src/**/*.js"
],
"extends": [
"plugin:evelyn/node"
]
}
]
}
```
### TypeScript React App Example
**`.eslintrc.js`**
```js
module.exports = {
"plugins": [
"@evelyn",
],
"extends": [
"plugin:@evelyn/default",
"plugin:@evelyn/node",
"plugin:@evelyn/react",
"plugin:@evelyn/typescript",
],
"ignorePatterns": [
"build",
"coverage",
],
"overrides": [
{
"files": [
"**/*.test.{ts,tsx}",
"**/__tests__/**/*.{ts,tsx}",
],
"extends": [
"plugin:@evelyn/jest",
"plugin:@evelyn/testing-library-react",
],
},
],
};
```
**`package.json`** (snippet)
Make sure to remove any references to old ESLint plugins or configs and replace the lint script with `eslint ./`.
```json
{
"name": "my-app",
"...": "...",
"scripts": {
"...": "...",
"lint": "eslint ./"
}
}
```
## Testing
```bash
# Install dependencies
npm install
# Symlink itself into node_modules for ESLint
# As of eslint-plugin-evelyn v3.0.0, this is done fully automatically
npm run link
# Run all tests!
npm run test
```
### Final Config Array Tests
[final-config-array.eslintrc.js](./test/final-config-array.eslintrc.js) tests to make sure all modules and configs load properly. Without this test, if a parser or plugin doesn't load and is never used to lint a file, ESLint won't report the error.
## Linting
This plugin uses itself to lint so we must make sure the working copy of `eslint-plugin-evelyn` is in `node_modules`. Only ESLint should require it from there.
```bash
# Install dependencies
npm install
# Symlink itself into node_modules for ESLint
# As of eslint-plugin-evelyn v3.0.0, this is done fully automatically
npm run link
# Run lint!
npm run lint
```
## Debugging
- Make sure you're using the local version of eslint using `npm run` or `npx eslint`
- Use the `--debug` ESLint CLI flag for determining things like the modules that get loaded
- Use the `--print-config` ESLint CLI flag for a minimal computed config
### Saving the Entire Computed Config Array
Run the default export from the `save-config.js` file from inside the config file to output to monkey-patch ESLint. This works on this project as well as any package that has eslint-plugin-evelyn `>=1.0.0` as a dependency.
`.eslintrc.js`
```js
require("eslint-plugin-evelyn/lib/util/save-config")();
// The rest of your config file
// [...]
```
This saves the config array that is usually partially outputted to the console during execution with the `--debug` flag.
```bash
$ npx eslint --debug
# [...]
eslint:cascading-config-array-factory Configuration was determined: ConfigArray [...]
```
## Recording Changes to the Final Config Array
[record-changes.eslintrc.js](./changes/record-changes.eslintrc.js) saves the final config array to [record-changes.json](./changes/record-changes.json) with paths removed.
The script is used to track the changes to the final array over time using the pre-commit git hook. This is helpful in reviewing pull requests.
---
## Configs
See the `peerDependencies` in [package.json](./package.json) for recommended dependency version ranges.
| Name | Peer Dependencies |
| --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| [babel](./lib/configs/babel.js) | @babel/eslint-parser |
| [default](./lib/configs/default.js) | eslint-plugin-unicorn, eslint-plugin-import, eslint-plugin-regexp |
| [esm](./lib/configs/esm.js) | eslint-plugin-unicorn, eslint-plugin-import |
| [jest](./lib/configs/jest.js) | eslint-plugin-node, eslint-plugin-jest |
| [jsx](./lib/configs/jsx.js) | eslint-plugin-jsx-a11y |
| [mocha](./lib/configs/mocha.js) | eslint-plugin-node, eslint-plugin-mocha |
| [node](./lib/configs/node.js) | eslint-plugin-node |
| [react](./lib/configs/react.js) | eslint-plugin-react, eslint-plugin-jsx-a11y, eslint-plugin-react-hooks, eslint-plugin-import |
| [testing-library](./lib/configs/testing-library.js) | eslint-plugin-testing-library |
| [testing-library-react](./lib/configs/testing-library-react.js) | eslint-plugin-testing-library |
| [typescript](./lib/configs/typescript.js) | @typescript-eslint/eslint-plugin, @typescript-eslint/parser, typescript, eslint-plugin-import, eslint-import-resolver-typescript |
---
## Semantic Versioning Policy
This plugin follows semantic versioning [a-la-ESLint](https://github.com/eslint/eslint#semantic-versioning-policy).
- Patch release (not intended to break your lint build)
- A bug fix in a rule that results in ESLint reporting fewer or the same amount of errors
- Improvements to documentation
- Non-user-facing changes such as refactoring code
- Re-releasing after a failed release
- Minor release (might break your lint build)
- A new config or rule is added
- A new non-default option is added to an existing rule
- A bug fix in a rule that results in ESLint reporting more errors
- An existing rule, config, or part of the public API is deprecated, but still runs/works
- New capabilities to the public API are added
- A config is updated in a way that results in ESLint fewer or the same amount of errors
- The hypothetical removal of `semi` would be a good example as not enforcing it could create the potential to break your code
- Major release (likely to break your lint build)
- A config or rule is removed
- A config is updated in a way that results in ESLint reporting more errors
- A newer version of ESLint, a plugin, or Node.js may be required
- Any changes to the low end of any of the `peerDependencies` or the `engines`
- A rule's default behavior is changed
- Part of the public API is removed or changed in an incompatible way
## License
Copyright Evelyn Hathaway, [MIT License](/LICENSE)