Refactor types

remarkjs · May 16, 2023 · db9755f · db9755f
1 parent 0beb67b
commit db9755f
Show file tree

Hide file tree

Showing 41 changed files with 234 additions and 89 deletions.
diff --git a/packages/remark-lint-blockquote-indentation/index.js b/packages/remark-lint-blockquote-indentation/index.js
@@ -79,9 +79,13 @@
  */
 
 /**
- * @typedef {import('mdast').Root} Root
  * @typedef {import('mdast').Blockquote} Blockquote
- * @typedef {'consistent'|number} Options
+ * @typedef {import('mdast').Root} Root
+ */
+
+/**
+ * @typedef {'consistent' | number} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-checkbox-character-style/index.js b/packages/remark-lint-checkbox-character-style/index.js
@@ -89,12 +89,18 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- *
+ */
+
+/**
  * @typedef Styles
- * @property {'x'|'X'|'consistent'} [checked='consistent']
- * @property {' '|'\x09'|'consistent'} [unchecked='consistent']
- *
- * @typedef {'consistent'|Styles} Options
+ *   Styles.
+ * @property {'x' | 'X' | 'consistent'} [checked='consistent']
+ *   Preferred style to use for checked checkboxes (default: `'consistent'`).
+ * @property {' ' | '\t' | 'consistent'} [unchecked='consistent']
+ *   Preferred style to use for unchecked checkboxes (default: `'consistent'`).
+ *
+ * @typedef {'consistent' | Styles} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'
@@ -109,9 +115,9 @@ const remarkLintCheckboxCharacterStyle = lintRule(
   /** @type {import('unified-lint-rule').Rule<Root, Options>} */
   (tree, file, option = 'consistent') => {
     const value = String(file)
-    /** @type {'x'|'X'|'consistent'} */
+    /** @type {'x' | 'X' | 'consistent'} */
     let checked = 'consistent'
-    /** @type {' '|'\x09'|'consistent'} */
+    /** @type {' ' | '\x09' | 'consistent'} */
     let unchecked = 'consistent'
 
     if (typeof option === 'object') {

diff --git a/packages/remark-lint-code-block-style/index.js b/packages/remark-lint-code-block-style/index.js
@@ -128,8 +128,13 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {'fenced'|'indented'} Style
- * @typedef {'consistent'|Style} Options
+ */
+
+/**
+ * @typedef {'fenced' | 'indented'} Style
+ *   Styles.
+ * @typedef {'consistent' | Style} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-emphasis-marker/index.js b/packages/remark-lint-emphasis-marker/index.js
@@ -88,8 +88,13 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {'*'|'_'} Marker
- * @typedef {'consistent'|Marker} Options
+ */
+
+/**
+ * @typedef {'*' | '_'} Marker
+ *   Styles.
+ * @typedef {'consistent' | Marker} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-fenced-code-flag/index.js b/packages/remark-lint-fenced-code-flag/index.js
@@ -97,14 +97,21 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- *
+ */
+
+/**
  * @typedef {Array<string>} Flags
+ *   Language flags.
  *
  * @typedef FlagMap
+ *   Configuration.
  * @property {Flags} [flags]
+ *   Language flags.
  * @property {boolean} [allowEmpty=false]
+ *   Allow language flags to be omitted (default: `false`).
  *
- * @typedef {Flags|FlagMap} Options
+ * @typedef {Flags | FlagMap} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-fenced-code-marker/index.js b/packages/remark-lint-fenced-code-marker/index.js
@@ -102,8 +102,13 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {'~'|'`'} Marker
- * @typedef {'consistent'|Marker} Options
+ */
+
+/**
+ * @typedef {'~' | '`'} Marker
+ *   Styles.
+ * @typedef {'consistent' | Marker} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-file-extension/index.js b/packages/remark-lint-file-extension/index.js
@@ -43,7 +43,11 @@
 
 /**
  * @typedef {import('mdast').Root} Root
+ */
+
+/**
  * @typedef {string} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-first-heading-level/index.js b/packages/remark-lint-first-heading-level/index.js
@@ -107,10 +107,16 @@
  */
 
 /**
- * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Heading} Heading
  * @typedef {import('mdast').HTML} HTML
- * @typedef {import('mdast').Heading['depth']} Depth
+ * @typedef {import('mdast').Root} Root
+ */
+
+/**
+ * @typedef {Heading['depth']} Depth
+ *   Styles.
  * @typedef {Depth} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'
@@ -128,7 +134,7 @@ const remarkLintFirstHeadingLevel = lintRule(
   (tree, file, option = 1) => {
     visit(tree, (node) => {
       if (!generated(node)) {
-        /** @type {Depth|undefined} */
+        /** @type {Depth | undefined} */
         let rank
 
         if (node.type === 'heading') {
@@ -153,10 +159,10 @@ export default remarkLintFirstHeadingLevel
 
 /**
  * @param {HTML} node
- * @returns {Depth|undefined}
+ * @returns {Depth | undefined}
  */
 function infer(node) {
   const results = node.value.match(re)
-  // @ts-expect-error: can be castes fine.
+  // @ts-expect-error: can be casted fine.
   return results ? Number(results[1]) : undefined
 }
diff --git a/packages/remark-lint-heading-increment/index.js b/packages/remark-lint-heading-increment/index.js
@@ -46,8 +46,12 @@
  */
 
 /**
+ * @typedef {import('mdast').Heading} Heading
  * @typedef {import('mdast').Root} Root
- * @typedef {import('mdast').Heading['depth']} Depth
+ */
+
+/**
+ * @typedef {Heading['depth']} Depth
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-heading-style/index.js b/packages/remark-lint-heading-style/index.js
@@ -114,8 +114,13 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {'atx'|'atx-closed'|'setext'} Type
- * @typedef {'consistent'|Type} Options
+ */
+
+/**
+ * @typedef {'atx' | 'atx-closed' | 'setext'} Type
+ *   Styles.
+ * @typedef {'consistent' | Type} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-linebreak-style/index.js b/packages/remark-lint-linebreak-style/index.js
@@ -67,8 +67,13 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {'unix'|'windows'} Type
- * @typedef {'consistent'|Type} Options
+ */
+
+/**
+ * @typedef {'unix' | 'windows'} Type
+ *   Styles.
+ * @typedef {'consistent' | Type} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-link-title-style/index.js b/packages/remark-lint-link-title-style/index.js
@@ -123,8 +123,13 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {'"'|"'"|'()'} Marker
- * @typedef {'consistent'|Marker} Options
+ */
+
+/**
+ * @typedef {'"' | '\'' | '()'} Marker
+ *   Styles.
+ * @typedef {'consistent' | Marker} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-list-item-content-indent/index.js b/packages/remark-lint-list-item-content-indent/index.js
@@ -61,7 +61,7 @@ const remarkLintListItemContentIndent = lintRule(
 
     visit(tree, 'listItem', (node) => {
       let index = -1
-      /** @type {number|undefined} */
+      /** @type {number | undefined} */
       let style
 
       while (++index < node.children.length) {

diff --git a/packages/remark-lint-list-item-indent/index.js b/packages/remark-lint-list-item-indent/index.js
@@ -152,7 +152,11 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {'tab-size'|'space'|'mixed'} Options
+ */
+
+/**
+ * @typedef {'tab-size' | 'space' | 'mixed'} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-list-item-spacing/index.js b/packages/remark-lint-list-item-spacing/index.js
@@ -136,7 +136,9 @@
  * @typedef {import('mdast').ListItem} ListItem
  *
  * @typedef Options
- * @property {boolean} [checkBlanks=false]
+ *   Options.
+ * @property {boolean | null | undefined} [checkBlanks=false]
+ *   Adhere to CommonMark looseness instead of markdown-style-guide preference.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-maximum-heading-length/index.js b/packages/remark-lint-maximum-heading-length/index.js
@@ -46,7 +46,11 @@
 
 /**
  * @typedef {import('mdast').Root} Root
+ */
+
+/**
  * @typedef {number} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-maximum-line-length/index.js b/packages/remark-lint-maximum-line-length/index.js
@@ -109,8 +109,11 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {import('mdast').Parent} Parent
+ */
+
+/**
  * @typedef {number} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'
@@ -160,9 +163,7 @@ const remarkLintMaximumLineLength = lintRule(
     // the wrap.
     // However, when they do, and there’s whitespace after it, they are not
     // allowed.
-    visit(tree, (node, pos, parent_) => {
-      const parent = /** @type {Parent} */ (parent_)
-
+    visit(tree, (node, pos, parent) => {
       if (
         (node.type === 'link' ||
           node.type === 'image' ||

diff --git a/packages/remark-lint-no-consecutive-blank-lines/index.js b/packages/remark-lint-no-consecutive-blank-lines/index.js
@@ -113,7 +113,7 @@ const remarkLintNoConsecutiveBlankLines = lintRule(
      *
      * @param {Point} start
      * @param {Point} end
-     * @param {0|1|2} max
+     * @param {0 | 1 | 2} max
      */
     function compare(start, end, max) {
       const diff = end.line - start.line

diff --git a/packages/remark-lint-no-duplicate-headings-in-section/index.js b/packages/remark-lint-no-duplicate-headings-in-section/index.js
@@ -73,8 +73,8 @@
  */
 
 /**
- * @typedef {import('mdast').Root} Root
  * @typedef {import('mdast').Heading} Heading
+ * @typedef {import('mdast').Root} Root
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-no-file-name-irregular-characters/index.js b/packages/remark-lint-no-file-name-irregular-characters/index.js
@@ -43,8 +43,11 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- *
- * @typedef {RegExp|string} Options
+ */
+
+/**
+ * @typedef {RegExp | string} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-no-heading-punctuation/index.js b/packages/remark-lint-no-heading-punctuation/index.js
@@ -54,7 +54,11 @@
 
 /**
  * @typedef {import('mdast').Root} Root
+ */
+
+/**
  * @typedef {string} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-no-missing-blank-lines/index.js b/packages/remark-lint-no-missing-blank-lines/index.js
@@ -78,9 +78,13 @@
 
 /**
  * @typedef {import('mdast').Root} Root
- *
+ */
+
+/**
  * @typedef Options
- * @property {boolean} [exceptTightLists=false]
+ *   Options.
+ * @property {boolean | null | undefined} [exceptTightLists=false]
+ *   Allow tight list items.
  */
 
 import {lintRule} from 'unified-lint-rule'

diff --git a/packages/remark-lint-no-multiple-toplevel-headings/index.js b/packages/remark-lint-no-multiple-toplevel-headings/index.js
@@ -45,7 +45,11 @@
 /**
  * @typedef {import('mdast').Root} Root
  * @typedef {import('mdast').Heading} Heading
+ */
+
+/**
  * @typedef {Heading['depth']} Options
+ *   Options.
  */
 
 import {lintRule} from 'unified-lint-rule'
@@ -61,7 +65,7 @@ const remarkLintNoMultipleToplevelHeadings = lintRule(
   },
   /** @type {import('unified-lint-rule').Rule<Root, Options>} */
   (tree, file, option = 1) => {
-    /** @type {string|undefined} */
+    /** @type {string | undefined} */
     let duplicate
 
     visit(tree, 'heading', (node) => {