Skip to content

Vscode plugin for resolving Ember's imports and component invocations to the files on disk

Notifications You must be signed in to change notification settings

jackson-dean/ember-goto

Repository files navigation

Ember Go To

This is a WIP.

Makes 'Go to Definition' work for ember applications with in-repo addons and for resolving modules from the node_modules directory. Relies on namespaced, absolute import paths. Also provides a "Related Files" feature which displays related files based on the current file, which is available via a command in the command palette.

Coming soon: auto creation of jsconfig.json based on project for more integrated experience

Features

  • "Go to Definition" for named and default imports in javascript files.
  • "Go to Definition" for component and helper invocations in templates.
  • "Related files" for navigating quickly betweeen js/hbs/test locations depending on the current open file.

Extension Settings

If you want to resolve modules in unconventional locations, you need to specify where this extension should search for them. By default it will try to resolve modules from lib and node_modules. The config should provide additional sources under the config key ember-goto.extraAddonSources.

Example config for non-conventional directories:

	"ember-goto.extraAddonSources": [
		"engines",
	]

If modules are imported using the application namespace, you must provide the name of the application via the config "ember-goto.appNamespace". This is the same as the name key found in the package.json for your top level ember app:

	"ember-goto.appNamespace": "your-app-name"

If your project has addons with names different from the directory name on the file system, that can be configured with "ember-goto.addonNameAliases":

	"ember-goto.addNameAliases": {
		"name-in-package.json": "name-on-disk"
	}

If your ember app is nested in a subdirectory of your overall project. You must provide the absolute path to the ember app location:

	"ember-goto.projectRoot": "/Absolute/file/system/path/to/my-ember-app"

Install

Not published in the marketplace yet, but it can be easily installed by downloading the .vsix file from this repo and using the code command line utility.

First, you need to make sure the code executable is in your path. Vscode has a command to easily do this.

Step 1: Press cmd+shift+p to open the Command Palette Step 2: Search for the command "Shell Command: Install 'code' command to PATH" and execute it Step 3: Run the following in a terminal:

git clone https://github.com/jackson-dean/ember-goto.git && cd ember-goto && code --install-extension ember-goto-0.0.1.vsix

After installation you can reload or start a new instance of vscode. To confirm the plugin is loaded, you can right click in any editor and there should be a new option, "Related Files", and a new command in the command palette of the same name.

About

Vscode plugin for resolving Ember's imports and component invocations to the files on disk

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published