# eslint-config-crypho

> Crypho eslint configuration

Latest version **1.10.2** (published 2021-03-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install eslint-config-crypho
pnpm add eslint-config-crypho
yarn add eslint-config-crypho
bun add eslint-config-crypho
```

## 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.10.2 |
| Published | 2021-03-26 |
| First published | 2019-06-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | ggozad, wichert |
| Keywords | eslint |

## Links

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

## Dependencies (13)

- [eslint](https://npm.io/package/eslint.md) ^7.17.0
- [prettier](https://npm.io/package/prettier.md) ^2.2.1
- [babel-eslint](https://npm.io/package/babel-eslint.md) ^10.1.0
- [crypho-prettier](https://npm.io/package/crypho-prettier.md) ^1.1.1
- [eslint-plugin-babel](https://npm.io/package/eslint-plugin-babel.md) ^5.3.1
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.22.0
- [eslint-plugin-promise](https://npm.io/package/eslint-plugin-promise.md) ^4.3.1
- [eslint-plugin-unicorn](https://npm.io/package/eslint-plugin-unicorn.md) ^28.0.2
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^8.1.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^3.3.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^4.18.0
- [eslint-plugin-react-native](https://npm.io/package/eslint-plugin-react-native.md) ^3.10.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^4.18.0

## 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.10.2 (latest) — 2021-03-26
- 1.10.1 — 2021-03-26
- 1.10.0 — 2021-03-23
- 1.9.0 — 2020-04-01
- 1.8.0 — 2020-04-01
- 1.7.1 — 2020-02-11
- 1.6.2 — 2019-12-23
- 1.6.1 — 2019-12-03
- 1.6.0 — 2019-11-13
- 1.5.1 — 2019-11-12
- 1.5.0 — 2019-11-12
- 1.4.5 — 2019-06-25
- 1.4.4 — 2019-06-24
- 1.4.1 — 2019-06-24
- 1.4.0 — 2019-06-20
- … 10 more at https://npm.io/package/eslint-config-crypho/versions

## README

# Crypho eslint configuration

This package contains the standard [eslint](https://eslint.org) configuration for Crypho.

It exposes separate configurations:: one for normal usage and one for React projects.

## JavaScript

For Javascript projects you only need to add `@crypho` to your
`.eslintrc`:

```json
{
  "extends": [
    "crypho"
  ]
}
```

This will enable the following rules:

* The [recommended config](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/index.js) from [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
* The recommended rules fron [eslint-plugin-promise](https://www.npmjs.com/package/eslint-plugin-promise
* Using eslint-plugin-prettier to remove conflicts between prettier and eslint.
* Assume an ES6 environment
* For test files also enable the `jest` and `node` environments.

## TypeScript

If you use Typescript you will also need to install some extra packages:

```shell
npm install @typescript-eslint/eslint-plugin @typescript-eslint/parser --save-dev
```

or, if you use yarn:

```shell
yarn add @typescript-eslint/eslint-plugin @typescript-eslint/parser --only=dev
```

You must also add `crypho/typescript` to your `.eslintrc` configuration file:

```json
{
  "extends": [
    "crypho",
    "crypho/typescript"
  ]
}
```

## React

For React using projects you can also enable a set of React-specific rules:

```json
{
  "extends": [
    "crypho",
    "crypho/react",
  ]
}
```

This enables several rules:

* Use Babel to parse files
* For `*.jsx` and `*.tsx` files:

  * Enable JSX parsing
  * Disable the `unicorn/filename-case` rule

* Assume a `browser` environment in all files
* The recommended rules from [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react)


## Command-line tools

For packages containing *only* command-line tools you can use the `crypho/cli` ruleset:

```json
{
  "extends": [
    "crypho",
    "crypho/cli",
  ]
}
```

This will:

* assume the `node` environment
* allow console statements

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