iccheck

ICCheck - Inconsistent Change Checker

ICCheck takes any 2 revisions (including commit and worktree) from a Git repository and reports possible inconsistent changes in pre-commit files, commited files, and/or Pull Requests.

ICCheck lists (pre-commit) changes made on a git repository and checks missing changes on cloned codes (i.e. copy-pasted codes).

The plugin and the method for detecting cloned code is still in development and being improved. While ICCheck detects many cloned codes correctly, note that it may also detect many false-positives.

Installation

Command Line Interface (CLI, Binary File)

• Download from the latest releases page.
• Or, build it from source: go install github.com/salab/iccheck@latest

Editor Extensions (VSCode, IntelliJ IDEA)

ICCheck utilizes LSP (Language Server Protocol) to support many editors with ease.

Currently, the following extensions are available:

• VSCode: iccheck - Visual Studio Marketplace
• IntelliJ IDEA Ultimate: ICCheck - Inconsistency Check - IntelliJ IDEs Plugin | Marketplace

Usage

CLI

Input Format

Running iccheck --help displays help message.

Finds inconsistent changes in your git changes.

Specify special values in base or target git ref arguments to compare against some special filesystems.
  "WORKTREE" : Compare against the current worktree.

Usage:
  iccheck [flags]
  iccheck [command]

Available Commands:
  help        Help about any command
  lsp         Starts ICCheck Language Server

Flags:
      --fail-code int         Exit code if it detects any inconsistent changes (default: 0)
      --format string         Format type (console, json, github) (default "console")
  -f, --from string           Base git ref to compare against. Usually earlier in time. (default "main")
  -h, --help                  help for iccheck
      --log-level string      Log level (debug, info, warn, error) (default "info")
  -r, --repo string           Source git directory (default ".")
      --timeout-seconds int   Timeout for detecting clones in seconds (default: 15) (default 15)
  -t, --to string             Target git ref to compare from. Usually later in time. (default "HEAD")
  -v, --version               version for iccheck

Use "iccheck [command] --help" for more information about a command.

Example: Run ICCheck on this git repository for the last commit, to detect any inconsistent changes.

iccheck --from HEAD~ --to HEAD --repo .

Output Format

ICCheck outputs detected inconsistent changes to stdout, and other logging outputs to stderr.

Output format can be changed via the --format argument. Make sure to check --format json out for ease integration with other systems such as review bots.

For example, one can utilize jq to process the JSON stdout into the GitHub Actions annotation format.

iccheck --format json | jq -r '":::notice file=\(.filename),line=\(.start_l),endLine=\(.end_l),title=Possible missing change::Possible missing a consistent change here (L\(.start_l) - L\(.end_l), distance \(.distance))"'

In GitHub Actions

An example workflow file:

name: Change Check

on:
  push:
    branches:
      - 'main'
  pull_request:

env:
  ICCHECK_FROM: "origin/main"
  ICCHECK_TO: "HEAD"

jobs:
  iccheck:
    name: Change Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: '0'
      - uses: actions/setup-go@v5
        with:
          go-version: "1.22"
      - name: Set different base commit on main branch
        if: github.ref == 'refs/heads/main'
        run: echo "ICCHECK_FROM=HEAD~" >> "$GITHUB_ENV"
      - run: go install github.com/salab/iccheck@latest
      - run: iccheck --from "$ICCHECK_FROM" --to "$ICCHECK_TO" --format github

Editor Extensions

Install the extension. Then, edit any text files in a git-controlled directory. ICCheck will automatically run when you open or edit files, and display line warnings if you are likely missing changes to other similar lines.