# zenlint

> Fix lint configuration from history

Latest version **0.1.11** (published 2020-09-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install zenlint
pnpm add zenlint
yarn add zenlint
bun add zenlint
```

Provides the command `zenlint`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.11 |
| Published | 2020-09-30 |
| First published | 2020-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10.15.0 |
| Dependencies | 9 |
| Unpacked size | 62.3 KB |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Yuki Ueda |
| Maintainers | ikuyadeu |
| Keywords | lint |

## Links

- npm: https://www.npmjs.com/package/zenlint
- Repository: https://github.com/Ikuyadeu/zenlint
- Homepage: https://github.com/Ikuyadeu/zenlint#readme
- Issues: https://github.com/Ikuyadeu/zenlint/issues
- npm.io page: https://npm.io/package/zenlint

## Dependencies (9)

- [csv](https://npm.io/package/csv.md) ^5.3.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.19
- [commander](https://npm.io/package/commander.md) 6.1.0
- [csv-writer](https://npm.io/package/csv-writer.md) 1.6.0
- [simple-git](https://npm.io/package/simple-git.md) 2.20.1
- [text-table](https://npm.io/package/text-table.md) 0.2.0
- [v8-compile-cache](https://npm.io/package/v8-compile-cache.md) ^2.1.1
- [eslint-plugin-jsdoc](https://npm.io/package/eslint-plugin-jsdoc.md) ^30.5.1
- [eslint-config-standard-with-typescript](https://npm.io/package/eslint-config-standard-with-typescript.md) ^19.0.1

## 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
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.1.11 (latest) — 2020-09-30
- 0.1.10 — 2020-09-30
- 0.1.9 — 2020-09-29
- 0.1.8 — 2020-09-28
- 0.1.7 — 2020-09-28
- 0.1.6 — 2020-09-28
- 0.1.5 — 2020-09-28
- 0.1.4 — 2020-09-28
- 0.1.3 — 2020-09-28
- 0.1.2 — 2020-09-28

## README

# Zenlint that make lint file automatically
 
## Usage

### 1. Install

```sh
npm install -g zenlint
```

### 2. Execute

#### 3.1 If you want to generate configfile such as `.eslintrc.json`

```sh
zenlint --generate ./your/project/path
```

#### 3.2 If you want to get recommended rules

```sh
$ zenlint ./your/project/path

Available  unicode-bom
Available  valid-jsdoc
Available  wrap-iife
Available  wrap-regex
Available  yield-star-spacing
Available  yoda
Ignored    no-undef
Ignored    no-fallthrough
Ignored    no-sparse-arrays
Ignored    no-redeclare
157 rules are available 4 rules are ignored 
```

#### 3.2 If you want to check rules by pull request

1. make `.github/workflows/zenlint.yml` on your project

```yml
name: "Zenlint test"
on: # rebuild any PRs and main branch changes
  pull_request:
  push:
    branches:
      - master
jobs:
  devreplay:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - run: npm install zenlint
      - uses: actions/setup-node@v1
        with:
          node-version: "12.x"
      - run: echo "::add-matcher::.github/zenlint-match.json"   
      - name: Run zenlint
        run: node_modules/.bin/zenlint ./src
```

2. make `.github/zenlint-match.json`

```json
{
    "problemMatcher": [
        {
            "owner": "zenlint",
            "pattern": [
                {
                    "regexp": "^(warning|error)\\s+((Available|Ignored)\\s+(.+))",
                    "severity": 1,
                    "message": 2
                }
            ]
        }
    ]
}
```

3. Push your source code on the GitHub
4. Check `Actions` button on your GitHub project
5. You'll get warnings [example](https://github.com/devreplay/devreplay-actions/actions/runs/277820912)


## Tool support plan
* JavaScript/TypeScript
    * [x] ESLint (Also standard js is supported by eslint)
* Python
    * [ ] pylint
    * [ ] flake8
    * [ ] black
* Ruby
    * [ ] rubocop
* YAML
    * [ ] yamlint

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