Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

common lint reporter

Actions
common lint reporter that can handle various lint report files
v1.1.1
Star (3)

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_name: 'Lint Report'

Detail information

Contributes

Could you want to contribute?

see Contributing.md

License

Using

common lint reporter is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

common lint reporter that can handle various lint report files
v1.1.1

common lint reporter is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.