Update tsconfig.json

Author: wooorm

index.js

@@ -1,7 +1,7 @@
 /**
- * @typedef {import('./lib/index.js').XChild}} Child
+ * @typedef {import('./lib/index.js').XChild} Child
  *   Acceptable child value
- * @typedef {import('./lib/index.js').XAttributes}} Attributes
+ * @typedef {import('./lib/index.js').XAttributes} Attributes
  *   Acceptable attributes value.
  */
 

jsx-dev-runtime.js

@@ -13,7 +13,7 @@ export {Fragment} from './jsx-runtime.js'
 export const jsxDEV =
   /**
    * @type {{
-   *   (name: null|undefined, props: {children?: XChild}, ...unused: unknown[]): Root
+   *   (name: null | undefined, props: {children?: XChild}, ...unused: unknown[]): Root
    *   (name: string, props: JSXProps, ...unused: unknown[]): Element
    * }}
    */

lib/index.js

@@ -1,15 +1,18 @@
 /**
  * @typedef {import('xast').Root} Root
  * @typedef {import('xast').Element} Element
+ */
+
+/**
  * @typedef {Root['children'][number]} Child
- * @typedef {Child|Root} Node
- * @typedef {Root|Element} XResult
- * @typedef {string|number|boolean|null|undefined} XValue
+ * @typedef {Child | Root} Node
+ * @typedef {Root | Element} XResult
+ * @typedef {string | number | boolean | null | undefined} XValue
  * @typedef {{[attribute: string]: XValue}} XAttributes Attributes to support JS primitive types
  *
- * @typedef {string|number|null|undefined} XPrimitiveChild
- * @typedef {Array<Node|XPrimitiveChild>} XArrayChild
- * @typedef {Node|XPrimitiveChild|XArrayChild} XChild
+ * @typedef {string | number | null | undefined} XPrimitiveChild
+ * @typedef {Array<Node | XPrimitiveChild>} XArrayChild
+ * @typedef {Node | XPrimitiveChild | XArrayChild} XChild
  * @typedef {import('./jsx-classic.js').Element} x.JSX.Element
  * @typedef {import('./jsx-classic.js').IntrinsicAttributes} x.JSX.IntrinsicAttributes
  * @typedef {import('./jsx-classic.js').IntrinsicElements} x.JSX.IntrinsicElements
@@ -19,15 +22,15 @@
 /**
  * Create XML trees in xast.
  *
- * @param name Qualified name. Case sensitive and can contain a namespace prefix (such as `rdf:RDF`). Pass `null|undefined` to build a root.
+ * @param name Qualified name. Case sensitive and can contain a namespace prefix (such as `rdf:RDF`). Pass `null | undefined` to build a root.
  * @param attributes Map of attributes. Nullish (null or undefined) or NaN values are ignored, other values (strings, booleans) are cast to strings.
  * @param children (Lists of) child nodes. When strings are encountered, they are mapped to Text nodes.
  */
 export const x =
   /**
    * @type {{
    *   (): Root
-   *   (name: null|undefined, ...children: Array<XChild>): Root
+   *   (name: null | undefined, ...children: Array<XChild>): Root
    *   (name: string, attributes: XAttributes, ...children: Array<XChild>): Element
    *   (name: string, ...children: Array<XChild>): Element
    * }}
@@ -36,8 +39,8 @@ export const x =
     /**
      * Hyperscript compatible DSL for creating virtual xast trees.
      *
-     * @param {string|null} [name]
-     * @param {XAttributes|XChild} [attributes]
+     * @param {string | null} [name]
+     * @param {XAttributes | XChild} [attributes]
      * @param {Array<XChild>} children
      * @returns {XResult}
      */
@@ -112,7 +115,7 @@ function addChild(nodes, value) {
 }
 
 /**
- * @param {XAttributes|XChild} value
+ * @param {XAttributes | XChild} value
  * @returns {value is XAttributes}
  */
 function isAttributes(value) {

lib/runtime.js

@@ -6,7 +6,7 @@
  * @typedef {import('./index.js').XAttributes} XAttributes
  * @typedef {import('./index.js').XValue} XValue
  *
- * @typedef {{[x: string]: XValue|XChild}} JSXProps
+ * @typedef {{[x: string]: XValue | XChild}} JSXProps
  */
 
 import {x} from './index.js'
@@ -17,19 +17,19 @@ export * from './jsx-automatic.js'
 /**
  * Create XML trees in xast through JSX.
  *
- * @param name Qualified name. Case sensitive and can contain a namespace prefix (such as `rdf:RDF`). Pass `null|undefined` to build a root.
+ * @param name Qualified name. Case sensitive and can contain a namespace prefix (such as `rdf:RDF`). Pass `null | undefined` to build a root.
  * @param props Map of attributes. Nullish (null or undefined) or NaN values are ignored, other values (strings, booleans) are cast to strings. `children` can contain one child or a list of children. When strings are encountered, they are mapped to text nodes.
  */
 export const jsx =
   /**
    * @type {{
-   *   (name: null|undefined, props: {children?: XChild}, key?: string): Root
+   *   (name: null | undefined, props: {children?: XChild}, key?: string): Root
    *   (name: string, props: JSXProps, key?: string): Element
    * }}
    */
   (
     /**
-     * @param {string|null} name
+     * @param {string | null} name
      * @param {XAttributes & {children?: XChild}} props
      * @returns {XResult}
      */

package.json

@@ -59,7 +59,6 @@
     "prettier": "^2.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",
-    "rimraf": "^3.0.0",
     "tape": "^5.0.0",
     "tsd": "^0.25.0",
     "type-coverage": "^2.0.0",
@@ -69,11 +68,11 @@
   },
   "scripts": {
     "prepack": "npm run build && npm run format",
-    "build": "rimraf \"{script/**,test/**,}*.d.ts\" \"lib/{index,runtime}.d.ts\" && tsc && tsd && type-coverage",
-    "generate": "node script/generate-jsx",
+    "generate": "node script/generate-jsx.js",
+    "build": "tsc --build --clean && tsc --build && tsd && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "test-api": "node test/index.js",
-    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test/index.js",
+    "test-api": "node --conditions development test.js",
+    "test-coverage": "c8 --check-coverage --100 --reporter lcov npm run test-api",
     "test": "npm run generate && npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {

readme.md

@@ -215,7 +215,7 @@ When nullish, a [`Root`][root] is built instead.
 
 ###### `attributes`
 
-Map of attributes (`Record<string, string|number|boolean|null|undefined>`,
+Map of attributes (`Record<string, string | number | boolean | null | undefined>`,
 optional).
 Nullish (`null` or `undefined`) or `NaN` values are ignored, other values are
 turned to strings.

test/jsx.jsx

@@ -1,3 +1,5 @@
+/** @jsxImportSource xastscript */
+
 import test from 'tape'
 import {u} from 'unist-builder'
 import {x} from '../index.js'
@@ -9,6 +11,8 @@ test('name', (t) => {
 
   const A = 'a'
 
+  // Note: this file is a template, generated with different runtimes.
+  // @ts-ignore: TS (depending on this build) sometimes doesn’t understand.
   t.deepEqual(<A />, x(A), 'should support an uppercase tag name')
 
   t.deepEqual(
@@ -42,6 +46,8 @@ test('name', (t) => {
   const com = {acme: {a: 'A', b: 'B'}}
 
   t.deepEqual(
+    // Note: this file is a template, generated with different runtimes.
+    // @ts-ignore: TS (depending on this build) sometimes doesn’t understand.
     <com.acme.a />,
     x(com.acme.a),
     'should support members as names (`a.b`)'

tsconfig.json

@@ -1,24 +1,23 @@
 {
-  "include": [
-    "*.js",
-    "script/**/*.js",
-    "test/**/*.js",
-    "lib/index.js",
-    "lib/runtime.js",
-    "lib/jsx-automatic.d.ts",
-    "lib/jsx-classic.d.ts"
+  "include": ["**/**.js", "**/**.jsx"],
+  "exclude": [
+    "coverage/",
+    "node_modules/",
+    "lib/jsx-automatic.js",
+    "lib/jsx-classic.js"
   ],
   "compilerOptions": {
-    "target": "ES2020",
-    "lib": ["ES2020"],
-    "module": "Node16",
-    "allowJs": true,
     "checkJs": true,
     "declaration": true,
     "emitDeclarationOnly": true,
-    "allowSyntheticDefaultImports": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["es2020"],
+    "module": "node16",
+    "newLine": "lf",
     "skipLibCheck": true,
-    "strictNullChecks": true,
-    "strict": true
+    "strict": true,
+    "target": "es2020",
+    "jsx": "preserve"
   }
 }