feat(builtins): builtinModules

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

Author: unicornware

__tests__/setup/chai.ts

@@ -5,18 +5,7 @@
  */
 
 import chai from 'chai'
-import chaiEach from 'chai-each'
-import chaiQuantifiers from 'chai-quantifiers'
 
 // configure chai
 chai.config.includeStack = true
 chai.config.truncateThreshold = 0
-
-/**
- * initialize chai plugins.
- *
- * @see https://github.com/jamesthomasonjr/chai-each
- * @see https://github.com/funny-bytes/chai-quantifiers
- */
-chai.use(chaiEach)
-chai.use(chaiQuantifiers)

package.json

@@ -98,8 +98,6 @@
     "@vitest/ui": "0.28.3",
     "add-stream": "1.0.0",
     "chai": "4.3.7",
-    "chai-each": "0.0.1",
-    "chai-quantifiers": "1.0.17",
     "conventional-changelog": "3.1.25",
     "conventional-changelog-core": "4.2.4",
     "conventional-changelog-writer": "5.0.1",

src/__tests__/builtin-modules.spec-d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file Type Tests - builtinModules
+ * @module builtin-modules/tests/unit-d/builtinModules
+ */
+
+import type testSubject from '../builtin-modules'
+
+describe('unit-d:builtinModules', () => {
+  it('should equal type of string[]', () => {
+    expectTypeOf<typeof testSubject>().toEqualTypeOf<string[]>()
+  })
+})

src/__tests__/builtin-modules.spec.ts

@@ -0,0 +1,13 @@
+/**
+ * @file Unit Tests - builtinModules
+ * @module builtin-modules/tests/unit/builtinModules
+ */
+
+import module from 'node:module'
+import testSubject from '../builtin-modules'
+
+describe('unit:builtinModules', () => {
+  it('should be superset of module.builtinModules', () => {
+    expect(testSubject).to.include.members(module.builtinModules)
+  })
+})

src/builtin-modules.ts

@@ -0,0 +1,88 @@
+/**
+ * @file builtinModules
+ * @module builtin-modules/builtinModules
+ */
+
+/**
+ * Names of modules provided by Node.js.
+ *
+ * Possible use cases:
+ *
+ * - Check if a module can be imported using the [`node:`][1] protocol
+ * - Check if a module is maintained by Node.js
+ *
+ * [1]: https://nodejs.org/api/esm.html#node-imports
+ *
+ * @const {string[]} builtinModules
+ */
+const builtinModules: string[] = [
+  '_http_agent',
+  '_http_client',
+  '_http_common',
+  '_http_incoming',
+  '_http_outgoing',
+  '_http_server',
+  '_stream_duplex',
+  '_stream_passthrough',
+  '_stream_readable',
+  '_stream_transform',
+  '_stream_wrap',
+  '_stream_writable',
+  '_tls_common',
+  '_tls_wrap',
+  'assert',
+  'assert/strict',
+  'async_hooks',
+  'buffer',
+  'child_process',
+  'cluster',
+  'console',
+  'constants',
+  'crypto',
+  'dgram',
+  'diagnostics_channel',
+  'dns',
+  'dns/promises',
+  'domain',
+  'events',
+  'fs',
+  'fs/promises',
+  'http',
+  'http2',
+  'https',
+  'inspector',
+  'inspector/promises',
+  'module',
+  'net',
+  'os',
+  'path',
+  'path/posix',
+  'path/win32',
+  'perf_hooks',
+  'process',
+  'punycode',
+  'querystring',
+  'readline',
+  'readline/promises',
+  'repl',
+  'stream',
+  'stream/consumers',
+  'stream/promises',
+  'stream/web',
+  'string_decoder',
+  'sys',
+  'timers',
+  'timers/promises',
+  'tls',
+  'trace_events',
+  'tty',
+  'url',
+  'util',
+  'util/types',
+  'v8',
+  'vm',
+  'worker_threads',
+  'zlib'
+]
+
+export default builtinModules

src/index.ts

@@ -3,4 +3,4 @@
  * @module builtin-modules
  */
 
-export {}
+export { default as builtinModules } from './builtin-modules'

yarn.lock

@@ -1169,8 +1169,6 @@ __metadata:
     "@vitest/ui": "npm:0.28.3"
     add-stream: "npm:1.0.0"
     chai: "npm:4.3.7"
-    chai-each: "npm:0.0.1"
-    chai-quantifiers: "npm:1.0.17"
     conventional-changelog: "npm:3.1.25"
     conventional-changelog-core: "npm:4.2.4"
     conventional-changelog-writer: "npm:5.0.1"
@@ -2928,22 +2926,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"chai-each@npm:0.0.1":
-  version: 0.0.1
-  resolution: "chai-each@npm:0.0.1"
-  checksum: 545be493fb9eace3aea28ef9556a0433dd1467bd0bf96d1bb50212c0f12b833ae033fd50b56b6ca739a58868fab060ef794bca14da3b36347f4f8574d66fc2a8
-  languageName: node
-  linkType: hard
-
-"chai-quantifiers@npm:1.0.17":
-  version: 1.0.17
-  resolution: "chai-quantifiers@npm:1.0.17"
-  peerDependencies:
-    chai: ^4.x.x
-  checksum: 9e1c4af526998af9a862917c426ac0ff48560f1ab03ff97ef67ed65b88b2dad0d2af8a2f9315a55fbc434d77b1f82ecf5aa16b15453fa33dcad7f4a5266cb3ca
-  languageName: node
-  linkType: hard
-
 "chai@npm:4.3.7, chai@npm:^4.3.7":
   version: 4.3.7
   resolution: "chai@npm:4.3.7"