locter 1.2.3 → 2.0.0

package/README.MD

@@ -153,7 +153,8 @@ import { loadSync, locateSync } from 'locter';
 
 Two loaders are predefined from scratch and already registered:
 - **ConfLoader**: This loader allows to load `.conf` files.
-- **JsonLoader**: This loader allows to load `.json` files.
+- **JSONLoader**: This loader allows to load `.json` files.
+- **YAMLLoader**: This loader allows to load `.yml` files.
 - **ModuleLoader**: This loader allows to load modules with
   `.js`, `.mjs`, `.mts`, `.cjs`, `.cts`, `.ts` file extensions independent of the environment (cjs or esm).
 

package/dist/index.cjs

@@ -3,11 +3,12 @@
 var destr = require('destr');
 var flat = require('flat');
 var fs = require('node:fs');
-var glob = require('glob');
+var fg = require('fast-glob');
 var path = require('node:path');
 var ebec = require('ebec');
 var createJITI = require('jiti');
 var node_url = require('node:url');
+var yaml = require('yaml');
 
 function hasOwnProperty(obj, prop) {
     return Object.prototype.hasOwnProperty.call(obj, prop);
@@ -78,6 +79,30 @@ function isFilePath(input) {
     return extension && extension !== '';
 }
 
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */ function isJestRuntimeEnvironment() {
+    return process.env && process.env.JEST_WORKER_ID !== undefined;
+}
+function isTsNodeRuntimeEnvironment() {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    return !!process[Symbol.for('ts-node.register.instance')];
+}
+
+function isTypeScriptError(input) {
+    if (!isObject(input)) {
+        return false;
+    }
+    if (typeof input.diagnosticCodes !== 'undefined') {
+        return true;
+    }
+    return typeof input.message === 'string' && /TS\d+/.test(input.message);
+}
+
 function buildLocatorOptions(options) {
     var _options;
     options = options || {};
@@ -127,14 +152,20 @@ async function locateMany(pattern, options) {
     const patterns = Array.isArray(pattern) ? pattern : [
         pattern
     ];
+    let ignore;
+    if (options.ignore) {
+        ignore = Array.isArray(options.ignore) ? options.ignore : [
+            options.ignore
+        ];
+    }
     const items = [];
     for(let i = 0; i < patterns.length; i++){
         for(let j = 0; j < options.path.length; j++){
-            const files = await glob.glob(patterns[i], {
+            const files = await fg(patterns[i], {
                 absolute: true,
                 cwd: options.path[j],
-                nodir: true,
-                ignore: options.ignore
+                ignore,
+                onlyFiles: true
             });
             for(let k = 0; k < files.length; k++){
                 items.push(pathToLocatorInfo(files[k], true));
@@ -148,13 +179,19 @@ async function locate(pattern, options) {
     const patterns = Array.isArray(pattern) ? pattern : [
         pattern
     ];
+    let ignore;
+    if (options.ignore) {
+        ignore = Array.isArray(options.ignore) ? options.ignore : [
+            options.ignore
+        ];
+    }
     for(let i = 0; i < patterns.length; i++){
         for(let j = 0; j < options.path.length; j++){
-            const files = await glob.glob(patterns[i], {
+            const files = await fg(patterns[i], {
                 absolute: true,
                 cwd: options.path[j],
-                nodir: true,
-                ignore: options.ignore
+                ignore,
+                onlyFiles: true
             });
             const element = files.shift();
             if (element) {
@@ -170,14 +207,20 @@ function locateManySync(pattern, options) {
     const patterns = Array.isArray(pattern) ? pattern : [
         pattern
     ];
+    let ignore;
+    if (options.ignore) {
+        ignore = Array.isArray(options.ignore) ? options.ignore : [
+            options.ignore
+        ];
+    }
     const items = [];
     for(let i = 0; i < patterns.length; i++){
         for(let j = 0; j < options.path.length; j++){
-            const files = glob.globSync(patterns[i], {
+            const files = fg.sync(patterns[i], {
                 absolute: true,
                 cwd: options.path[j],
-                nodir: true,
-                ignore: options.ignore
+                ignore,
+                onlyFiles: true
             });
             for(let k = 0; k < files.length; k++){
                 items.push(pathToLocatorInfo(files[k], true));
@@ -191,13 +234,19 @@ function locateSync(pattern, options) {
     const patterns = Array.isArray(pattern) ? pattern : [
         pattern
     ];
+    let ignore;
+    if (options.ignore) {
+        ignore = Array.isArray(options.ignore) ? options.ignore : [
+            options.ignore
+        ];
+    }
     for(let i = 0; i < patterns.length; i++){
         for(let j = 0; j < options.path.length; j++){
-            const files = glob.globSync(patterns[i], {
+            const files = fg.sync(patterns[i], {
                 absolute: true,
                 cwd: options.path[j],
-                nodir: true,
-                ignore: options.ignore
+                ignore,
+                onlyFiles: true
             });
             const element = files.shift();
             if (element) {
@@ -264,41 +313,60 @@ class ConfLoader {
     }
 }
 
-function isJestRuntimeEnvironment() {
-    return process.env && process.env.JEST_WORKER_ID !== undefined;
-}
-function isTsNodeRuntimeEnvironment() {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    return !!process[Symbol.for('ts-node.register.instance')];
+function isESModule(input) {
+    return isObject(input) && // eslint-disable-next-line no-underscore-dangle
+    typeof input.__esModule !== 'undefined';
 }
-function getModuleExport(data, filterFn) {
-    if (filterFn) {
-        const keys = Object.keys(data);
-        for(let i = 0; i < keys.length; i++){
-            if (filterFn(keys[i], data[keys[i]])) {
-                return {
-                    key: keys[i],
-                    value: data[keys[i]]
+// https://2ality.com/2017/01/babel-esm-spec-mode.html
+function toModuleRecord(data) {
+    if (isESModule(data)) {
+        return data;
+    }
+    const output = Object.create(null, {
+        __esModule: {
+            value: true
+        },
+        [Symbol.toStringTag]: {
+            value: 'Module'
+        }
+    });
+    if (isObject(data)) {
+        // eslint-disable-next-line no-restricted-syntax
+        for(const key in data){
+            if (hasOwnProperty(output, key)) {
+                continue;
+            }
+            let descriptor = Object.getOwnPropertyDescriptor(data, key);
+            if (!descriptor || 'get' in descriptor || descriptor.writable || descriptor.configurable) {
+                descriptor = {
+                    enumerable: true,
+                    get () {
+                        return data[key];
+                    }
                 };
             }
+            Object.defineProperty(output, key, descriptor);
         }
-        throw new ebec.BaseError('Cannot find specific module export.');
     }
-    let value;
-    if (hasOwnProperty(data, '__esModule') && // eslint-disable-next-line no-underscore-dangle
-    !!data.__esModule && hasOwnProperty(data, 'default')) {
-        value = data.default;
-    } else {
-        value = data;
+    if (!hasOwnProperty(output, 'default')) {
+        Object.defineProperty(output, 'default', {
+            value: data,
+            enumerable: true
+        });
     }
-    if (isObject(value) && hasOwnProperty(value, 'default')) {
-        value = value.default;
+    return Object.freeze(output);
+}
+function getModuleExport(data, filterFn) {
+    const keys = Object.keys(data);
+    for(let i = 0; i < keys.length; i++){
+        if (filterFn(keys[i], data[keys[i]])) {
+            return {
+                key: keys[i],
+                value: data[keys[i]]
+            };
+        }
     }
-    return {
-        key: 'default',
-        value
-    };
+    return undefined;
 }
 
 class ModuleLoader {
@@ -307,7 +375,7 @@ class ModuleLoader {
         try {
             output = await this.load(input);
         } catch (e) {
-            if (e instanceof SyntaxError || e instanceof ReferenceError) {
+            if (e instanceof SyntaxError || e instanceof ReferenceError || isTypeScriptError(e)) {
                 throw e;
             }
             // jiti + ts-node
@@ -318,48 +386,38 @@ class ModuleLoader {
                 output = this.jiti(input);
             }
         }
-        return output;
+        return toModuleRecord(output);
     }
     executeSync(input) {
         let output;
         try {
             output = this.loadSync(input);
         } catch (e) {
-            if (e instanceof SyntaxError || e instanceof ReferenceError) {
+            if (e instanceof SyntaxError || e instanceof ReferenceError || isTypeScriptError(e)) {
                 throw e;
             }
             output = this.jiti(input);
         }
-        return output;
+        return toModuleRecord(output);
     }
     // ---------------------------------------------------------------------------
-    async load(data, options) {
-        options = options || {};
-        const [name, locatorInfo] = this.build(data, options);
+    async load(data, options = {}) {
+        const id = this.build(data, options);
         try {
             // segmentation fault
             // issue: https://github.com/nodejs/node/issues/35889
+            /*
             if (isJestRuntimeEnvironment()) {
-                // eslint-disable-next-line global-require,import/no-dynamic-require
-                return require(name);
+                return require(id);
             }
-            return await import(name);
+             */ return await import(id);
         } catch (e) {
             /* istanbul ignore next */ if (isObject(e) && hasStringProperty(e, 'code')) {
-                if (locatorInfo) {
-                    if (!options.withExtension && (e.code === 'ERR_MODULE_NOT_FOUND' || e.code === 'MODULE_NOT_FOUND')) {
-                        return this.load(locatorInfo, {
-                            ...options,
-                            withExtension: true
-                        });
-                    }
-                    if (!options.withFilePrefix && (e.code === 'ERR_UNSUPPORTED_ESM_URL_SCHEME' || e.code === 'UNSUPPORTED_ESM_URL_SCHEME')) {
-                        return this.load(locatorInfo, {
-                            ...options,
-                            withExtension: true,
-                            withFilePrefix: true
-                        });
-                    }
+                if (!options.withFilePrefix && (e.code === 'ERR_UNSUPPORTED_ESM_URL_SCHEME' || e.code === 'UNSUPPORTED_ESM_URL_SCHEME')) {
+                    return this.load(data, {
+                        ...options,
+                        withFilePrefix: true
+                    });
                 }
                 throw new ebec.BaseError({
                     code: e.code,
@@ -370,22 +428,13 @@ class ModuleLoader {
             /* istanbul ignore next */ return handleException(e);
         }
     }
-    loadSync(data, options) {
-        options = options || {};
-        const [name, locatorInfo] = this.build(data, options);
+    loadSync(data, options = {}) {
+        const id = this.build(data, options);
         try {
             // eslint-disable-next-line global-require,import/no-dynamic-require
-            return require(name);
+            return require(id);
         } catch (e) {
             /* istanbul ignore next */ if (isObject(e) && hasStringProperty(e, 'code')) {
-                if (locatorInfo) {
-                    if (!options.withExtension && (e.code === 'ERR_MODULE_NOT_FOUND' || e.code === 'MODULE_NOT_FOUND')) {
-                        return this.loadSync(locatorInfo, {
-                            ...options,
-                            withExtension: true
-                        });
-                    }
-                }
                 throw new ebec.BaseError({
                     code: e.code,
                     message: hasStringProperty(e, 'message') ? e.message : undefined,
@@ -395,31 +444,16 @@ class ModuleLoader {
             return handleException(e);
         }
     }
-    build(data, options) {
-        let name;
-        let locatorInfo;
-        options = options || {};
+    build(data, options = {}) {
         if (isLocatorInfo(data) || isFilePath(data)) {
-            if (typeof data === 'string') {
-                locatorInfo = pathToLocatorInfo(data);
-            } else {
-                locatorInfo = data;
-            }
-            if (options.withExtension) {
-                name = buildFilePath(locatorInfo);
-            } else {
-                name = buildFilePathWithoutExtension(locatorInfo);
+            if (typeof data !== 'string') {
+                data = buildFilePath(data);
             }
             if (options.withFilePrefix) {
-                name = node_url.pathToFileURL(name).href;
+                data = node_url.pathToFileURL(data).href;
             }
-        } else {
-            name = data;
         }
-        return [
-            name,
-            locatorInfo
-        ];
+        return data;
     }
     constructor(){
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -462,6 +496,31 @@ class JSONLoader {
     }
 }
 
+class YAMLLoader {
+    async execute(input) {
+        const filePath = buildFilePath(input);
+        try {
+            const file = await fs.promises.readFile(filePath, {
+                encoding: 'utf-8'
+            });
+            return yaml.parse(file);
+        } catch (e) {
+            return handleException(e);
+        }
+    }
+    executeSync(input) {
+        const filePath = buildFilePath(input);
+        try {
+            const file = fs.readFileSync(filePath, {
+                encoding: 'utf-8'
+            });
+            return yaml.parse(file);
+        } catch (e) {
+            return handleException(e);
+        }
+    }
+}
+
 /*
  * Copyright (c) 2023.
  * Author Peter Placzek (tada5hi)
@@ -472,6 +531,7 @@ class JSONLoader {
     LoaderId["MODULE"] = "module";
     LoaderId["JSON"] = "json";
     LoaderId["CONF"] = "conf";
+    LoaderId["YAML"] = "yaml";
 })(LoaderId || (LoaderId = {}));
 
 class LoaderManager {
@@ -549,6 +609,11 @@ class LoaderManager {
                     loader = new JSONLoader();
                     break;
                 }
+            case LoaderId.YAML:
+                {
+                    loader = new YAMLLoader();
+                    break;
+                }
             /* istanbul ignore next */ default:
                 {
                     const pluginPath = this.normalizePath(id);
@@ -600,6 +665,12 @@ class LoaderManager {
                     '.json'
                 ],
                 loader: LoaderId.JSON
+            },
+            {
+                test: [
+                    '.yml'
+                ],
+                loader: LoaderId.YAML
             }
         ];
     }
@@ -649,12 +720,14 @@ exports.getModuleExport = getModuleExport;
 exports.handleException = handleException;
 exports.hasOwnProperty = hasOwnProperty;
 exports.hasStringProperty = hasStringProperty;
+exports.isESModule = isESModule;
 exports.isFilePath = isFilePath;
 exports.isJestRuntimeEnvironment = isJestRuntimeEnvironment;
 exports.isLocatorInfo = isLocatorInfo;
 exports.isObject = isObject;
 exports.isSafeObjectKey = isSafeObjectKey;
 exports.isTsNodeRuntimeEnvironment = isTsNodeRuntimeEnvironment;
+exports.isTypeScriptError = isTypeScriptError;
 exports.load = load;
 exports.loadSync = loadSync;
 exports.locate = locate;
@@ -665,4 +738,5 @@ exports.pathToLocatorInfo = pathToLocatorInfo;
 exports.registerLoader = registerLoader;
 exports.removeFileNameExtension = removeFileNameExtension;
 exports.toArray = toArray;
+exports.toModuleRecord = toModuleRecord;
 //# sourceMappingURL=index.cjs.map