feat(type-formatting): add parameterDefaultValueSpacing for type parameter spacing

Author: brettz9

.README/rules/type-formatting.md

@@ -18,7 +18,7 @@ Currently offers the following options for formatting types.
 |Tags|`param`, `property`, `returns`, `this`, `throws`, `type`, `typedef`, `yields`|
 |Recommended|false|
 |Settings|`mode`|
-|Options|`arrayBrackets`, `enableFixer`, `genericDot`, `objectFieldIndent`, `objectFieldQuote`, `objectFieldSeparator`, `objectFieldSeparatorOptionalLinebreak`, `objectFieldSeparatorTrailingPunctuation`, `separatorForSingleObjectField`, `stringQuotes`, `typeBracketSpacing`, `unionSpacing`|
+|Options|`arrayBrackets`, `defaultValueSpacing`, `elementSpacing`, `enableFixer`, `genericDot`, `objectFieldIndent`, `objectFieldQuote`, `objectFieldSeparator`, `objectFieldSeparatorOptionalLinebreak`, `objectFieldSeparatorTrailingPunctuation`, `separatorForSingleObjectField`, `stringQuotes`, `typeBracketSpacing`, `unionSpacing`|
 
 ## Failing examples
 

docs/rules/type-formatting.md

@@ -22,6 +22,18 @@ A single options object has the following properties.
 
 Determines how array generics are represented. Set to `angle` for the style `Array<type>` or `square` for the style `type[]`. Defaults to "square".
 
+<a name="user-content-type-formatting-options-defaultvaluespacing"></a>
+<a name="type-formatting-options-defaultvaluespacing"></a>
+### <code>defaultValueSpacing</code>
+
+The space character (if any) to use between the equal signs of a default value
+
+<a name="user-content-type-formatting-options-elementspacing"></a>
+<a name="type-formatting-options-elementspacing"></a>
+### <code>elementSpacing</code>
+
+The space character (if any) to use between elements in generics and tuples
+
 <a name="user-content-type-formatting-options-enablefixer"></a>
 <a name="type-formatting-options-enablefixer"></a>
 ### <code>enableFixer</code>
@@ -114,7 +126,7 @@ Determines the spacing to add to unions (`|`). Defaults to a single space (`" "`
 |Tags|`param`, `property`, `returns`, `this`, `throws`, `type`, `typedef`, `yields`|
 |Recommended|false|
 |Settings|`mode`|
-|Options|`arrayBrackets`, `enableFixer`, `genericDot`, `objectFieldIndent`, `objectFieldQuote`, `objectFieldSeparator`, `objectFieldSeparatorOptionalLinebreak`, `objectFieldSeparatorTrailingPunctuation`, `separatorForSingleObjectField`, `stringQuotes`, `typeBracketSpacing`, `unionSpacing`|
+|Options|`arrayBrackets`, `defaultValueSpacing`, `elementSpacing`, `enableFixer`, `genericDot`, `objectFieldIndent`, `objectFieldQuote`, `objectFieldSeparator`, `objectFieldSeparatorOptionalLinebreak`, `objectFieldSeparatorTrailingPunctuation`, `separatorForSingleObjectField`, `stringQuotes`, `typeBracketSpacing`, `unionSpacing`|
 
 <a name="user-content-type-formatting-failing-examples"></a>
 <a name="type-formatting-failing-examples"></a>
@@ -288,6 +300,24 @@ The following patterns are considered problems:
  */
 // "jsdoc/type-formatting": ["error"|"warn", {"objectFieldIndent":"  ","objectFieldSeparator":"semicolon-and-linebreak","objectFieldSeparatorOptionalLinebreak":true}]
 // Message: Inconsistent semicolon-and-linebreak separator usage
+
+/**
+ * @param {SomeType<T, U>} cfg
+ */
+// "jsdoc/type-formatting": ["error"|"warn", {"elementSpacing":""}]
+// Message: Element spacing should be ""
+
+/**
+ * @param {[string, number]} cfg
+ */
+// "jsdoc/type-formatting": ["error"|"warn", {"elementSpacing":""}]
+// Message: Element spacing should be ""
+
+/**
+ * @param {<T, U extends V = string, W = string>(x: T) => U} cfg
+ */
+// "jsdoc/type-formatting": ["error"|"warn", {"defaultValueSpacing":""}]
+// Message: Default value spacing should be ""
 ````
 
 
@@ -367,5 +397,20 @@ The following patterns are not considered problems:
  * }} cfg
  */
 // "jsdoc/type-formatting": ["error"|"warn", {"objectFieldIndent":"  ","objectFieldSeparator":"semicolon-and-linebreak","objectFieldSeparatorOptionalLinebreak":true}]
+
+/**
+ * @param {SomeType<T,U>} cfg
+ */
+// "jsdoc/type-formatting": ["error"|"warn", {"elementSpacing":""}]
+
+/**
+ * @param {[string,number]} cfg
+ */
+// "jsdoc/type-formatting": ["error"|"warn", {"elementSpacing":""}]
+
+/**
+ * @param {<T, U extends V=string, W=string>(x: T) => U} cfg
+ */
+// "jsdoc/type-formatting": ["error"|"warn", {"defaultValueSpacing":""}]
 ````
 

src/rules.d.ts

@@ -2947,6 +2947,14 @@ export interface Rules {
            * Determines how array generics are represented. Set to `angle` for the style `Array<type>` or `square` for the style `type[]`. Defaults to "square".
            */
           arrayBrackets?: "angle" | "square";
+          /**
+           * The space character (if any) to use between the equal signs of a default value
+           */
+          defaultValueSpacing?: string;
+          /**
+           * The space character (if any) to use between elements in generics and tuples
+           */
+          elementSpacing?: string;
           /**
            * Whether to enable the fixer. Defaults to `true`.
            */

src/rules/typeFormatting.js

@@ -17,6 +17,7 @@ export default iterateJsdoc(({
 }) => {
   const {
     arrayBrackets = 'square',
+    defaultValueSpacing = ' ',
     elementSpacing = ' ',
     enableFixer = true,
     genericDot = false,
@@ -318,6 +319,18 @@ export default iterateJsdoc(({
           break;
         }
 
+        case 'JsdocTypeTypeParameter': {
+          const typeNode = /** @type {import('jsdoc-type-pratt-parser').TypeParameterResult} */ (nde);
+          if (typeNode.defaultValue && (typeNode.meta?.defaultValueSpacing ?? ' ') !== defaultValueSpacing) {
+            typeNode.meta = {
+              defaultValueSpacing,
+            };
+            errorMessage = `Default value spacing should be "${defaultValueSpacing}"`;
+          }
+
+          break;
+        }
+
         case 'JsdocTypeUnion': {
           const typeNode = /** @type {import('jsdoc-type-pratt-parser').UnionResult} */ (nde);
           /* c8 ignore next -- Guard */
@@ -393,6 +406,10 @@ export default iterateJsdoc(({
             ],
             type: 'string',
           },
+          defaultValueSpacing: {
+            description: 'The space character (if any) to use between the equal signs of a default value',
+            type: 'string',
+          },
           elementSpacing: {
             description: 'The space character (if any) to use between elements in generics and tuples',
             type: 'string',

test/rules/assertions/typeFormatting.js

@@ -752,6 +752,33 @@ export default {
          */
       `,
     },
+    {
+      code: `
+        /**
+         * @param {<T, U extends V = string, W = string>(x: T) => U} cfg
+         */
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Default value spacing should be ""',
+        },
+        {
+          line: 3,
+          message: 'Default value spacing should be ""',
+        },
+      ],
+      options: [
+        {
+          defaultValueSpacing: '',
+        },
+      ],
+      output: `
+        /**
+         * @param {<T, U extends V=string, W=string>(x: T) => U} cfg
+         */
+      `,
+    },
   ],
   valid: [
     {
@@ -933,5 +960,41 @@ export default {
         },
       ],
     },
+    {
+      code: `
+        /**
+         * @param {SomeType<T,U>} cfg
+         */
+      `,
+      options: [
+        {
+          elementSpacing: '',
+        },
+      ],
+    },
+    {
+      code: `
+        /**
+         * @param {[string,number]} cfg
+         */
+      `,
+      options: [
+        {
+          elementSpacing: '',
+        },
+      ],
+    },
+    {
+      code: `
+        /**
+         * @param {<T, U extends V=string, W=string>(x: T) => U} cfg
+         */
+      `,
+      options: [
+        {
+          defaultValueSpacing: '',
+        },
+      ],
+    },
   ],
 };