Provides path completion for visual studio code.
path-autocomplete.extensionOnImport
- boolean If true it will append the extension as well when inserting the file name on import
or require
statements.
path-autocomplete.includeExtension
- boolean If true it will append the extension as well when inserting the file name.
path-autocomplete.excludedItems
This option allows you to exclude certain files from the suggestions.
"path-autocomplete.excludedItems": {
"**/*.js": { "when": "**/*.ts" }, // ignore js files if i'm inside a ts file
"**/*.map": { "when": "**" }, // always ignore *.map files
"**/{.git,node_modules}": { "when": "**" }, // always ignore .git and node_modules folders
"**": { "when": "**", "isDir": true }, // always ignore `folder` suggestions
"**/*.ts": { "when": "**", "context": "import.*" }, // ignore .ts file suggestions in all files when the current line matches the regex from the `context`
}
minimatch is used to check if the files match the pattern.
path-autocomplete.pathMappings
Useful for defining aliases for absolute or relative paths.
"path-autocomplete.pathMappings": {
"/test": "${folder}/src/Actions/test", // alias for /test
"/": "${folder}/src", // the absolute root folder is now /src,
"$root": ${folder}/src // the relative root folder is now /src
// or multiple folders for one mapping
"$root": ["${folder}/p1/src", "${folder}/p2/src"] // the root is now relative to both p1/src and p2/src
}
path-autocomplete.pathSeparators
- string Lists the separators used for extracting the inserted path when used outside strings.
The default value is: \t({[
path-autocomplete.transformations
List of custom transformation applied to the inserted text.
Example: replace _
with an empty string when selecting a SCSS partial file.
"path-autocomplete.transformations": [{
"type": "replace",
"parameters": ["^_", ""],
"when": {
"fileName": "\\.scss$"
}
}],
Supported transformation:
replace
- Performs a string replace on the selected item text.
Parameters:
regex
- a regex pattern
replaceString
- the replacement string
path-autocomplete.triggerOutsideStrings
boolean - if true it will trigger the autocomplete outside of quotes
path-autocomplete.enableFolderTrailingSlash
boolean - if true it will add a slash after the insertion of a folder path that will trigger the autocompletion.
path-autocomplete.disableUpOneFolder
boolean - disables the up one folder (..) element from the completion list.
path-autocomplete.useBackslash
boolean - if true it will use \\
when iserting the paths.
path-autocomplete.ignoredFilesPattern
- string - Glob patterns for disabling the path completion in the specified file types. Example: "*/.{css,scss}"
path-autocomplete.ignoredPrefixes
array - list of ignored prefixes to disable suggestions
on certain preceeding words/characters.
Example:
"path-autocomplete.ignoredPrefixes": [
"//" // type double slash and no suggesstions will be displayed
]
VSCode doesn't automatically recognize path aliases so you cannot alt+click to open files. To fix this you need to create jsconfig.json
or tsconfig.json
to the root of your project and define your alises. An example configuration: