feat(types): Transform

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

src/index.ts

@@ -4,4 +4,5 @@
  */
 
 export type { Options } from './interfaces'
+export type { Transform } from './types'
 export { default as fromDocs } from './util'

src/interfaces/__tests__/options.spec-d.ts

@@ -3,8 +3,8 @@
  * @module docast-util-from-docs/interfaces/tests/unit-d/Options
  */
 
-import type { Root } from '@flex-development/docast'
-import type { Fn, Nilable, OneOrMany } from '@flex-development/tutils'
+import type { Transform } from '#src/types'
+import type { Nilable, OneOrMany } from '@flex-development/tutils'
 import type * as mdast from 'mdast-util-from-markdown'
 import type * as micromark from 'micromark-util-types'
 import type TestSubject from '../options'
@@ -28,9 +28,9 @@ describe('unit-d:interfaces/Options', () => {
       .toEqualTypeOf<Nilable<micromark.Extension[]>>()
   })
 
-  it('should match [transforms?: Nilable<Fn<[Root], void>[]>]', () => {
+  it('should match [transforms?: Nilable<Transform[]>]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('transforms')
-      .toEqualTypeOf<Nilable<Fn<[Root], void>[]>>()
+      .toEqualTypeOf<Nilable<Transform[]>>()
   })
 })

src/interfaces/options.ts

@@ -3,8 +3,8 @@
  * @module docast-util-from-docs/interfaces/Options
  */
 
-import type { Root } from '@flex-development/docast'
-import type { Fn, Nilable, OneOrMany } from '@flex-development/tutils'
+import type { Transform } from '#src/types'
+import type { Nilable, OneOrMany } from '@flex-development/tutils'
 import type { Code } from 'mdast'
 import type * as mdast from 'mdast-util-from-markdown'
 import type * as micromark from 'micromark-util-types'
@@ -41,9 +41,9 @@ interface Options {
   /**
    * Tree transforms.
    *
-   * @see {@linkcode Root}
+   * @see {@linkcode Transform}
    */
-  transforms?: Nilable<Fn<[tree: Root], void>[]>
+  transforms?: Nilable<Transform[]>
 }
 
 export type { Options as default }

src/parser.ts

@@ -31,7 +31,6 @@ import {
   template,
   trim,
   type Assign,
-  type Fn,
   type Nilable,
   type Optional
 } from '@flex-development/tutils'
@@ -64,7 +63,7 @@ import type { VFile } from 'vfile'
 import { TokenKind } from './enums'
 import type { Options, Token } from './interfaces'
 import Lexer from './lexer'
-import type { UncommentReplacer } from './types'
+import type { Transform, UncommentReplacer } from './types'
 
 declare module 'mdast' {
   interface BreakData {
@@ -1019,13 +1018,9 @@ class Parser {
     /**
      * Tree transforms.
      *
-     * @const {Fn<[Root], void>[]} transforms
+     * @const {Transform[]} transforms
      */
-    const transforms: Fn<[tree: Root], void>[] = fallback(
-      this.options.transforms,
-      [],
-      isNIL
-    )
+    const transforms: Transform[] = fallback(this.options.transforms, [], isNIL)
 
     /**
      * Dump paragraphs.

src/types/__tests__/transform.spec-d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Type Tests - Transform
+ * @module docast-util-from-docs/types/tests/unit-d/Transform
+ */
+
+import type { Root } from '@flex-development/docast'
+import type TestSubject from '../transform'
+
+describe('unit-d:types/Transform', () => {
+  it('should be callable with [Root]', () => {
+    expectTypeOf<TestSubject>().parameters.toEqualTypeOf<[Root]>()
+  })
+
+  it('should return void', () => {
+    expectTypeOf<TestSubject>().returns.toBeVoid()
+  })
+})

src/types/index.ts

@@ -3,4 +3,5 @@
  * @module docast-util-from-docs/types
  */
 
+export type { default as Transform } from './transform'
 export type { default as UncommentReplacer } from './uncomment-replacer'

src/types/transform.ts

@@ -0,0 +1,20 @@
+/**
+ * @file Type Definitions - Transform
+ * @module docast-util-from-docs/types/Transform
+ */
+
+import type { Root } from '@flex-development/docast'
+
+/**
+ * Transform the docblock syntax `tree`.
+ *
+ * @see {@linkcode Root}
+ *
+ * @this {void}
+ *
+ * @param {Root} tree - docast tree
+ * @return {void} Nothing
+ */
+type Transform = (this: void, tree: Root) => void
+
+export type { Transform as default }