https://github.com/vazco/eslint-config-vazco

ESLint rules used across Vazco.eu in React projects
https://github.com/vazco/eslint-config-vazco

eslint eslint-rules hacktoberfest

Last synced: about 2 months ago
JSON representation

ESLint rules used across Vazco.eu in React projects

• Host: GitHub
• URL: https://github.com/vazco/eslint-config-vazco
• Owner: vazco
• License: mit
• Created: 2016-04-27T20:26:08.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-14T14:26:59.000Z (12 months ago)
• Last Synced: 2024-11-08T06:11:44.862Z (about 2 months ago)
• Topics: eslint, eslint-rules, hacktoberfest
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/eslint-config-vazco
• Size: 725 KB
• Stars: 9
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    vazco/eslint-config-vazco





    

        

    

    

    

    

        

    



## Install

To install simply add this config (along with it's peer dependencies) to your project's dev-dependencies:

```

npm install --save-dev eslint-config-vazco

npx install-peerdeps --dev eslint-config-vazco

```

## Usage

Extend your project's ESLint rules with our config.

This can be done in few ways (for TypeScript projects replace `vazco` with `vazco/typescript`):

#### .eslintrc / .eslintrc.json

```javascript

{

    "extends": "vazco",

    "rules": {

        // custom project rules

    }

}

```

#### .eslintrc.yaml

```yaml

extends:

  - vazco

rules:

  // custom project rules

```

#### package.json

```json

{

    "eslintConfig": {

        "extends": "vazco"

    }

}

```

#### Prettier workflow

Introducing prettier to project can be problematic.

To avoid merge conflicts, all active branches should reformat code at the same time.

Later on code could be `--fix`ed on every commit, with tools like [lint-staged](https://github.com/okonet/lint-staged) and [pre-commit](https://github.com/observing/pre-commit) or [husky](https://github.com/typicode/husky)

## Changelog

All changes introduces in the config are tracked inside [changelog file](CHANGELOG.md).

## How to change the rules

All information regarding making changes in the config and versioning details can be found in [contributing file](CONTRIBUTING.md).

Please read them before opening a Pull Request or suggesting a change.

## License



**Like every package maintained by [Vazco](https://vazco.eu/), eslint-config-vazco is [MIT licensed](https://github.com/vazco/uniforms/blob/master/LICENSE).**