<commit_before># eslint-canary [![Build Status](https://travis-ci.org/not-an-aardvark/eslint-canary.svg?branch=master)](https://travis-ci.org/not-an-aardvark/eslint-canary)

(WIP) Regression build for [ESLint](https://github.com/eslint/eslint)

## Usage

```
$ npm install eslint-canary -g
$ eslint-canary path/to/package/folder/containing/eslint
```

`eslint-canary` clones a hardcoded list of projects known to use ESLint, and runs ESLint on all of them to ensure that no errors are reported. This is intended to catch regressions in ESLint that are missed by ESLint's unit tests.

## Adding your project

To add your project to the regression build, make a PR to `projects.yml`.

## Development

```bash<commit_msg>Docs: reorganize the README text<commit_after># eslint-canary [![Build Status](https://travis-ci.org/not-an-aardvark/eslint-canary.svg?branch=master)](https://travis-ci.org/not-an-aardvark/eslint-canary)

(WIP) Regression build for [ESLint](https://github.com/eslint/eslint)

`eslint-canary` clones a hardcoded list of projects known to use ESLint, and runs ESLint on all of them to ensure that no errors are reported. This is intended to catch regressions in ESLint that are missed by ESLint's unit tests.

## Usage

```
$ npm install eslint-canary -g
$ eslint-canary path/to/package/folder/containing/eslint
```

## Adding your project

To add your project to the regression build, make a PR to `projects.yml`.

## Development

```bash
{'fraction_non_alphanumeric': 0.11890034364261168, 'fraction_numerical': 0.0, 'mean_word_length': 4.665369649805448, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1475159', 'n_tokens_mistral': 510, 'n_tokens_neox': 483, 'n_words': 151}