feat(nodes): Literal, Node

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

Author: unicornware

.commitlintrc.ts

@@ -18,7 +18,7 @@ import { scopes } from '@flex-development/commitlint-config'
 const config: UserConfig = {
   extends: ['@flex-development'],
   rules: {
-    'scope-enum': [Severity.Error, 'always', scopes(['chore'])]
+    'scope-enum': [Severity.Error, 'always', scopes(['chore', 'nodes', 'spec'])]
   }
 }
 

package.json

@@ -47,6 +47,11 @@
     "./package.json": "./package.json"
   },
   "imports": {
+    "#interfaces/*": {
+      "fst": "./src/interfaces/*.mts",
+      "types": "./dist/interfaces/*.d.mts",
+      "default": "./dist/interfaces/*.d.mts"
+    },
     "#nodes/*": {
       "fst": "./src/nodes/*.mts",
       "types": "./dist/nodes/*.d.mts",

src/__tests__/fst.spec-d.mts

@@ -3,5 +3,6 @@
  * @module fst
  */
 
+export type * from '#interfaces/index'
 export type * from '#nodes/index'
 export type * from '#types/index'

src/index.mts

@@ -0,0 +1,13 @@
+/**
+ * @file Type Tests - Data
+ * @module fst/interfaces/tests/unit-d/Data
+ */
+
+import type TestSubject from '#interfaces/data'
+import type unist from 'unist'
+
+describe('unit-d:interfaces/Data', () => {
+  it('should extend unist.Data', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<unist.Data>()
+  })
+})

src/interfaces/__tests__/data.spec-d.mts

@@ -0,0 +1,26 @@
+/**
+ * @file Interfaces - Data
+ * @module fst/interfaces/Data
+ */
+
+import type unist from 'unist'
+
+/**
+ * Info associated with fst nodes.
+ *
+ * This space is guaranteed to never be specified by unist or fst, but it
+ * can be used in utilities and plugins to store custom data.
+ *
+ * @example
+ *  declare module '@flex-development/fst' {
+ *    interface Data {
+ *      // `node.data.url` is typed as `string | undefined`
+ *      url?: string | undefined
+ *    }
+ *  }
+ *
+ * @extends {unist.Data}
+ */
+interface Data extends unist.Data {}
+
+export type { Data as default }

src/interfaces/data.mts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Interfaces
+ * @module fst/interfaces
+ */
+
+export type { default as Data } from '#interfaces/data'

src/interfaces/index.mts

@@ -0,0 +1,20 @@
+/**
+ * @file Type Tests - Literal
+ * @module fst/nodes/tests/unit-d/Literal
+ */
+
+import type TestSubject from '#nodes/literal'
+import type { Node } from '@flex-development/fst'
+import type { Nilable } from '@flex-development/tutils'
+
+describe('unit-d:nodes/Literal', () => {
+  it('should extend Node', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<Node>()
+  })
+
+  it('should match [value: string | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('value')
+      .toEqualTypeOf<Nilable<string>>()
+  })
+})

src/nodes/__tests__/.gitkeep

@@ -0,0 +1,21 @@
+/**
+ * @file Type Tests - Node
+ * @module fst/nodes/tests/unit-d/Node
+ */
+
+import type TestSubject from '#nodes/node'
+import type { Data } from '@flex-development/fst'
+import type { Optional } from '@flex-development/tutils'
+import type unist from 'unist'
+
+describe('unit-d:nodes/Node', () => {
+  it('should extend unist.Node', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<unist.Node>()
+  })
+
+  it('should match [data?: Data | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('data')
+      .toEqualTypeOf<Optional<Data>>()
+  })
+})