https://github.com/eslint-community/eslint-formatter-codeframe

ESLint’s official `codeframe` formatter, extracted from ESLint 7
https://github.com/eslint-community/eslint-formatter-codeframe

eslint eslint-formatter

Last synced: 2 days ago
JSON representation

ESLint’s official `codeframe` formatter, extracted from ESLint 7

• Host: GitHub
• URL: https://github.com/eslint-community/eslint-formatter-codeframe
• Owner: eslint-community
• License: other
• Created: 2021-08-03T11:37:13.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-03T13:23:24.000Z (about 1 month ago)
• Last Synced: 2024-10-04T06:49:20.562Z (about 1 month ago)
• Topics: eslint, eslint-formatter
• Language: JavaScript
• Homepage: https://npm.im/eslint-formatter-codeframe
• Size: 33.2 KB
• Stars: 10
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# eslint-formatter-codeframe

> ESLint’s official `codeframe` formatter, extracted from ESLint 7

This formatter has been removed from ESLint 8 so it lives as a standalone module here.

## Install

```sh

npm install --save-dev eslint-formatter-codeframe

```

## Usage

More information about formatters can be found on https://eslint.org/docs/user-guide/formatters/

```

eslint --format codeframe

```

## Example output

```

error: 'addOne' is defined but never used (no-unused-vars) at fullOfProblems.js:1:10:

> 1 | function addOne(i) {

    |          ^

  2 |     if (i != NaN) {

  3 |         return i ++

  4 |     } else {

error: Use the isNaN function to compare with NaN (use-isnan) at fullOfProblems.js:2:9:

  1 | function addOne(i) {

> 2 |     if (i != NaN) {

    |         ^

  3 |         return i ++

  4 |     } else {

  5 |       return

error: Unexpected space before unary operator '++' (space-unary-ops) at fullOfProblems.js:3:16:

  1 | function addOne(i) {

  2 |     if (i != NaN) {

> 3 |         return i ++

    |                ^

  4 |     } else {

  5 |       return

  6 |     }

warning: Missing semicolon (semi) at fullOfProblems.js:3:20:

  1 | function addOne(i) {

  2 |     if (i != NaN) {

> 3 |         return i ++

    |                    ^

  4 |     } else {

  5 |       return

  6 |     }

warning: Unnecessary 'else' after 'return' (no-else-return) at fullOfProblems.js:4:12:

  2 |     if (i != NaN) {

  3 |         return i ++

> 4 |     } else {

    |            ^

  5 |       return

  6 |     }

  7 | };

warning: Expected indentation of 8 spaces but found 6 (indent) at fullOfProblems.js:5:1:

  3 |         return i ++

  4 |     } else {

> 5 |       return

    | ^

  6 |     }

  7 | };

error: Function 'addOne' expected a return value (consistent-return) at fullOfProblems.js:5:7:

  3 |         return i ++

  4 |     } else {

> 5 |       return

    |       ^

  6 |     }

  7 | };

warning: Missing semicolon (semi) at fullOfProblems.js:5:13:

  3 |         return i ++

  4 |     } else {

> 5 |       return

    |             ^

  6 |     }

  7 | };

error: Unnecessary semicolon (no-extra-semi) at fullOfProblems.js:7:2:

  5 |       return

  6 |     }

> 7 | };

    |  ^

5 errors and 4 warnings found.

2 errors and 4 warnings potentially fixable with the `--fix` option.

```

## Links

- [Other official ESLint formatters as standalone modules](https://github.com/fregante/eslint-formatters)