<commit_before>[![Coveralls – test coverage
](https://img.shields.io/coveralls/studio-b12/polydox.svg?style=flat-square)
](https://coveralls.io/r/studio-b12/polydox)
 [![Travis – build status
](https://img.shields.io/travis/studio-b12/polydox/master.svg?style=flat-square)
](https://travis-ci.org/studio-b12/polydox)
 [![David – status of dependencies
](https://img.shields.io/david/studio-b12/polydox.svg?style=flat-square)
](https://david-dm.org/studio-b12/polydox)
 [![Stability: experimental
](https://img.shields.io/badge/stability-experimental-yellow.svg?style=flat-square)
](https://nodejs.org/api/documentation.html#documentation_stability_index)
 [![Code style: airbnb
](https://img.shields.io/badge/code%20style-airbnb-blue.svg?style=flat-square)
](https://github.com/airbnb/javascript)




polydox
===

**Pipe multiple files into *[dox][]* at once.**

[dox]:  http://npm.im/dox




Why
---

The original `dox` CLI tool [reads a single source from stdin][]:

```sh
$ dox < utils.js
...JSON...
```

This simple idea gets complicated in a multi-file project. Here are your options:

* Concat files before piping them to `dox`:

```sh
$ cat source/*.js | dox
...LINE NUMBERS LOST...
```

* Concat `dox` output:

```sh
$ for file in source/*.js; do dox $file; done
...NOT VALID JSON...
```

* Wild hacks.

**But worry no more!** Now you have `polydox`:

```sh
$ polydox source/*.js
[
  {
    // …usual dox output PLUS:
    "sourceFile": "source/a.js"
  },
  {
    // …usual dox output PLUS:
    "sourceFile": "source/b.js"
  },
]
```

[reads a single source from stdin]:  https://github.com/tj/dox/tree/934b22c#usage-examples




Installation
------------

```sh
$ npm install --global polydox
```




Usage
-----

    polydox [options] <file>...


Options:

    -r  --raw   Don’t preprocess stuff with markdown


Examples:

    $ polydox a.js

    $ polydox a.js b.js c.js > dox-output.json

    $ polydox source/*.js | doxie --render --inject into Readme.md





License
-------

[MIT][] © [Studio B12 GmbH][]

[MIT]:              ./License.md
[Studio B12 GmbH]:  http://studio-b12.de<commit_msg>Update the readme<commit_after>[![Coveralls – test coverage
](https://img.shields.io/coveralls/studio-b12/polydox.svg?style=flat-square)
](https://coveralls.io/r/studio-b12/polydox)
 [![Travis – build status
](https://img.shields.io/travis/studio-b12/polydox/master.svg?style=flat-square)
](https://travis-ci.org/studio-b12/polydox)
 [![David – status of dependencies
](https://img.shields.io/david/studio-b12/polydox.svg?style=flat-square)
](https://david-dm.org/studio-b12/polydox)
 [![Stability: experimental
](https://img.shields.io/badge/stability-experimental-yellow.svg?style=flat-square)
](https://nodejs.org/api/documentation.html#documentation_stability_index)
 [![Code style: airbnb
](https://img.shields.io/badge/code%20style-airbnb-blue.svg?style=flat-square)
](https://github.com/airbnb/javascript)




polydox
===

**Pipe multiple files into *[dox][]* at once.**

[dox]:  http://npm.im/dox




Why
---

The original `dox` CLI tool [reads a single source from stdin][]:

```sh
$ dox < utils.js
...JSON...
```

This simple idea gets complicated in a multi-file project. Here are your options:

* Concat files before piping them to `dox`:

```sh
$ cat source/*.js | dox
...LINE NUMBERS LOST...
```

* Concat `dox` output:

```sh
$ for file in source/*.js; do dox $file; done
...NOT VALID JSON...
```

* Wild hacks.

**But worry no more!** Now you have `polydox`:

```sh
$ polydox source/*.js
[
  {
    // …usual dox output PLUS:
    "sourceFile": "source/a.js"
  },
  {
    // …usual dox output PLUS:
    "sourceFile": "source/b.js"
  },
]
```

[reads a single source from stdin]:  https://github.com/tj/dox/tree/934b22c#usage-examples




Installation
------------

```sh
$ npm install --global polydox
```




Usage
-----

    polydox [options] <file>...


  Options:

    -h  --help   Print a short synopsis (-h) or this usage info (--help)
    -r  --raw    Don’t preprocess stuff with markdown


  Examples:

    $ polydox a.js

    $ polydox a.js b.js c.js > dox-output.json

    $ polydox source/*.js | doxie --render --inject into Readme.md





License
-------

[MIT][] © [Studio B12 GmbH][]

[MIT]:              ./License.md
[Studio B12 GmbH]:  http://studio-b12.de
{'fraction_non_alphanumeric': 0.1902097902097902, 'fraction_numerical': 0.011655011655011656, 'mean_word_length': 3.1140939597315436, 'pattern_counts': {'":': 4, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 22, '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': '5149254', 'n_tokens_mistral': 1765, 'n_tokens_neox': 1619, 'n_words': 359}