Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aminnairi/eslint-config
ESLint configuration presets
https://github.com/aminnairi/eslint-config
eslint eslint-config javascript
Last synced: about 5 hours ago
JSON representation
ESLint configuration presets
- Host: GitHub
- URL: https://github.com/aminnairi/eslint-config
- Owner: aminnairi
- License: mit
- Created: 2020-03-26T22:20:52.000Z (over 4 years ago)
- Default Branch: latest
- Last Pushed: 2023-01-05T17:27:49.000Z (almost 2 years ago)
- Last Synced: 2024-05-27T22:05:03.907Z (6 months ago)
- Topics: eslint, eslint-config, javascript
- Language: JavaScript
- Size: 213 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :wrench: eslint-config
## :pushpin: Requirements
- [Node.js](https://nodejs.org)
- [NPM](https://www.npmjs.com)
## :building_construction: Installation
```console
$ npm install aminnairi/eslint-config
```
## :thinking: Usage
```console
$ touch .eslintrc.js
```
```javascript
"use strict";
module.exports = {
"extends": [
"@aminnairi"
]
};
```
## :construction_worker: Development
### :pushpin: Requirements
- [Git](https://git-scm.com/)
- [Docker](https://docs.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
- [GNU/Make](https://www.gnu.org/software/make/)
### :building_construction: Installation
```console
$ git clone https://github.com/aminnairi/eslint-config.git
$ cd eslint-config
```
### :thinking: Usage
```console
$ make install # install the dependencies
$ make build # build the configuration into the "lib" folder
$ make uninstall # remove the "node_modules" folder
```
## :pray: Contributing
So, you tried it and you like it! Except for some rules that could be better based on your personnal preference. If that is your case, instead of proposing a pull request, you should rather [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the project and make modifications based on your own usage of this module. Why? Simply because you and I may not be in agreement for the thing you may want to update in this configuration. Maybe you like single quotes, and I like double quotes. I won't accept PR for using single quotes for instance, so you would better be using your own version. But that would be a pretty long road to customize all of the rules available. That is why forking the project might be your best shot in this situation.