eslint-config-apiconnect

API Connect core coding conventions

Usage no npm install needed!

<script type="module">
  import eslintConfigApiconnect from 'https://cdn.skypack.dev/eslint-config-apiconnect';
</script>

README

eslint-config-apiconnect

Baseline eslint config for API Connect projects. A work in progress.

Basic Usage

Add eslint-config-apiconnect to devDependencies.

$ npm install -D eslint-config-apiconnect

Create/modify .eslintrc in the project's root to include:

{
  "extends": "apiconnect"
}

Advanced Usage

It is sometimes desirable to override some of these rules because a team does not want to follow that particular rule for this repository:

{
  "extends": "apiconnect",
  "rules": {
    "comma-dangle": 0
  }
}

In cases where these rules are being adopted but the code has many style errors, it might be helpful to turn the worst errors into warnings until the entire repo can be fixed:

{
  "extends": "apiconnect",
  "rules": {
    "comma-dangle": 1,
  }
}

Further Reading