Skip to content

Multiple format supported lint reporter for GitHub Actions

License

Notifications You must be signed in to change notification settings

MeilCli/common-lint-reporter

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

common-lint-reporter

CI-Master
This is multiple format supported lint reporter for GitHub Actions

Focuses on:

  • Many lint file format support
  • Flexible extendable reporting
  • Multiple report format support, as check-run, comment or inline-comment

Specification

Current supporting lint file format:

report format file format tool compatibility
androidlint xml androidlint
checkstyle xml eslint
dotnet format json dotnet format
eslint json eslint
junit xml eslint, textlint, cpplint, RuboCop
markdownlint txt markdownlint
RuboCop json RuboCop
stylelint json stylelint
textlint json textlint

Feature request

Now, this action is WIP. Features are not enough and should improve about transformer and operator. If you have nice idea, please send as issue:heart:

Usage

Basic information

This action have 3 steps. Flexible and extendable are realized by separating step

  1. Transform lint report file to common lint format file
  2. Operate converting common lint file
  3. Report common lint to GitHub

Quick usage

name: CI

on:
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm install
      - run: npm run build
      - run: npm run lint
        continue-on-error: true
      - uses: MeilCli/common-lint-reporter/transformer/eslint@1
        with:
          # your output path
          report_files: |
            eslint_report.json
      - uses: MeilCli/common-lint-reporter/operator/filter-by-file-changed@v1
      - uses: MeilCli/common-lint-reporter@v1
        with:
          report_type: 'check_run'
          report_to_same_check_run: 'true'

Detail information

Contributes

Could you want to contribute?

see Contributing.md

License

Using