eslint-config-vazco

KO | EN

gitlite — search

#hacktoberfest #ai #go #machine-learning #rust #deep-learning #nodejs #awesome #kubernetes #awesome-list #vue #security #pytorch #ios

eslint-config-vazco

(★ 8)

ESLint rules used across Vazco.eu in React projects

eslint-config-vazco Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">
    <a href="https://github.com/vazco">vazco</a>/eslint-config-vazco
</h1>

## 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).**

eslint-config-vazco

eslint-config-vazco Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

eslint-config-vazco

eslint-config-vazco Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README