feat(interfaces): Options

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

Author: unicornware

build.config.ts

@@ -13,6 +13,15 @@ import pkg from './package.json' assert { type: 'json' }
  * @const {Config} config
  */
 const config: Config = defineBuildConfig({
+  entries: [
+    { dts: 'only' },
+    {
+      dts: false,
+      pattern: ['**/index.ts', 'internal/*', 'regex/*', 'utils/*'],
+      sourcemap: true,
+      sourcesContent: false
+    }
+  ],
   target: 'node' + pkg.engines.node.replace(/^\D+/, ''),
   tsconfig: 'tsconfig.build.json'
 })

package.json

@@ -22,7 +22,8 @@
   },
   "type": "module",
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "exports": {
     ".": "./dist/index.mjs",
@@ -68,15 +69,15 @@
   },
   "dependencies": {
     "@flex-development/errnode": "1.5.0",
-    "@flex-development/pathe": "1.0.3"
+    "@flex-development/pathe": "1.0.3",
+    "@flex-development/tutils": "6.0.0-alpha.10"
   },
   "devDependencies": {
     "@commitlint/cli": "17.4.3",
     "@commitlint/config-conventional": "17.4.3",
     "@flex-development/mkbuild": "1.0.0-alpha.11",
     "@flex-development/mlly": "1.0.0-alpha.11",
     "@flex-development/tsconfig-utils": "1.1.1",
-    "@flex-development/tutils": "6.0.0-alpha.10",
     "@graphql-eslint/eslint-plugin": "3.16.0",
     "@types/chai": "4.3.4",
     "@types/conventional-changelog": "3.1.1",

src/.npmignore

@@ -0,0 +1,8 @@
+# NPM IGNORE
+# https://npm.github.io/publishing-pkgs-docs/publishing/the-npmignore-file.html
+# https://github.com/yarnpkg/yarn/issues/685#issuecomment-457618561
+
+# DIRECTORIES & FILES
+**/__mocks__/**
+**/__snapshots__/**
+**/__tests__/**

src/index.ts

@@ -3,4 +3,5 @@
  * @module ext-regex
  */
 
+export * from './interfaces'
 export * from './regex'

src/interfaces/__tests__/options.spec-d.ts

@@ -0,0 +1,19 @@
+/**
+ * @file Type Tests - Options
+ * @module ext-regex/interfaces/tests/unit-d/Options
+ */
+
+import type { KeysRequired, Nilable } from '@flex-development/tutils'
+import type TestSubject from '../options'
+
+describe('unit-d:interfaces/Options', () => {
+  it('should allow empty object', () => {
+    expectTypeOf<KeysRequired<TestSubject>>().toBeNever()
+  })
+
+  it('should match [flags?: Nilable<string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('flags')
+      .toEqualTypeOf<Nilable<string>>()
+  })
+})

src/interfaces/index.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Interfaces
+ * @module ext-regex/interfaces
+ */
+
+export type { default as Options } from './options'

src/interfaces/options.ts

@@ -0,0 +1,23 @@
+/**
+ * @file Interfaces - Options
+ * @module ext-regex/interfaces/Options
+ */
+
+import type { Nilable } from '@flex-development/tutils'
+
+/**
+ * Options for creating regular expressions matching file extensions.
+ */
+interface Options {
+  /**
+   * Flags passed to the {@linkcode RegExp} constructor.
+   *
+   * @see https://developer.mozilla.org/docs/Web/JavaScript/Guide/Regular_Expressions#advanced_searching_with_flags
+   *
+   *
+   * @default undefined
+   */
+  flags?: Nilable<string>
+}
+
+export type { Options as default }

vitest.config.ts

@@ -52,7 +52,12 @@ const config: UserConfigExport = defineConfig((): UserConfig => {
         all: !LINT_STAGED,
         clean: true,
         cleanOnRerun: true,
-        exclude: ['**/__mocks__/**', '**/__tests__/**', '**/index.ts'],
+        exclude: [
+          '**/__mocks__/**',
+          '**/__tests__/**',
+          '**/index.ts',
+          'src/interfaces/'
+        ],
         extension: ['.ts'],
         ignoreClassMethods: [],
         include: ['src'],