feat: add sg_flags option to pass additional ast-grep flags (#5)

* feat: add `sg_flags` option to pass additional ast-grep flags

Signed-off-by: Rintaro Okamura <[email protected]>

* docs: update readme

- update inputs
- add usage example about custom parser

Signed-off-by: Rintaro Okamura <[email protected]>

* docs: fix typo

Signed-off-by: Rintaro Okamura <[email protected]>

---------

Signed-off-by: Rintaro Okamura <[email protected]>

Author: rinx

README.md

@@ -1,4 +1,4 @@
-# action-ast-grep
+# GitHub Action: Run ast-grep with reviewdog
 
 [![Test](https://github.com/reviewdog/action-ast-grep/workflows/Test/badge.svg)](https://github.com/reviewdog/action-ast-grep/actions?query=workflow%3ATest)
 [![reviewdog](https://github.com/reviewdog/action-ast-grep/workflows/reviewdog/badge.svg)](https://github.com/reviewdog/action-ast-grep/actions?query=workflow%3Areviewdog)
@@ -7,58 +7,79 @@
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-ast-grep?logo=github&sort=semver)](https://github.com/reviewdog/action-ast-grep/releases)
 [![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github&link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)
 
-![demo1](https://github.com/user-attachments/assets/1c767bc0-43c4-4a60-ab97-b8b8e916ddc8)
-![demo2](https://github.com/user-attachments/assets/3c341c29-536c-4032-b5f4-f9ec06731dfe)
-
 This is an action to run [ast-grep(sg)][ast-grep] with [reviewdog][reviewdog].
 
 [ast-grep]: https://github.com/ast-grep/ast-grep
 [reviewdog]: https://github.com/reviewdog/reviewdog
 
-## Input
+## Examples
 
-```yaml
-inputs:
-  github_token:
-    description: 'GITHUB_TOKEN'
-    default: '${{ github.token }}'
-  workdir:
-    description: 'Working directory relative to the root directory.'
-    default: '.'
-  ### Flags for reviewdog ###
-  tool_name:
-    description: 'Tool name to use for reviewdog reporter.'
-    default: 'ast-grep'
-  level:
-    description: 'Report level for reviewdog [info,warning,error].'
-    default: 'error'
-  reporter:
-    description: 'Reporter of reviewdog command [github-check,github-pr-review,github-pr-check].'
-    default: 'github-check'
-  filter_mode:
-    description: |
-      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
-      Default is added.
-    default: 'added'
-  fail_on_error:
-    description: |
-      Exit code for reviewdog when errors are found [true,false].
-      Default is `false`.
-    default: 'false'
-  reviewdog_flags:
-    description: 'Additional reviewdog flags.'
-    default: ''
-  ### Flags for ast-grep ###
-  sg_version:
-    description: 'ast-grep version.'
-    default: ''
-  sg_config:
-    description: 'path to the ast-grep config file'
-    default: 'sgconfig.yml'
-```
+![demo1](https://github.com/user-attachments/assets/1c767bc0-43c4-4a60-ab97-b8b8e916ddc8)
+![demo2](https://github.com/user-attachments/assets/3c341c29-536c-4032-b5f4-f9ec06731dfe)
+
+## Inputs
+
+### `github_token`
+
+GITHUB_TOKEN
+The default is `${{ github.token }}`.
+
+### `workdir`
+
+Working directory relative to the root directory.
+The default is `.`.
+
+### `tool_name`
+
+Tool name to use for reviewdog reporter.
+The default is `ast-grep`.
+
+### `level`
+
+Report level for reviewdog [info,warning,error].
+The default is `error`.
+
+### `reporter`
+
+Reporter of reviewdog command [github-check,github-pr-review,github-pr-check].
+The default is `github-check`.
+
+### `filter_mode`
+
+Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
+Default is `added` except that sarif reporter uses `nofilter`.
+
+### `fail_on_error`
+
+Exit code for reviewdog when errors are found [true,false].
+The default is `false`.
+
+### `reviewdog_flags`
+
+Additional reviewdog flags.
+
+### `output_dir`
+
+Output directory of reviewdog result. Useful for -reporter=sarif
+The default is `../reviewdog-results`.
+
+### `sg_version`
+
+ast-grep version.
+
+### `sg_config`
+
+The path to the ast-grep config file.
+The default is `sgconfig.yml`.
+
+### `sg_flags`
+
+Additional ast-grep flags.
 
 ## Usage
 
+### Basic
+
 Create `sgconfig.yml` and some rules in your repository by following the [project setup guide][sg-scan-guide].
 
 Add a workflow to run action-ast-grep that triggered by pull request event.
@@ -74,7 +95,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: reviewdog/action-ast-grep@v1
         with:
-          github_token: ${{ secrets.github_token }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           # Change reviewdog reporter if you need [github-check,github-pr-review,github-pr-check].
           reporter: github-pr-review
           # Change reporter level if you need.
@@ -88,6 +109,40 @@ Reviewdog will report `ast-grep scan` result.
 
 [sg-scan-guide]: https://ast-grep.github.io/guide/scan-project.html
 
+### Advanced: Use Custom Language Parser
+
+ast-grep experimentally supports custom languages. ([ref][sg-custom-lang])
+
+To use this feature with this action, build tree-sitter parsers before calling this action on your workflow.
+
+For building tree-sitter parsers, [rinx/setup-tree-sitter-parser][rinx/setup-tree-sitter-parser] is useful.
+
+```yaml
+name: reviewdog
+on: [pull_request]
+jobs:
+  ast-grep:
+    name: runner / ast-grep / fennel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build tree-sitter grammar for fennel
+        uses: rinx/setup-tree-sitter-parser@v1
+        with:
+          # this action will place the build artifact here.
+          parser_dir: ./
+          parser_repository: alexmozaidze/tree-sitter-fennel
+      - name: Run ast-grep with reviewdog
+        uses: reviewdog/action-ast-grep@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          level: info
+          reporter: github-pr-review
+```
+
+[sg-custom-lang]: https://ast-grep.github.io/advanced/custom-language.html
+[rinx/setup-tree-sitter-parser]: https://github.com/rinx/setup-tree-sitter-parser
+
 ## Development
 
 ### Release

action.yml

@@ -26,7 +26,6 @@ inputs:
   fail_on_error:
     description: |
       Exit code for reviewdog when errors are found [true,false].
-      Default is `false`.
     default: 'false'
   reviewdog_flags:
     description: 'Additional reviewdog flags.'
@@ -41,6 +40,9 @@ inputs:
   sg_config:
     description: 'path to the ast-grep config file'
     default: 'sgconfig.yml'
+  sg_flags:
+    description: 'Additional ast-grep flags.'
+    default: ''
 
 runs:
   using: 'composite'
@@ -64,6 +66,7 @@ runs:
         INPUT_OUTPUT_DIR: ${{ inputs.output_dir }}
         INPUT_SG_VERSION: ${{ inputs.sg_version }}
         INPUT_SG_CONFIG: ${{ inputs.sg_config }}
+        INPUT_SG_FLAGS: ${{ inputs.sg_flags }}
         DEFAULT_SG_VERSION: 0.26.2
     - if: inputs.reporter == 'sarif'
       uses: github/codeql-action/upload-sarif@v3

script.sh

@@ -34,7 +34,10 @@ echo '::endgroup::'
 echo '::group:: Running ast-grep with reviewdog 🐶 ...'
 
 # shellcheck disable=SC2086
-ast-grep scan --config="${INPUT_SG_CONFIG}" --json=compact |
+ast-grep scan \
+  --config="${INPUT_SG_CONFIG}" \
+  --json=compact \
+  ${INPUT_SG_FLAGS} |
   jq -f "${GITHUB_ACTION_PATH}/to-rdjsonl.jq" -c |
   reviewdog \
     -f=rdjsonl \