<commit_before># tldr-lint

`tldr-lint` is a linting tool for validating [tldr](https://github.com/tldr-pages/tldr) pages.
It can also format your pages for you!

# Usage
It's really simple.

```
  Usage: tldr-lint [options] <file|dir>

  Options:

    -h, --help           output usage information
    -V, --version        output the version number
    -f, --format         also attempt formatting (to stdout, or as specified by -o)
    -o, --output <file>  output formatted file
    -v, --verbose        print verbose output (for debugging)
```


# Linter Errors
There's a bunch of them. Couldn't bother writing them down just yet.
They're all in `lib/tldr-lint.js` though if you feel inclined.

## TODO
- Assert file has .md extension
- Assert file name is same as page title<commit_msg>Travis, NPM, DavidDM dependencies, Gitter badges<commit_after># tldr-lint

[![NPM version][npm-image]][npm-url]
[![Travs CI Build Status][travis-image]][travis-url]
[![David DM Dependency Status][dep-image]][dep-url]
[![Gitter chat][gitter-image]][gitter-url]

`tldr-lint` is a linting tool for validating [tldr](https://github.com/tldr-pages/tldr) pages.
It can also format your pages for you!

# Usage
It's really simple.

```
  Usage: tldr-lint [options] <file|dir>

  Options:

    -h, --help           output usage information
    -V, --version        output the version number
    -f, --format         also attempt formatting (to stdout, or as specified by -o)
    -o, --output <file>  output formatted file
    -v, --verbose        print verbose output (for debugging)
```


# Linter Errors
There's a bunch of them. Couldn't bother writing them down just yet.
They're all in `lib/tldr-lint.js` though if you feel inclined.

## TODO
- Assert file has .md extension
- Assert file name is same as page title

[npm-url]: https://www.npmjs.com/package/tldr-lint
[npm-image]: https://img.shields.io/npm/v/tldr-lint.svg

[travis-url]: https://travis-ci.org/tldr-pages/tldr-lint
[travis-image]: https://travis-ci.org/tldr-pages/tldr-lint.svg?branch=master

[dep-url]: https://david-dm.org/tldr-pages/tldr-lint
[dep-image]: https://david-dm.org/tldr-pages/tldr-lint.svg?theme=shields.io

[dev-dep-url]: https://david-dm.org/tldr-pages/tldr-lint#info=devDependencies
[dev-dep-image]: https://david-dm.org/tldr-pages/tldr-lint/dev-status.svg?theme=shields.io

[gitter-url]: https://gitter.im/tldr-pages/tldr
[gitter-image]: https://badges.gitter.im/tldr-pages/tldr.png
{'fraction_non_alphanumeric': 0.1458842705786471, 'fraction_numerical': 0.0, 'mean_word_length': 3.3451327433628317, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 12, 'lorem ipsum': 0, 'www.': 1, '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': '1709834', 'n_tokens_mistral': 919, 'n_tokens_neox': 882, 'n_words': 238}