File tree Expand file tree Collapse file tree 1 file changed +28
-4
lines changed Expand file tree Collapse file tree 1 file changed +28
-4
lines changed Original file line number Diff line number Diff line change @@ -9,13 +9,13 @@ Please note that this project was originally created by [@mcheshkov](https://git
99
1010I have customized and made it flexible with additional checks and configurations.
1111
12- ### Installation ###
12+ ###Installation
1313
1414``` haxe
1515haxelib install checkstyle
1616```
1717
18- ### Configuration ###
18+ ###Configuration
1919
2020More information in [ wiki page] ( https://github.com/adireddy/haxe-checkstyle/wiki/Haxe-Checkstyle ) .
2121
@@ -142,12 +142,36 @@ More information in [wiki page](https://github.com/adireddy/haxe-checkstyle/wiki
142142}
143143```
144144
145- ### Reference ###
145+ ###Options
146+
147+ To see all the options available run ` haxelib run checkstyle `
148+
149+ [ -p | --path] <loc > : Set reporter path
150+ [ -x | --xslt] <x > : Set reporter style (XSLT)
151+ [ -r | --reporter] <reporterName > : Set reporter
152+ [ --list-reporters] : List all reporters
153+ [ -c | --config] <configPath > : Set config file
154+ [ --list-checks] : List all checks
155+ [ -s | --source] <sourcePath > : Set sources to process
156+
157+ ###Hudson and Bamboo Integration
158+
159+ You can generate the report in checkstyle XML format that can be integrated with Hudson and Bamboo easily.
160+
161+ You can also set XSLT style for the XML generated. See the sample below.
162+
163+ ` haxelib run checkstyle -s src -c config.json -r xml -p report.xml -x report.xsl `
164+
165+ Sample Hudson integration chart.
166+
167+ ![ hudson] ( https://raw.githubusercontent.com/adireddy/haxe-checkstyle/master/hudson.png )
168+
169+ ###Reference
146170
147171http://haxe.org/manual/class-field-visibility.html
148172
149173http://adireddy.github.io/haxe/haxe-access-modifiers-return-types/
150174
151- ### Issues ###
175+ ###Issues
152176
153177Found any bug? Please create a new [ issue] ( https://github.com/adireddy/haxe-checkstyle/issues/new ) .
You can’t perform that action at this time.
0 commit comments