<commit_before># ECLint

[![Build Status](https://travis-ci.org/jedmao/eclint.svg?branch=master)](https://travis-ci.org/jedmao/eclint)
[![npm version](https://badge.fury.io/js/eclint.svg)](http://badge.fury.io/js/eclint)
[![Code Climate](https://codeclimate.com/github/jedmao/eclint/badges/gpa.svg)](https://codeclimate.com/github/jedmao/eclint)
[![Test Coverage](https://codeclimate.com/github/jedmao/eclint/badges/coverage.svg)](https://codeclimate.com/github/jedmao/eclint)
[![NPM license](http://img.shields.io/npm/l/editorconfig-tools.svg?style=flat-square)](https://www.npmjs.org/package/editorconfig-tools)


## Introduction

ECLint is a tool for validating or fixing code that doesn't adhere to settings defined in `.editorconfig`. It also infers settings from existing code. See the [EditorConfig Project](http://editorconfig.org/) for details about the `.editorconfig` file.

This version of ECLint runs on [EditorConfig Core](https://www.npmjs.com/package/editorconfig) 0.12.x.


## Installation

```
$ npm install [-g] eclint
```


## Features

- [Command-Line Interface (CLI)](#cli)
- [Check](#check), [fix](#fix) or [infer](#infer) the following EditorConfig rules across one or more files:
  - [charset](#charset)
  - [indent_style](#indent_style)
  - [indent_size](#indent_size)
  - [trim_trailing_whitespace](#trim_trailing_whitespace)
  - [end_of_line](#end_of_line)
  - [insert_final_newline](#insert_final_newline)
  - [max_line_length (unofficial)](#max_line_length-unofficial)
- [TypeScript/JavaScript API](#api)
- [Gulp plugin](#gulp-plugin)


## CLI

The command-line interface (CLI) for this project uses [gitlike-cli](#https://www.npmjs.com/search?q=gitlike-cli) to parse the `eclint` command, along with its [check](#check), [fix](#fix) and [infer](#infer) sub-commands. Internally, the command is sent to the [API](#api) to do its magic.

Running just `eclint` will provide the following help information:

```
$ eclint

  CommandError: Missing required sub-command.

  Usage: eclint.js [options] <command> [null]

  Commands:

    check  Validate that file(s) adhere to .editorconfig settings
    fix    Fix formatting errors that disobey .editorconfig settings
    infer  Infer .editorconfig settings from one or more files

  Options:

    -h, --help     output help information
    -v, --version  output version information
```<commit_msg>Readme fix<commit_after># ECLint

[![Build Status](https://travis-ci.org/jedmao/eclint.svg?branch=master)](https://travis-ci.org/jedmao/eclint)
[![npm version](https://badge.fury.io/js/eclint.svg)](http://badge.fury.io/js/eclint)
[![Code Climate](https://codeclimate.com/github/jedmao/eclint/badges/gpa.svg)](https://codeclimate.com/github/jedmao/eclint)
[![Test Coverage](https://codeclimate.com/github/jedmao/eclint/badges/coverage.svg)](https://codeclimate.com/github/jedmao/eclint)
[![NPM license](http://img.shields.io/npm/l/editorconfig-tools.svg?style=flat-square)](https://www.npmjs.org/package/editorconfig-tools)


## Introduction

ECLint is a tool for validating or fixing code that doesn't adhere to settings defined in `.editorconfig`. It also infers settings from existing code. See the [EditorConfig Project](http://editorconfig.org/) for details about the `.editorconfig` file.

This version of ECLint runs on [EditorConfig Core](https://www.npmjs.com/package/editorconfig) 0.12.x.


## Installation

```
$ npm install [-g] eclint
```


## Features

- [Command-Line Interface (CLI)](#cli)
- [Check](#check), [fix](#fix) or [infer](#infer) the following EditorConfig rules across one or more files:
  - [charset](#charset)
  - [indent_style](#indent_style)
  - [indent_size](#indent_size)
  - [trim_trailing_whitespace](#trim_trailing_whitespace)
  - [end_of_line](#end_of_line)
  - [insert_final_newline](#insert_final_newline)
  - [max_line_length (unofficial)](#max_line_length-unofficial)
- [TypeScript/JavaScript API](#api)
- [Gulp plugin](#gulp-plugin)


## CLI

The command-line interface (CLI) for this project uses [gitlike-cli](https://www.npmjs.com/search?q=gitlike-cli) to parse the `eclint` command, along with its [check](#check), [fix](#fix) and [infer](#infer) sub-commands. Internally, the command is sent to the [API](#api) to do its magic.

Running just `eclint` will provide the following help information:

```
$ eclint

  CommandError: Missing required sub-command.

  Usage: eclint.js [options] <command> [null]

  Commands:

    check  Validate that file(s) adhere to .editorconfig settings
    fix    Fix formatting errors that disobey .editorconfig settings
    infer  Infer .editorconfig settings from one or more files

  Options:

    -h, --help     output help information
    -v, --version  output version information
```
{'fraction_non_alphanumeric': 0.1496411988180667, 'fraction_numerical': 0.001266357112705783, 'mean_word_length': 4.836206896551724, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 20, 'lorem ipsum': 0, 'www.': 6, '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': '389876', 'n_tokens_mistral': 1674, 'n_tokens_neox': 1538, 'n_words': 363}