Skip to content

Latest commit

 

History

History
187 lines (127 loc) · 3.62 KB

README.md

File metadata and controls

187 lines (127 loc) · 3.62 KB

Path Intellisense

Visual Studio Code plugin that autocompletes filenames.

Installation

In the command palette (cmd-shift-p) select Install Extension and choose Path Intellisense.

To use Path Intellisense instead of the default autocompletion, the following configuration option must be added to your settings:

{ "typescript.suggest.paths": false }
{ "javascript.suggest.paths": false }

Usage

IDE

Node packages intellisense

Use npm intellisense

Contributing

Something missing? Found a bug? - Create a pull request or an issue. Github

Open in Gitpod

Are you a windows user?

There is an issue on windows with the period key. See Issue ChristianKohler/NpmIntellisense#12

Add this to the keybinding:

{ "key": ".", "command": "" }

TsConfig support

BaseUrl

Pathintellisense uses the ts.config.compilerOptions.baseUrl as a mapping. So no need to define it twice.

For example:

# Folderstructure

src/
module-a
foo.ts
module-b
// tsconfig

{
	"baseUrl": "src",
}

would allow to type:

{
  import {} from "module-a/foo.ts";
}

You can disable this behaviour by setting it to true:

{
	"path-intellisense.ignoreTsConfigBaseUrl": true,
}

Paths

Pathintellisense uses the ts.config.compilerOptions.paths as a mapping.

For example:

{
  "compilerOptions": {
    "paths": {
      "@/*": ["src/*"]
    }
  }
}

Note: Fallbacks are not supported.

Settings

File extension in import statements

Path Intellisense removes the file extension by default if the statement is a import statement. To enable file extensions set the following setting to true:

{
	"path-intellisense.extensionOnImport": true,
}

Show hidden files

Per default, hidden files are not displayed. Set this to true to show hidden files.

{
	"path-intellisense.showHiddenFiles": true,
}

If set to false, PathIntellisense ignores the default "files.exclude" as well:

{
	"files.exclude": {
		"**/*.map.js": true
	}
}

Auto slash when navigating to folder

Per default, the autocompletion does not add a slash after a directory.

{
	"path-intellisense.autoSlashAfterDirectory": false,
}

Automatically trigger next suggestion

When a suggestion was selected, the next suggestion will automatically pop up.

This setting will override the autoSlashAfterDirectory setting.

{
	"path-intellisense.autoTriggerNextSuggestion": false,
}

Absolute paths

Per default, absolute paths are resolved within the current workspace root path. Set it to false to resolve absolute paths to the disk root path.

{
	"path-intellisense.absolutePathToWorkspace": true,
}

Mappings

Define custom mappings which can be useful for using absolute paths or in combination with webpack resolve options.

{
	"path-intellisense.mappings": {
		"/": "${workspaceFolder}",
		"lib": "${workspaceFolder}/lib",
		"global": "/Users/dummy/globalLibs"
	},
}

Use ${workspaceFolder} when the path should be relative to the current root of the current project. V2.2.1 and lower used ${workspaceRoot}. Newer version support both placeholders.

History

See changelog

License

This software is released under MIT License