Clone or download
AlexHaxe use formatter (#461)
* use formatter
* allow failure of Haxe dev build
Latest commit 9b1545d Sep 11, 2018
Permalink
Failed to load latest commit information.
resources use formatter (#461) Sep 10, 2018
schema new DocCommentStyle and TypeDocComment checks (#440) Jun 21, 2018
src/checkstyle use formatter (#461) Sep 10, 2018
test use formatter (#461) Sep 10, 2018
.codeclimate.yml fix reported line pos in MethodCount (#415) May 11, 2018
.editorconfig fix reported line pos in MethodCount (#415) May 11, 2018
.gitignore new DocCommentStyle and TypeDocComment checks (#440) Jun 21, 2018
.travis.yml use formatter (#461) Sep 10, 2018
CHANGELOG.md use formatter (#461) Sep 10, 2018
CODE_OF_CONDUCT.md update Mar 27, 2016
Checkstyle.hxproj Travis: fix builds with Haxe dev Mar 17, 2016
LICENSE.md New comment doc checks (#442) Jun 23, 2018
LIMITATIONS.md format Mar 27, 2016
README.md added links to vscode extension Jun 14, 2018
build.hxml separated builds into individual jobs Nov 8, 2016
buildAll.hxml change getLinePos from O(n/2) to O(log(N)) (#439) Jun 17, 2018
buildDebug.hxml separated builds into individual jobs Nov 8, 2016
buildGlobal.hxml moved tokentree to separate library (#434) Jun 9, 2018
buildJS.hxml added buildJS.hxml Jun 13, 2018
buildSchema.hxml added code comments and adjusted schema generator (#433) Jun 7, 2018
buildTelemetry.hxml separated builds into individual jobs Nov 8, 2016
buildTest.hxml Json schema (#431) Jun 5, 2018
checkstyle.json use formatter (#461) Sep 10, 2018
gruntfile.js New comment doc checks (#442) Jun 23, 2018
haxelib.json prepare version 2.4.2 (#447) Jul 1, 2018
hxformat.json use formatter (#461) Sep 10, 2018
package.json prepare version 2.4.2 (#447) Jul 1, 2018

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.

codeclimate-pr

Installation

haxelib install checkstyle

Basic Usage

haxelib run checkstyle -s src

Automatic detection of your coding style (experimental)

haxelib run checkstyle -s src -detect detectedCheckstyle.json

VSCode integration

There is a VSCode extension for haxe-checkstyle available in the VSCode marketplace. It is currently built with haxe-checkstyle v2.4.1 and tokentree v1.0.1. You can view the development version here: vscode-checkstyle

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