@oat-sa/eslint-config-tao/README.md

Shareable `.eslintrc` configurations package for `oat-sa` projects.

# eslint-config-tao

Shareable `.eslintrc.js` configurations package for `oat-sa` projects.

## Concept

All extensions, projects and libraries (`oat-sa` wide) should use the shared config as a basis.
Current extension contains a pack of shareable configs depending on the stack and target.
General idea is described here: [https://eslint.org/docs/developer-guide/shareable-configs]()

### Examples

Use shareable eslint configurations via the `extends` config property.

1. Default configuration. Edit the `.eslintrc.js` of your project:

   ```javascript
   module.exports = {
     extends: '@oat-sa/eslint-config-tao'
   };
   ```

2. Configuration for AMD modules:

   ```javascript
   module.exports = {
     extends: '@oat-sa/eslint-config-tao/amd'
   };
   ```

3. Configuration for es modules, svelte, etc.:

   ```javascript
   module.exports = {
     extends: '@oat-sa/eslint-config-tao/svelte'
   };
   ```

4. Configuration for node:
   ```javascript
   module.exports = {
     extends: '@oat-sa/eslint-config-tao/node'
   };
   ```

5. Configuration for cypress:
   ```javascript
   module.exports = {
     extends: '@oat-sa/eslint-config-tao/cypress'
   };
   ```

## History

- _0.1.0_ Initial release.
- _1.0.0_ Added the support of the `node` config, include all plugins as dependencies, turn off `implicit-arrow-linebreak`
  - _1.1.0_ Added the `cypress` profile
- _2.0.0_ Updated `eslint-plugin-jsdoc` and `eslint` to address vulnerabilities; updated `eslint-plugin-jest` to address compatibility issue