/README.md

https://github.com/faceair/atom-goto-definition · Markdown · 38 lines · 25 code · 13 blank · 0 comment · 0 complexity · f553485372c3cc6e939afc1a08825d95 MD5 · raw file 

    

  1. # Goto Definition
    2. 

  2. 

  3. [![macOS & Linux Build Status](https://travis-ci.org/faceair/atom-goto-definition.svg?branch=master)](https://travis-ci.org/faceair/atom-goto-definition)
    4. 

  4. [![Windows Build Status](https://ci.appveyor.com/api/projects/status/q8lttuxttxf69xs4?svg=true)](https://ci.appveyor.com/project/faceair/atom-goto-definition)
    5. 

  5. [![dependencies Status](https://david-dm.org/faceair/atom-goto-definition/status.svg)](https://david-dm.org/faceair/atom-goto-definition)
    6. 

  6. 

  7. ![demo](http://ww1.sinaimg.cn/large/71ef46c1ly1fdt8wgbaiqg20zi0j8hdu.gif)
    8. 

  8. 

  9. * Support for `JavaScript(ES6 && JSX)`, `TypeScript`, `CoffeeScript`, `Python`, `Ruby`, `PHP`, `Hack`, `Perl`, `KRL`, `Erb`, `Haml`, `C/C++`, `Puppet`, `ASP`, `Shell`
    10. 

  10. * Works with Mac OSX, Linux and Windows
    11. 

  11. * Goto-Definition functionality, by default on `Alt+Cmd+Enter`/`Ctrl+Alt+Enter`
    12. 

  12. * Support [hyperclick](https://atom.io/packages/hyperclick), `<cmd-click>` on a word to jump to it's declaration
    13. 

  13. 

  14. ## Installing
    15. 

  15. Install the package ```goto-definition``` in Atom (Preferences->Install) or use Atom's package manager from a shell:  
    16. 

  16. ```
    17. 

  17. $ apm install goto-definition
    18. 

  18. ```
    19. 

  19. 

  20. ## Performance Mode
    21. 

  21. 

  22. Performance mode is 10x faster than nomal mode. If you want a better experience, please use the performance mode.
    23. 

  23. 

  24. Steps:
    25. 

  25. 

  26. 1. Install `ripgrep`, see [https://github.com/BurntSushi/ripgrep#installation](https://github.com/BurntSushi/ripgrep#installation). Yeap, now we use `ripgrep` to search definitions, because it's incredibly fast.
    27. 

  27. 2. Turn `Settings -> Packages -> goto-definition -> Settings -> Performance Mode` on.
    28. 

  28. 3. Enjoy it.
    29. 

  29. 

  30. Please note that performance mode is still under testing, suggestions and feedback are welcome. Performance mode will be activated by default in the next version once it has been tested extensively.
    31. 

  31. 

  32. ### Ignoring files
    33. 

  33. 

  34. You can ignore files while in performace mode by creating a `.ignore` file in the root of your project. Same syntax than `.gitignore`.
    35. 

  35. 

  36. ### Notice
    37. 

  37. 

  38. * In normal mode, if you want to include VCS ignored paths, please uncheck `Settings -> Exclude VCS Ignored Paths` option under package preferences.
    39.