https://github.com/krizzu/eslint-check-action

GitHub action running eslint check in your project, annotating errors/warnings in PR.
https://github.com/krizzu/eslint-check-action

automation ci continuous-integration eslint github-actions

Last synced: 9 days ago
JSON representation

GitHub action running eslint check in your project, annotating errors/warnings in PR.

• Host: GitHub
• URL: https://github.com/krizzu/eslint-check-action
• Owner: krizzu
• License: mit
• Created: 2019-11-18T08:07:39.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T01:06:12.000Z (almost 2 years ago)
• Last Synced: 2024-03-15T01:03:29.647Z (8 months ago)
• Topics: automation, ci, continuous-integration, eslint, github-actions
• Language: TypeScript
• Size: 120 KB
• Stars: 9
• Watchers: 2
• Forks: 8
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Eslint check action

GitHub action running eslint check in your project, annotating errors/warnings in PR.

## Features

- Customizable

- Installs project dependencies if missing

- Annotates lines in PR with warnings and errors

## Usage

Add workflow to your project (ex. `.github/workflows/eslint.yml`):

```yaml

name: Lint

on: [push]

jobs:

  eslint_check:

    name: Prepare action

    runs-on: ubuntu-latest

    steps:

      # Checkout action must run prior to eslint check

    - name: Checkout 

      uses: actions/checkout@v1

    - name: Lint

      uses: Krizzu/[email protected]

      with:

        ghToken: ${{ secrets.GITHUB_TOKEN }}

        eslintFiles: "lib, scripts"

        eslintConfig: "myConfigs/eslint.config.js",

        eslintExt: "ts, tsx"

```

### params

**eslintFiles**

Relative path to files/directories to run lint on.

Default: `.`

**eslintConfig**

Relative path to eslint config. Can either be `.js` config, `.eslintrc` or `package.json`.

Default: `.eslintrc`

**eslintExt**

File extension to run linting on.

Default: `js, ts, jsx, tsx`

## License

MIT.