Commit 21549d2
authored
Add description to module name property for improved IntelliSense (#19310)
## Summary
This PR adds a human-readable description to the `name` property on
module/test declarations so that IntelliSense (hover info, completions)
surfaces helpful guidance about the deployment name constraints.
## Changes
In `src/Bicep.Core/LanguageConstants.cs`:
- Added a `nameDescription` string ("The deployment name. Must be 1-64
characters, and can contain alphanumerics, underscores, parentheses,
hyphens, and periods.") and passed it to the `NamedTypeProperty`
constructor for the module name property in both `CreateModuleType` and
the test/extension common properties.
This ensures that when users hover over or complete the `name` property
in a module or test block, they see the allowed pattern and length
constraints directly in the editor.
###### Microsoft Reviewers: [Open in
CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/Azure/bicep/pull/19310)
Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>1 parent 53b6d28 commit 21549d2
File tree
5 files changed
+9
-6
lines changed- src
- Bicep.Core.Samples/Files/baselines/InvalidModules_LF/Completions
- Bicep.Core
5 files changed
+9
-6
lines changedLines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
44 | | - | |
| 44 | + | |
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | | - | |
| 29 | + | |
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
44 | | - | |
| 44 | + | |
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | | - | |
| 29 | + | |
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
377 | 377 | | |
378 | 378 | | |
379 | 379 | | |
| 380 | + | |
380 | 381 | | |
381 | 382 | | |
382 | 383 | | |
383 | | - | |
| 384 | + | |
384 | 385 | | |
385 | 386 | | |
386 | 387 | | |
| |||
407 | 408 | | |
408 | 409 | | |
409 | 410 | | |
| 411 | + | |
| 412 | + | |
410 | 413 | | |
411 | 414 | | |
412 | | - | |
| 415 | + | |
413 | 416 | | |
414 | 417 | | |
415 | 418 | | |
| |||
0 commit comments