@cspell/dynamic-import 6.22.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jason Dent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+# `@cspell/dynamic-import`
+
+A small library to assist with dynamically loading CommonJS and ESM Modules from either CommonJS or ESM Modules.
+
+## Install
+
+```sh
+npm install -S @cspell/dynamic-import
+```
+
+## Usage
+
+**TypeScript**
+
+```ts
+import { dynamicImport } from '@cspell/dynamic-import';
+```
+
+<!--- @@inject: ../../static/footer.md --->
+
+<br/>
+
+---
+
+<p align="center">
+Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
+<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
+</a>
+</p>
+
+<!--- @@inject-end: ../../static/footer.md --->

package/dist/cjs/index.cjs

@@ -0,0 +1,65 @@
+'use strict';
+
+var node_path = require('node:path');
+var node_url = require('node:url');
+
+/**
+ * Thunk Layer for `import` to allow dynamic imports.
+ * @param {string} module - name of module to load
+ * @returns
+ */
+function dImport(module) {
+    return import(module.toString());
+}
+
+/**
+ * Lazy load the importer so we can use an ESM packages inside a cjs file.
+ */
+
+/**
+ * @type {Promise<typeof import('import-meta-resolve')> | undefined}
+ */
+let pImportResolve;
+
+/**
+ * Dynamically import a module using `import`.
+ * @param {string} moduleName - name of module, or relative path.
+ * @param {(string | URL)[] | string | URL} paths - search paths
+ * @returns the loaded module.
+ */
+async function dynamicImportFrom(moduleName, paths) {
+    paths = Array.isArray(paths) ? paths : paths ? [paths] : undefined;
+    if (!paths || !paths.length || typeof moduleName !== 'string') {
+        try {
+            return await dImport(moduleName);
+        } catch (err) {
+            err.code = err.code ?? 'ERR_MODULE_NOT_FOUND';
+            throw err;
+        }
+    }
+
+    const importResolveModule = await (pImportResolve || (pImportResolve = dImport('import-meta-resolve')));
+
+    const { resolve } = importResolveModule;
+
+    let lastError = undefined;
+
+    for (const parent of paths) {
+        try {
+            const url =
+                typeof parent === 'string'
+                    ? parent.startsWith('file://')
+                        ? new URL(parent)
+                        : node_url.pathToFileURL(parent + node_path.sep)
+                    : parent;
+            const location = await resolve(moduleName, url);
+            return await dImport(location);
+        } catch (err) {
+            lastError = err;
+        }
+    }
+    throw lastError;
+}
+
+exports.dynamicImport = dynamicImportFrom;
+//# sourceMappingURL=index.cjs.map

package/lib/dImport.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Thunk Layer for `import` to allow dynamic imports.
+ * @param {string} module - name of module to load
+ * @returns
+ */
+export function dImport(module: string): Promise<any>;

package/lib/dImport.js

@@ -0,0 +1,8 @@
+/**
+ * Thunk Layer for `import` to allow dynamic imports.
+ * @param {string} module - name of module to load
+ * @returns
+ */
+export function dImport(module) {
+    return import(module.toString());
+}

package/lib/dynamicImport.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Dynamically import a module using `import`.
+ * @param moduleName - name of module, or relative path.
+ * @param searchPath - absolute search path, URL, or array of paths. Note: Paths must be absolute.
+ *    The last path element of the URL will be removed if it does not end in a `/`.
+ * @returns Promise resolving to the loaded module.
+ */
+export declare function dynamicImportFrom<T>(
+    moduleName: string,
+    searchPath: (string | URL)[] | string | URL
+): Promise<T>;

package/lib/dynamicImport.js

@@ -0,0 +1,52 @@
+import { dImport } from './dImport.js';
+import { sep as pathSep } from 'node:path';
+import { pathToFileURL } from 'node:url';
+
+/**
+ * Lazy load the importer so we can use an ESM packages inside a cjs file.
+ */
+
+/**
+ * @type {Promise<typeof import('import-meta-resolve')> | undefined}
+ */
+let pImportResolve;
+
+/**
+ * Dynamically import a module using `import`.
+ * @param {string} moduleName - name of module, or relative path.
+ * @param {(string | URL)[] | string | URL} paths - search paths
+ * @returns the loaded module.
+ */
+export async function dynamicImportFrom(moduleName, paths) {
+    paths = Array.isArray(paths) ? paths : paths ? [paths] : undefined;
+    if (!paths || !paths.length || typeof moduleName !== 'string') {
+        try {
+            return await dImport(moduleName);
+        } catch (err) {
+            err.code = err.code ?? 'ERR_MODULE_NOT_FOUND';
+            throw err;
+        }
+    }
+
+    const importResolveModule = await (pImportResolve || (pImportResolve = dImport('import-meta-resolve')));
+
+    const { resolve } = importResolveModule;
+
+    let lastError = undefined;
+
+    for (const parent of paths) {
+        try {
+            const url =
+                typeof parent === 'string'
+                    ? parent.startsWith('file://')
+                        ? new URL(parent)
+                        : pathToFileURL(parent + pathSep)
+                    : parent;
+            const location = await resolve(moduleName, url);
+            return await dImport(location);
+        } catch (err) {
+            lastError = err;
+        }
+    }
+    throw lastError;
+}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { dynamicImportFrom as dynamicImport } from './dynamicImport';

package/lib/index.js

@@ -0,0 +1 @@
+export { dynamicImportFrom as dynamicImport } from './dynamicImport.js';

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@cspell/dynamic-import",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "6.22.0",
+  "description": "Dynamic Module Loader",
+  "keywords": [
+    "module",
+    "esm",
+    "cjs",
+    "import",
+    "require"
+  ],
+  "author": "Jason Dent <jason@streetsidesoftware.nl>",
+  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/dynamic-import#readme",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "dist",
+    "!**/__mocks__",
+    "!**/*.spec.*",
+    "!**/*.test.*",
+    "!**/test/**",
+    "!**/*.map"
+  ],
+  "scripts": {
+    "build": "pnpm build:cjs",
+    "build:cjs": "rollup -c rollup.config.mjs",
+    "coverage:vitest": "vitest run --coverage",
+    "coverage:fix": "nyc report --temp-dir \"$(pwd)/coverage\" --reporter lcov --report-dir \"$(pwd)/coverage\" --cwd ../..",
+    "test-watch": "vitest",
+    "test": "vitest run"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/streetsidesoftware/cspell.git"
+  },
+  "bugs": {
+    "url": "https://github.com/streetsidesoftware/cspell/labels/cspell-pipe"
+  },
+  "engines": {
+    "node": ">=14"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "rollup": "^3.14.0",
+    "vitest": "^0.28.4"
+  },
+  "dependencies": {
+    "import-meta-resolve": "^2.2.1"
+  },
+  "gitHead": "a133874ed7590cbe140f5067cfa80db84b644a5d"
+}