Refactor code-style

*   Add support for `null` as input of API
*   Add more docs to JSDoc

Author: wooorm

lib/index.js

@@ -13,24 +13,26 @@
  * @typedef {import('estree-jsx').JSXNamespacedName} JSXNamespacedName
  * @typedef {import('estree-jsx').JSXIdentifier} JSXIdentifier
  *
+ * @typedef {'automatic' | 'classic'} Runtime
+ *
  * @typedef Options
- *   Configuration (optional).
+ *   Configuration.
  *
  *   > 👉 **Note**: you can also configure `runtime`, `importSource`, `pragma`,
  *   > and `pragmaFrag` from within files through comments.
- * @property {'automatic' | 'classic'} [runtime='classic']
+ * @property {Runtime | null | undefined} [runtime='classic']
  *   Choose the runtime.
  *
  *   Comment form: `@jsxRuntime theRuntime`.
- * @property {string} [importSource='react']
+ * @property {string | null | undefined} [importSource='react']
  *   Place to import `jsx`, `jsxs`, `jsxDEV`, and/or `Fragment` from, when the
  *   effective runtime is automatic.
  *
  *   Comment form: `@jsxImportSource theSource`.
  *
  *   > 👉 **Note**: `/jsx-runtime` or `/jsx-dev-runtime` is appended to this
  *   > provided source.
- *   > In CJS, that can resolve to a file, as in `theSource/jsx-runtime.js`,
+ *   > In CJS, that can resolve to a file (as in `theSource/jsx-runtime.js`),
  *   > but for ESM an export map needs to be set up to point to files:
  *   >
  *   > ```js
@@ -41,33 +43,50 @@
  *   >   "./jsx-dev-runtime": "./path/to/jsx-runtime.js"
  *   >   // …
  *   > ```
- * @property {string} [pragma='React.createElement']
+ * @property {string | null | undefined} [pragma='React.createElement']
  *   Identifier or member expression to call when the effective runtime is
  *   classic.
  *
  *   Comment form: `@jsx identifier`.
- * @property {string} [pragmaFrag='React.Fragment']
+ * @property {string | null | undefined} [pragmaFrag='React.Fragment']
  *   Identifier or member expression to use as a symbol for fragments when the
  *   effective runtime is classic.
  *
  *   Comment form: `@jsxFrag identifier`.
- * @property {boolean} [development=false]
+ * @property {boolean | null | undefined} [development=false]
  *   Import `jsxDEV` from `theSource/jsx-dev-runtime.js` and add location info
  *   on where a component originated from.
  *
  *   This helps debugging but adds a lot of code that you don’t want in
  *   production.
  *   Only used in the automatic runtime.
- * @property {string} [filePath]
+ * @property {string | null | undefined} [filePath]
  *   File path to the original source file.
+ *
  *   Used in the location info when using the automatic runtime with
  *   `development: true`.
  *
  * @typedef Annotations
- * @property {'automatic' | 'classic'} [jsxRuntime]
- * @property {string} [jsx]
- * @property {string} [jsxFrag]
- * @property {string} [jsxImportSource]
+ *   State where info from comments is gathered.
+ * @property {Runtime | undefined} [jsxRuntime]
+ *   Runtime.
+ * @property {string | undefined} [jsx]
+ *   JSX identifier (`pragma`).
+ * @property {string | undefined} [jsxFrag]
+ *   JSX identifier of fragment (`pragmaFrag`).
+ * @property {string | undefined} [jsxImportSource]
+ *   Where to import an automatic JSX runtime from.
+ *
+ * @typedef Imports
+ *   State of used identifiers from the automatic runtime.
+ * @property {boolean | undefined} [fragment]
+ *   Symbol of `Fragment`.
+ * @property {boolean | undefined} [jsx]
+ *   Symbol of `jsx`.
+ * @property {boolean | undefined} [jsxs]
+ *   Symbol of `jsxs`.
+ * @property {boolean | undefined} [jsxDEV]
+ *   Symbol of `jsxDEV`.
  */
 
 import {walk} from 'estree-walker'
@@ -79,6 +98,7 @@ const regex = /@(jsx|jsxFrag|jsxImportSource|jsxRuntime)\s+(\S+)/g
  * Turn JSX in `tree` into function calls: `<x />` -> `h('x')`!
  *
  * @template {Node} Tree
+ *   Node type.
  * @param {Tree} tree
  *   Tree to transform.
  * @param {Options} [options={}]
@@ -91,7 +111,7 @@ export function buildJsx(tree, options = {}) {
   let automatic = options.runtime === 'automatic'
   /** @type {Annotations} */
   const annotations = {}
-  /** @type {{fragment?: boolean, jsx?: boolean, jsxs?: boolean, jsxDEV?: boolean}} */
+  /** @type {Imports} */
   const imports = {}
 
   walk(tree, {
@@ -444,7 +464,6 @@ export function buildJsx(tree, options = {}) {
       parameters.unshift(name)
 
       // Types of `estree-walker` are wrong
-      // type-coverage:ignore-next-line
       this.replace(
         create(node, {
           type: 'CallExpression',

readme.md

@@ -156,7 +156,7 @@ Comment form: `@jsxImportSource theSource`.
 
 > 👉 **Note**: `/jsx-runtime` or `/jsx-dev-runtime` is appended to this provided
 > source.
-> In CJS, that can resolve to a file, as in `theSource/jsx-runtime.js`, but for
+> In CJS, that can resolve to a file (as in `theSource/jsx-runtime.js`), but for
 > ESM an export map needs to be set up to point to files:
 >
 > ```js