feat(nodes): Directory, File, Parent, Root

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

Author: unicornware

src/nodes/__tests__/directory.spec-d.mts

@@ -0,0 +1,40 @@
+/**
+ * @file Type Tests - Directory
+ * @module fst/nodes/tests/unit-d/Directory
+ */
+
+import type * as TestSubject from '#nodes/directory'
+import type {
+  Data,
+  Parent
+} from '@flex-development/fst'
+import type { Optional } from '@flex-development/tutils'
+
+describe('unit-d:nodes/Directory', () => {
+  type Subject = TestSubject.default
+  type SubjectData = TestSubject.DirectoryData
+
+  it('should extend Parent', () => {
+    expectTypeOf<Subject>().toMatchTypeOf<Parent>()
+  })
+
+  it('should match [data?: DirectoryData | undefined]', () => {
+    expectTypeOf<Subject>()
+      .toHaveProperty('data')
+      .toEqualTypeOf<Optional<SubjectData>>()
+  })
+
+  it('should match [name: string]', () => {
+    expectTypeOf<Subject>().toHaveProperty('name').toEqualTypeOf<string>()
+  })
+
+  it('should match [type: "directory"]', () => {
+    expectTypeOf<Subject>().toHaveProperty('type').toEqualTypeOf<'directory'>()
+  })
+
+  describe('DirectoryData', () => {
+    it('should extend Data', () => {
+      expectTypeOf<SubjectData>().toMatchTypeOf<Data>()
+    })
+  })
+})

src/nodes/__tests__/file.spec-d.mts

@@ -0,0 +1,37 @@
+/**
+ * @file Type Tests - File
+ * @module fst/nodes/tests/unit-d/File
+ */
+
+import type * as TestSubject from '#nodes/file'
+import type { Data, Literal } from '@flex-development/fst'
+import type { Optional } from '@flex-development/tutils'
+
+describe('unit-d:nodes/File', () => {
+  type Subject = TestSubject.default
+  type SubjectData = TestSubject.FileData
+
+  it('should extend Literal', () => {
+    expectTypeOf<Subject>().toMatchTypeOf<Literal>()
+  })
+
+  it('should match [data?: FileData | undefined]', () => {
+    expectTypeOf<Subject>()
+      .toHaveProperty('data')
+      .toEqualTypeOf<Optional<SubjectData>>()
+  })
+
+  it('should match [name: string]', () => {
+    expectTypeOf<Subject>().toHaveProperty('name').toEqualTypeOf<string>()
+  })
+
+  it('should match [type: "file"]', () => {
+    expectTypeOf<Subject>().toHaveProperty('type').toEqualTypeOf<'file'>()
+  })
+
+  describe('FileData', () => {
+    it('should extend Data', () => {
+      expectTypeOf<SubjectData>().toMatchTypeOf<Data>()
+    })
+  })
+})

src/nodes/__tests__/parent.spec-d.mts

@@ -0,0 +1,19 @@
+/**
+ * @file Type Tests - Parent
+ * @module fst/nodes/tests/unit-d/Parent
+ */
+
+import type TestSubject from '#nodes/parent'
+import type { Child, Node } from '@flex-development/fst'
+
+describe('unit-d:nodes/Parent', () => {
+  it('should extend Node', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<Node>()
+  })
+
+  it('should match [children: Child[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('children')
+      .toEqualTypeOf<Child[]>()
+  })
+})

src/nodes/__tests__/root.spec-d.mts

@@ -0,0 +1,43 @@
+/**
+ * @file Type Tests - Root
+ * @module fst/nodes/tests/unit-d/Root
+ */
+
+import type * as TestSubject from '#nodes/root'
+import type { Data, Directory, File, Parent } from '@flex-development/fst'
+import type { Optional } from '@flex-development/tutils'
+
+describe('unit-d:nodes/Root', () => {
+  type Subject = TestSubject.default
+  type SubjectData = TestSubject.RootData
+
+  it('should extend Parent', () => {
+    expectTypeOf<Subject>().toMatchTypeOf<Parent>()
+  })
+
+  it('should match [children: (Directory | File)[]]', () => {
+    expectTypeOf<Subject>()
+      .toHaveProperty('children')
+      .toEqualTypeOf<(Directory | File)[]>()
+  })
+
+  it('should match [data?: RootData | undefined]', () => {
+    expectTypeOf<Subject>()
+      .toHaveProperty('data')
+      .toEqualTypeOf<Optional<SubjectData>>()
+  })
+
+  it('should match [path: string]', () => {
+    expectTypeOf<Subject>().toHaveProperty('path').toEqualTypeOf<string>()
+  })
+
+  it('should match [type: "root"]', () => {
+    expectTypeOf<Subject>().toHaveProperty('type').toEqualTypeOf<'root'>()
+  })
+
+  describe('RootData', () => {
+    it('should extend Data', () => {
+      expectTypeOf<SubjectData>().toMatchTypeOf<Data>()
+    })
+  })
+})

src/nodes/directory.mts

@@ -0,0 +1,53 @@
+/**
+ * @file Nodes - Directory
+ * @module fst/nodes/Directory
+ */
+
+import type { Data, File, Parent } from '@flex-development/fst'
+
+/**
+ * Info associated with directories.
+ *
+ * @see {@linkcode Data}
+ *
+ * @extends {Data}
+ */
+interface DirectoryData extends Data {}
+
+/**
+ * Node representing a directory.
+ *
+ * @see {@linkcode Parent}
+ *
+ * @extends {Parent}
+ */
+interface Directory extends Parent {
+  /**
+   * List of children.
+   *
+   * @see {@linkcode File}
+   */
+  children: (Directory | File)[]
+
+  /**
+   * Info from the ecosystem.
+   *
+   * @see {@linkcode DirectoryData}
+   */
+  data?: DirectoryData | undefined
+
+  /**
+   * Directory name (relative to parent).
+   *
+   * @example
+   *  'src'
+   */
+  name: string
+
+  /**
+   * Node type.
+   */
+  type: 'directory'
+}
+
+export type { Directory as default, DirectoryData }

src/nodes/file.mts

@@ -0,0 +1,53 @@
+/**
+ * @file Nodes - File
+ * @module fst/nodes/File
+ */
+
+import type { Data, Literal } from '@flex-development/fst'
+
+/**
+ * Info associated with files.
+ *
+ * @see {@linkcode Data}
+ *
+ * @extends {Data}
+ */
+interface FileData extends Data {}
+
+/**
+ * Node representing a file.
+ *
+ * @see {@linkcode Literal}
+ *
+ * @extends {Literal}
+ */
+interface File extends Literal {
+  /**
+   * Info from the ecosystem.
+   *
+   * @see {@linkcode FileData}
+   */
+  data?: FileData | undefined
+
+  /**
+   * File name (relative to parent).
+   *
+   * @example
+   *  'index.mts'
+   */
+  name: string
+
+  /**
+   * Node type.
+   */
+  type: 'file'
+
+  /**
+   * File contents.
+   *
+   * @override
+   */
+  value: string | null | undefined
+}
+
+export type { File as default, FileData }

src/nodes/index.mts

@@ -4,5 +4,9 @@
  * @see https://github.com/syntax-tree/unist#nodes
  */
 
+export type { default as Directory, DirectoryData } from '#nodes/directory'
+export type { default as File, FileData } from '#nodes/file'
 export type { default as Literal } from '#nodes/literal'
 export type { default as Node } from '#nodes/node'
+export type { default as Parent } from '#nodes/parent'
+export type { default as Root, RootData } from '#nodes/root'

src/nodes/parent.mts

@@ -0,0 +1,24 @@
+/**
+ * @file Nodes - Parent
+ * @module fst/nodes/Parent
+ */
+
+import type { Child, Node } from '@flex-development/fst'
+
+/**
+ * Abstract fst node that contains other fst nodes.
+ *
+ * @see {@linkcode Node}
+ *
+ * @extends {Node}
+ */
+interface Parent extends Node {
+  /**
+   * List of children.
+   *
+   * @see {@linkcode Child}
+   */
+  children: Child[]
+}
+
+export type { Parent as default }

src/nodes/root.mts

@@ -0,0 +1,55 @@
+/**
+ * @file Nodes - Root
+ * @module fst/nodes/Root
+ */
+
+import type {
+  Directory,
+  DirectoryData,
+  File,
+  Parent
+} from '@flex-development/fst'
+
+/**
+ * Info associated with file system roots.
+ *
+ * @see {@linkcode DirectoryData}
+ *
+ * @extends {DirectoryData}
+ */
+interface RootData extends DirectoryData {}
+
+/**
+ * Node representing the root of a file system.
+ *
+ * @see {@linkcode Parent}
+ *
+ * @extends {Parent}
+ */
+interface Root extends Parent {
+  /**
+   * List of children.
+   *
+   * @see {@linkcode Directory}
+   * @see {@linkcode File}
+   */
+  children: (Directory | File)[]
+
+  /**
+   * Info from the ecosystem.
+   *
+   * @see {@linkcode RootData}
+   */
+  data?: RootData | undefined
+
+  /**
+   * Path to root directory.
+   */
+  path: string
+
+  /**
+   * Node type.
+   */
+  type: 'root'
+}
+export type { Root as default, RootData }