Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feedzai/eslint-config-feedzai
https://github.com/feedzai/eslint-config-feedzai
eslint feedzai
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/feedzai/eslint-config-feedzai
- Owner: feedzai
- License: apache-2.0
- Created: 2018-07-18T17:01:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-12T00:35:09.000Z (4 months ago)
- Last Synced: 2024-08-02T18:47:55.482Z (3 months ago)
- Topics: eslint, feedzai
- Language: JavaScript
- Size: 218 KB
- Stars: 9
- Watchers: 28
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-eslint - Feedzai - Feedzai's shareable config for JavaScript/React projects. (Configs / Configs by Well-Known Companies/Organizations)
README
# eslint-config-feedzai
[](https://travis-ci.com/feedzai/eslint-config-feedzai)
This repository contains the ESLint configuration used across products at Feedzai.
We share this configuration to promote the use of linters in JavaScript and to share our conventions and best practices in the hope of inspiring others when defining their configurations.
This repo includes two distinct ESLint configurations:
- `@feedzai/eslint-config-feedzai`- This configuration contains our ESLint rules, including the ones for ECMAScript 6+.
If you're using React in your projects please check the `@feedzai/eslint-config-feedzai-react`.
This packages requires `eslint` and `eslint-plugin-import`.
- `@feedzai/eslint-config-feedzai-react` - This configuration extends the `@feedzai/eslint-config-feedzai` and includes the rules for React, a11y and Jest.
This package requires `eslint`, `@feedzai/eslint-config-feedzai`, `eslint-plugin-import`, `eslint-plugin-jest`, `eslint-plugin-jsx-a11y` and `eslint-plugin-react`.
## Usage
### Installing package dependencies
In order to list the correct versions of each package you could use this command:
```shell
npm info "@feedzai/eslint-config-feedzai@latest" peerDependencies
```
After this command, you can install those packages manually or if you're using the **npm version > 5** you could use this shortcut:
```shell
npx install-peerdeps --dev @feedzai/eslint-config-feedzai-react
```
If you want to do all manually you should use:
```shell
npm install --save-dev @feedzai/eslint-config-feedzai eslint@^#.#.# eslint-plugin-import@^#.#.#
```
or :
```shell
npm install --save-dev @feedzai/eslint-config-feedzai-react eslint@^#.#.# @feedzai/eslint-config-feedzai@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-jest@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-react@^#.#.#
```
### Using Feedzai's ESLint configurations in your `.eslintrc` file
Add `"extends": "@feedzai/eslint-config-feedzai"` for JavaScript projects or `"extends": "@feedzai/eslint-config-feedzai-react"` for React projects to your `.eslintrc` file.
## Development tasks
You can check if those packages follow our coding style conventions by using `npm run lint` in the root folder of each package.
## Deployment tasks
The available commands are:
- `deploy:major` - creates a git tag and publish the X.0.0 version. _This command should be executed only in the `master` branch._
- `deploy:minor` - creates a git tag and publish the X.Y.0 version. _This command should be executed in the hot-fix branches (`hf-X.x.x`)._
- `deploy:patch` - creates a git tag and publish the X.Y.Z version. _This command should be executed in the hot-fix branches (`hf-X.x.x`)._