ESLint Config Waracle

ESLint configs for Waracle JavaScript Style Guide heavily based on the excellent Airbnb rule set.

Installation

The config is in the main npm registry so no authentication is required and it's licensed under MIT

npm install eslint-config-waracle --save-dev

Usage

Default

For non-TypeScript projects, use

In .eslintrc.json:

{
  "extends": ["waracle"]
}

Typescript

For TypeScript projects use the configuration typescript

{
  "extends": ["waracle/typescript"]
}

Sonarcloud

For projects using SonarCloud, also use the configuration sonarcloud

{
  "extends": ["waracle", "waracle/sonarcloud"]
}

OR

{
  "extends": ["waracle/typescript", "waracle/sonarcloud"]
}

Rules

• eslint
• eslint-config-airbnb

Contributing

PRs are welcome but please follow the commit message template enforced using commitizen

Versioning

[Semantic-Release] will automatically version and deploy via github actions

License

MIT