Merge pull request #206393 from mumian/0729-linter-unquoted

new linter rule - prefer-unquoted-property-names

Author: JamesJBarnett

articles/azure-resource-manager/bicep/bicep-config-linter.md

@@ -2,7 +2,7 @@
 title: Linter settings for Bicep config
 description: Describes how to customize configuration values for the Bicep linter
 ms.topic: conceptual
-ms.date: 07/21/2022
+ms.date: 07/29/2022
 ---
 
 # Add linter settings in the Bicep config file
@@ -47,6 +47,9 @@ The following example shows the rules that are available for configuration.
         "prefer-interpolation": {
           "level": "warning"
         },
+        "prefer-unquoted-property-names": {
+          "level": "warning"
+        },
         "secure-parameter-default": {
           "level": "warning"
         },

articles/azure-resource-manager/bicep/linter-rule-prefer-unquoted-property-names.md

@@ -0,0 +1,57 @@
+---
+title: Linter rule - prefer unquoted property names
+description: Linter rule - prefer unquoted property names
+ms.topic: conceptual
+ms.date: 07/29/2022
+---
+
+# Linter rule - prefer unquoted property names
+
+This rule finds unnecessary single quotes where an object property name is declared and where an object property is dereferenced with array access.
+
+In Bicep, quotes are optionally allowed when the object property keys contain numbers or special characters. For example, space, '-', or '.'. For more information, see [Objects](./data-types.md#objects).
+
+## Linter rule code
+
+Use the following value in the [Bicep configuration file](bicep-config-linter.md) to customize rule settings:
+
+`prefer-unquoted-property-names`
+
+## Solution
+
+Quotes are not required in following code:
+
+```bicep
+var obj = {
+  newProp: {} // Property name is fine.
+  'my-prop' : {} // Quotes are required.
+  '1' : {} //  Quotes are required.
+  'myProp': {} // Quotes are NOT required.
+ }
+
+var x0 = obj.newProp // Code is fine.
+var x1 = obj['my-prop'] // Quotes and square brackets are required.
+var x2 = obj['1'] // Quotes and square brackets are required.
+var x3 = obj['myProp'] // Use obj.myProp instead.
+```
+
+You can fix it by removing the unnecessary quotes:
+
+```bicep
+var obj = {
+  newProp: {}
+  'my-prop' : {}
+  '1' : {}
+  myProp: {}
+ }
+
+
+var x0 = obj.newProp
+var x1 = obj['my-prop']
+var x2 = obj['1']
+var x3 = obj.myProp
+```
+
+## Next steps
+
+For more information about the linter, see [Use Bicep linter](./linter.md).

articles/azure-resource-manager/bicep/linter.md

@@ -2,7 +2,7 @@
 title: Use Bicep linter
 description: Learn how to use Bicep linter.
 ms.topic: conceptual
-ms.date: 07/22/2022
+ms.date: 07/29/2022
 ---
 
 # Use Bicep linter
@@ -29,6 +29,7 @@ The default set of linter rules is minimal and taken from [arm-ttk test cases](.
 - [no-unused-vars](./linter-rule-no-unused-variables.md)
 - [outputs-should-not-contain-secrets](./linter-rule-outputs-should-not-contain-secrets.md)
 - [prefer-interpolation](./linter-rule-prefer-interpolation.md)
+- [prefer-unquoted-property-names](./linter-rule-prefer-unquoted-property-names.md)
 - [secure-parameter-default](./linter-rule-secure-parameter-default.md)
 - [simplify-interpolation](./linter-rule-simplify-interpolation.md)
 - [use-protectedsettings-for-commandtoexecute-secrets](./linter-rule-use-protectedsettings-for-commandtoexecute-secrets.md)

articles/azure-resource-manager/bicep/toc.yml

@@ -380,6 +380,8 @@
         href: linter-rule-outputs-should-not-contain-secrets.md
       - name: Prefer interpolation
         href: linter-rule-prefer-interpolation.md
+      - name: Prefer unquoted property names
+        href: linter-rule-prefer-unquoted-property-names.md
       - name: Secure parameter default
         href: linter-rule-secure-parameter-default.md
       - name: Simplify interpolation