This repository has been archived by the owner. It is now read-only.
⚠️⚠️⚠️ DEPRECATED
Clone or download
r-chris Merge pull request #64 from ardavis/master
Allow jumping to Ruby constant definitions
Latest commit 87437eb Nov 20, 2017

README.md

Goto Definition

macOS & Linux Build Status Windows Build Status dependencies Status

demo

  • Support for JavaScript(ES6 && JSX), TypeScript, CoffeeScript, Python, Ruby, PHP, Hack, Perl, KRL, Erb, Haml, C/C++, Puppet, ASP, Shell
  • Works with Mac OSX, Linux and Windows
  • Goto-Definition functionality, by default on Alt+Cmd+Enter/Ctrl+Alt+Enter
  • Support hyperclick, <cmd-click> on a word to jump to it's declaration

Installing

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

$ apm install goto-definition

Performance Mode

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

Steps:

  1. Install ripgrep, see https://github.com/BurntSushi/ripgrep#installation. Yeap, now we use ripgrep to search definitions, because it's incredibly fast.
  2. Turn Settings -> Packages -> goto-definition -> Settings -> Performance Mode on.
  3. Enjoy it.

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.

Ignoring files

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

Notice

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