# @mink-agency/eslint-config

> Generic eslint configuration for web development - ESLint Shareable Config

Latest version **1.5.1** (published 2021-08-30) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install @mink-agency/eslint-config
pnpm add @mink-agency/eslint-config
yarn add @mink-agency/eslint-config
bun add @mink-agency/eslint-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.1 |
| Published | 2021-08-30 |
| First published | 2021-08-30 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Benjamin Simode |
| Maintainers | kevindesousa, benjamin-3-mink, benjaminmink, minkagency |
| Keywords | JavaScript Standard Style, check, checker, code, code checker, code linter, code standards, code style, enforce, eslint, eslintconfig, hint, jscs, jshint, lint, policy, quality, simple, standard, standard style, style, style checker, style linter, verify |

## Links

- npm: https://www.npmjs.com/package/@mink-agency/eslint-config
- Repository: https://github.com/mink-agency/eslint-config
- Homepage: https://github.com/mink-agency/eslint-config#readme
- Issues: https://github.com/mink-agency/eslint-config/issues
- npm.io page: https://npm.io/package/@mink-agency/eslint-config

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.5.1 (latest) — 2021-08-30

## README

# eslint-config

[![Build Status](https://app.travis-ci.com/mink-agency/eslint-config.svg?branch=main)](https://app.travis-ci.com/mink-agency/eslint-config)

## Quick start

1. Install the following dev-dependencies:

    ```
    yarn add -D \
      @mink-agency/eslint-config \
      eslint \
      eslint-plugin-node
    ```

2. Extend the `@mink-agency/eslint-config` config in your `.eslintrc` (or `eslintConfig` key in your
   `package.json`):

    ```json
    "eslintConfig": {
      "extends": "@mink-agency/eslint-config"
    }
    ```

3. Specify the version of Node.js your project uses by setting `.engines.node` in your `package.json`.

    ```json
    "engines": {
      "node": ">=8"
    }
    ```

4. Run `eslint` on your project as part of your `lint:js` scripts:

    ```json
    "scripts": {
      "lint:js": "yarn run eslint --cache --ext .js --ignore-path .gitignore ./resources/",
    }
    ```

## Usage

The "Quick start" above exemplifies usage of this package with standard Node.js code.

Depending on the ECMAScript version of your code, whether you are using non-standard syntax like Flow and React's JSX,
or other considerations, you may want to extend a variety of configurations provided by this
package. `@mink-agency/eslint-config` exposes several configurations targeting specific ESLint plugins, each
named after the plugin it targets.

To use each plugin-specific configuration, you'll need to do the following:

- Install as dev-dependencies `@mink-agency/eslint-config`, `eslint`, and any plugins that are used by the
  configuration(s)
  you are extending, such as `@mink-agency/eslint-plugin-node` or `@mink-agency/eslint-plugin-promise`.
- Add the configuration(s) you are using to the `"extends"` array in your project's ESLint configuration, like this:

    ```json
    {
      "extends": [
        "@mink-agency/eslint-config/import",
        "@mink-agency/eslint-config/promise"
      ]
    }
    ```

### Plugin-specific configurations

- [`@mink-agency/eslint-config`**`/node`**](./node.js)
    - Depends on [eslint-plugin-node](https://github.com/mysticatea/eslint-plugin-node).
    - For Node.js and CommonJS.
    - Specify the version of Node.js your project uses by either setting `.engines.node` in your `package.json`, or by
      extending an LTS-version-specific ESLint configuration: **`node10`, `node12`, `node14`**.
- [`@mink-agency/eslint-config`**`/import`**](./import.js)
    - Depends on [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import).
    - For ES2015 modules (`import` and `export`).
- [`@mink-agency/eslint-config`**`/promise`**](./promise.js)
    - Depends on [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise).
    - For `Promise`s.
- [`@mink-agency/eslint-config`**`/no-inline-styles`**](./no-inline-styles.js)
    - Depends on [eslint-plugin-no-inline-styles](https://github.com/nmanthena18/eslint-no-inline-styles).
    - Disallow inline styling.
- [`@mink-agency/eslint-config`**`/xss`**](./xss.js)
    - Depends on [eslint-plugin-xss](https://github.com/Rantanen/eslint-plugin-xss).
    - For avoiding potential XSS issues in front end JavaScript.
    - Does not perform any JavaScript style linting if used on its own.
- [`@mink-agency/eslint-config`**`/react`**](./react.js)
    - Depends on [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react).
    - For React and JSX.
- [`@mink-agency/eslint-config`**`/vue3`**](./vue3.js)
  - Depends on [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue).
  - For Vue3.

### With Prettier

If you are using [Prettier](https://prettier.io/) to format your JS,
install [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) and add it at the end of
your `"extends"` array. It will turn off all ESLint rules related to the code-style preferences that Prettier already
addresses.

---
_Source: https://npm.io/package/@mink-agency/eslint-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
