feat(attacher): attacher

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

Author: unicornware

src/__snapshots__/parser.functional.snap renamed to src/__snapshots__/attacher.functional.snap

@@ -1,6 +1,6 @@
 // Vitest Snapshot v1
 
-exports[`functional:parser > should create ast for abstract class declaration 1`] = `
+exports[`functional:attacher > should create ast for abstract class declaration 1`] = `
 root[6]
 ├─0 comment[2] (1:1-4:4, 0-61)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - Person\\n * @module fixtures/Person\\n */"}
@@ -52,7 +52,7 @@ exports[`functional:parser > should create ast for abstract class declaration 1`
           data: {"tag":"@return","text":"{string} String representation of \`this\`","value":"@return {string} String representation of \`this\`"}
 `;
 
-exports[`functional:parser > should create ast for async function declaration 1`] = `
+exports[`functional:attacher > should create ast for async function declaration 1`] = `
 root[7]
 ├─0 comment[3] (1:1-5:4, 0-126)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - dblLinear\\n * @module fixtures/dblLinear\\n * @see https://codewars.com/kata/5672682212c8ecf83e000050\\n */"}
@@ -106,7 +106,7 @@ exports[`functional:parser > should create ast for async function declaration 1`
           data: {"tag":"@const","text":"{number} z - \`z\`","value":"@const {number} z - \`z\`"}
 `;
 
-exports[`functional:parser > should create ast for async function* declaration 1`] = `
+exports[`functional:attacher > should create ast for async function* declaration 1`] = `
 root[4]
 ├─0 comment[2] (1:1-4:4, 0-67)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - fibonacci\\n * @module fixtures/fibonacci\\n */"}
@@ -144,7 +144,7 @@ exports[`functional:parser > should create ast for async function* declaration 1
           data: {"tag":"@var","text":"{IteratorResult<number, number>} curr - Current sequence value","value":"@var {IteratorResult<number, number>} curr - Current sequence value"}
 `;
 
-exports[`functional:parser > should create ast for class declaration 1`] = `
+exports[`functional:attacher > should create ast for class declaration 1`] = `
 root[9]
 ├─0 comment[3] (1:1-5:4, 0-142)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - FibonacciSequence\\n * @module fixtures/FibonacciSequence\\n * @see https://codewars.com/kata/55695bc4f75bbaea5100016b\\n */"}
@@ -216,7 +216,7 @@ exports[`functional:parser > should create ast for class declaration 1`] = `
           data: {"tag":"@const","text":"{number} value - Temporary sequence value","value":"@const {number} value - Temporary sequence value"}
 `;
 
-exports[`functional:parser > should create ast for const enum declaration 1`] = `
+exports[`functional:attacher > should create ast for const enum declaration 1`] = `
 root[2]
 ├─0 comment[2] (1:1-4:4, 0-65)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - LogLevel\\n * @module fixtures/LogLevel\\n */"}
@@ -232,7 +232,7 @@ exports[`functional:parser > should create ast for const enum declaration 1`] =
           data: {"tag":"@enum","text":"{number}","value":"@enum {number}"}
 `;
 
-exports[`functional:parser > should create ast for default function declaration 1`] = `
+exports[`functional:attacher > should create ast for default function declaration 1`] = `
 root[4]
 ├─0 comment[3] (1:1-5:4, 0-136)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - sumOfIntervals\\n * @module fixtures/sumOfIntervals\\n * @see https://codewars.com/kata/52b7ed099cdc285c300001cd\\n */"}
@@ -268,7 +268,7 @@ exports[`functional:parser > should create ast for default function declaration
           data: {"tag":"@const","text":"{[number, number] | undefined} prev - Previous interval","value":"@const {[number, number] | undefined} prev - Previous interval"}
 `;
 
-exports[`functional:parser > should create ast for default variable declaration 1`] = `
+exports[`functional:attacher > should create ast for default variable declaration 1`] = `
 root[5]
 ├─0 comment[3] (1:1-5:4, 0-136)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - miniStringFuck\\n * @module fixtures/miniStringFuck\\n * @see https://codewars.com/kata/586dd26a69b6fd46dd0000c0\\n */"}
@@ -300,7 +300,7 @@ exports[`functional:parser > should create ast for default variable declaration
           data: {"tag":"@var","text":"{string} output - Program output","value":"@var {string} output - Program output"}
 `;
 
-exports[`functional:parser > should create ast for enum declaration 1`] = `
+exports[`functional:attacher > should create ast for enum declaration 1`] = `
 root[6]
 ├─0 comment[2] (1:1-4:4, 0-53)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - Op\\n * @module fixtures/Op\\n */"}
@@ -332,7 +332,7 @@ exports[`functional:parser > should create ast for enum declaration 1`] = `
           data: {"value":"Subtraction operator."}
 `;
 
-exports[`functional:parser > should create ast for function declaration 1`] = `
+exports[`functional:attacher > should create ast for function declaration 1`] = `
 root[8]
 ├─0 comment[3] (1:1-5:4, 0-126)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - calculate\\n * @module fixtures/calculate\\n * @see https://codewars.com/kata/581bc0629ad9ff9873000316\\n */"}
@@ -394,7 +394,7 @@ exports[`functional:parser > should create ast for function declaration 1`] = `
           data: {"tag":"@var","text":"{number} result - Result of calculating two-term expression","value":"@var {number} result - Result of calculating two-term expression"}
 `;
 
-exports[`functional:parser > should create ast for function* declaration 1`] = `
+exports[`functional:attacher > should create ast for function* declaration 1`] = `
 root[2]
 ├─0 comment[2] (1:1-4:4, 0-65)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - alphabet\\n * @module fixtures/alphabet\\n */"}
@@ -416,7 +416,7 @@ exports[`functional:parser > should create ast for function* declaration 1`] = `
           data: {"tag":"@return","text":"{Generator<string, void, void>} Alphabet generator","value":"@return {Generator<string, void, void>} Alphabet generator"}
 `;
 
-exports[`functional:parser > should create ast for interface declaration 1`] = `
+exports[`functional:attacher > should create ast for interface declaration 1`] = `
 root[4]
 ├─0 comment[2] (1:1-4:4, 0-77)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - CoordinatePair\\n * @module fixtures/CoordinatePair\\n */"}
@@ -438,7 +438,7 @@ exports[`functional:parser > should create ast for interface declaration 1`] = `
           data: {"value":"y-coordinate."}
 `;
 
-exports[`functional:parser > should create ast for namespace declaration 1`] = `
+exports[`functional:attacher > should create ast for namespace declaration 1`] = `
 root[4]
 ├─0 comment[2] (1:1-4:4, 0-71)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - StringUtils\\n * @module fixtures/StringUtils\\n */"}
@@ -470,7 +470,7 @@ exports[`functional:parser > should create ast for namespace declaration 1`] = `
           data: {"tag":"@template","text":"D - String delimiter","value":"@template D - String delimiter"}
 `;
 
-exports[`functional:parser > should create ast for type declaration 1`] = `
+exports[`functional:attacher > should create ast for type declaration 1`] = `
 root[2]
 ├─0 comment[2] (1:1-4:4, 0-69)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - Coordinate\\n * @module fixtures/Coordinate\\n */"}
@@ -484,7 +484,7 @@ exports[`functional:parser > should create ast for type declaration 1`] = `
           data: {"value":"One member in a pair of numbers that represent a single point on a\\ntwo-dimensional grid."}
 `;
 
-exports[`functional:parser > should create ast for variable declaration 1`] = `
+exports[`functional:attacher > should create ast for variable declaration 1`] = `
 root[3]
 ├─0 comment[2] (1:1-4:4, 0-57)
 │   │ data: {"symbol":null,"value":"/**\\n * @file Fixtures - psum\\n * @module fixtures/psum\\n */"}

src/__tests__/attacher.functional.spec.ts

@@ -0,0 +1,180 @@
+/**
+ * @file Functional Tests - attacher
+ * @module docast/tests/attacher/functional
+ */
+
+import type { Options, ParserOptions } from '#src/interfaces'
+import type { Root } from '#src/nodes'
+import fs from 'node:fs'
+import path from 'node:path'
+import { unified, type Processor } from 'unified'
+import { inspect } from 'unist-util-inspect'
+import type { TestContext } from 'vitest'
+import testSubject from '../attacher'
+
+describe('functional:attacher', () => {
+  let processor: Processor
+
+  beforeEach((ctx: TestContext): void => {
+    processor = unified()
+
+    ctx.expect.addSnapshotSerializer({
+      print: (val: unknown): string => inspect(val),
+      test: (): boolean => true
+    })
+  })
+
+  it('should create ast for abstract class declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/person.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for async function declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/dbl-linear.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for async function* declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/fibonacci.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for class declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/fibonacci-sequence.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for const enum declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/log-level.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for default function declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/sum-of-intervals.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for default variable declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/mini-string-fuck.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for enum declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/op.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for function declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/calculate.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for function* declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/alphabet.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for interface declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/coordinate-pair.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for namespace declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/string-utils.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for type declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/coordinate.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+
+  it('should create ast for variable declaration', () => {
+    // Arrange
+    const filepath: string = path.resolve('__fixtures__/psum.ts')
+    const file: string = fs.readFileSync(filepath, 'utf8')
+    const options: ParserOptions = { ...path.parse(filepath), path: filepath }
+    processor.use<[Options?], string, Root>(testSubject, options)
+
+    // Act + Expect
+    expect(processor.parse(file)).toMatchSnapshot()
+  })
+})