Quick links: --- Troubleshooting --- Setup --- Configuration ---
Provide Intellisense capabilities to your Aurelia project (through the LSP) by letting you access View Model variables in your Views, rename them across your components, and many other features. For a complete list, check out the Features. The extension works out of the box on Linux/Mac/Windows, but still allows you to customize it to your projects needs.
(Defintions: Show all places where <custom-element>
component is used)
CLI |
---|
+ --- root/ | + --- src/ // Default place where the Extension tries to search | for Aurelia files | + --- tsconfig.json // (Optional) Powers all the language features | (through a Typescript Program) | + --- jsconfig.json // Same as `tsconfig.json` | + --- package.json // Determine, if given project is an Aurelia project |
Monorepo |
---|
+ --- root/ | + --- aurelia/ | + --- src/ // Default place where the Extension tries to search | for Aurelia files | + --- tsconfig.json // (Optional) Powers all the language features | (through a Typescript Program) | + --- package.json // Determine, if given project is an Aurelia project | + --- burelia/ | + (same as aurelia/) // Behaves the same as `aurelia/` | + --- non-aurelia/ // Will not get picked up | + ... |
Complex |
---|
+ --- root/ | + --- frontend/ | + --- aurelia/ | + --- src/ // Default place where the Extension tries to search | for Aurelia files | + --- tsconfig.json // (Optional) Powers all the language features | (through a Typescript Program) | + --- package.json // Determine, if given project is an Aurelia project | + --- backend/ | + --- service/ |
npx makes au
)allowJS: true
to your tsconfig.json
au new
)au new
project, and legacy monorepo setup, with 131 componentsComplex |
---|
+ --- root/ | + --- frontend/ // aureliaProject.rootDirectory = | absolute/path/root/frontend | + --- aurelia/ | + --- deeper-path/ | + --- src/ // aureliaProject.pathToAureliaFiles = | absolute/path/root/.../deeper-path/src | + --- tsconfig.json // aureliaProject.pathToTsConfig = | absolute/path/root/.../aurelia/tsconfig.json | + --- package.json // aureliaProject.packageJsonInclude = | absolute/path/root/.../frontend/package.json | + --- backend/ | + --- service/ |
You can find a more detailed list of features here. Furthermore, our tests are in a readable format and can provide much deeper insights into the extension behavior. You are encouraged to check those out:
And I'm on the line at character
When I trigger Suggestions with ''
Then I should get the correct method with brackets
Examples:
| LINE | CODE | METHOD_NAME |
| 0 | `` | functionVariable |
```
(Legend below)
Feature/Region | A/AI/TI | BA | BB | CA | CE | HTML | I/R | RF | Signal | VC |
---|---|---|---|---|---|---|---|---|---|---|
Code Action | ➖ | ➖ | ➖ | ➖ | ➖ | ➕ | ➖ | ➖ | ➖ | ➖ |
Completion | ➕ | ➕ | ➖ | ➖ | ➕ | ➕ | ➕ | ➕ | ➖ | ➕ |
Definition | ➕ | ➕ | ➖ | ➖ | ➕ | ➕ | ➕ | ➕* | ➖ | ➕ |
Diagnostics | ➖ | ➖ | ➖ | ➖ | ➖ | ➕ | ➖ | ➖ | ➖ | ➖ |
Hover | ➖ | ➖ | ➖ | ➖ | ➖ | ➕ | ➖ | ➖ | ➖ | ➖ |
Rename | ➕ | ➕ | ➖ | ➖ | ➕ | ➕ | ➖ | ➕* | ➖ | ➖ |
(Document) Symbol | ➕ | ➕ | ➖ | ➖ | ➕ | ➕ | ➕ | ➕ | ➖ | ➕ |
(Workspace) Symbol | ➕ | ➕ | ➖ | ➖ | ➕ | ➕ | ➕ | ➕ | ➖ | ➕ |
Missing: Router, Promise, <let>
➕ : Supported ➕* : Partially (or unsable) supported ➖ : Not supported | |||
---|---|---|---|
A: Attribute | CA: CustomAttribute | RF: RepeatFor | |
AI: AttributeInterpolation | CE: CustomElement | TI: TextInterpolation | |
BA: BindableAttribute | HTML: HTML | VC: ValueConverter | |
BB: BindingBehavior | I/R: Import/Require |
@customElement
decoratorYou can manually install the extension by downloading the .vsix file in the top right section under "Release". Once you downloaded it, install via
code --install-extension aurelia-2.x.y.vsix
Completions
Extension not working as expected
aurelia.capabilities
. Else please open an issuePlease note, that due to the low iteration count, all features may not be as stable as we like them to be. Before submitting and issue, check out the General issues, Troubleshooting and [FAQ] section. If you still haven't found a solution to your problem, you are more than welcome to open an issue. The extension is in active use by the authors, so you can expect a swift response, but do note, that an actual fix cannot be guaranteed. Regardless, we are thankful, that you took the time to troubleshoot with us!
# l.
bumb version in package.json
"version": "2.3.5"
npm i && npm run changelog
commit: chore(release): release v2.3.5
# 2.
git tag -a 2.3.5 -m "v2.3.5"
git push --follow-tags
git tag -d 2.3.5
git push --delete origin 2.3.5
Use odd minor versions
Use even minor versions