Haxe JavaScript
Permalink
Failed to load latest commit information.
resources
src/checkstyle ignoring check if it's not available Dec 17, 2016
test
.codeclimate.yml Disable MD033, remove trailing whitespace Mar 29, 2016
.editorconfig tweaked .editorconfig Mar 6, 2016
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
Checkstyle.hxproj
LICENCE.md
LIMITATIONS.md
README.md
build.hxml separated builds into individual jobs Nov 8, 2016
buildAll.hxml
buildDebug.hxml
buildGlobal.hxml separated builds into individual jobs Nov 8, 2016
buildTelemetry.hxml
buildTest.hxml
checkstyle.json
gruntfile.js
haxelib.json new release prep Dec 17, 2016
package.json new release prep Dec 17, 2016

README.md

logo

License Release Build Status Codecov Code Climate Code Climate Issues Gitter chat

Haxe Checkstyle is a static analysis tool to help developers write Haxe code that adheres to a coding standard.

It automates the process of checking Haxe code to spare developers of this boring (but important) task.

Code conventions improve readability, allowing team members to understand each other's code better.

Ideal for any project that wants to enforce coding conventions.

Static analysis is usually performed as part of a code review.

Code Climate

Haxe Checkstyle is available on the Code Climate platform (free for open source projects). It requires a .codeclimate.yml file and an optional but recommended checkstyle.json file to be added to the root of your repository - see here for more details.

When everything is set up, Code Climate automatically runs Haxe Checkstyle for you on each new commit (also on pull requests if configured that way).

The current number of issues can be tracked via a badge:

Code Climate

Immediate results, right in your pull requests.

img

Installation

haxelib install checkstyle

Basic Usage

haxelib run checkstyle -s src

Reference

More information and reference.

Issues Stories in Ready

Found any bug? Please create a new issue.

Coverage

codecov.io

Licensing Information

This content is released under the MIT license.

This project was derived from haxelint created by @mcheshkov.

Contributor Code of Conduct

Code of Conduct is adapted from Contributor Covenant, version 1.4