<commit_before># Ctags Node module [![Build Status](https://travis-ci.org/atom/node-ctags.png)](https://travis-ci.org/atom/node-ctags)

Read all about ctags [here](http://ctags.sourceforge.net/).

## Installing

```sh
npm install ctags
```

## Building
  * Clone the repository
  * Run `npm install`
  * Run `grunt` to compile the native and CoffeeScript code

## Documentation

### findTags(path, tag, [options])

Get all tags matching the tag specified from the tags file at the path.

`path` - The string path to the tags file.

`tag` - The string name of the tag to search for.

`options` - An optional options object containing the following keys:
  * `caseInsensitive`: `true` to include tags that match case insensitively,
    (default: `false`)
  * `partialMatch`: `true` to include tags that partially match the given tag
    (default: `false`)

Returns an array containing objects that have `name` and `file` keys and
optionally a `pattern` key if the tag file specified contains tag patterns.

#### Example

```coffeescript
ctags = require 'ctags'<commit_msg>Doc how to run specs<commit_after># Ctags Node module [![Build Status](https://travis-ci.org/atom/node-ctags.png)](https://travis-ci.org/atom/node-ctags)

Read all about ctags [here](http://ctags.sourceforge.net/).

## Installing

```sh
npm install ctags
```

## Building
  * Clone the repository
  * Run `npm install`
  * Run `grunt` to compile the native and CoffeeScript code
  * Run `grunt test` to run the specs

## Documentation

### findTags(path, tag, [options])

Get all tags matching the tag specified from the tags file at the path.

`path` - The string path to the tags file.

`tag` - The string name of the tag to search for.

`options` - An optional options object containing the following keys:
  * `caseInsensitive`: `true` to include tags that match case insensitively,
    (default: `false`)
  * `partialMatch`: `true` to include tags that partially match the given tag
    (default: `false`)

Returns an array containing objects that have `name` and `file` keys and
optionally a `pattern` key if the tag file specified contains tag patterns.

#### Example

```coffeescript
ctags = require 'ctags'
{'fraction_non_alphanumeric': 0.11304347826086956, 'fraction_numerical': 0.0, 'mean_word_length': 4.192399049881235, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, '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': '7497897', 'n_tokens_mistral': 670, 'n_tokens_neox': 651, 'n_words': 270}