Skip to content

Add description to module name property for improved IntelliSense #19310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenglol merged 2 commits into from
Apr 1, 2026
Merged

Add description to module name property for improved IntelliSense #19310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98be7b8
improve intellisense.
brendandburns Mar 31, 2026
074960b
Update completion baselines for module name property description
brendandburns Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...Core.Samples/Files/baselines/InvalidModules_LF/Completions/moduleATopLevelProperties.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"detail": "name",
"documentation": {
"kind": "markdown",
"value": "Type: `string` \n"
"value": "Type: `string` \nThe deployment name. Must be 1-64 characters, and can contain alphanumerics, underscores, parentheses, hyphens, and periods. \n"
},
"deprecated": false,
"preselect": false,
Expand Down
2 changes: 1 addition & 1 deletion ....Samples/Files/baselines/InvalidModules_LF/Completions/moduleATopLevelPropertyAccess.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"detail": "name",
"documentation": {
"kind": "markdown",
"value": "Type: `string` \n"
"value": "Type: `string` \nThe deployment name. Must be 1-64 characters, and can contain alphanumerics, underscores, parentheses, hyphens, and periods. \n"
},
"deprecated": false,
"preselect": false,
Expand Down
2 changes: 1 addition & 1 deletion ...Files/baselines/InvalidModules_LF/Completions/moduleAWithConditionTopLevelProperties.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"detail": "name",
"documentation": {
"kind": "markdown",
"value": "Type: `string` \n"
"value": "Type: `string` \nThe deployment name. Must be 1-64 characters, and can contain alphanumerics, underscores, parentheses, hyphens, and periods. \n"
},
"deprecated": false,
"preselect": false,
Expand Down
2 changes: 1 addition & 1 deletion ...s/baselines/InvalidModules_LF/Completions/moduleAWithConditionTopLevelPropertyAccess.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"detail": "name",
"documentation": {
"kind": "markdown",
"value": "Type: `string` \n"
"value": "Type: `string` \nThe deployment name. Must be 1-64 characters, and can contain alphanumerics, underscores, parentheses, hyphens, and periods. \n"
},
"deprecated": false,
"preselect": false,
Expand Down
7 changes: 5 additions & 2 deletions src/Bicep.Core/LanguageConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,10 +377,11 @@ public static TypeSymbol CreateModuleType(IFeatureProvider features, IEnumerable
var nameRequirednessFlags = TypePropertyFlags.None;
// Taken from the official REST specs for Microsoft.Resources/deployments
var nameType = TypeFactory.CreateStringType(minLength: 1, maxLength: 64, pattern: @"^[-\w._()]+$");
var nameDescription = "The deployment name. Must be 1-64 characters, and can contain alphanumerics, underscores, parentheses, hyphens, and periods.";

List<NamedTypeProperty> moduleProperties =
[
new(ModuleNamePropertyName, nameType, nameRequirednessFlags | TypePropertyFlags.DeployTimeConstant | TypePropertyFlags.ReadableAtDeployTime | TypePropertyFlags.LoopVariant),
new(ModuleNamePropertyName, nameType, nameRequirednessFlags | TypePropertyFlags.DeployTimeConstant | TypePropertyFlags.ReadableAtDeployTime | TypePropertyFlags.LoopVariant, nameDescription),
new(ResourceScopePropertyName, CreateResourceScopeReference(moduleScope), scopePropertyFlags),
new(ModuleParamsPropertyName, paramsType, paramsRequiredFlag | TypePropertyFlags.WriteOnly),
new(ModuleOutputsPropertyName, outputsType, TypePropertyFlags.ReadOnly),
Expand All @@ -407,9 +408,11 @@ public static TypeSymbol CreateUsingConfigType()
var optionalPropFlags = TypePropertyFlags.WriteOnly | TypePropertyFlags.DeployTimeConstant | TypePropertyFlags.ReadableAtDeployTime | TypePropertyFlags.DisallowAny;
var requiredPropFlags = optionalPropFlags | TypePropertyFlags.Required;

var nameDescription = "The deployment name. Must be 1-64 characters, and can contain alphanumerics, underscores, parentheses, hyphens, and periods.";

NamedTypeProperty[] commonProps = [
// Taken from the official REST specs for Microsoft.Resources/deployments
new(ModuleNamePropertyName, TypeFactory.CreateStringType(minLength: 1, maxLength: 64, pattern: @"^[-\w._()]+$"), optionalPropFlags),
new(ModuleNamePropertyName, TypeFactory.CreateStringType(minLength: 1, maxLength: 64, pattern: @"^[-\w._()]+$"), optionalPropFlags, nameDescription),
// TODO model this properly as a scope, rather than a string
new(ResourceScopePropertyName, LanguageConstants.String, requiredPropFlags),
];
Expand Down
Loading