cspell-lib 8.1.2 → 8.1.3

package/dist/esm/Settings/Controller/configLoader/configLoader.js

@@ -320,6 +320,9 @@ function resolveFilename(filename, relativeTo) {
     if (filename instanceof URL)
         return { filename: toFilePathOrHref(filename) };
     const r = resolveFile(filename, relativeTo);
+    if (r.warning) {
+        logWarning(r.warning);
+    }
     return {
         filename: r.filename.startsWith('file:/') ? fileURLToPath(r.filename) : r.filename,
         error: r.found ? undefined : new Error(`Failed to resolve file: "${filename}"`),

package/dist/esm/util/resolveFile.d.ts

@@ -1,8 +1,19 @@
 import { fileURLOrPathToPath, isFileURL, isURLLike } from './url.js';
 export interface ResolveFileResult {
+    /**
+     * Absolute path or URL to the file.
+     */
     filename: string;
     relativeTo: string | undefined;
     found: boolean;
+    /**
+     * A warning message if the file was found, but there was a problem.
+     */
+    warning?: string;
+    /**
+     * The method used to resolve the file.
+     */
+    method: string;
 }
 /**
  * Resolve filename to absolute paths.
@@ -11,6 +22,7 @@ export interface ResolveFileResult {
  * @param relativeTo absolute path
  */
 export declare function resolveFile(filename: string, relativeTo: string | URL): ResolveFileResult;
+export declare function _resolveFile(filename: string, relativeTo: string | URL): ResolveFileResult;
 /**
  * Check to see if it is a URL.
  * Note: URLs are absolute!

package/dist/esm/util/resolveFile.js

@@ -8,7 +8,7 @@ import resolveFrom from 'resolve-from';
 import { fileURLToPath } from 'url';
 import { srcDirectory } from '../../lib-cjs/pkg-info.cjs';
 import { fileURLOrPathToPath, isDataURL, isFileURL, isURLLike, resolveFileWithURL, toFilePathOrHref, toURL, } from './url.js';
-const testNodeModules = /^node_modules\//;
+const regExpStartsWidthNodeModules = /^node_modules[/\\]/;
 /**
  * Resolve filename to absolute paths.
  * It tries to look for local files as well as node_modules
@@ -16,6 +16,14 @@ const testNodeModules = /^node_modules\//;
  * @param relativeTo absolute path
  */
 export function resolveFile(filename, relativeTo) {
+    const result = _resolveFile(filename, relativeTo);
+    const match = filename.match(regExpStartsWidthNodeModules);
+    if (match) {
+        result.warning ??= `Import of '${filename}' should not start with '${match[0]}' in '${toFilePathOrHref(relativeTo)}'. Use '${filename.replace(regExpStartsWidthNodeModules, '')}' or a relative path instead.`;
+    }
+    return result;
+}
+export function _resolveFile(filename, relativeTo) {
     filename = filename.replace(/^~/, os.homedir());
     const steps = [
         { filename, fn: tryUrl },
@@ -25,20 +33,21 @@ export function resolveFile(filename, relativeTo) {
         { filename, fn: tryResolveExists },
         { filename, fn: tryNodeResolveDefaultPaths },
         { filename, fn: tryResolveFrom },
-        { filename: filename.replace(testNodeModules, ''), fn: tryResolveFrom },
         { filename, fn: tryResolveGlobal },
+        { filename, fn: tryLegacyResolve },
     ];
     for (const step of steps) {
         const r = step.fn(step.filename, relativeTo);
         if (r?.found)
             return r;
     }
-    const r = tryUrl(filename, relativeTo);
-    return (r || {
+    const result = tryUrl(filename, relativeTo) || {
         filename: isRelative(filename) ? joinWith(filename, relativeTo) : filename.toString(),
         relativeTo: relativeTo.toString(),
         found: false,
-    });
+        method: 'not found',
+    };
+    return result;
 }
 /**
  * Check to see if it is a URL.
@@ -55,9 +64,10 @@ function tryUrl(filename, relativeToURL) {
                 filename: file,
                 relativeTo: undefined,
                 found: fs.existsSync(file),
+                method: 'tryUrl',
             };
         }
-        return { filename: filename.toString(), relativeTo: undefined, found: true };
+        return { filename: filename.toString(), relativeTo: undefined, found: true, method: 'tryUrl' };
     }
     if (isURLLike(relativeToURL) && !isDataURL(relativeToURL)) {
         const relToURL = toURL(relativeToURL);
@@ -67,6 +77,7 @@ function tryUrl(filename, relativeToURL) {
             filename: toFilePathOrHref(url),
             relativeTo: toFilePathOrHref(relToURL),
             found: !isRelToAFile || fs.existsSync(url),
+            method: 'tryUrl',
         };
     }
     return undefined;
@@ -77,7 +88,7 @@ function tryCreateRequire(filename, relativeTo) {
     const require = createRequire(relativeTo);
     try {
         const r = require.resolve(filename);
-        return { filename: r, relativeTo: relativeTo.toString(), found: true };
+        return { filename: r, relativeTo: relativeTo.toString(), found: true, method: 'tryCreateRequire' };
     }
     catch (_) {
         return undefined;
@@ -86,7 +97,7 @@ function tryCreateRequire(filename, relativeTo) {
 function tryNodeResolveDefaultPaths(filename) {
     try {
         const r = require.resolve(filename);
-        return { filename: r, relativeTo: undefined, found: true };
+        return { filename: r, relativeTo: undefined, found: true, method: 'tryNodeResolveDefaultPaths' };
     }
     catch (_) {
         return undefined;
@@ -94,7 +105,7 @@ function tryNodeResolveDefaultPaths(filename) {
 }
 function tryNodeRequireResolve(filenameOrURL, relativeTo) {
     const filename = fileURLOrPathToPath(filenameOrURL);
-    const relativeToPath = fileURLOrPathToPath(relativeTo);
+    const relativeToPath = pathFromRelativeTo(relativeTo);
     const home = os.homedir();
     function calcPaths(p) {
         const paths = [p];
@@ -110,7 +121,7 @@ function tryNodeRequireResolve(filenameOrURL, relativeTo) {
     const paths = calcPaths(path.resolve(relativeToPath));
     try {
         const r = require.resolve(filename, { paths });
-        return { filename: r, relativeTo: relativeToPath, found: true };
+        return { filename: r, relativeTo: relativeToPath, found: true, method: 'tryNodeRequireResolve' };
     }
     catch (_) {
         return undefined;
@@ -120,7 +131,7 @@ function tryImportResolve(filename, relativeTo) {
     try {
         const paths = isRelative(filename) ? [relativeTo] : [relativeTo, srcDirectory];
         const resolved = fileURLToPath(importResolveModuleName(filename, paths));
-        return { filename: resolved, relativeTo: relativeTo.toString(), found: true };
+        return { filename: resolved, relativeTo: relativeTo.toString(), found: true, method: 'tryImportResolve' };
     }
     catch (_) {
         return undefined;
@@ -128,35 +139,59 @@ function tryImportResolve(filename, relativeTo) {
 }
 function tryResolveGlobal(filename) {
     const r = resolveGlobal(filename);
-    return (r && { filename: r, relativeTo: undefined, found: true }) || undefined;
+    return (r && { filename: r, relativeTo: undefined, found: true, method: 'tryResolveGlobal' }) || undefined;
 }
 function tryResolveExists(filename, relativeTo) {
-    if (filename instanceof URL || isURLLike(filename) || isURLLike(relativeTo))
+    if (filename instanceof URL || isURLLike(filename) || (isURLLike(relativeTo) && !isFileURL(relativeTo))) {
         return undefined;
-    const toTry = [{ filename }, { filename: path.resolve(relativeTo.toString(), filename), relativeTo }];
+    }
+    relativeTo = pathFromRelativeTo(relativeTo);
+    const toTry = [{ filename }, { filename: path.resolve(relativeTo, filename), relativeTo }];
     for (const { filename, relativeTo } of toTry) {
         const found = path.isAbsolute(filename) && fs.existsSync(filename);
         if (found)
-            return { filename, relativeTo: relativeTo?.toString(), found };
+            return { filename, relativeTo: relativeTo?.toString(), found, method: 'tryResolveExists' };
     }
     filename = path.resolve(filename);
     return {
         filename,
         relativeTo: path.resolve('.'),
         found: fs.existsSync(filename),
+        method: 'tryResolveExists',
     };
 }
 function tryResolveFrom(filename, relativeTo) {
     if (relativeTo instanceof URL)
         return undefined;
     try {
-        return { filename: resolveFrom(relativeTo, filename), relativeTo, found: true };
+        return {
+            filename: resolveFrom(pathFromRelativeTo(relativeTo), filename),
+            relativeTo,
+            found: true,
+            method: 'tryResolveFrom',
+        };
     }
     catch (error) {
         // Failed to resolve a relative module request
         return undefined;
     }
 }
+function tryLegacyResolve(filename, relativeTo) {
+    if (filename instanceof URL || isURLLike(filename) || (isURLLike(relativeTo) && !isFileURL(relativeTo))) {
+        return undefined;
+    }
+    const relativeToPath = isURLLike(relativeTo) ? fileURLToPath(new URL('./', relativeTo)) : relativeTo.toString();
+    const match = filename.match(regExpStartsWidthNodeModules);
+    if (match) {
+        const fixedFilename = filename.replace(regExpStartsWidthNodeModules, '');
+        const found = tryImportResolve(fixedFilename, relativeToPath) || tryResolveFrom(fixedFilename, relativeToPath);
+        if (found?.found) {
+            found.method = 'tryLegacyResolve';
+            return found;
+        }
+    }
+    return undefined;
+}
 function isRelative(filename) {
     if (filename instanceof URL)
         return false;
@@ -175,6 +210,9 @@ function joinWith(filename, relativeTo) {
         ? toFilePathOrHref(new URL(filename, relativeTo))
         : path.resolve(relativeTo, filename);
 }
+function pathFromRelativeTo(relativeTo) {
+    return relativeTo instanceof URL || isURLLike(relativeTo) ? fileURLToPath(new URL('./', relativeTo)) : relativeTo;
+}
 export const __testing__ = {
     isRelative,
     isFileURL,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "8.1.2",
+  "version": "8.1.3",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -57,21 +57,21 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "8.1.2",
-    "@cspell/cspell-pipe": "8.1.2",
-    "@cspell/cspell-resolver": "8.1.2",
-    "@cspell/cspell-types": "8.1.2",
-    "@cspell/dynamic-import": "8.1.2",
-    "@cspell/strong-weak-map": "8.1.2",
+    "@cspell/cspell-bundled-dicts": "8.1.3",
+    "@cspell/cspell-pipe": "8.1.3",
+    "@cspell/cspell-resolver": "8.1.3",
+    "@cspell/cspell-types": "8.1.3",
+    "@cspell/dynamic-import": "8.1.3",
+    "@cspell/strong-weak-map": "8.1.3",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.3",
     "configstore": "^6.0.0",
-    "cspell-config-lib": "8.1.2",
-    "cspell-dictionary": "8.1.2",
-    "cspell-glob": "8.1.2",
-    "cspell-grammar": "8.1.2",
-    "cspell-io": "8.1.2",
-    "cspell-trie-lib": "8.1.2",
+    "cspell-config-lib": "8.1.3",
+    "cspell-dictionary": "8.1.3",
+    "cspell-glob": "8.1.3",
+    "cspell-grammar": "8.1.3",
+    "cspell-io": "8.1.3",
+    "cspell-trie-lib": "8.1.3",
     "fast-equals": "^5.0.1",
     "gensequence": "^6.0.0",
     "import-fresh": "^3.3.0",
@@ -95,5 +95,5 @@
     "cspell-dict-nl-nl": "^1.1.2",
     "lorem-ipsum": "^2.0.8"
   },
-  "gitHead": "ba4eef94480562e7641298b32cb99723fd64aeca"
+  "gitHead": "ea4335117b7c0e7b9ec22738315c82fae24ea997"
 }