Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flaconi/eslint-config-flaconi
shared eslint config
https://github.com/flaconi/eslint-config-flaconi
Last synced: about 4 hours ago
JSON representation
shared eslint config
- Host: GitHub
- URL: https://github.com/flaconi/eslint-config-flaconi
- Owner: Flaconi
- License: mit
- Created: 2019-11-22T13:56:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T16:46:35.000Z (over 1 year ago)
- Last Synced: 2024-11-08T14:51:54.570Z (8 days ago)
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/RichardLitt/standard-readme)
[](LICENSE)
# eslint-config-flaconi
> [Flaconi's](https://www.flaconi.de/) shareable eslint config
## Install
#### Flow based projects
```
yarn add -D [email protected] eslint-config-flaconi [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]
```
or
```
npm i -D [email protected] eslint-config-flaconi [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]
```
#### Typescript based projects
```
yarn add -D [email protected] eslint-config-flaconi [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] @typescript-eslint/[email protected] @typescript-eslint/[email protected] [email protected] [email protected]
```
or
```
npm i -D [email protected] eslint-config-flaconi [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] @typescript-eslint/[email protected] @typescript-eslint/[email protected] [email protected] [email protected]
```
## Usage
Add the following to your `.eslintrc`:
```json
{
"extends": [
"flaconi"
]
}
```
or to the `package.json`:
```json
{
"eslintConfig": {
"extends": "flaconi"
}
}
```
or to `.eslintrc.js`:
```js
module.exports = {
extends: 'flaconi',
}
```
## Contains
Our default export contains all of our ESLint rules, including ECMAScript 6+ and React. It requires:
* `@typescript-eslint/eslint-plugin`
* `@typescript-eslint/parser`
* `babel-eslint`
* `eslint`
* `eslint-config-prettier`
* `eslint-config-react-app`
* `eslint-config-standard`
* `eslint-plugin-flowtype`
* `eslint-plugin-import`
* `eslint-plugin-jsx-a11y`
* `eslint-plugin-node`
* `eslint-plugin-prettier`
* `eslint-plugin-promise`
* `eslint-plugin-react`
* `eslint-plugin-react-hooks`
* `eslint-plugin-standard`
* `prettier`
* `stylelint`
## Limitations
[eslint-config-flaconi](https://github.com/Flaconi/eslint-config-flaconi) works based on the following:
1. [react](https://github.com/facebook/react) project
2. [jest](https://github.com/facebook/jest) for tests
3. [babel-eslint](https://github.com/babel/babel-eslint) parser
## Develop
Developing or testing locally the repo is possible using the `yarn link` command.
1. `git clone https://github.com/Flaconi/eslint-config-flaconi.git && cd eslint-config-flaconi`
2. `yarn link`
3. `cd` to any project and run `yarn link "eslint-config-flaconi"`
4. Install all plugins (except `eslint-config-flaconi`)
5. your `.eslintrc` file must look like this:
```json
{
"extends": [
"flaconi"
]
}
```
## Contributing
PRs are welcome. Please read the [code of conduct](./.github/CODE_OF_CONDUCT.md) and [contribution guidelines](./.github/CONTRIBUTING.md).
## License
[MIT](LICENSE) © Flaconi GmbH