https://github.com/ableco/eslint-formatter-github-annotations

https://github.com/ableco/eslint-formatter-github-annotations

eslint eslint-formatter

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ableco/eslint-formatter-github-annotations
• Owner: ableco
• License: mit
• Created: 2021-07-09T18:40:50.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T12:57:40.000Z (almost 2 years ago)
• Last Synced: 2024-11-11T20:43:23.837Z (2 months ago)
• Topics: eslint, eslint-formatter
• Language: JavaScript
• Homepage:
• Size: 84 KB
• Stars: 2
• Watchers: 35
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# eslint-formatter-github-annotations

An [ESLint](https://eslint.org/) formatter to report as GitHub Checks annotations

## Usage

1. Add `eslint-formatter-github-annotations` to your dependencies:

   ``` shell

   npm install --save-dev eslint-formatter-github-annotations

   ```

2. Create a GitHub action workflow with this formatter:

   ``` yaml

   name: lint

   on:

     pull_request:

   jobs:

     eslint:

       runs-on: ubuntu-latest

       steps:

         - uses: actions/checkout@v2

         - run: npm install

         - run: npx eslint -f github-annotations .

   ```

## Testing

``` shell

npm run test

```

## Contributing

Contributions are welcome. Please check out the [Contributing guide](CONTRIBUTING.md) for the guidelines you need to follow.

Please read our [Code of Conduct](CODE_OF_CONDUCT.md) so that you can understand the kind of respectful behavior we expect of all participants.

## License

Open Source Project is released under the MIT license. See [LICENSE](LICENSE) for the full license text.