<commit_before># twolfson-style [![Build status](https://travis-ci.org/twolfson/twolfson-style.png?branch=master)](https://travis-ci.org/twolfson/twolfson-style)

Lint and style configurations for [@twolfson][]

This was built to create a common versioned location for [@twolfson's][@twolfson] style choices.

Currently, we are leveraging [`jscs`][], a tool built exclusively for verifying consistent style, and [`jshint`][], a tool that performs both linting and style checking.

[@twolfson]: http://github.com/twolfson/
[`jscs`]: https://github.com/jscs-dev/node-jscs
[`jshint`]: http://jshint.org/

## Getting Started
Install the module with: `npm install twolfson-style`

Then, install the `.jscsrc` and `.jshintrc` to your project's repo:

```bash
# Copy over `rc` files
# `./node_modules/.bin/` can be removed if you are in a `npm-run-script` context
./node_modules/.bin/twolfson-style install

# Verify we have added the files
ls .js*
# .jscsrc  .jshintrc
```

These files can be integrated with [`jscs`][] and [`jshint`][] respectively. A common usage is an [`npm-run-script`][]:

```js
// DEV: By providing a `lib/` instead of `lib/*.js`, both `jscs` and `jshint` recurse the directory (e.g. `lib/hello/world.js`)
"lint": "jshint lib/ test/ && jscs lib/ test/"
```

[`npm-run-script`]: https://www.npmjs.org/doc/cli/npm-run-script.html

## Documentation
### CLI
`twolfson-style` installs a `twolfson-style` executable:

```bash
$ bin/twolfson-style --help

  Usage: twolfson-style [options] [command]

  Commands:

    install [dir]  undefined

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

```

### Library versions
The supported [`jscs`][] and [`jshint`][] versions are the same as this package's [`package.json`][].

[`package.json`][]

[`package.json`]: package.json

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint via [grunt](https://github.com/gruntjs/grunt) and test via `npm test`.

## Donating
Support this project and [others by twolfson][gratipay] via [gratipay][].

[![Support via Gratipay][gratipay-badge]][gratipay]

[gratipay-badge]: https://cdn.rawgit.com/gratipay/gratipay-badge/2.x.x/dist/gratipay.png
[gratipay]: https://www.gratipay.com/twolfson/

## Unlicense
As of Nov 20 2014, <NAME> has released this repository and its contents to the public domain.

It has been released under the [UNLICENSE][].
<commit_msg>Completed documentation<commit_after># twolfson-style [![Build status](https://travis-ci.org/twolfson/twolfson-style.png?branch=master)](https://travis-ci.org/twolfson/twolfson-style)

Lint and style configurations for [@twolfson][]

This was built to create a common versioned location for [@twolfson's][@twolfson] style choices.

Currently, we are leveraging [`jscs`][], a tool built exclusively for verifying consistent style, and [`jshint`][], a tool that performs both linting and style checking.

[@twolfson]: http://github.com/twolfson/
[`jscs`]: https://github.com/jscs-dev/node-jscs
[`jshint`]: http://jshint.org/

## Getting Started
Install the module with: `npm install twolfson-style`

Then, install the `.jscsrc` and `.jshintrc` to your project's repo:

```bash
# Copy over `rc` files
# `./node_modules/.bin/` can be removed if you are in a `npm-run-script` context
./node_modules/.bin/twolfson-style install

# Verify we have added the files
ls .js*
# .jscsrc  .jshintrc
```

These files can be integrated with [`jscs`][] and [`jshint`][] respectively. A common usage is an [`npm-run-script`][]:

```js
// DEV: By providing a `lib/` instead of `lib/*.js`, both `jscs` and `jshint` recurse the directory (e.g. `lib/hello/world.js`)
"lint": "jshint lib/ test/ && jscs lib/ test/"
```

[`npm-run-script`]: https://www.npmjs.org/doc/cli/npm-run-script.html

## Documentation
### CLI
`twolfson-style` installs a `twolfson-style` executable:

```bash
$ bin/twolfson-style --help

  Usage: twolfson-style [options] [command]

  Commands:

    install [dir]  Install style `rc` configuration files to `dir` or the current directory

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

```

#### `install [dir]`
The `install` command copies over the `.jscsrc` and `.jshintrc` files to a specified directory, `dir`, or the current working directory, `process.cwd()`.

Currently, we only provide `node` styles but in the future, we are considering adding `--env browser` to alter the styles for browser linting.

### Library versions
The supported [`jscs`][] and [`jshint`][] versions are the same as this package's [`package.json`][].

[`package.json`][]

[`package.json`]: package.json

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint via [grunt](https://github.com/gruntjs/grunt) and test via `npm test`.

## Donating
Support this project and [others by twolfson][gratipay] via [gratipay][].

[![Support via Gratipay][gratipay-badge]][gratipay]

[gratipay-badge]: https://cdn.rawgit.com/gratipay/gratipay-badge/2.x.x/dist/gratipay.png
[gratipay]: https://www.gratipay.com/twolfson/

## Unlicense
As of Nov 20 2014, <NAME> has released this repository and its contents to the public domain.

It has been released under the [UNLICENSE][].

{'fraction_non_alphanumeric': 0.14906602552247086, 'fraction_numerical': 0.0025892361753282783, 'mean_word_length': 4.397205588822355, 'pattern_counts': {'":': 2, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 14, 'lorem ipsum': 0, 'www.': 4, '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': '3121310', 'n_tokens_mistral': 1918, 'n_tokens_neox': 1822, 'n_words': 587}