feat: [docmark-util-symbol] constants

unicornware · unicornware · commit bcb49ef2e784 · 2026-02-15T23:42:42.000-05:00
Signed-off-by: Lexus Drumgold &lt;unicornware@flexdevelopment.llc&gt;
diff --git a/.codecov.yml b/.codecov.yml
@@ -139,7 +139,7 @@ ignore:
   - '**/index.mts'
   - '**/interfaces/**'
   - '**/types/**'
-  - '!src/index.mts'
+  - '!packages/*/src/index.mts'
 
 profiling:
   critical_files_paths: []
diff --git a/build/plugins/dts.mts b/build/plugins/dts.mts
diff --git a/packages/docmark-util-symbol/package.json b/packages/docmark-util-symbol/package.json
@@ -48,11 +48,15 @@
     },
     "./package.json": "./package.json"
   },
+  "imports": {
+    "#lib/*": "./src/*.mts"
+  },
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
   "devDependencies": {
     "@flex-development/docmark-util-types": "workspace:*",
-    "@flex-development/unist-util-types": "1.6.1"
+    "@flex-development/unist-util-types": "1.6.1",
+    "micromark-util-symbol": "2.0.1"
   },
   "sideEffects": false
 }
diff --git a/packages/docmark-util-symbol/src/__snapshots__/happy-dom/constants.snap b/packages/docmark-util-symbol/src/__snapshots__/happy-dom/constants.snap
@@ -0,0 +1,40 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`unit:constants > should be readonly record of constant values 1`] = `
+{
+  "attentionSideAfter": 2,
+  "attentionSideBefore": 1,
+  "atxHeadingOpeningFenceSizeMax": 6,
+  "autolinkDomainSizeMax": 63,
+  "autolinkSchemeSizeMax": 32,
+  "cdataOpeningString": "CDATA[",
+  "characterGroupPunctuation": 2,
+  "characterGroupWhitespace": 1,
+  "characterReferenceDecimalSizeMax": 7,
+  "characterReferenceHexadecimalSizeMax": 6,
+  "characterReferenceNamedSizeMax": 31,
+  "codeFencedSequenceSizeMin": 3,
+  "contentTypeContent": "content",
+  "contentTypeDocument": "document",
+  "contentTypeFlow": "flow",
+  "contentTypeString": "string",
+  "contentTypeText": "text",
+  "hardBreakPrefixSizeMin": 2,
+  "htmlBasic": 6,
+  "htmlCdata": 5,
+  "htmlComment": 2,
+  "htmlComplete": 7,
+  "htmlDeclaration": 4,
+  "htmlInstruction": 3,
+  "htmlRaw": 1,
+  "htmlRawSizeMax": 8,
+  "linkReferenceSizeMax": 999,
+  "linkResourceDestinationBalanceMax": 32,
+  "listItemValueSizeMax": 10,
+  "numericBaseDecimal": 10,
+  "numericBaseHexadecimal": 16,
+  "tabSize": 4,
+  "thematicBreakMarkerCountMin": 3,
+  "v8MaxSafeChunkSize": 10000,
+}
+`;
diff --git a/packages/docmark-util-symbol/src/__snapshots__/happy-dom/index.e2e.snap b/packages/docmark-util-symbol/src/__snapshots__/happy-dom/index.e2e.snap
@@ -1,3 +1,7 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`e2e:docmark-util-symbol > should expose public api 1`] = `[]`;
+exports[`e2e:docmark-util-symbol > should expose public api 1`] = `
+[
+  "constants",
+]
+`;
diff --git a/packages/docmark-util-symbol/src/__snapshots__/node/constants.snap b/packages/docmark-util-symbol/src/__snapshots__/node/constants.snap
@@ -0,0 +1,40 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`unit:constants > should be readonly record of constant values 1`] = `
+{
+  "attentionSideAfter": 2,
+  "attentionSideBefore": 1,
+  "atxHeadingOpeningFenceSizeMax": 6,
+  "autolinkDomainSizeMax": 63,
+  "autolinkSchemeSizeMax": 32,
+  "cdataOpeningString": "CDATA[",
+  "characterGroupPunctuation": 2,
+  "characterGroupWhitespace": 1,
+  "characterReferenceDecimalSizeMax": 7,
+  "characterReferenceHexadecimalSizeMax": 6,
+  "characterReferenceNamedSizeMax": 31,
+  "codeFencedSequenceSizeMin": 3,
+  "contentTypeContent": "content",
+  "contentTypeDocument": "document",
+  "contentTypeFlow": "flow",
+  "contentTypeString": "string",
+  "contentTypeText": "text",
+  "hardBreakPrefixSizeMin": 2,
+  "htmlBasic": 6,
+  "htmlCdata": 5,
+  "htmlComment": 2,
+  "htmlComplete": 7,
+  "htmlDeclaration": 4,
+  "htmlInstruction": 3,
+  "htmlRaw": 1,
+  "htmlRawSizeMax": 8,
+  "linkReferenceSizeMax": 999,
+  "linkResourceDestinationBalanceMax": 32,
+  "listItemValueSizeMax": 10,
+  "numericBaseDecimal": 10,
+  "numericBaseHexadecimal": 16,
+  "tabSize": 4,
+  "thematicBreakMarkerCountMin": 3,
+  "v8MaxSafeChunkSize": 10000,
+}
+`;
diff --git a/packages/docmark-util-symbol/src/__snapshots__/node/index.e2e.snap b/packages/docmark-util-symbol/src/__snapshots__/node/index.e2e.snap
@@ -1,3 +1,7 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`e2e:docmark-util-symbol > should expose public api 1`] = `[]`;
+exports[`e2e:docmark-util-symbol > should expose public api 1`] = `
+[
+  "constants",
+]
+`;
diff --git a/packages/docmark-util-symbol/src/__tests__/constants.spec.mts b/packages/docmark-util-symbol/src/__tests__/constants.spec.mts
@@ -0,0 +1,18 @@
+/**
+ * @file Unit Tests - constants
+ * @module docmark-util-symbol/tests/unit/constants
+ */
+
+import testSubject from '#lib/constants'
+import * as micromark from 'micromark-util-symbol'
+
+describe('unit:constants', () => {
+  it('should be readonly record of constant values', () => {
+    expect(testSubject).to.be.frozen
+    expect(testSubject).toMatchSnapshot()
+  })
+
+  it('should match micromark.constants', () => {
+    expect(testSubject).toMatchObject(micromark.constants)
+  })
+})
diff --git a/packages/docmark-util-symbol/src/constants.mts b/packages/docmark-util-symbol/src/constants.mts
@@ -0,0 +1,48 @@
+/**
+ * @file constants
+ * @module docmark-util-symbol/constants
+ */
+
+/**
+ * Constant values.
+ *
+ * @enum {number | string}
+ */
+const constants = Object.freeze({
+  attentionSideAfter: 2,
+  attentionSideBefore: 1,
+  atxHeadingOpeningFenceSizeMax: 6,
+  autolinkDomainSizeMax: 63,
+  autolinkSchemeSizeMax: 32,
+  cdataOpeningString: 'CDATA[',
+  characterGroupPunctuation: 2,
+  characterGroupWhitespace: 1,
+  characterReferenceDecimalSizeMax: 7,
+  characterReferenceHexadecimalSizeMax: 6,
+  characterReferenceNamedSizeMax: 31,
+  codeFencedSequenceSizeMin: 3,
+  contentTypeContent: 'content',
+  contentTypeDocument: 'document',
+  contentTypeFlow: 'flow',
+  contentTypeString: 'string',
+  contentTypeText: 'text',
+  hardBreakPrefixSizeMin: 2,
+  htmlBasic: 6,
+  htmlCdata: 5,
+  htmlComment: 2,
+  htmlComplete: 7,
+  htmlDeclaration: 4,
+  htmlInstruction: 3,
+  htmlRaw: 1,
+  htmlRawSizeMax: 8,
+  linkReferenceSizeMax: 999,
+  linkResourceDestinationBalanceMax: 32,
+  listItemValueSizeMax: 10,
+  numericBaseDecimal: 10,
+  numericBaseHexadecimal: 0x10,
+  tabSize: 4,
+  thematicBreakMarkerCountMin: 3,
+  v8MaxSafeChunkSize: 10_000
+} as const)
+
+export default constants
diff --git a/packages/docmark-util-symbol/src/index.mts b/packages/docmark-util-symbol/src/index.mts
@@ -3,4 +3,4 @@
  * @module docmark-util-symbol
  */
 
-export {}
+export { default as constants } from '#lib/constants'
diff --git a/rollup.config.mts b/rollup.config.mts
@@ -3,11 +3,17 @@
  * @module config/rollup
  */
 
-import dts from '#build/plugins/dts'
 import listWorkspaces from '#utils/list-workspaces'
 import pathe from '@flex-development/pathe'
+import resolve from '@rollup/plugin-node-resolve'
 import type { Dirent } from 'node:fs'
-import type { RollupOptions } from 'rollup'
+import type {
+  NormalizedOutputOptions,
+  OutputBundle,
+  PluginContext,
+  RollupOptions
+} from 'rollup'
+import { dts } from 'rollup-plugin-dts'
 
 /**
  * The rollup configuration.
@@ -41,6 +47,55 @@ export default listWorkspaces().map((
     }),
     input: file,
     output: [{ file, format: 'esm' }],
-    plugins: [dts()]
+    plugins: [
+      resolve({ extensions: ['.d.mts', '.mts'] }),
+      dts({
+        includeExternal: workspace.name === 'docmark-util-types'
+          ? ['@flex-development/fsm-tokenizer']
+          : []
+      }),
+      {
+        /**
+         * Re-add lost `type` modifiers.
+         *
+         * @see https://github.com/Swatinem/rollup-plugin-dts/issues/354
+         *
+         * @this {PluginContext}
+         *
+         * @param {NormalizedOutputOptions} options
+         *  The normalized output options
+         * @param {OutputBundle} bundle
+         *  The output bundle object
+         * @return {undefined}
+         */
+        generateBundle(
+          this: PluginContext,
+          options: NormalizedOutputOptions,
+          bundle: OutputBundle
+        ): undefined {
+          for (const output of Object.values(bundle)) {
+            if (output.type === 'chunk') {
+              output.code = output.code
+                .replaceAll('import *', 'import type *')
+                .replaceAll('import {', 'import type {')
+
+              if (workspace.name === 'docmark-util-types') {
+                output.code = output.code.replaceAll(
+                  'export {',
+                  'export type {'
+                )
+              }
+            }
+          }
+
+          return void this
+        },
+
+        /**
+         * The plugin name.
+         */
+        name: 'build:dts'
+      }
+    ]
   }
 })
diff --git a/vitest.config.mts b/vitest.config.mts
@@ -5,7 +5,6 @@
  */
 
 import Notifier from '#tests/reporters/notifier'
-import VerboseReporter from '#tests/reporters/verbose'
 import listWorkspaces from '#utils/list-workspaces'
 import pathe from '@flex-development/pathe'
 import { ok } from 'devlop'
@@ -138,15 +137,15 @@ function config(this: void, env: ConfigEnv): ViteUserConfig {
         })
       }),
       reporters: JSON.parse(process.env['VITEST_UI'] ?? '0')
-        ? [new Notifier(), new VerboseReporter()]
+        ? [new Notifier(), ['tree']]
         : env.mode === 'reports'
-        ? [new VerboseReporter()]
+        ? [['tree']]
         : [
           ci ? 'github-actions' : new Notifier(),
           'blob',
           'json',
           ['junit', { suiteName: pkg.name }],
-          new VerboseReporter()
+          ['tree']
         ],
       /**
        * Store snapshots next to the directory of `file`.
diff --git a/yarn.lock b/yarn.lock
