feat(nodes): MultiLineComment

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

src/nodes/__tests__/comment-multi-line.spec-d.ts

@@ -0,0 +1,37 @@
+/**
+ * @file Type Tests - MultiLineComment
+ * @module esast/nodes/tests/unit-d/MultiLineComment
+ */
+
+import type { CommentData, Node } from '@flex-development/esast'
+import type { Optional } from '@flex-development/tutils'
+import type * as TestSubject from '../comment-multi-line'
+
+describe('unit-d:nodes/MultiLineComment', () => {
+  type Subject = TestSubject.default
+  type SubjectData = TestSubject.MultiLineCommentData
+
+  it('should extend Node', () => {
+    expectTypeOf<Subject>().toMatchTypeOf<Node>()
+  })
+
+  it('should match [data?: Optional<MultiLineCommentData>]', () => {
+    expectTypeOf<Subject>()
+      .toHaveProperty('data')
+      .toEqualTypeOf<Optional<SubjectData>>()
+  })
+
+  it('should match [multi: true]', () => {
+    expectTypeOf<Subject>().toHaveProperty('multi').toEqualTypeOf<true>()
+  })
+
+  it('should match [type: "comment"]', () => {
+    expectTypeOf<Subject>().toHaveProperty('type').toEqualTypeOf<'comment'>()
+  })
+
+  describe('MultiLineCommentData', () => {
+    it('should extend CommentData', () => {
+      expectTypeOf<SubjectData>().toMatchTypeOf<CommentData>()
+    })
+  })
+})

src/nodes/comment-multi-line.ts

@@ -0,0 +1,44 @@
+/**
+ * @file Nodes - MultiLineComment
+ * @module esast/nodes/MultiLineComment
+ */
+
+import type { CommentData, Node } from '@flex-development/esast'
+import type { Optional } from '@flex-development/tutils'
+
+/**
+ * Info associated with multi line comments.
+ *
+ * @see {@linkcode CommentData}
+ *
+ * @extends {CommentData}
+ */
+interface MultiLineCommentData extends CommentData {}
+
+/**
+ * A multi line comment.
+ *
+ * @see {@linkcode Node}
+ *
+ * @extends {Node}
+ */
+interface MultiLineComment extends Node {
+  /**
+   * Info from the ecosystem.
+   *
+   * @see {@linkcode MultiLineCommentData}
+   */
+  data?: Optional<MultiLineCommentData>
+
+  /**
+   * Multi line comment marker.
+   */
+  multi: true
+
+  /**
+   * Node type.
+   */
+  type: 'comment'
+}
+
+export type { MultiLineCommentData, MultiLineComment as default }

src/nodes/index.ts

@@ -8,6 +8,10 @@ export type {
   default as DocblockComment,
   DocblockCommentData
 } from './comment-docblock'
+export type {
+  default as MultiLineComment,
+  MultiLineCommentData
+} from './comment-multi-line'
 export type { default as Directive, DirectiveData } from './directive'
 export type { default as Identifier, IdentifierData } from './identifier'
 export type { default as DefaultIdentifier } from './identifier-default'