feat: Add glob support for URLs (#5824)

streetsidesoftware · Jun 29, 2024 · 8081fca · 8081fca
1 parent ca5159e
commit 8081fca
Show file tree

Hide file tree

Showing 55 changed files with 6,202 additions and 1,087 deletions.
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -7,6 +7,12 @@
  "options": {
  "trailingComma": "none"
  }
+ },
+ {
+ "files": "**/src/GlobMatcher.test.ts",
+ "options": {
+ "printWidth": 180
+ }
  }
  ]
 }
diff --git a/cspell.code-workspace b/cspell.code-workspace
@@ -41,7 +41,14 @@
  "autoAttachChildProcesses": true,
  "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
  "program": "${workspaceRoot:cspell-monorepo}/node_modules/vitest/vitest.mjs",
- "args": ["run", "--test-timeout=600000", "${relativeFile}"],
+ "args": [
+ "run",
+ "--testTimeout=600000",
+ "--hideSkippedTests",
+ "--reporter=basic",
+ "--no-file-parallelism",
+ "${relativeFile}"
+ ],
  "cwd": "${fileWorkspaceFolder}",
  "smartStep": true,
  "console": "integratedTerminal"

diff --git a/packages/cspell-gitignore/package.json b/packages/cspell-gitignore/package.json
@@ -53,7 +53,9 @@
  "node": ">=18"
  },
  "dependencies": {
+ "@cspell/url": "workspace:*",
  "cspell-glob": "workspace:*",
+ "cspell-io": "workspace:*",
  "find-up-simple": "^1.0.0"
  }
 }
diff --git a/packages/cspell-gitignore/src/GitIgnore.test.ts b/packages/cspell-gitignore/src/GitIgnore.test.ts
@@ -1,15 +1,25 @@
 import * as path from 'node:path';
+import { fileURLToPath } from 'node:url';
 
 import { describe, expect, test } from 'vitest';
 
 import { GitIgnore } from './GitIgnore.js';
 
-const pkg = path.resolve(__dirname, '..');
-const packages = path.resolve(pkg, '..');
-const gitRoot = path.resolve(packages, '..');
-const samples = path.resolve(pkg, 'samples');
-const pkgCSpellLib = path.join(packages, 'cspell-lib');
-const gitIgnoreFile = path.resolve(gitRoot, '.gitignore');
+const dirUrl = new URL('.', import.meta.url);
+
+const pkgUrl = new URL('../', dirUrl);
+const packagesUrl = new URL('../', pkgUrl);
+const gitRootUrl = new URL('../', packagesUrl);
+const samplesUrl = new URL('samples/', pkgUrl);
+const pkgCSpellLibUrl = new URL('cspell-lib/', packagesUrl);
+const gitIgnoreFileUrl = new URL('.gitignore', gitRootUrl);
+
+const pkg = fileURLToPath(pkgUrl);
+const packages = fileURLToPath(packagesUrl);
+const gitRoot = fileURLToPath(gitRootUrl);
+const samples = fileURLToPath(samplesUrl);
+const pkgCSpellLib = fileURLToPath(pkgCSpellLibUrl);
+const gitIgnoreFile = fileURLToPath(gitIgnoreFileUrl);
 // const pathSamples = path.resolve(pkg, 'samples');
 // const gitIgnoreSamples = path.resolve(pathSamples, '.gitignore');
 
@@ -58,12 +68,23 @@ describe('GitIgnoreServer', () => {
  file | roots | expected
  ${__filename} | ${undefined} | ${undefined}
  ${p(samples, 'ignored/keepme.md')} | ${undefined} | ${undefined}
- ${p(samples, 'ignored/file.txt')} | ${undefined} | ${{ glob: 'ignored/**', matched: true, line: 3, root: samples, gitIgnoreFile: p(samples, '.gitignore') }}
- ${p(pkg, 'node_modules/bin')} | ${undefined} | ${oc({ glob: 'node_modules/', matched: true, root: gitRoot, gitIgnoreFile: gitIgnoreFile })}
+ ${p(samples, 'ignored/file.txt')} | ${undefined} | ${{ glob: 'ignored/**', matched: true, line: 3, root: pr(samples), gitIgnoreFile: p(samples, '.gitignore') }}
+ ${p(pkg, 'node_modules/bin')} | ${undefined} | ${oc({ glob: 'node_modules/', matched: true, root: pr(gitRoot), gitIgnoreFile: gitIgnoreFile })}
+ ${p(pkg, 'node_modules/')} | ${undefined} | ${oc({ glob: 'node_modules/', matched: true, root: pr(gitRoot), gitIgnoreFile: gitIgnoreFile })}
  ${__filename} | ${[p(samples, 'ignored')]} | ${undefined}
  ${p(samples, 'ignored/keepme.md')} | ${[p(samples, 'ignored')]} | ${undefined}
  ${p(samples, 'ignored/file.txt')} | ${[p(samples, 'ignored')]} | ${undefined}
- ${p(pkg, 'node_modules/bin')} | ${[p(samples, 'ignored')]} | ${oc({ glob: 'node_modules/', matched: true, root: gitRoot, gitIgnoreFile: gitIgnoreFile })}
+ ${p(pkg, 'node_modules/bin')} | ${[p(samples, 'ignored')]} | ${oc({ glob: 'node_modules/', matched: true, root: pr(gitRoot), gitIgnoreFile: gitIgnoreFile })}
+ `('isIgnoredEx $file $roots', async ({ file, roots, expected }) => {
+ const dir = path.dirname(file);
+ const gs = new GitIgnore(roots);
+ const r = await gs.findGitIgnoreHierarchy(dir);
+ expect(r.isIgnoredEx(file)).toEqual(expected);
+ });
+
+ test.each`
+ file | roots | expected
+ ${p(pkg, 'node_modules/')} | ${undefined} | ${oc({ glob: 'node_modules/', matched: true, root: pr(gitRoot), gitIgnoreFile: gitIgnoreFile })}
  `('isIgnoredEx $file $roots', async ({ file, roots, expected }) => {
  const dir = path.dirname(file);
  const gs = new GitIgnore(roots);
@@ -77,6 +98,7 @@ describe('GitIgnoreServer', () => {
  p(samples, 'ignored/keepme.md'),
  p(samples, 'ignored/file.txt'),
  p(pkg, 'node_modules/bin'),
+ p(pkg, 'node_modules/'),
  ];
  const gs = new GitIgnore();
  const r = await gs.filterOutIgnored(files);
@@ -118,4 +140,8 @@ describe('GitIgnoreServer', () => {
  function p(dir: string, ...dirs: string[]) {
  return path.join(dir, ...dirs);
  }
+
+ function pr(...dirs: string[]) {
+ return path.join(path.resolve(...dirs), './');
+ }
 });
diff --git a/packages/cspell-gitignore/src/GitIgnoreFile.test.ts b/packages/cspell-gitignore/src/GitIgnoreFile.test.ts
@@ -1,4 +1,5 @@
 import * as path from 'node:path';
+import { fileURLToPath } from 'node:url';
 
 import { GlobMatcher } from 'cspell-glob';
 import { describe, expect, test } from 'vitest';
@@ -7,8 +8,9 @@ import { __testing__, GitIgnoreFile, GitIgnoreHierarchy, loadGitIgnore } from '.
 
 const { mustBeHierarchical } = __testing__;
 
+const __dirname = fileURLToPath(new URL('./', import.meta.url));
 const pathPackage = path.resolve(__dirname, '..');
-const pathRepo = path.resolve(pathPackage, '../..');
+const pathRepo = path.join(path.resolve(pathPackage, '../..'), './');
 const gitIgnoreFile = path.resolve(pathRepo, '.gitignore');
 
 const oc = (obj: unknown) => expect.objectContaining(obj);

diff --git a/packages/cspell-gitignore/src/__snapshots__/app.test.ts.snap b/packages/cspell-gitignore/src/__snapshots__/app.test.ts.snap
@@ -29,6 +29,10 @@ exports[`app > app.run [ '../node_modules' ] 1`] = `".gitignore:50:node_modules/
 
 exports[`app > app.run [ '../node_modules' ] 2`] = `""`;
 
+exports[`app > app.run [ '../node_modules/.bin/run.mjs' ] 1`] = `".gitignore:50:node_modules/ ../node_modules/.bin/run.mjs"`;
+
+exports[`app > app.run [ '../node_modules/.bin/run.mjs' ] 2`] = `""`;
+
 exports[`app > app.run [ '-r', '.' ] 1`] = `""`;
 
 exports[`app > app.run [ '-r', '.' ] 2`] = `"Missing files"`;

diff --git a/packages/cspell-gitignore/src/app.test.ts b/packages/cspell-gitignore/src/app.test.ts
@@ -22,6 +22,7 @@ describe('app', () => {
  params
  ${[path.basename(__dirname) + '/code.ts']}
  ${['../node_modules']}
+ ${['../node_modules/.bin/run.mjs']}
  ${['-r', '.', 'dist']}
  ${['temp']}
  ${['-r', '.', 'temp']}

diff --git a/packages/cspell-gitignore/src/app.ts b/packages/cspell-gitignore/src/app.ts
@@ -40,8 +40,9 @@ export async function run(args: string[]): Promise<void> {
  for (const file of files) {
  const filename = path.relative(cwd, file);
  const pFile = gi.isIgnoredEx(file);
- const pDir = gi.isIgnoredEx(file + '/ ');
+ const pDir = gi.isIgnoredEx(file + '/');
  const r = (await pFile) || (await pDir);
+ console.warn('%o', { pFile: await pFile, pDir: await pDir });
  const gitignore = r?.gitIgnoreFile ? path.relative(repo, r.gitIgnoreFile) : '';
  const line = r?.line || '';
  const glob = r?.glob || '';

diff --git a/packages/cspell-gitignore/tsconfig.esm.json b/packages/cspell-gitignore/tsconfig.esm.json
diff --git a/packages/cspell-gitignore/tsconfig.json b/packages/cspell-gitignore/tsconfig.json
@@ -1,4 +1,9 @@
 {
- "files": [],
- "references": [{ "path": "./tsconfig.esm.json" }]
+ "extends": "../../tsconfig.esm.json",
+ "compilerOptions": {
+ "rootDir": "src",
+ "outDir": "dist",
+ "types": ["node"]
+ },
+ "include": ["src"]
 }
diff --git a/packages/cspell-glob/package.json b/packages/cspell-glob/package.json
@@ -11,11 +11,11 @@
  "license": "MIT",
  "type": "module",
  "sideEffects": false,
- "types": "dist/esm/index.d.ts",
- "module": "dist/esm/index.js",
+ "types": "dist/index.d.ts",
+ "module": "dist/index.js",
  "exports": {
  ".": {
- "import": "./dist/esm/index.js"
+ "import": "./dist/index.js"
  }
  },
  "files": [
@@ -25,18 +25,22 @@
  "!**/__mocks__",
  "!**/test/**",
  "!**/*.test.*",
+ "!**/perf/**",
+ "!**/*.perf.*",
  "!**/*.spec.*",
  "!**/*.map"
  ],
  "scripts": {
  "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
- "build": "tsc -b . -f",
- "build:esm": "tsc -p tsconfig.esm.json",
+ "build": "tsc -p .",
  "clean-build": "pnpm run clean && pnpm run build",
  "coverage": "vitest run --coverage",
+ "test:perf": "insight --file \"dist/perf/**/*.perf.{mjs,js}\" -t 1000",
+ "test:perf:ts": "insight --register ts-node/esm --file \"src/perf/**/*.perf.{mts,ts}\" -t 1000",
+ "test:perf:prof": "NODE_ENV=production node --cpu-prof ../../node_modules/perf-insight/bin.mjs --file \"dist/perf/**/*.perf.{mjs,js}\" -t 1000",
  "test:watch": "vitest",
  "test": "vitest run",
- "watch": "tsc -b . -w -f"
+ "watch": "tsc -p . -w"
  },
  "repository": {
  "type": "git",
@@ -50,6 +54,7 @@
  "node": ">=18"
  },
  "dependencies": {
+ "@cspell/url": "workspace:*",
  "micromatch": "^4.0.7"
  },
  "devDependencies": {