fix: Fix how global references are resolved (#4729)

Author: Jason3S

.eslintrc.js

@@ -21,6 +21,9 @@ const config = {
         '**/[Ss]amples/**', // cspell:disable-line
         '**/[Tt]emp/**',
         '**/*.d.ts',
+        '**/*.d.cts',
+        '**/*.d.mts',
+        '**/src/lib*/*.cjs',
         '**/*.map',
         '**/coverage/**',
         '**/cspell-default.config.js',

.github/actions/build-for-integrations/action.yaml

@@ -94,6 +94,11 @@ runs:
         cat /home/runner/.pnpm/_logs/*.log
       shell: bash
 
+    - name: Clean
+      if: ${{ !steps.step-cache-build.outputs.cache-hit }}
+      run: pnpm run clean
+      shell: bash
+
     - name: Build
       if: ${{ !steps.step-cache-build.outputs.cache-hit }}
       run: pnpm run build

.github/actions/build/action.yaml

@@ -110,6 +110,11 @@ runs:
         cat /home/runner/.pnpm/_logs/*.log
       shell: bash
 
+    - name: Clean
+      if: ${{ !steps.step-cache-build.outputs.cache-hit }}
+      run: pnpm run clean
+      shell: bash
+
     - name: Build
       if: ${{ !steps.step-cache-build.outputs.cache-hit }}
       run: pnpm run build

.github/workflows/coverage.yml

@@ -38,18 +38,9 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v2.4.0
+      - name: Install and Build
+        uses: ./.github/actions/install-build
 
-      - name: Use Node.js
-        uses: actions/setup-node@v3
-        with:
-          cache: pnpm
-
-      - run: pnpm -v
-
-      - run: pnpm i
-      - run: pnpm run build
       - run: pnpm run coverage
 
       - name: Upload coverage Coveralls

.gitignore

@@ -36,6 +36,7 @@ lcov.info
 
 dist
 out
+*.d.cts
 
 # And temp files
 

.prettierignore

@@ -28,3 +28,5 @@ test-fixtures/**
 .pnp.js
 **/fixtures/with-errors/**
 api.d.ts
+**/*.d.cts
+**/*.cjs

cspell.code-workspace

@@ -18,6 +18,7 @@
         { "path": "packages/cspell-json-reporter" },
         { "path": "packages/cspell-lib" },
         { "path": "packages/cspell-pipe" },
+        { "path": "packages/cspell-resolver" },
         { "path": "packages/cspell-service-bus" },
         { "path": "packages/cspell-strong-weak-map" },
         { "path": "packages/cspell-tools" },

packages/cspell-gitignore/src/GitIgnore.test.ts

@@ -26,8 +26,8 @@ describe('GitIgnoreServer', () => {
         ${__dirname}             | ${[packages]}     | ${[pkg]}
         ${__dirname}             | ${[pkg, gitRoot]} | ${[pkg]}
         ${p(samples, 'ignored')} | ${undefined}      | ${[gitRoot, pkg, samples]}
-        ${p(pkgCSpellLib)}       | ${[pkg]}          | ${[gitRoot]}
-        ${p(pkgCSpellLib)}       | ${[packages]}     | ${[]}
+        ${p(pkgCSpellLib)}       | ${[pkg]}          | ${[gitRoot, pkgCSpellLib]}
+        ${p(pkgCSpellLib)}       | ${[packages]}     | ${[pkgCSpellLib]}
     `('findGitIgnoreHierarchy $dir $roots', async ({ dir, roots, expected }) => {
         const gs = new GitIgnore(roots);
         const r = await gs.findGitIgnoreHierarchy(dir);

packages/cspell-gitignore/src/__snapshots__/app.test.ts.snap

@@ -25,7 +25,7 @@ exports[`app > app.run [ ' ' ] 1`] = `""`;
 
 exports[`app > app.run [ ' ' ] 2`] = `"Missing files"`;
 
-exports[`app > app.run [ '../node_modules' ] 1`] = `".gitignore:47:node_modules/	../node_modules"`;
+exports[`app > app.run [ '../node_modules' ] 1`] = `".gitignore:48:node_modules/	../node_modules"`;
 
 exports[`app > app.run [ '../node_modules' ] 2`] = `""`;
 
@@ -45,7 +45,7 @@ exports[`app > app.run [ 'src/code.ts' ] 1`] = `"::	src/code.ts"`;
 
 exports[`app > app.run [ 'src/code.ts' ] 2`] = `""`;
 
-exports[`app > app.run [ 'temp' ] 1`] = `".gitignore:42:temp	temp"`;
+exports[`app > app.run [ 'temp' ] 1`] = `".gitignore:43:temp	temp"`;
 
 exports[`app > app.run [ 'temp' ] 2`] = `""`;
 

packages/cspell-gitignore/vitest.config.ts packages/cspell-gitignore/vitest.config.mts

@@ -1,7 +1,7 @@
 import { mergeConfig } from 'vite';
 import { defineConfig } from 'vitest/config';
 
-import viteConfig from '../../vitest.config';
+import viteConfig from '../../vitest.config.mjs';
 
 export default mergeConfig(
     viteConfig,

packages/cspell-lib/.gitignore

@@ -0,0 +1 @@
+src/**/*.cjs

packages/cspell-lib/package.json

@@ -60,6 +60,7 @@
   "dependencies": {
     "@cspell/cspell-bundled-dicts": "workspace:*",
     "@cspell/cspell-pipe": "workspace:*",
+    "@cspell/cspell-resolver": "workspace:*",
     "@cspell/cspell-types": "workspace:*",
     "@cspell/strong-weak-map": "workspace:*",
     "clear-module": "^4.1.2",
@@ -76,7 +77,6 @@
     "gensequence": "^5.0.2",
     "import-fresh": "^3.3.0",
     "resolve-from": "^5.0.0",
-    "resolve-global": "^1.0.0",
     "vscode-languageserver-textdocument": "^1.0.8",
     "vscode-uri": "^3.0.7"
   },

packages/cspell-lib/src/lib-cjs/tsconfig.cjs.json

@@ -0,0 +1,14 @@
+{
+    "extends": "../../../../tsconfig.cjs.json",
+    "compilerOptions": {
+        "allowJs": false,
+        "composite": true,
+        "tsBuildInfoFile": "../../temp/compile.lib-cjs.tsbuildInfo",
+        "module": "CommonJS",
+        "moduleResolution": "node16",
+        "rootDir": ".",
+        "outDir": "../../dist/lib-cjs",
+        "types": ["node"]
+    },
+    "files": ["index.cts", "pkg-info.cts", "vscodeUri.cts"]
+}

packages/cspell-lib/src/lib-cjs/tsconfig.json

@@ -1,14 +1,3 @@
 {
-    "extends": "../../../../tsconfig.cjs.json",
-    "compilerOptions": {
-        "allowJs": false,
-        "composite": true,
-        "tsBuildInfoFile": "../../temp/compile.lib-cjs.tsbuildInfo",
-        "module": "CommonJS",
-        "moduleResolution": "node16",
-        "rootDir": ".",
-        "outDir": "../../dist/lib-cjs",
-        "types": ["node"]
-    },
-    "include": ["**/*.cts"]
+    "references": [{ "path": "./tsconfig.cjs.json" }, { "path": "./tsconfig.test.json" }]
 }

packages/cspell-lib/src/lib-cjs/tsconfig.test.json

@@ -0,0 +1,14 @@
+/*
+ Note: this configuration is needed to work around a bug in vite / vitest that cannot
+ convert .cts files to .cjs.
+ */
+{
+    "extends": "./tsconfig.cjs.json",
+    "compilerOptions": {
+        "declarationMap": false,
+        "sourceMap": false,
+        "tsBuildInfoFile": "../../temp/compile.lib-test.tsbuildInfo",
+        "outDir": ".",
+        "types": ["node"]
+    }
+}

packages/cspell-lib/src/lib/util/resolveFile.ts

@@ -1,8 +1,8 @@
+import { resolveGlobal } from '@cspell/cspell-resolver';
 import * as fs from 'fs';
 import * as os from 'os';
 import * as path from 'path';
 import resolveFrom from 'resolve-from';
-import resolveGlobal from 'resolve-global';
 
 export interface ResolveFileResult {
     filename: string;
@@ -94,7 +94,7 @@ function tryNodeResolve(filename: string, relativeTo: string): ResolveFileResult
 }
 
 function tryResolveGlobal(filename: string): ResolveFileResult {
-    const r = resolveGlobal.silent(filename);
+    const r = resolveGlobal(filename);
     return { filename: r || filename, relativeTo: undefined, found: !!r };
 }
 

packages/cspell-lib/tsconfig.esm.json

@@ -11,5 +11,5 @@
         "types": ["node"]
     },
     "include": ["src/lib", "src/lib-cjs/vscode-uri.cts"],
-    "references": [{ "path": "./src/lib-cjs" }, { "path": "./src/test-util" }]
+    "references": [{ "path": "./src/lib-cjs/tsconfig.cjs.json" }, { "path": "./src/test-util" }]
 }

packages/cspell-resolver/.gitignore

@@ -0,0 +1,4 @@
+# Sample .gitignore
+
+dist
+temp

packages/cspell-resolver/CHANGELOG.md

@@ -0,0 +1 @@
+# Change Log

packages/cspell-resolver/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 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.

packages/cspell-resolver/README.md

@@ -0,0 +1,11 @@
+# CSpell Module Resolver
+
+A library to assist with resolving module and file locations for import / loading.
+
+## Install
+
+```sh
+npm install -S @cspell/cspell-resolver
+```
+
+<!--- @@inject: ../../static/footer.md --->

packages/cspell-resolver/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@cspell/cspell-resolver",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "7.0.0",
+  "description": "Library to help resolve module locations.",
+  "keywords": [
+    "cspell",
+    "resolve"
+  ],
+  "author": "Jason Dent <jason@streetsidesoftware.nl>",
+  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-resolver#readme",
+  "license": "MIT",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "directories": {
+    "dist": "dist"
+  },
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "!**/*.tsbuildInfo",
+    "!**/__mocks__",
+    "!**/*.spec.*",
+    "!**/*.test.*",
+    "!**/test/**",
+    "!**/*.map"
+  ],
+  "scripts": {
+    "build": "tsc -p .",
+    "watch": "tsc -p . -w",
+    "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
+    "clean-build": "pnpm run clean && pnpm run build",
+    "coverage": "vitest run --coverage",
+    "test-watch": "vitest",
+    "test": "vitest run"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/streetsidesoftware/cspell.git"
+  },
+  "bugs": {
+    "url": "https://github.com/streetsidesoftware/cspell/issues"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "dependencies": {
+    "global-dirs": "^3.0.1"
+  }
+}

packages/cspell-resolver/src/__snapshots__/index.test.ts.snap

@@ -0,0 +1,8 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`index > index methods exist 1`] = `
+[
+  "requireResolve",
+  "resolveGlobal",
+]
+`;

packages/cspell-resolver/src/index.test.ts

@@ -0,0 +1,9 @@
+import { describe, expect, test } from 'vitest';
+
+import * as m from './index';
+
+describe('index', () => {
+    test('index methods exist', () => {
+        expect(Object.keys(m)).toMatchSnapshot();
+    });
+});

packages/cspell-resolver/src/index.ts

@@ -0,0 +1 @@
+export { requireResolve, resolveGlobal } from './requireResolve.js';

packages/cspell-resolver/src/requireResolve.test.ts

@@ -0,0 +1,14 @@
+import * as path from 'path';
+import { describe, expect, test } from 'vitest';
+
+import { requireResolve, resolveGlobal } from './requireResolve.js';
+
+describe('requireResolve', () => {
+    test('requireResolve', () => {
+        expect(requireResolve('./' + path.basename(__filename))).toEqual(__filename);
+    });
+
+    test('resolveGlobal not found', () => {
+        expect(resolveGlobal('not-found-module')).toBeUndefined();
+    });
+});

packages/cspell-resolver/src/requireResolve.ts

@@ -0,0 +1,14 @@
+import { npm, yarn } from 'global-dirs';
+
+export function resolveGlobal(modulesName: string): string | undefined {
+    const paths = [npm.packages, yarn.packages];
+    return requireResolve(modulesName, paths);
+}
+
+export function requireResolve(filename: string, paths?: string[]): string | undefined {
+    try {
+        return require.resolve(filename, paths ? { paths } : undefined);
+    } catch (e) {
+        return undefined;
+    }
+}

packages/cspell-resolver/tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "extends": "../../tsconfig.cjs.json",
+    "compilerOptions": {
+        "module": "CommonJS",
+        "moduleResolution": "node16",
+        "outDir": "dist",
+        "types": ["node"]
+    },
+    "include": ["src"]
+}

packages/cspell/.gitignore

@@ -1,7 +1,7 @@
 /api
-/lib/*.map
-/lib/*.d.cts
-/lib/*.cjs
+/src/lib/*.map
+/src/lib/*.d.cts
+/src/lib/*.cjs
 /dist.*/**
 /esm
 /dist