<commit_before>![logo](resources/logo.png)

[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://opensource.org/licenses/MIT)
[![Build Status](https://travis-ci.org/HaxeCheckstyle/haxe-checkstyle.svg?branch=master)](https://travis-ci.org/HaxeCheckstyle/haxe-checkstyle)
[![codecov.io](https://codecov.io/github/HaxeCheckstyle/haxe-checkstyle/coverage.svg?branch=dev)](https://codecov.io/github/HaxeCheckstyle/haxe-checkstyle?branch=dev)
[![Code Climate](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle/badges/gpa.svg)](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle)
[![Issue Count](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle/badges/issue_count.svg)](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle)
[![Version](https://img.shields.io/badge/haxelib-v2.1.1-EA8220.svg)](http://lib.haxe.org/p/checkstyle/)
[![Gitter chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/HaxeCheckstyle/haxe-checkstyle)

Checkstyle is a development library 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 others code better.

Ideal for any project that want to enforce coding conventions.

### Code Climate

Haxe Checkstyle is available in [Code Climate](https://docs.codeclimate.com/docs/haxe-checkstyle) platform which lets you configure your analysis via a .codeclimate.yml file in the root of your repository.

[![codeclimate](http://adireddy.github.io/images/codeclimate-platform.png)](https://docs.codeclimate.com/docs/haxe-checkstyle)

If you are not familiar with Code Climate, it’s a static analysis tool for monitoring the health of your code. It supports a whole host of languages and frameworks – and it’s all open source!

### Installation

```
haxelib install checkstyle
```

### Basic Usage

```
haxelib run checkstyle -s src<commit_msg>Readme: improved Code Climate section<commit_after>![logo](resources/logo.png)

[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://opensource.org/licenses/MIT)
[![Build Status](https://travis-ci.org/HaxeCheckstyle/haxe-checkstyle.svg?branch=master)](https://travis-ci.org/HaxeCheckstyle/haxe-checkstyle)
[![codecov.io](https://codecov.io/github/HaxeCheckstyle/haxe-checkstyle/coverage.svg?branch=dev)](https://codecov.io/github/HaxeCheckstyle/haxe-checkstyle?branch=dev)
[![Code Climate](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle/badges/gpa.svg)](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle)
[![Issue Count](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle/badges/issue_count.svg)](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle)
[![Version](https://img.shields.io/badge/haxelib-v2.1.1-EA8220.svg)](http://lib.haxe.org/p/checkstyle/)
[![Gitter chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/HaxeCheckstyle/haxe-checkstyle)

Checkstyle is a development library 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.

### Code Climate

Haxe-Checkstyle is available on the [Code Climate](https://docs.codeclimate.com/docs/haxe-checkstyle) platform (free for open source projects). It requires a `checkstyle.json` and a `.codeclimate.yml` file to be added to the root of your repository - see [here](https://docs.codeclimate.com/docs/haxe-checkstyle) 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:

[![Issue Count](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle/badges/issue_count.svg)](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle)

For pull requests, the summary is displayed in the "checks" section:

<img src="http://blog.codeclimate.com/images/integrations_red.png" width="600">

### Installation

```
haxelib install checkstyle
```

### Basic Usage

```
haxelib run checkstyle -s src
{'fraction_non_alphanumeric': 0.13591359135913592, 'fraction_numerical': 0.004725472547254726, 'mean_word_length': 5.704374057315234, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 30, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1930250', 'n_tokens_mistral': 1510, 'n_tokens_neox': 1442, 'n_words': 313}