Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/eslint-config
ESLint configuration for my own projects
https://github.com/ehmicky/eslint-config
code-quality continuous-integration editorconfig es6 eslint eslintconfig fp functional html javascript lint markdown modularity nodejs prettier prettierrc standard standard-js strict testing
Last synced: 10 days ago
JSON representation
ESLint configuration for my own projects
- Host: GitHub
- URL: https://github.com/ehmicky/eslint-config
- Owner: ehmicky
- License: apache-2.0
- Created: 2018-10-06T11:48:12.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T20:58:45.000Z (4 months ago)
- Last Synced: 2024-10-11T10:17:07.765Z (26 days ago)
- Topics: code-quality, continuous-integration, editorconfig, es6, eslint, eslintconfig, fp, functional, html, javascript, lint, markdown, modularity, nodejs, prettier, prettierrc, standard, standard-js, strict, testing
- Language: JavaScript
- Homepage:
- Size: 17.7 MB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@ehmicky/eslint-config)
[](https://www.npmjs.com/package/@ehmicky/eslint-config)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
[ESLint](https://eslint.org/) configuration for my own projects.
This is not meant to be shared and semantic versioning is not followed.
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Coding style
## Functional programming
State should be immutable.
Variables and object properties should be read-only. They should be copied
instead of mutated. Assignment should only happen during declaration.
The following patterns should be avoided as they imply state:
- loops (`for`, `while`). Use functional methods (like `Array.map()` and
`Array.filter()`) and recursion instead.
- classes/OOP. To inherit/share behavior, use composition or generic programming
instead.
- events. Use promises and streams instead.
Global variables should not be used except the ones that are built-in (e.g.
`Object`).
Throwing exceptions is allowed as this can simplify code.
## Modularity
Code should be split into small files and functions:
- files have at most 90 non-empty lines and 10 dependencies.
- functions have at most 4 branches and 10 statements.
- branches/blocks should not be nested.
- lines are at most 80 characters long.
## Modern JavaScript
- ES modules. Exports should be named (no `export default`).
- object and array destructuring.
- object spreading: `{ ...object }` instead of `Object.assign({}, ...object)`
- arguments spreading: `funcName(...args)` instead of
`funcName.call(this, ...args)`
- parameters spreading: `(...args) => ...` instead of `(arguments) => ...`
- template strings instead of concatenation.
- `async`/`await` instead of explicit promises or callbacks.
- vanilla JavaScript instead of Lodash/Underscore.
- only JavaScript features supported by the Node.js version specified in your
`package.json` `engines` field.
## Strictness
The configuration is very explicit and enforces strict linting. This should help
you find bugs and maintain a consistent coding style:
- no dead code.
- typecasting should be explicit.
- file dependencies should be sorted.
- variable names should remain short.
- constants should be assigned to variables.
- avoiding turning off ESLint rules with comments.
- RegExps should use the `u` flag.
- no variables shadowing.
## Other styling rules
- named parameters (i.e. passing an object as single parameter) instead of
positional parameters.
- arrow functions should be preferred
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
inclusive environment.
# Contributing
This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's `Edit`
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug, please check our
[guidelines](CONTRIBUTING.md). Pull requests are welcome!