KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #cli #claude-code #codex #developer-tools #ai #dsh-plugin #ai-agent #mcp #deepseek-harness #windows

knip-reporter

★ 13 Open GitHub ↗

⚙️📄 Report the results from knip on pull requests

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GitHub Action: knip-reporter

> ⚙️📄 Report the results from [knip](https://github.com/webpro/knip) on pull requests.

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/codex-/knip-reporter/ci.yml?style=flat-square)](https://github.com/Codex-/knip-reporter/actions/workflows/ci.yml) [![GitHub Marketplace](https://img.shields.io/badge/Marketplace-knip–reporter-blue?style=flat-square&logo=github&link=https%3A%2F%2Fgithub.com%2Fmarketplace%2Factions%2Fawait-remote-run)](https://github.com/marketplace/actions/knip-reporter)

This action posts a [knip](https://github.com/webpro/knip) report as comments on a pull request. It can run `knip` itself, or consume an existing report.

## Usage

There are two primary ways to use this action, which will depend on your requirements. This action can run `knip` itself (default), or you can use `knip` to generate the report. Once a report has been generated/provided, this action works with that report.

### Generate the report

The execution of `knip` requires you to have followed the general `knip` setup and have a command script present in your `package.json` file, `knip`, by default but this can be of any name. If this script name deviates from the standard `knip` setup, please provide the script name in the config.

`knip-reporter` appends a reporter to the `knip` command used, `--reporter json`, to output a parseable report with information needed for annotations where supported.

```yaml
name: Pull Request
on:
  pull_request:

# This permissions config is only required if you are
# not providing own permissive token
permissions:
  checks: write
  pull-requests: write

steps:
  - name: Post the knip results
    uses: codex-/knip-reporter@v3
```

### Provide the report

If you wish to avoid having this action run any commands itself, you can provide the path to an existing report for `knip-reporter` to work with.

The provided report must be generated with the JSON reporter (using `--reporter json`)

```yaml
name: Pull Request
on:
  pull_request:

# This permissions config is only required if you are
# not providing own permissive token
permissions:
  checks: write
  pull-requests: write

steps:
  - name: Generate the knip report
    # `--silent` will stop the wrapping output from pnpm, leaving just the report
    run: pnpm --silent knip --reporter json > knip-report.json
    continue-on-error: true # Any reports generated with content result in a non-zero exit code

- name: Post the knip results
    uses: codex-/knip-reporter@v3
    with:
      json_report_path: ./knip-report.json
```

## Config

The following inputs are supported

| Input                 | Description                                                                                                        | Required | Default                                |
| --------------------- | ------------------------------------------------------------------------------------------------------------------ | -------- | -------------------------------------- |
| `token`               | GitHub Personal Access Token for making API requests.                                                              | `false`  | `${{ github.token }}`                  |
| `command_script_name` | The package script that runs knip.                                                                                 | `false`  | `knip`                                 |
| `comment_id`          | ID to use when updating the PR comment. Spaces will be replaced with dashes.                                       | `false`  | `${{ github.workflow }}-knip-reporter` |
| `annotations`         | Annotate the project code with the knip results.                                                                   | `false`  | `true`                                 |
| `verbose`             | Include annotated items in the comment report.                                                                     | `false`  | `false`                                |
| `ignore_results`      | Do not fail the action run if knip results are found.                                                              | `false`  | `false`                                |
| `working_directory`   | Run knip in a different directory.                                                                                 | `false`  | `.`                                    |
| `json_report_path`    | Use a pre-existing knip report instead of running `knip`. Relative paths are resolved against `working_directory`. | `false`  |                                        |

### Issues

If you encounter a case where comments are not being posted, or known sections are missing from the report, please [enable step debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging#enabling-step-debug-logging) and create an issue with the results and expected behaviour.

### APIs Used

- `Checks`
  - `Check Runs`
    - [`Create a check run`](https://docs.github.com/en/rest/checks/runs#create-a-check-run)
      - POST `/repos/{owner}/{repo}/check-runs`
    - [`Update a check run`](https://docs.github.com/en/rest/checks/runs#update-a-check-run)
      - PATCH `/repos/{owner}/{repo}/check-runs/{check_run_id}`
- `Issues`
  - `Comments`
    - [`Create an issue comment`](https://docs.github.com/en/rest/issues/comments#create-an-issue-comment)
      - POST `/repos/{owner}/{repo}/issues/{issue_number}/comments`
    - [`List issue comments`](https://docs.github.com/en/rest/issues/comments#list-issue-comments)
      - GET `/repos/{owner}/{repo}/issues/{issue_number}/comments`
    - [`Update an issue comment`](https://docs.github.com/en/rest/issues/comments#update-an-issue-comment)
      - PATCH `/repos/{owner}/{repo}/issues/comments/{comment_id}`
    - [`Delete an issue comment`](https://docs.github.com/en/rest/issues/comments#delete-an-issue-comment)
      - DELETE `/repos/{owner}/{repo}/issues/comments/{comment_id}`

knip-reporter

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README