# yet-another-eslint-blame

> Yet another eslint blame (might) with better adaptability. The input is eslint's output with json format (You can see it [here](https://eslint.org/docs/user-guide/formatters/#json)). And it's will run git blame for each eslint report.

Latest version **0.0.3** (published 2022-03-03) · 0 weekly downloads

## Install

```sh
npm install yet-another-eslint-blame
pnpm add yet-another-eslint-blame
yarn add yet-another-eslint-blame
bun add yet-another-eslint-blame
```

Provides the command `yaeb`.

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-03-03 |
| First published | 2022-03-02 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 25.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Maintainers | kingwl |

## Links

- npm: https://www.npmjs.com/package/yet-another-eslint-blame
- Repository: https://github.com/kwai-explore/yet-another-eslint-blame
- Homepage: https://github.com/kwai-explore/yet-another-eslint-blame#readme
- Issues: https://github.com/kwai-explore/yet-another-eslint-blame/issues
- npm.io page: https://npm.io/package/yet-another-eslint-blame

## Dependencies (3)

- [yargs](https://npm.io/package/yargs.md) ^17.3.1
- [get-stdin](https://npm.io/package/get-stdin.md) 8
- [git-blame-line](https://npm.io/package/git-blame-line.md) ^0.2.4

## Recent versions

- 0.0.3 (latest) — 2022-03-03
- 0.0.2 — 2022-03-03
- 0.0.1 — 2022-03-02

## README

# yet-another-eslint-blame

Yet another eslint blame (might) with better adaptability.  
The input is eslint's output with json format (You can see it [here](https://eslint.org/docs/user-guide/formatters/#json)).
And it's will run git blame for each eslint report. 

## Install 

```
pnpm install yet-another-eslint-blame
```

## Usage

### Before all

**We have to `cd` into the repo's directory to read git histories.**

### Read eslint json output from file

1. Run `eslint` and output with json:  
    eg: Run `eslint src -f json -o ./a.json`
2. run `yet-another-eslint-blame`:  
    eg: Run `yaeb ./a.json`
3. Enjoy!

### Read eslint json output with stdin

1. Run `eslint` and output with json, and pipe into `yet-another-eslint-blame`:  
    eg: Run `eslint src -f json | yaeb`
2. Enjoy!

### Output with markdown todo list

With `-f markdown`, we will output something like:

```markdown
- [] [<file and line number with the relative path>](./<file and line number with the relative path>) @<author>
```

It will looks like:

- [ ] [package.json#L2](./package.json#L2) @kingwl

You can just copy it into gitlab's merge requests or issues.

## Options

| name               | type             | default | description                          |
|--------------------|------------------|---------|--------------------------------------|
| `--format` or `-f`     | `json` or `markdown` | `json`    | Generate json or markdown todo list. |
| `--output` or `-o`     | `string`           |         | Specify output into a file.          |
| `--warn` or  `-w`      | `boolean`          | `false`   | Includes warning message.            |
| `--suppressed` or `-s` | `boolean`          | `false`   | Includes suppressed message.         |
| `--rule` or `-r` | `string`          |      | Specify a rule Id.         |
| `--groupby` or `-g` | `rule`          | `rule` | Specify group by what.         |

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