breaking: svelte-check v4 (#2453)

- breaking: make TypeScript a peer dependency - breaking: require node 18 or later - breaking: require Svelte 4 or later (devDependencies pinned to Svelte 3 because other packages in this repo still use it. Theoretically we still support Svelte 3 with svelte-check v4 but this gives us the opportunity to adjust that later without a major) - chore: switch from fast-glob to fdir (#2433) closes #2397 fixes #2364 --------- Co-authored-by: Simon Holthausen <[email protected]> Co-authored-by: Ben McCann <[email protected]>
sveltejs · Aug 27, 2024 · d6a2031 · d6a2031
1 parent 0655c67
commit d6a2031
Show file tree

Hide file tree

Showing 8 changed files with 138 additions and 217 deletions.
diff --git a/packages/language-server/package.json b/packages/language-server/package.json
@@ -50,7 +50,7 @@
         "@vscode/emmet-helper": "2.8.4",
         "chokidar": "^3.4.1",
         "estree-walker": "^2.0.1",
-        "fast-glob": "^3.2.7",
+        "fdir": "^6.2.0",
         "lodash": "^4.17.21",
         "prettier": "~3.2.5",
         "prettier-plugin-svelte": "^3.2.2",

diff --git a/packages/language-server/src/lib/documents/configLoader.ts b/packages/language-server/src/lib/documents/configLoader.ts
@@ -4,7 +4,7 @@ import { CompileOptions } from 'svelte/types/compiler/interfaces';
 // @ts-ignore
 import { PreprocessorGroup } from 'svelte/types/compiler/preprocess';
 import { importSveltePreprocess } from '../../importPackage';
-import _glob from 'fast-glob';
+import { fdir } from 'fdir';
 import _path from 'path';
 import _fs from 'fs';
 import { pathToFileURL, URL } from 'url';
@@ -47,6 +47,8 @@ const _dynamicImport = new Function('modulePath', 'return import(modulePath)') a
     modulePath: URL
 ) => Promise<any>;
 
+const configRegex = /\/svelte\.config\.(js|cjs|mjs)$/;
+
 /**
  * Loads svelte.config.{js,cjs,mjs} files. Provides both a synchronous and asynchronous
  * interface to get a config file because snapshots need access to it synchronously.
@@ -61,7 +63,7 @@ export class ConfigLoader {
     private disabled = false;
 
     constructor(
-        private globSync: typeof _glob.sync,
+        private globSync: typeof fdir,
         private fs: Pick<typeof _fs, 'existsSync'>,
         private path: Pick<typeof _path, 'dirname' | 'relative' | 'join'>,
         private dynamicImport: typeof _dynamicImport
@@ -84,12 +86,19 @@ export class ConfigLoader {
         Logger.log('Trying to load configs for', directory);
 
         try {
-            const pathResults = this.globSync('**/svelte.config.{js,cjs,mjs}', {
-                cwd: directory,
-                // the second pattern is necessary because else fast-glob treats .tmp/../node_modules/.. as a valid match for some reason
-                ignore: ['**/node_modules/**', '**/.*/**'],
-                onlyFiles: true
-            });
+            const pathResults = new this.globSync({})
+                .withPathSeparator('/')
+                .exclude((_, path) => {
+                    // no / at the start, path could start with node_modules
+                    return path.includes('node_modules/') || path.includes('/.') || path[0] === '.';
+                })
+                .filter((path, isDir) => {
+                    return !isDir && configRegex.test(path);
+                })
+                .withRelativePaths()
+                .crawl(directory)
+                .sync();
+
             const someConfigIsImmediateFileInDirectory =
                 pathResults.length > 0 && pathResults.some((res) => !this.path.dirname(res));
             if (!someConfigIsImmediateFileInDirectory) {
@@ -296,4 +305,4 @@ export class ConfigLoader {
     }
 }
 
-export const configLoader = new ConfigLoader(_glob.sync, _fs, _path, _dynamicImport);
+export const configLoader = new ConfigLoader(fdir, _fs, _path, _dynamicImport);
diff --git a/packages/language-server/test/lib/documents/configLoader.test.ts b/packages/language-server/test/lib/documents/configLoader.test.ts
@@ -19,6 +19,29 @@ describe('ConfigLoader', () => {
         return path.join(...filePath.split('/'));
     }
 
+    function mockFdir(results: string[] | (() => string[])): any {
+        return class {
+            withPathSeparator() {
+                return this;
+            }
+            exclude() {
+                return this;
+            }
+            filter() {
+                return this;
+            }
+            withRelativePaths() {
+                return this;
+            }
+            crawl() {
+                return this;
+            }
+            sync() {
+                return typeof results === 'function' ? results() : results;
+            }
+        };
+    }
+
     async function assertFindsConfig(
         configLoader: ConfigLoader,
         filePath: string,
@@ -32,7 +55,7 @@ describe('ConfigLoader', () => {
 
     it('should load all config files below and the one inside/above given directory', async () => {
         const configLoader = new ConfigLoader(
-            (() => ['svelte.config.js', 'below/svelte.config.js']) as any,
+            mockFdir(['svelte.config.js', 'below/svelte.config.js']),
             { existsSync: () => true },
             path,
             (module: URL) => Promise.resolve({ default: { preprocess: module.toString() } })
@@ -63,7 +86,7 @@ describe('ConfigLoader', () => {
 
     it('finds first above if none found inside/below directory', async () => {
         const configLoader = new ConfigLoader(
-            () => [],
+            mockFdir([]),
             {
                 existsSync: (p) =>
                     typeof p === 'string' && p.endsWith(path.join('some', 'svelte.config.js'))
@@ -78,7 +101,7 @@ describe('ConfigLoader', () => {
 
     it('adds fallback if no config found', async () => {
         const configLoader = new ConfigLoader(
-            () => [],
+            mockFdir([]),
             { existsSync: () => false },
             path,
             (module: URL) => Promise.resolve({ default: { preprocess: module.toString() } })
@@ -98,14 +121,14 @@ describe('ConfigLoader', () => {
         let firstGlobCall = true;
         let nrImportCalls = 0;
         const configLoader = new ConfigLoader(
-            (() => {
+            mockFdir(() => {
                 if (firstGlobCall) {
                     firstGlobCall = false;
                     return ['svelte.config.js'];
                 } else {
                     return [];
                 }
-            }) as any,
+            }),
             {
                 existsSync: (p) =>
                     typeof p === 'string' &&
@@ -139,11 +162,8 @@ describe('ConfigLoader', () => {
     });
 
     it('can deal with missing config', () => {
-        const configLoader = new ConfigLoader(
-            () => [],
-            { existsSync: () => false },
-            path,
-            () => Promise.resolve('unimportant')
+        const configLoader = new ConfigLoader(mockFdir([]), { existsSync: () => false }, path, () =>
+            Promise.resolve('unimportant')
         );
         assert.deepStrictEqual(
             configLoader.getConfig(normalizePath('/some/file.svelte')),
@@ -153,7 +173,7 @@ describe('ConfigLoader', () => {
 
     it('should await config', async () => {
         const configLoader = new ConfigLoader(
-            () => [],
+            mockFdir([]),
             { existsSync: () => true },
             path,
             (module: URL) => Promise.resolve({ default: { preprocess: module.toString() } })
@@ -167,7 +187,7 @@ describe('ConfigLoader', () => {
     it('should not load config when disabled', async () => {
         const moduleLoader = spy();
         const configLoader = new ConfigLoader(
-            () => [],
+            mockFdir([]),
             { existsSync: () => true },
             path,
             moduleLoader

diff --git a/packages/svelte-check/package.json b/packages/svelte-check/package.json
@@ -1,7 +1,7 @@
 {
     "name": "svelte-check",
     "description": "Svelte Code Checker Terminal Interface",
-    "version": "3.0.0",
+    "version": "4.0.0",
     "main": "./dist/src/index.js",
     "bin": "./bin/svelte-check",
     "author": "The Svelte Community",
@@ -22,16 +22,19 @@
         "url": "https://github.com/sveltejs/language-tools/issues"
     },
     "homepage": "https://github.com/sveltejs/language-tools#readme",
+    "engines": {
+        "node": ">= 18.0.0"
+    },
     "dependencies": {
         "@jridgewell/trace-mapping": "^0.3.17",
         "chokidar": "^3.4.1",
+        "fdir": "^6.2.0",
         "picocolors": "^1.0.0",
-        "sade": "^1.7.4",
-        "svelte-preprocess": "^5.1.3",
-        "typescript": "^5.0.3"
+        "sade": "^1.7.4"
     },
     "peerDependencies": {
-        "svelte": "^3.55.0 || ^4.0.0-next.0 || ^4.0.0 || ^5.0.0-next.0"
+        "svelte": "^4.0.0 || ^5.0.0-next.0",
+        "typescript": ">=5.0.0"
     },
     "scripts": {
         "build": "rollup -c && node ./dist/src/index.js --workspace ./test --tsconfig ./tsconfig.json",
@@ -46,11 +49,12 @@
         "@rollup/plugin-typescript": "^10.0.0",
         "@types/sade": "^1.7.2",
         "builtin-modules": "^3.3.0",
-        "fast-glob": "^3.2.7",
         "rollup": "3.7.5",
         "rollup-plugin-cleanup": "^3.2.0",
         "rollup-plugin-copy": "^3.4.0",
+        "svelte": "^3.57.0",
         "svelte-language-server": "workspace:*",
+        "typescript": "^5.5.2",
         "vscode-languageserver": "8.0.2",
         "vscode-languageserver-protocol": "3.17.2",
         "vscode-languageserver-types": "3.17.2",

diff --git a/packages/svelte-check/rollup.config.mjs b/packages/svelte-check/rollup.config.mjs
@@ -65,7 +65,6 @@ export default [
             'sade',
             'svelte',
             'svelte/compiler',
-            'svelte-preprocess',
             '@jridgewell/trace-mapping'
             // import-fresh removed some time ago, no dependency uses it anymore.
             // if it creeps back in check if the dependency uses a version that

diff --git a/packages/svelte-check/src/index.ts b/packages/svelte-check/src/index.ts
@@ -4,7 +4,7 @@
 
 import { watch } from 'chokidar';
 import * as fs from 'fs';
-import glob from 'fast-glob';
+import { fdir } from 'fdir';
 import * as path from 'path';
 import { SvelteCheck, SvelteCheckOptions } from 'svelte-language-server';
 import { Diagnostic, DiagnosticSeverity } from 'vscode-languageserver-protocol';
@@ -30,11 +30,47 @@ async function openAllDocuments(
     filePathsToIgnore: string[],
     svelteCheck: SvelteCheck
 ) {
-    const files = await glob('**/*.svelte', {
-        cwd: workspaceUri.fsPath,
-        ignore: ['node_modules/**'].concat(filePathsToIgnore.map((ignore) => `${ignore}/**`))
+    const offset = workspaceUri.fsPath.length + 1;
+    // We support a very limited subset of glob patterns: You can only have  ** at the end or the start
+    const ignored: Array<(path: string) => boolean> = filePathsToIgnore.map((i) => {
+        if (i.endsWith('**')) i = i.slice(0, -2);
+
+        if (i.startsWith('**')) {
+            i = i.slice(2);
+
+            if (i.includes('*'))
+                throw new Error(
+                    'Invalid svelte-check --ignore pattern: Only ** at the start or end is supported'
+                );
+
+            return (path) => path.includes(i);
+        }
+
+        if (i.includes('*'))
+            throw new Error(
+                'Invalid svelte-check --ignore pattern: Only ** at the start or end is supported'
+            );
+
+        return (path) => path.startsWith(i);
     });
-    const absFilePaths = files.map((f) => path.resolve(workspaceUri.fsPath, f));
+    const isIgnored = (path: string) => {
+        path = path.slice(offset);
+        for (const i of ignored) {
+            if (i(path)) {
+                return true;
+            }
+        }
+        return false;
+    };
+    const absFilePaths = await new fdir()
+        .filter((path) => path.endsWith('.svelte') && !isIgnored(path))
+        .exclude((_, path) => {
+            return path.includes('/node_modules/') || path.includes('/.');
+        })
+        .withPathSeparator('/')
+        .withFullPaths()
+        .crawl(workspaceUri.fsPath)
+        .withPromise();
 
     for (const absFilePath of absFilePaths) {
         const text = fs.readFileSync(absFilePath, 'utf-8');

diff --git a/packages/svelte-check/src/options.ts b/packages/svelte-check/src/options.ts
@@ -67,13 +67,19 @@ export function parseOptions(cb: (opts: SvelteCheckCliOptions) => any) {
         )
         .action((opts) => {
             const workspaceUri = getWorkspaceUri(opts);
+            const tsconfig = getTsconfig(opts, workspaceUri.fsPath);
+
+            if (opts.ignore && tsconfig) {
+                throwError('`--ignore` only has an effect when using `--no-tsconfig`');
+            }
+
             cb({
                 workspaceUri,
                 outputFormat: getOutputFormat(opts),
                 watch: !!opts.watch,
                 preserveWatchOutput: !!opts.preserveWatchOutput,
-                tsconfig: getTsconfig(opts, workspaceUri.fsPath),
-                filePathsToIgnore: getFilepathsToIgnore(opts),
+                tsconfig,
+                filePathsToIgnore: opts.ignore?.split(',') || [],
                 failOnWarnings: !!opts['fail-on-warnings'],
                 compilerWarnings: getCompilerWarnings(opts),
                 diagnosticSources: getDiagnosticSources(opts),
@@ -141,11 +147,15 @@ function getTsconfig(myArgs: Record<string, any>, workspacePath: string) {
         tsconfig = path.join(workspacePath, tsconfig);
     }
     if (tsconfig && !fs.existsSync(tsconfig)) {
-        throw new Error('Could not find tsconfig/jsconfig file at ' + myArgs.tsconfig);
+        throwError('Could not find tsconfig/jsconfig file at ' + myArgs.tsconfig);
     }
     return tsconfig;
 }
 
+function throwError(msg: string) {
+    throw new Error('Invalid svelte-check CLI args: ' + msg);
+}
+
 function getCompilerWarnings(opts: Record<string, any>) {
     return stringToObj(opts['compiler-warnings']);
 
@@ -180,10 +190,6 @@ function getDiagnosticSources(opts: Record<string, any>): DiagnosticSource[] {
         : diagnosticSources;
 }
 
-function getFilepathsToIgnore(opts: Record<string, any>): string[] {
-    return opts.ignore?.split(',') || [];
-}
-
 const thresholds = ['warning', 'error'] as const;
 type Threshold = (typeof thresholds)[number];