feat(regex): EXPORT_LIST_REGEX

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

Author: unicornware

src/__snapshots__/export-list.snap

@@ -0,0 +1,92 @@
+// Vitest Snapshot v1
+
+exports[`unit:EXPORT_LIST_REGEX > exports > should match named export(s) in multi-line statement 1`] = `
+{
+  "0": "export {
+  addFive,
+  addFour,
+  addThree,
+  addTwo,
+  squareFive,
+  squareFour,
+  squareThree,
+  squareTwo
+}",
+  "1": undefined,
+  "2": "{
+  addFive,
+  addFour,
+  addThree,
+  addTwo,
+  squareFive,
+  squareFour,
+  squareThree,
+  squareTwo
+}",
+  "groups": {
+    "exports": "{
+  addFive,
+  addFour,
+  addThree,
+  addTwo,
+  squareFive,
+  squareFour,
+  squareThree,
+  squareTwo
+}",
+    "type": undefined,
+  },
+  "index": 0,
+}
+`;
+
+exports[`unit:EXPORT_LIST_REGEX > exports > should match named export(s) in single-line statement 1`] = `
+{
+  "0": "export { defineBuildConfig, type BuildConfig }",
+  "1": undefined,
+  "2": "{ defineBuildConfig, type BuildConfig }",
+  "groups": {
+    "exports": "{ defineBuildConfig, type BuildConfig }",
+    "type": undefined,
+  },
+  "index": 0,
+}
+`;
+
+exports[`unit:EXPORT_LIST_REGEX > exports > should match named type export(s) in multi-line statement 1`] = `
+{
+  "0": "export type {
+  JsonObject,
+  LiteralUnion,
+  Nullable
+}",
+  "1": "type",
+  "2": "{
+  JsonObject,
+  LiteralUnion,
+  Nullable
+}",
+  "groups": {
+    "exports": "{
+  JsonObject,
+  LiteralUnion,
+  Nullable
+}",
+    "type": "type",
+  },
+  "index": 0,
+}
+`;
+
+exports[`unit:EXPORT_LIST_REGEX > exports > should match named type export(s) in single-line statement 1`] = `
+{
+  "0": "export type { default as Options }",
+  "1": "type",
+  "2": "{ default as Options }",
+  "groups": {
+    "exports": "{ default as Options }",
+    "type": "type",
+  },
+  "index": 0,
+}
+`;

src/__tests__/export-list.spec.ts

@@ -0,0 +1,97 @@
+/**
+ * @file Unit Tests - EXPORT_LIST_REGEX
+ * @module export-regex/tests/list/unit
+ */
+
+import { omit } from 'radash'
+import { dedent } from 'ts-dedent'
+import TEST_SUBJECT from '../export-list'
+
+describe('unit:EXPORT_LIST_REGEX', () => {
+  beforeEach(() => {
+    TEST_SUBJECT.lastIndex = 0
+  })
+
+  describe('comments', () => {
+    it('should ignore export in multi-line comment', () => {
+      // Arrange
+      const code = dedent`
+        /**
+         * @example
+         *   export { name1, name2, name3 }
+         */
+      `
+
+      // Act + Expect
+      expect(TEST_SUBJECT.test(code)).to.be.false
+    })
+
+    it('should ignore export in single-line comment', () => {
+      expect(TEST_SUBJECT.test('// export { foo, bar }')).to.be.false
+    })
+  })
+
+  describe('exports', () => {
+    it('should match named export(s) in multi-line statement', () => {
+      // Arrange
+      const code = dedent`
+        export {
+          addFive,
+          addFour,
+          addThree,
+          addTwo,
+          squareFive,
+          squareFour,
+          squareThree,
+          squareTwo
+        }
+      `
+
+      // Act
+      const result = TEST_SUBJECT.exec(code)
+
+      // Expect
+      expect(result).to.not.be.null
+      expect(omit(result!, ['input'])).toMatchSnapshot()
+    })
+
+    it('should match named export(s) in single-line statement', () => {
+      // Arrange
+      const code = 'export { defineBuildConfig, type BuildConfig }'
+
+      // Act
+      const result = TEST_SUBJECT.exec(code)
+
+      // Expect
+      expect(result).to.not.be.null
+      expect(omit(result!, ['input'])).toMatchSnapshot()
+    })
+
+    it('should match named type export(s) in multi-line statement', () => {
+      // Arrange
+      const code = dedent`
+        export type {
+          JsonObject,
+          LiteralUnion,
+          Nullable
+        }
+      `
+
+      // Act
+      const result = TEST_SUBJECT.exec(code)
+
+      // Expect
+      expect(result).to.not.be.null
+      expect(omit(result!, ['input'])).toMatchSnapshot()
+    })
+
+    it('should match named type export(s) in single-line statement', () => {
+      // Act
+      const result = TEST_SUBJECT.exec('export type { default as Options }')
+
+      // Expect
+      expect(result).to.not.be.null
+      expect(omit(result!, ['input'])).toMatchSnapshot()
+    })
+  })
+})

src/export-list.ts

@@ -0,0 +1,58 @@
+/**
+ * @file EXPORT_LIST_REGEX
+ * @module export-regex/list
+ */
+
+/**
+ * List `export` statement regex. Ignores matches in comments.
+ *
+ * @example
+ *  import { EXPORT_LIST_REGEX } from '@flex-development/export-regex'
+ *  import { dedent } from 'ts-dedent'
+ *
+ *  const code: string = dedent`
+ *    export { defineBuildConfig, type BuildConfig }
+ *    export type {
+ *      JsonObject,
+ *      LiteralUnion,
+ *      Nullable
+ *    }
+ *  `
+ *
+ *  const print = (matches: IterableIterator<RegExpMatchArray>): void => {
+ *    console.debug([...matches].map(match => omit(match, ['input'])))
+ *  }
+ *
+ *  print(code.matchAll(EXPORT_LIST_REGEX))
+ *  // [
+ *  //   {
+ *  //     '0': 'export { defineBuildConfig, type BuildConfig }',
+ *  //     '1': undefined,
+ *  //     '2': '{ defineBuildConfig, type BuildConfig }',
+ *  //     index: 0,
+ *  //     groups: [Object: null prototype] {
+ *  //       type: undefined,
+ *  //       exports: '{ defineBuildConfig, type BuildConfig }'
+ *  //     }
+ *  //   },
+ *  //   {
+ *  //     '0': 'export type {\n  JsonObject,\n  LiteralUnion,\n  Nullable\n}',
+ *  //     '1': 'type',
+ *  //     '2': '{\n  JsonObject,\n  LiteralUnion,\n  Nullable\n}',
+ *  //     index: 82,
+ *  //     groups: [Object: null prototype] {
+ *  //       type: 'type',
+ *  //       exports: '{\n  JsonObject,\n  LiteralUnion,\n  Nullable\n}'
+ *  //     }
+ *  //   }
+ *  // ]
+ *
+ * @see https://regex101.com/r/KQEDdZ
+ * @see https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/export#syntax
+ *
+ * @const {RegExp} EXPORT_LIST_REGEX
+ */
+const EXPORT_LIST_REGEX: RegExp =
+  /(?<=^|[\n;])export(?:(?:\s+(?<type>type)\s*)|\s*)(?<exports>{[\w\t\n\r "$'*,./{}-]+?})/g
+
+export default EXPORT_LIST_REGEX

src/index.ts

@@ -4,3 +4,4 @@
  */
 
 export { default as EXPORT_AGGREGATE_REGEX } from './export-aggregate'
+export { default as EXPORT_LIST_REGEX } from './export-list'