jsctags
Version:
jsctags generator
128 lines (104 loc) • 4.49 kB
Markdown
# jsctags
[](https://travis-ci.org/ramitos/jsctags) [](https://codeclimate.com/github/ramitos/jsctags/coverage) [](https://www.npmjs.com/package/jsctags) [](https://david-dm.org/ramitos/jsctags) [](https://codeclimate.com/github/ramitos/jsctags) [](https://www.npmjs.com/package/jsctags)
jsctags generator using [tern](https://github.com/marijnh/tern)
## install
For access to the binary:
```sh
npm install -g git+https://github.com/ramitos/jsctags.git
```
Otherwise, add to your project's package.json under dependencies or
dev-dependencies:
```json
"jsctags": "git://github.com/ramitos/jsctags.git"
```
## usage
```sh
$ jsctags [--dir=/path/to] /path/to/file.js [-f]
```
```sh
$ cat /path/to/file.js | jsctags [--dir=/path/to] [--file=/path/to/file.js] [-f]
```
By default, `jsctags` will output a JSON file. Use the `-f` flag to output an exuberant ctags-compatible file.
```js
const jsctags = require('jsctags');
const fs = require('fs');
const file = '/path/to/file.js';
const dir = '/path/to/';
const content = fs.readFileSync(file, 'utf8');
jsctags(file, dir, content, function(e, tags) {
console.log(tags);
});
```
## Usage with Vim
If you'd like to take a JavaScript project and generate a `tags` file that Vim can parse, you can use the below command. It searches your directory for any `.js` files, excluding `./node_modules`, formats the tags correctly for Vim and outputs them into `tags`.
```bash
find . -type f -iregex ".*\.js$" -not -path "./node_modules/*" -exec jsctags {} -f \; | sed '/^$/d' | LANG=C sort > tags
```
If you would like tags generated for files within `node_modules/`, just remove the `-not -path "./node_modules/*` part of the command:
```bash
find . -type f -iregex ".*\.js$" -exec jsctags {} -f \; | sed '/^$/d' | LANG=C sort > tags
```
## examples
* [arguments](examples/arguments.md)
* [array_holes](examples/array_holes.md)
* [arrow](examples/arrow.md)
* [autothis](examples/autothis.md)
* [bind](examples/bind.md)
* [block_scope](examples/block_scope.md)
* [blowup](examples/blowup.md)
* [browser](examples/browser.md)
* [builtins](examples/builtins.md)
* [catch_error](examples/catch_error.md)
* [cautiouspropagation](examples/cautiouspropagation.md)
* [class](examples/class.md)
* [computedprop](examples/computedprop.md)
* [contextcomplete](examples/contextcomplete.md)
* [copyprops](examples/copyprops.md)
* [ctorpattern](examples/ctorpattern.md)
* [defineProperty](examples/defineProperty.md)
* [destructure](examples/destructure.md)
* [docstrings](examples/docstrings.md)
* [effects](examples/effects.md)
* [empty_overridden_prop](examples/empty_overridden_prop.md)
* [es6-features](examples/es6-features.md)
* [extends](examples/extends.md)
* [finddef](examples/finddef.md)
* [findref](examples/findref.md)
* [fn_arguments](examples/fn_arguments.md)
* [for_of](examples/for_of.md)
* [generate](examples/generate.sh)
* [generator](examples/generator.md)
* [generic_each](examples/generic_each.md)
* [getter](examples/getter.md)
* [global_this](examples/global_this.md)
* [hint-objlit](examples/hint-objlit.md)
* [hint_browser](examples/hint_browser.md)
* [hint_ecma5](examples/hint_ecma5.md)
* [hint_simple](examples/hint_simple.md)
* [indirect_class](examples/indirect_class.md)
* [infinite-expansion](examples/infinite-expansion.md)
* [jsdoc](examples/jsdoc.md)
* [map](examples/map.md)
* [merge](examples/merge.md)
* [mixin](examples/mixin.md)
* [new_array](examples/new_array.md)
* [new_to_prototype](examples/new_to_prototype.md)
* [object_create](examples/object_create.md)
* [objectlit](examples/objectlit.md)
* [objnames](examples/objnames.md)
* [order_of_definition](examples/order_of_definition.md)
* [phantom_object](examples/phantom_object.md)
* [plus](examples/plus.md)
* [promise](examples/promise.md)
* [proto](examples/proto.md)
* [protoname](examples/protoname.md)
* [react](examples/react.md)
* [replace_bogus_prop](examples/replace_bogus_prop.md)
* [set](examples/set.md)
* [simple](examples/simple.md)
* [simple_generic](examples/simple_generic.md)
* [super](examples/super.md)
* [symbol](examples/symbol.md)
* [template](examples/template.md)
## license
MIT