fix(type-formatting): do not strip quotes for objectFieldQuote when not an ID; always allow unescaped digits

Author: brettz9

.README/rules/type-formatting.md

@@ -26,7 +26,8 @@ Boolean value of whether to use a dot before the angled brackets of a generic (e
 
 Whether and how object field properties should be quoted (e.g., `{"a": string}`).
 Set to `single`, `double`, or `null`. Defaults to `null` (no quotes unless
-required due to whitespace within the field).
+required due to special characters within the field). Digits will be kept as is,
+regardless of setting (they can either represent a digit or a string digit).
 
 ### `propertyQuotes`
 

docs/rules/type-formatting.md

@@ -38,7 +38,8 @@ Boolean value of whether to use a dot before the angled brackets of a generic (e
 
 Whether and how object field properties should be quoted (e.g., `{"a": string}`).
 Set to `single`, `double`, or `null`. Defaults to `null` (no quotes unless
-required due to whitespace within the field).
+required due to special characters within the field). Digits will be kept as is,
+regardless of setting (they can either represent a digit or a string digit).
 
 <a name="user-content-type-formatting-options-propertyquotes"></a>
 <a name="type-formatting-options-propertyquotes"></a>
@@ -319,6 +320,20 @@ The following patterns are not considered problems:
  * @param {{"a bc": string}} quotedKeyParam
  */
 
+/**
+ * @param {{55: string}} quotedKeyParam
+ */
+
+/**
+ * @param {{"a-b-c": string}} quotedKeyParam
+ */
+// "jsdoc/type-formatting": ["error"|"warn", {"objectFieldQuote":null}]
+
+/**
+ * @param {{55: string}} quotedKeyParam
+ */
+// "jsdoc/type-formatting": ["error"|"warn", {"objectFieldQuote":"double"}]
+
 /**
  * @param {ab.cd.ef} cfg
  */

src/rules/typeFormatting.js

@@ -250,8 +250,15 @@ export default iterateJsdoc(({
         case 'JsdocTypeObjectField': {
           const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectFieldResult} */ (nde);
           if ((objectFieldQuote ||
-            (typeof typeNode.key === 'string' && !(/\s/v).test(typeNode.key))) &&
-            typeNode.meta.quote !== (objectFieldQuote ?? undefined)
+            (typeof typeNode.key === 'string' &&
+              (
+                (/^\p{ID_Start}\p{ID_Continue}*$/v).test(typeNode.key) ||
+                (/^(\d+(\.\d*)?|\.\d+)([eE][\-+]?\d+)?$/v).test(typeNode.key)
+              )
+            )) &&
+            typeNode.meta.quote !== (objectFieldQuote ?? undefined) &&
+            (typeof typeNode.key !== 'string' ||
+                !(/^(\d+(\.\d*)?|\.\d+)([eE][\-+]?\d+)?$/v).test(typeNode.key))
           ) {
             typeNode.meta.quote = objectFieldQuote ?? undefined;
             errorMessage = `Inconsistent object field quotes ${objectFieldQuote}`;

test/rules/assertions/typeFormatting.js

@@ -714,6 +714,37 @@ export default {
          */
       `,
     },
+    {
+      code: `
+        /**
+         * @param {{55: string}} quotedKeyParam
+         */
+      `,
+    },
+    {
+      code: `
+        /**
+         * @param {{"a-b-c": string}} quotedKeyParam
+         */
+      `,
+      options: [
+        {
+          objectFieldQuote: null,
+        },
+      ],
+    },
+    {
+      code: `
+        /**
+         * @param {{55: string}} quotedKeyParam
+         */
+      `,
+      options: [
+        {
+          objectFieldQuote: 'double',
+        },
+      ],
+    },
     {
       code: `
         /**