Refactor types

micromark · Apr 4, 2023 · 16e3fcb · 16e3fcb
1 parent e3075a5
commit 16e3fcb
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 12 deletions.
diff --git a/dev/lib/html.js b/dev/lib/html.js
@@ -1,6 +1,8 @@
 /**
  * @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
- *
+ */
+
+/**
  * @typedef Options
  *   Configuration (optional).
  * @property {string} [clobberPrefix='user-content-']
@@ -31,22 +33,26 @@ import {sanitizeUri} from 'micromark-util-sanitize-uri'
 
 const own = {}.hasOwnProperty
 
+/** @type {Options} */
+const defaultOptions = {}
+
 /**
  * Function that can be called to get an HTML extension for micromark (passed
  * in `htmlExtensions`).
  *
- * @param {Options} [options={}]
+ * @param {Options | null | undefined} [options]
  *   Configuration (optional).
  * @returns {HtmlExtension}
  *   HTML extension for micromark (passed in `htmlExtensions`).
  */
-export function gfmFootnoteHtml(options = {}) {
-  const label = options.label || 'Footnotes'
-  const backLabel = options.backLabel || 'Back to content'
+export function gfmFootnoteHtml(options) {
+  const config = options || defaultOptions
+  const label = config.label || 'Footnotes'
+  const backLabel = config.backLabel || 'Back to content'
   const clobberPrefix =
-    options.clobberPrefix === undefined || options.clobberPrefix === null
+    config.clobberPrefix === undefined || config.clobberPrefix === null
       ? 'user-content-'
-      : options.clobberPrefix
+      : config.clobberPrefix
   return {
     enter: {
       gfmFootnoteDefinition() {

diff --git a/dev/lib/syntax.js b/dev/lib/syntax.js
@@ -1,12 +1,12 @@
 /**
+ * @typedef {import('micromark-util-types').Event} Event
+ * @typedef {import('micromark-util-types').Exiter} Exiter
  * @typedef {import('micromark-util-types').Extension} Extension
  * @typedef {import('micromark-util-types').Resolver} Resolver
+ * @typedef {import('micromark-util-types').State} State
  * @typedef {import('micromark-util-types').Token} Token
  * @typedef {import('micromark-util-types').TokenizeContext} TokenizeContext
  * @typedef {import('micromark-util-types').Tokenizer} Tokenizer
- * @typedef {import('micromark-util-types').Exiter} Exiter
- * @typedef {import('micromark-util-types').State} State
- * @typedef {import('micromark-util-types').Event} Event
  */
 
 import {ok as assert} from 'uvu/assert'
@@ -113,7 +113,7 @@ function tokenizePotentialGfmFootnoteCall(effects, ok, nok) {
 /** @type {Resolver} */
 function resolveToPotentialGfmFootnoteCall(events, context) {
   let index = events.length
-  /** @type {Token|undefined} */
+  /** @type {Token | undefined} */
   let labelStart
 
   // Find an opening.
@@ -298,7 +298,7 @@ function tokenizeDefinitionStart(effects, ok, nok) {
   /** @type {string} */
   let identifier
   let size = 0
-  /** @type {boolean|undefined} */
+  /** @type {boolean | undefined} */
   let data
 
   return start