Lightweight code review tool. Provide lint output to CodeCoach, it will automatically review pull requests. CodeCoach uses node.js as run time. It can be run from any command line. So it can be integrated with any CI with ease.

• ESLint
• TSLint
• MSBuild (both msbuild.exe and dotnet build commands)
• ScalaStyle
• AndroidLint
• DartLint
• SwiftLint (0.49.1 or later)

• GitHub
• GitHub Enterprise
• GitLab

Node.js v14 or later

Install it globally using npm

$ npm i -g @codecoach/cli

or Yarn

$ yarn global add @codecoach/cli

Use command codecoach with required config.

Configuration could be supplied by arguments options or config JSON file.

$ codecoach \
  -g="github"
  --githubRepoUrl="https://github.com/codeleague/codecoach" \
  --githubPr=99 \
  --githubToken="yourtoken" \
  -f="eslint;/path/to/eslintoutput.json" \
  -f="dotnetbuild;/path/to/dotnetbuild;/repo/src" \
  -r

$ codecoach --config="codecoach.json"

and in codecoach.json

{
  "vcs": "github",
  "githubRepoUrl": "https://github.com/codeleague/codecoach",
  "githubPr": 99,
  "githubToken": "yourtoken",
  "buildLogFile": [
    "eslint;/path/to/eslintoutput.json",
    "dotnetbuild;/path/to/dotnetbuild;/repo/src"
  ],
  "removeOldComment": true
}

Will do the same thing.

Warning: If both config file and options are supplied, options will override config in file.

Build log content files config. Splitted in to 3 part, formatted in <type>;<path>[;<cwd>]

• Type: one of dotnetbuild, msbuild, tslint, eslint, scalastyle, androidlint or dartlint
• Path: Path to lint output file to be processed
• cwd: Linter context repository root (optional, will use current directory if not provided)

For example,
Case 1: Run CodeCoach from repo root for eslint and dotnetbuild in the same lint context directory

--buildLogFile="eslint;./src/client/eslint-out.json" --buildLogFile="dotnetbuild;./src/api/msbuild.log"

Case 2: Run CodeCoach from somewhere else for androidlint (linter context root was /path/to/project/root)

--buildLogFile="androidlint;./android-lint.xml;/path/to/project/root"

Use -o <filename> to output lint result to file and -f json to format logs as JSON. (ref.)

Use -o <filename> to output lint result to file and -t json or --format json to format logs as JSON. (ref.)

Use -fileLoggerParameters or -flp switch with msbuild, dotnet build or dotnet msbuild command to send logs to file. (ref.)

Result is already written to target/scalastyle-result.xml when project is built (ref.)

Use -o <filename> to output lint result to file (ref.)

Use -o <filename> on output lint result created by command dart analyze > <filename> in dart project (ref.)

Use --output <filename> to output lint result to file and --reporter json to format logs as JSON. (ref.)

For contribution guidelines and project dev setup. Please see CONTRIBUTING.md