Browse Source

update the readme and add screencasts

master
Nicolas Petton 5 years ago
parent
commit
51b1fdff31
Signed by: nico GPG Key ID: 233587A47C207910
4 changed files with 26 additions and 23 deletions
  1. +26
    -0
      readme.md
  2. +0
    -23
      readme.org
  3. BIN
      screencasts/jump-to-definition.gif
  4. BIN
      screencasts/jump-to-references.gif

+ 26
- 0
readme.md View File

@ -0,0 +1,26 @@
# xref-js2
`xref-js2` adds navigation to definitions or references to JavaScript projects
in Emacs.
`xref-js2` adds an xref backend for JavaScript files.
Instead of using a tag system, it relies on `ag` to query the codebase of a
project. This might sound crazy at first, but it turns out that `ag` is so fast
that jumping using `xref-js2` is most of the time instantaneous, even on fairly
large JavaScript codebases (it has been tested on 50k lines of JS code).
Because line by line regexp search has its limitations, `xref-js2` does a second
pass on result candidates and eliminates possible false positives using
`js2-mode`'s AST, thus giving very accurate results.
## Requirements
- Emacs 25.1
- `ag` (the [silver searcher](http://geoff.greer.fm/ag/))
- js2-mode
## Demo
![jump-to-definition.gif](screencasts/jump-to-definition.gif)
![jump-to-references.gif](screencasts/jump-to-references.gif)

+ 0
- 23
readme.org View File

@ -1,23 +0,0 @@
* xref-js2
=xref-js2= adds navigation to definitions or references to JavaScript projects
in Emacs.
=xref-js2= adds an xref backend for JavaScript files.
Instead of using a tag system, it relies on =ag= to query the codebase of a
project. This might sound crazy at first, but it turns out that =ag= is so
fast that jumping using =xref-js2= is most of the time instantaneous, even on
fairly large JavaScript codebase (it successfully works with 50k lines of JS
code).
Because line by line regexp search has its limitations, =xref-js2= does a second
pass on result candidates and eliminates possible false positives using
=js2-mode='s AST, thus giving very accurate results.
** Requirements
- Emacs 25.1
- `ag' (the [[http://geoff.greer.fm/ag/][silver searcher]])
- js2-mode

BIN
screencasts/jump-to-definition.gif View File

Before After
Width: 700  |  Height: 700  |  Size: 247 KiB

BIN
screencasts/jump-to-references.gif View File

Before After
Width: 700  |  Height: 700  |  Size: 232 KiB

Loading…
Cancel
Save