@smart-gate/eslint-config-smartgate/README.md

ESLint shareable config for the Smart Gate CO. projects style guide.

# eslint-config-smartgate

ESLint shareable config for the Smart Gate Co. projects.

## Installation

```bash
npm install --save-dev @smart-gate/eslint-config-smartgate
```

## Usage

add `.eslint.cjs` then extend our configs (ESLint v8):

```cjs
modules.exports = {
  extends: ['@smart-gate/eslint-config-smartgate'],
};
```

1. next add the following script in your package json scripts:

```json
{
  "scripts": {
    "lint": "eslint . --fix --ignore-path .gitignore"
  }
}
```

1. By now, you should be able to run this script in your terminal:

```bash
npm run lint
```

> [!WARNING] Note
>
> 1. While creating a brand new project with this command `npm create vue@latest` make sure to say no for code quality option.
> 2. This package does not support latest eslint version (flat config object). we are still using `cjs` until vue eslint packages will be updated as well.
> 3. In order to avoid installation conflicts just uninstall the following packages in your `package.json`.
>    `eslint`, `@vue/eslint-config-typescript`, `eslint-config-google`, `eslint-plugin-import`, `eslint-plugin-vue`.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.