https://github.com/dansomething/codenarc-cli

Conveniently run CodeNarc from the command-line
https://github.com/dansomething/codenarc-cli

codenarc command-line groovy static-analysis

Last synced: 10 months ago
JSON representation

Conveniently run CodeNarc from the command-line

• Host: GitHub
• URL: https://github.com/dansomething/codenarc-cli
• Owner: dansomething
• License: mit
• Created: 2020-05-07T13:25:29.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-05-07T13:57:39.000Z (over 5 years ago)
• Last Synced: 2025-01-16T22:47:17.618Z (12 months ago)
• Topics: codenarc, command-line, groovy, static-analysis
• Language: Shell
• Homepage: https://codenarc.github.io/CodeNarc/
• Size: 8.74 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# codenarc-cli

Conveniently run [CodeNarc](https://codenarc.github.io/CodeNarc/) from the command-line.

### Prequisites

* [Groovy](http://groovy-lang.org/install.html)

### Install

1) [Download the codenarc-cli zip](https://github.com/dansomething/codenarc-cli/archive/master.zip)

2) Unzip codenarc-cli-master.zip

### Example

    # Display the command-line help

    /path/to/unzipped/codenarc-cli/codenarc -help

    # Analyze the current directory using the rules configured in `.codenarcrc`

    /path/to/unzipped/codenarc-cli/codenarc -basedir=. -rulesetfiles=file:.codenarcrc -report=console

### Platforms

Only tested on MacOS

### Links

* [CodeNarc Command-Line Parameters](https://codenarc.github.io/CodeNarc/codenarc-command-line.html)

* [CodeNarc Starter RuleSet](https://codenarc.github.io/CodeNarc/StarterRuleSet-AllRulesByCategory.groovy.txt)