https://github.com/becodeorg/eslint-config
⚙️ ESLint default configuration for BeCode projects
https://github.com/becodeorg/eslint-config
tooling
Last synced: 12 months ago
JSON representation
⚙️ ESLint default configuration for BeCode projects
- Host: GitHub
- URL: https://github.com/becodeorg/eslint-config
- Owner: becodeorg
- Created: 2019-02-25T13:14:37.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2022-01-23T08:46:13.000Z (over 4 years ago)
- Last Synced: 2025-04-26T09:36:27.451Z (about 1 year ago)
- Topics: tooling
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@becode/eslint-config
- Size: 2.71 MB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BeCode: ESLint Config
> ⚙️ ESLint default configuration for BeCode projects
* * *
## About
Many of us like to use [ESLint](https://eslint.org) for our projects.
This module contains the common ESLint rules configuration for BeCode project, in a simpler, *without-pain* configuration.
## Usage
### Automatic method
You can also use the following command in your project:
npx @becode/eslint-config
That will create the eslint config file *and* install the needed dependencies.
Simple and easy.
#### (optional) Create `pre-commit` git hook
You can also setup a git `pre-commit` hook to ensure that ESlint and Prettier are run *before* each commit, discarding commit if there's an error.
Simply use the `--with-hook` flag:
npx @becode/eslint-config --with-hook
#### (optional) Create `lint` npm script
You can also setup a `lint` npm script to lint and prettify your files.
> 🖐 **NOTE:**the script assumes your files are in a folder called `src`. Correct the path in your package.json if needed.
Simply use the `--with-script` flag:
npx @becode/eslint-config --with-script
### Manual method
To use our rules, you simply need to configure your `.eslintrc.js` to look like this:
```javascript
module.exports = {
extends: "@becode"
};
```
> cf. the official ESLint documentation [page about shareable configs](https://eslint.org/docs/developer-guide/shareable-configs#using-a-shareable-config).
* * *
February 2019, [leny](https://github.com/leny) for [BeCode](https://becode.org).