feat(regex): EXT_DTS_REGEX

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

Author: unicornware

__tests__/setup/index.ts

@@ -4,3 +4,4 @@
  */
 
 import './chai'
+import './serializers'

__tests__/setup/serializers/index.ts

@@ -0,0 +1,7 @@
+/**
+ * @file Entry Point - Snapshot Serializers
+ * @module tests/setup/serializers
+ * @see https://vitest.dev/guide/snapshot.html#custom-serializer
+ */
+
+import './regex-array'

__tests__/setup/serializers/regex-array.ts

@@ -0,0 +1,34 @@
+/**
+ * @file Snapshot Serializers - RegExpArray
+ * @module tests/setup/serializers/regex-array
+ */
+
+import type { RegExpArray } from '#tests/types'
+import { isNumber, isString, type Fn } from '@flex-development/tutils'
+import { get, omit } from 'radash'
+
+expect.addSnapshotSerializer({
+  /**
+   * Prints the given `value`.
+   *
+   * @param {unknown} value - Value to print
+   * @param {Fn<[unknown], string>} printer - Print function
+   * @return {string} `value` as printable string
+   */
+  print(value: unknown, printer: Fn<[unknown], string>): string {
+    return printer(omit(value as RegExpArray, ['index', 'input']))
+  },
+  /**
+   * Checks if the given `value` is a {@linkcode RegExpArray}.
+   *
+   * @param {unknown} value - Value to check
+   * @return {value is RegExpArray} `true` if `value` is {@linkcode RegExpArray}
+   */
+  test(value: unknown): value is RegExpArray {
+    return (
+      Array.isArray(value) &&
+      isNumber(get(value, 'index')) &&
+      isString(get(value, 'input'))
+    )
+  }
+})

__tests__/types/index.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Test Type Definitions
+ * @module tests/types
+ */
+
+export type { default as RegExpArray } from './reg-exp-array'

__tests__/types/reg-exp-array.ts

@@ -0,0 +1,11 @@
+/**
+ * @file Test Type Definitions - RegExpArray
+ * @module tests/types/RegExpArray
+ */
+
+/**
+ * A {@linkcode RegExpExecArray} or {@linkcode RegExpMatchArray}.
+ */
+type RegExpArray = RegExpExecArray | RegExpMatchArray
+
+export type { RegExpArray as default }

src/index.ts

@@ -3,4 +3,4 @@
  * @module ext-regex
  */
 
-export {}
+export * from './regex'

src/regex/__snapshots__/dts.snap

@@ -0,0 +1,91 @@
+// Vitest Snapshot v1
+
+exports[`unit:EXT_DTS_REGEX > .d.cts > should match extension ".d.cts" 1`] = `
+{
+  "0": ".d.cts",
+  "1": "c",
+  "groups": {
+    "type": "c",
+  },
+}
+`;
+
+exports[`unit:EXT_DTS_REGEX > .d.cts > should match module id given last extension is ".d.cts" 1`] = `
+{
+  "0": ".d.cts",
+  "1": "c",
+  "groups": {
+    "type": "c",
+  },
+}
+`;
+
+exports[`unit:EXT_DTS_REGEX > .d.cts > should match module id given only extension is ".d.cts" 1`] = `
+{
+  "0": ".d.cts",
+  "1": "c",
+  "groups": {
+    "type": "c",
+  },
+}
+`;
+
+exports[`unit:EXT_DTS_REGEX > .d.mts > should match extension ".d.mts" 1`] = `
+{
+  "0": ".d.mts",
+  "1": "m",
+  "groups": {
+    "type": "m",
+  },
+}
+`;
+
+exports[`unit:EXT_DTS_REGEX > .d.mts > should match module id given last extension is ".d.mts" 1`] = `
+{
+  "0": ".d.mts",
+  "1": "m",
+  "groups": {
+    "type": "m",
+  },
+}
+`;
+
+exports[`unit:EXT_DTS_REGEX > .d.mts > should match module id given only extension is ".d.mts" 1`] = `
+{
+  "0": ".d.mts",
+  "1": "m",
+  "groups": {
+    "type": "m",
+  },
+}
+`;
+
+exports[`unit:EXT_DTS_REGEX > .d.ts > should match extension ".d.ts" 1`] = `
+{
+  "0": ".d.ts",
+  "1": undefined,
+  "groups": {
+    "type": undefined,
+  },
+}
+`;
+
+exports[`unit:EXT_DTS_REGEX > .d.ts > should match module id given last extension is ".d.ts" 1`] = `
+{
+  "0": ".d.ts",
+  "1": undefined,
+  "groups": {
+    "type": undefined,
+  },
+}
+`;
+
+exports[`unit:EXT_DTS_REGEX > .d.ts > should match module id given only extension is ".d.ts" 1`] = `
+{
+  "0": ".d.ts",
+  "1": undefined,
+  "groups": {
+    "type": undefined,
+  },
+}
+`;

src/regex/__tests__/dts.spec-d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file Type Tests - EXT_DTS_REGEX
+ * @module ext-regex/regex/tests/unit-d/dts
+ */
+
+import type TEST_SUBJECT from '../dts'
+
+describe('unit-d:EXT_DTS_REGEX', () => {
+  it('should be instance of RegExp', () => {
+    expectTypeOf<typeof TEST_SUBJECT>().toEqualTypeOf<RegExp>()
+  })
+})

src/regex/__tests__/dts.spec.ts

@@ -0,0 +1,50 @@
+/**
+ * @file Unit Tests - EXT_DTS_REGEX
+ * @module ext-regex/regex/tests/unit/dts
+ */
+
+import TEST_SUBJECT from '../dts'
+
+describe('unit:EXT_DTS_REGEX', () => {
+  describe('.d.cts', () => {
+    it('should match extension ".d.cts"', () => {
+      expect(TEST_SUBJECT.exec('.d.cts')).toMatchSnapshot()
+    })
+
+    it('should match module id given last extension is ".d.cts"', () => {
+      expect(TEST_SUBJECT.exec('dist/users.controller.d.cts')).toMatchSnapshot()
+    })
+
+    it('should match module id given only extension is ".d.cts"', () => {
+      expect(TEST_SUBJECT.exec('dist/index.d.cts')).toMatchSnapshot()
+    })
+  })
+
+  describe('.d.mts', () => {
+    it('should match extension ".d.mts"', () => {
+      expect(TEST_SUBJECT.exec('.d.mts')).toMatchSnapshot()
+    })
+
+    it('should match module id given last extension is ".d.mts"', () => {
+      expect(TEST_SUBJECT.exec('dist/users.controller.d.mts')).toMatchSnapshot()
+    })
+
+    it('should match module id given only extension is ".d.mts"', () => {
+      expect(TEST_SUBJECT.exec('dist/index.d.mts')).toMatchSnapshot()
+    })
+  })
+
+  describe('.d.ts', () => {
+    it('should match extension ".d.ts"', () => {
+      expect(TEST_SUBJECT.exec('.d.ts')).toMatchSnapshot()
+    })
+
+    it('should match module id given last extension is ".d.ts"', () => {
+      expect(TEST_SUBJECT.exec('dist/users.controller.d.ts')).toMatchSnapshot()
+    })
+
+    it('should match module id given only extension is ".d.ts"', () => {
+      expect(TEST_SUBJECT.exec('dist/index.d.ts')).toMatchSnapshot()
+    })
+  })
+})

src/regex/dts.ts

@@ -0,0 +1,25 @@
+/**
+ * @file Regular Expressions - EXT_DTS_REGEX
+ * @module ext-regex/regex/dts
+ */
+
+/**
+ * TypeScript declaration file extension regex.
+ *
+ * Supported extensions:
+ *
+ * - `.d.cts`
+ * - `.d.mts`
+ * - `.d.ts`
+ *
+ * Captured groups:
+ *
+ * - `type`: Letter between `'.'` and `'ts'` in file extension
+ *
+ * @see https://regex101.com/r/LD2eKA
+ *
+ * @const {RegExp} EXT_DTS_REGEX
+ */
+const EXT_DTS_REGEX: RegExp = /\.d\.(?<type>[cm])?ts(?=\s*$)/
+
+export default EXT_DTS_REGEX