Skip to content

Commit be18b40

Browse files
Fix VSCode extension README link (#884)
1 parent b1a7a30 commit be18b40

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed
Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Key features of the Bicep VS Code extension
22

3-
The [bicep VS Code extension](./installing.md#install-the-bicep-vs-code-extension) is capable of many of the features you would expect out of other language tooling. Here is a comprehensive list of the features that are currently implemented.
3+
The [bicep VS Code extension](/docs/installing.md#install-the-bicep-vs-code-extension) is capable of many of the features you would expect out of other language tooling. Here is a comprehensive list of the features that are currently implemented.
44

55
## Validation
66

@@ -14,19 +14,19 @@ Bicep provides intellisense for the core language and extends to support type de
1414

1515
Type `.` for any object to view and autocomplete its properties. Works on any `param` or `var` of type `object`, and any `resource` or `module` properties (e.g. `myModule.outputs.`).
1616

17-
![intellisense being displayed for property access of a bicep resource](./images/resource-dot-property-intellisense.gif)
17+
![intellisense being displayed for property access of a bicep resource](/docs/images/resource-dot-property-intellisense.gif)
1818

1919
### Resource property names & property values
2020

2121
Bicep knows the allowed properties and values for any `resource` or `module` declaration.
2222

23-
![intellisense being displayed for available property names and property values where applicable of a bicep resource](./images/resource-property-names-and-values.gif)
23+
![intellisense being displayed for available property names and property values where applicable of a bicep resource](/docs/images/resource-property-names-and-values.gif)
2424

2525
### List all available resource types
2626

2727
Easily explore all available resource types and api versions for a given type. You can type partial fragments of the type and bicep will narrow the list down accordingly.
2828

29-
![intellisense being displayed for all available types for a resource](./images/list-types-intellisense.gif)
29+
![intellisense being displayed for all available types for a resource](/docs/images/list-types-intellisense.gif)
3030

3131
### Other intellisense and completions
3232

@@ -38,48 +38,48 @@ Easily explore all available resource types and api versions for a given type. Y
3838

3939
Bicep has a small set of snippets for core language keywords (`param`, `var`, `resource`, `module`, `output`). The snippets are contextual, so they should only show up in the places they are valid. We plan to convert all of the ARM Template resource snippets that are used by the ARM Tools VS Code extension into bicep snippets.
4040

41-
![snippets for top level keywords](./images/snippets.gif)
41+
![snippets for top level keywords](/docs/images/snippets.gif)
4242

4343
## Code navigation
4444

4545
The bicep language service supports document symbols, which help power a broad set of code navigation features.
4646

4747
### Go to definition, peek definition
4848

49-
![navigating from parameter used as a property value to the parameter declaration](./images/go-to-def.gif)
49+
![navigating from parameter used as a property value to the parameter declaration](/docs/images/go-to-def.gif)
5050

5151
### Find all references, peek references
5252

53-
![showing all times a particular symbol is referenced](./images/show-all-references.gif)
53+
![showing all times a particular symbol is referenced](/docs/images/show-all-references.gif)
5454

5555
### Outline view and breadcrumb view
5656

57-
![screenshot of vs code with the Outline panel and breadcrumb highlighted](./images/outline-and-breadcrumb.PNG)
57+
![screenshot of vs code with the Outline panel and breadcrumb highlighted](/docs/images/outline-and-breadcrumb.PNG)
5858

5959
### Highlights
6060

6161
When your cursor is on or in a particular symbol, bicep will highlight other uses of that symbol. The color of the highlight is different for declarations of a symbol as opposed to accessing a symbol.
6262

63-
![showing the cursor on a symbol and the other references that are automatically highlighted](./images/highlights.gif)
63+
![showing the cursor on a symbol and the other references that are automatically highlighted](/docs/images/highlights.gif)
6464

6565
### Hovers
6666

67-
![showing the mouse hovering over a symbol, which shows type information on a pop-up window](./images/hovers.gif)
67+
![showing the mouse hovering over a symbol, which shows type information on a pop-up window](/docs/images/hovers.gif)
6868

6969
## Refactoring
7070

7171
### Rename symbol
7272

7373
You can rename any symbol such as a `param` or `resource` and bicep will intelligently rename all the uses of that symbol
7474

75-
![rename a symbol called 'pip' into a symbol named 'publicIp' with the 'Rename symbol' feature](./images/rename-symbol.gif)
75+
![rename a symbol called 'pip' into a symbol named 'publicIp' with the 'Rename symbol' feature](/docs/images/rename-symbol.gif)
7676

7777
### Formatting
7878

7979
* Default keybinding is `alt` + `shift` + `f` on Windows, `option` + `shift` + `f` on macOS
8080
* You can also format via the VS Code UI. `View` -> `Command palette...` then type `format document`
8181

82-
![formatting a bicep file that is disorganized](./images/format.gif)
82+
![formatting a bicep file that is disorganized](/docs/images/format.gif)
8383

8484
* Bicep will set the following default settings for `.bicep` files when installed:
8585

@@ -100,4 +100,4 @@ You can change the default settings in the following places (sorted by precedenc
100100

101101
For small issues like misspelled symbols or incorrect casing, bicep will offer a "Quick fix" to fix it for you.
102102

103-
![correcting a spelling error with "quick fix"](./images/quick-fix.gif)
103+
![correcting a spelling error with "quick fix"](/docs/images/quick-fix.gif)

src/vscode-bicep/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"color": "E7F1FA",
3434
"theme": "light"
3535
},
36-
"homepage": "https://github.com/Azure/bicep/blob/main/docs/language-service.md",
36+
"homepage": "https://github.com/Azure/bicep/blob/main/README.md",
3737
"activationEvents": [
3838
"onLanguage:bicep"
3939
],
@@ -86,7 +86,7 @@
8686
"test:e2e": "node ./out/test/e2e/runTests.js",
8787
"test:unit": "jest --config jest.config.unit.js",
8888
"clean": "rimraf ./out ./coverage",
89-
"package": "gulp setversion && vsce package --out ./vscode-bicep.vsix && gulp resetversion"
89+
"package": "gulp setversion && vsce package --githubBranch main --out ./vscode-bicep.vsix && gulp resetversion"
9090
},
9191
"devDependencies": {
9292
"@types/jest": "^26.0.15",

0 commit comments

Comments
 (0)