<commit_before>jut
===

[![Build Status](http://img.shields.io/travis/jarofghosts/jut.svg?style=flat)](https://travis-ci.org/jarofghosts/jut)
[![npm install](http://img.shields.io/npm/dm/jut.svg?style=flat)](https://www.npmjs.org/package/jut)

locate used modules

## installation

`npm install -g jut`

## whafor?

`jut -m badmodule`

or use it with [jung](https://github.com/jarofghosts/jung) and a test runner!

`jung -f '\.js$' -- test_runner $(ls tests/**/*.js | jut -m '$JUNG_FILE' -Fnj)`

or something else. the world is yours.

## usage

`jut [options] --module <modulename>`

Options are:

* `--module, -m <modulename>` Find files that require `<modulename>`
* `--dir, -d <dirname>` Search files in `<dirname>` recursively
* `--file, -f <filename>` Search `<filename>` for modules
* `--justmatch, -j` Just print the filename that matches
* `--fullpath, -F` Print full path to matched file
* `--nocolor, -n` Don't colorize results
* `--version, -v` Print current version
* `--help, -h` Print help

## notes

in order to support searching for "deep-requires", (such as
`module-name/sub-module`) searching for a "local" file (such as
`../../module-name/sub-module`) requires a leading `./` in the module name.

## as a module

`jut(['array', 'of', 'module', './names']) -> TransformStream`

stream it filenames, and get out objects with match objects.
something like:

```js
var jut = require('jut')
  , ls = require('ls-stream') // for example
  , convert = require('dotpath-stream')
  , filter = require('stream-police')

ls('apps')
  .pipe(convert('path')) // reduce ls-stream object to path string
  .pipe(filter({verify: [/\.js$/]})) // only .js files
  .pipe(jut(['falafel'])) // right over to jut
  .on('data', function(data) {
    console.log(data) // {filename: fullpath, line: lineNumber, module: 'falafel'}
  })
```

## license

MIT
<commit_msg>fix stream class in README<commit_after>jut
===

[![Build Status](http://img.shields.io/travis/jarofghosts/jut.svg?style=flat)](https://travis-ci.org/jarofghosts/jut)
[![npm install](http://img.shields.io/npm/dm/jut.svg?style=flat)](https://www.npmjs.org/package/jut)

locate used modules

## installation

`npm install -g jut`

## whafor?

`jut -m badmodule`

or use it with [jung](https://github.com/jarofghosts/jung) and a test runner!

`jung -f '\.js$' -- test_runner $(ls tests/**/*.js | jut -m '$JUNG_FILE' -Fnj)`

or something else. the world is yours.

## usage

`jut [options] --module <modulename>`

Options are:

* `--module, -m <modulename>` Find files that require `<modulename>`
* `--dir, -d <dirname>` Search files in `<dirname>` recursively
* `--file, -f <filename>` Search `<filename>` for modules
* `--justmatch, -j` Just print the filename that matches
* `--fullpath, -F` Print full path to matched file
* `--nocolor, -n` Don't colorize results
* `--version, -v` Print current version
* `--help, -h` Print help

## notes

in order to support searching for "deep-requires", (such as
`module-name/sub-module`) searching for a "local" file (such as
`../../module-name/sub-module`) requires a leading `./` in the module name.

## as a module

`jut(['array', 'of', 'module', './names']) -> DuplexStream`

stream it filenames, and get out objects with match objects.
something like:

```js
var jut = require('jut')
  , ls = require('ls-stream') // for example
  , convert = require('dotpath-stream')
  , filter = require('stream-police')

ls('apps')
  .pipe(convert('path')) // reduce ls-stream object to path string
  .pipe(filter({verify: [/\.js$/]})) // only .js files
  .pipe(jut(['falafel'])) // right over to jut
  .on('data', function(data) {
    console.log(data) // {filename: fullpath, line: lineNumber, module: 'falafel'}
  })
```

## license

MIT

{'fraction_non_alphanumeric': 0.19121585431173005, 'fraction_numerical': 0.0, 'mean_word_length': 3.8443579766536966, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 19, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, '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': '697030', 'n_tokens_mistral': 1371, 'n_tokens_neox': 1314, 'n_words': 384}