# @guidecx/config-eslint

> The configuration files for ESLint used by all GuideCX Applications

Latest version **0.0.1-alpha.0** (published 2021-09-24) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha.0 |
| Published | 2021-09-24 |
| First published | 2021-09-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andrew Garvin |
| Maintainers | walex, dandrewgarvin, kylejw2 |

## Links

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

## Dependencies (9)

- [babel-eslint](https://npm.io/package/babel-eslint.md) ^10.0.2
- [eslint-plugin-graphql](https://npm.io/package/eslint-plugin-graphql.md) ^3.1.1
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^5.0.0
- [eslint-config-kentcdodds](https://npm.io/package/eslint-config-kentcdodds.md) 14.4.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^2.20.0
- [eslint-plugin-react-native](https://npm.io/package/eslint-plugin-react-native.md) ^3.8.1
- [eslint-plugin-eslint-comments](https://npm.io/package/eslint-plugin-eslint-comments.md) ^3.1.2
- [eslint-plugin-react-native-a11y](https://npm.io/package/eslint-plugin-react-native-a11y.md) ^1.3.1
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^2.20.0

## Recent versions

- 0.0.1-alpha.0 (latest) — 2021-09-24

## README

# `GCX Eslint Configuration`

_NOTE_: This package is dependent on having multiple dependencies installed (some of which are optional, based on which sub-config files you use). You should have the following dependencies installed and set up:

 - `@guidecx/config-prettier`
 - `husky`
 - `lint-staged`
 - `npm-run-all`
 - `typescript`

## Installing configuration files into another project

This packages has a few different exports you can use in your application. There are configuration files of the following type:

- base (core javascript)
- graphql
- jest
- react
- typescript

In your project, you can do the following to include these linting rules:

1. at the root of the other project, install the package with `npm install --save-dependency @guidecx/config-eslint`
2. in your projects `eslintrc.js` file, include the following configuration options:
   ```javascript
   'extends': [
     '@guidecx/config-eslint/base', // replace these lines with whatever config files you need from the list above
     '@guidecx/config-eslint/typescript'
     '@guidecx/config-eslint/react'
   ]
   ```
3. _note_: some of the configs in the package have dependencies that you need to set up as well. For example, if you're using the typescript lint file, you need to set up typescript in your project before the linter can run. At the very least, you'll need to run `npm install --save-dev husky lint-staged npm-run-all typescript`
4. once you've installed all the proper dependencies, you can test that the linting works by running `npx eslint {filename}` in your local repo. If everything is set up properly, you will see warnings and errors from eslint (assuming your code has them).
5. now that things are working manually, its time to run these automatically as a `pre-commit` husky hook (using `lint-staged`)
6. install both `husky` and `lint-staged`. according to the [lint-staged docs](https://www.npmjs.com/package/lint-staged#installation-and-setup), the easiest way to install husky and lint-staged together is by running `npx mrm lint-staged`.
7. add the following config options to your `package.json`:
    ```javascript
      "devDependencies": { // don't overwrite the versions installed on step 3
        "husky": "^4.3.7",
        "lint-staged": "^10.5.3",
        "npm-run-all": "^4.1.5",
        "typescript": "^3.7.5" // if you're in a vanillaJS project, you don't need this installed, but should also update the `validate` script below to not use `tsc`
      },
      "scripts": {
        "tsc": "tsc",
        "lint": "eslint 'src/**/*.{ts,tsx,js,jsx}'",
        "format": "prettier 'src/**/*.{ts,tsx,js,jsx,json,graphql}'",
        "format:write": "npm run format --list-different --write",
        "format:check": "npm run format --check",
        "validate": "npm-run-all --parallel -c format:check \"lint --quiet\" tsc test"
      },
      "lint-staged": {
        "src/**/*.{ts,tsx,js,jsx,graphql}": [
          "npm run format:write",
          "git add"
        ]
      },
      "husky": {
        "hooks": {
          "pre-commit": "lint-staged"
        }
      }
    ```
8. prettier and eslint should now be running every time you `commit` code via `git`!

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