npm package: @moneyforward/code-review-action
Description: Analyze code statically in Github actions
Author: Money Forward, Inc.
Latest version: 0.2.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# Code review action

Analyze code statically in Github actions

## Inputs

### `analyzer`

Specify the analyzer plugin

- Brakeman: [@moneyforward/code-review-action-brakeman-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-brakeman-plugin)
- Rubocop: [@moneyforward/code-review-action-rubocop-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-rubocop-plugin)
- Rails Best Practices: [@moneyforward/code-review-action-rails_best_practices-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-rails_best_practices-plugin)
- Reek: [@moneyforward/code-review-action-reek-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-reek-plugin)
- Querly: [@moneyforward/code-review-action-querly-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-querly-plugin)
- ESLint: [@moneyforward/code-review-action-eslint-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-jshint-plugin)
- JSHint: [@moneyforward/code-review-action-jshint-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-eslint-plugin)
- CoffeeLint: [@moneyforward/code-review-action-coffeelint-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-coffeelint-plugin)
- stylelint: [@moneyforward/code-review-action-stylelint-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-stylelint-plugin)
- Goodcheck: [@moneyforward/code-review-action-goodcheck-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-goodcheck-plugin)
- misspell: [@moneyforward/code-review-action-misspell-plugin](https://www.npmjs.com/package/@moneyforward/code-review-action-misspell-plugin)

... and more

### `options`

Changes the analyzer options.

Specify the options in JSON format.

### `files`

Specify files or directories

(Multiple files or directories can be specified by separating them with line feed)

### `working_directory`

Changes the current working directory of the Node.js process

### `reporter_type_notation`

Change the reporter.

(Multiple can be specified separated by commas)

## Example usage

```yaml
name: Analyze code statically
"on": pull_request
jobs:
  brakeman:
    runs-on: ubuntu-latest
    env:
      ANALYZER: '@moneyforward/code-review-action-brakeman-plugin'
      ANALYZER_VERSION: '~0'
    steps:
      - uses: actions/checkout@v2
      - run: sudo npm i -g --no-save "${ANALYZER}@${ANALYZER_VERSION}"
      - id: node-env
        run: echo "::set-output name=path::$(npm root -g)"
      - name: Analyze code statically
        uses: moneyforward/code-review-action@v0
        env:
          NODE_PATH: ${{ steps.node-env.outputs.path }}
        with:
          analyzer: ${{ env.ANALYZER }}
```

## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/moneyforward/code-review-action

## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).