<commit_before># rainbird-linter

Wrapper for JSHint/Plato that produces a JSHint report to the console, and a
Plato report to the filesystem. The reports cover the same filesets and use the
same linter options.


# Installation

```bash
npm install rainbird-linter
```

# Usage

```bash
Usage: node report.js [options]
  -t, --title=TITLE    The title of the report.
  -o, --output=PATH    The directory to output the reports to
  -l, --jshint=PATH    Path to a jshintrc file for JSHint linting.
  -f, --filesets=PATH  Path to a file containing the filesets to report on.
  -h, --help           display this help text.
```

## Example

```bash
node report.js --title "My Report" --output ~/reports/myproj/ \
               --jshint ~/.jshintrc --filesets ./filesets.json
```

The above command will create a Plato report entitled "My Report" in
`~/reports/myproj/` using a `.jshintrc` from the users home directory. This 
`.jshintrc` will also be used for the linter report to console. The included
files will be pulled from a file called `filesets.json` in the current
directory.

If the contents of `filesets.json` was:

```javascript
    "includeFiles": ["index.js", "lib/", "test/", "public/"],
    "excludeFiles": ["public/thirdparty/"]
```

The the report would be run over `index.js`, all javascript files under `lib/`,
all javascript files under `test/` and all javascript files under `public/`
apart from the content of `public/thirdparty/`.

# License

Copyright (c) 2014, RainBird Technologies <<EMAIL>><commit_msg>Update readme for new command line name<commit_after># rainbird-linter

Wrapper for JSHint/Plato that produces a JSHint report to the console, and a
Plato report to the filesystem. The reports cover the same filesets and use the
same linter options.


# Installation

```bash
npm install -g rainbird-linter
```

# Usage

```bash
Usage: rblint [options]
  -t, --title=TITLE    The title of the report.
  -o, --output=PATH    The directory to output the reports to
  -l, --jshint=PATH    Path to a jshintrc file for JSHint linting.
  -f, --filesets=PATH  Path to a file containing the filesets to report on.
  -h, --help           display this help text.
```

## Example

```bash
rblint --title "My Report" --output ~/reports/myproj/ --jshint ~/.jshintrc \
       --filesets ./filesets.json
```

The above command will create a Plato report entitled "My Report" in
`~/reports/myproj/` using a `.jshintrc` from the users home directory. This 
`.jshintrc` will also be used for the linter report to console. The included
files will be pulled from a file called `filesets.json` in the current
directory.

If the contents of `filesets.json` was:

```javascript
    "includeFiles": ["index.js", "lib/", "test/", "public/"],
    "excludeFiles": ["public/thirdparty/"]
```

The the report would be run over `index.js`, all javascript files under `lib/`,
all javascript files under `test/` and all javascript files under `public/`
apart from the content of `public/thirdparty/`.

# License

Copyright (c) 2014, RainB<NAME> <<EMAIL>>
{'fraction_non_alphanumeric': 0.11380780583797967, 'fraction_numerical': 0.0026238110856018366, 'mean_word_length': 3.4985250737463125, 'pattern_counts': {'":': 4, '<': 8, '<?xml version=': 0, '>': 8, 'https://': 0, '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': '582550', 'n_tokens_mistral': 1002, 'n_tokens_neox': 934, 'n_words': 401}