tstyche 4.1.0 → 4.3.0

package/build/tstyche.d.ts

@@ -43,6 +43,7 @@ interface ConfigFileOptions {
     checkSourceFiles?: boolean;
     checkSuppressedErrors?: boolean;
     failFast?: boolean;
+    fixtureFileMatch?: Array<string>;
     plugins?: Array<string>;
     rejectAnyType?: boolean;
     rejectNeverType?: boolean;
@@ -95,13 +96,13 @@ declare class ConfigDiagnosticText {
     static expectsListItemType(optionName: string, optionBrand: OptionBrand): string;
     static expectsValue(optionName: string): string;
     static fileDoesNotExist(filePath: string): string;
+    static fileMatchPatternCannotStartWith(optionName: string, segment: string): Array<string>;
     static inspectSupportedVersions(): string;
     static moduleWasNotFound(specifier: string): string;
     static rangeIsNotValid(value: string): string;
     static rangeUsage(): Array<string>;
     static requiresValueType(optionName: string, optionBrand: OptionBrand): string;
     static seen(element: string): string;
-    static testFileMatchCannotStartWith(segment: string): Array<string>;
     static unexpected(element: string): string;
     static unknownOption(optionName: string): string;
     static usage(optionName: string, optionBrand: OptionBrand): Array<string>;
@@ -558,6 +559,11 @@ declare class ExpectService {
     match(assertion: AssertionNode, onDiagnostics: DiagnosticsHandler<Diagnostic | Array<Diagnostic>>): MatchResult | undefined;
 }
 
+declare class Glob {
+    #private;
+    static toRegex(patterns: Array<string>, target: "directories" | "files"): RegExp;
+}
+
 declare class CancellationHandler implements EventHandler {
     #private;
     constructor(cancellationToken: CancellationToken, cancellationReason: CancellationReason);
@@ -717,6 +723,7 @@ declare class Runner {
 
 declare class Select {
     #private;
+    static isFixtureFile(filePath: string, resolvedConfig: ResolvedConfig): boolean;
     static isTestFile(filePath: string, resolvedConfig: ResolvedConfig): boolean;
     static selectFiles(resolvedConfig: ResolvedConfig): Promise<Array<string>>;
 }
@@ -810,5 +817,5 @@ declare class WhenService {
     action(when: WhenNode): void;
 }
 
-export { AssertionNode, BaseReporter, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Directive, EventEmitter, ExitCodeHandler, ExpectResult, ExpectService, FileWatcher, InputService, Line, ListReporter, OptionBrand, OptionGroup, Options, OutputService, Path, PluginService, ProjectResult, ProjectService, Reject, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, Runner, Scribbler, ScribblerJsx, Select, SelectDiagnosticText, SetupReporter, SourceFile, Store, SummaryReporter, SuppressedService, TargetResult, Task, TaskResult, TestResult, TestTree, TestTreeNode, TestTreeNodeBrand, TestTreeNodeFlags, Text, Version, WatchReporter, WatchService, Watcher, WhenNode, WhenService, addsPackageText, argumentIsProvided, argumentOrTypeArgumentIsProvided, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, environmentOptions, fileViewText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, nodeBelongsToArgumentList, summaryText, taskStatusText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };
+export { AssertionNode, BaseReporter, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Directive, EventEmitter, ExitCodeHandler, ExpectResult, ExpectService, FileWatcher, Glob, InputService, Line, ListReporter, OptionBrand, OptionGroup, Options, OutputService, Path, PluginService, ProjectResult, ProjectService, Reject, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, Runner, Scribbler, ScribblerJsx, Select, SelectDiagnosticText, SetupReporter, SourceFile, Store, SummaryReporter, SuppressedService, TargetResult, Task, TaskResult, TestResult, TestTree, TestTreeNode, TestTreeNodeBrand, TestTreeNodeFlags, Text, Version, WatchReporter, WatchService, Watcher, WhenNode, WhenService, addsPackageText, argumentIsProvided, argumentOrTypeArgumentIsProvided, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, environmentOptions, fileViewText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, nodeBelongsToArgumentList, summaryText, taskStatusText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };
 export type { CodeFrameOptions, CommandLineOptions, ConfigFileOptions, DiagnosticsHandler, DirectiveRange, DirectiveRanges, EnvironmentOptions, Event, EventHandler, FileWatchHandler, InlineConfig, InputHandler, ItemDefinition, MatchResult, OptionDefinition, Plugin, Reporter, ReporterEvent, ResolvedConfig, ScribblerOptions, SelectHookContext, SuppressedError, SuppressedErrors, TargetResultStatus, TaskResultStatus, TextRange, TypeChecker, WatchHandler, WatcherOptions };

package/build/tstyche.js

@@ -225,6 +225,12 @@ class ConfigDiagnosticText {
     static fileDoesNotExist(filePath) {
         return `The specified path '${filePath}' does not exist.`;
     }
+    static fileMatchPatternCannotStartWith(optionName, segment) {
+        return [
+            `A '${optionName}' pattern cannot start with '${segment}'.`,
+            "The files are only collected within the 'rootPath' directory.",
+        ];
+    }
     static inspectSupportedVersions() {
         return "Use the '--list' command line option to inspect the list of supported versions.";
     }
@@ -247,12 +253,6 @@ class ConfigDiagnosticText {
     static seen(element) {
         return `The ${element} was seen here.`;
     }
-    static testFileMatchCannotStartWith(segment) {
-        return [
-            `A test file match pattern cannot start with '${segment}'.`,
-            "The test files are only collected within the 'rootPath' directory.",
-        ];
-    }
     static unexpected(element) {
         return `Unexpected ${element}.`;
     }
@@ -934,6 +934,16 @@ class Options {
             group: OptionGroup.CommandLine,
             name: "fetch",
         },
+        {
+            brand: OptionBrand.List,
+            description: "The list of glob patterns matching the fixture files.",
+            group: OptionGroup.ConfigFile,
+            items: {
+                brand: OptionBrand.String,
+                name: "fixtureFileMatch",
+            },
+            name: "fixtureFileMatch",
+        },
         {
             brand: OptionBrand.BareTrue,
             description: "Print the list of command line options with brief descriptions and exit.",
@@ -1147,10 +1157,11 @@ class Options {
                 }
                 break;
             }
+            case "fixtureFileMatch":
             case "testFileMatch":
                 for (const segment of ["/", "../"]) {
                     if (optionValue.startsWith(segment)) {
-                        onDiagnostics(Diagnostic.error(ConfigDiagnosticText.testFileMatchCannotStartWith(segment), origin));
+                        onDiagnostics(Diagnostic.error(ConfigDiagnosticText.fileMatchPatternCannotStartWith(canonicalOptionName, segment), origin));
                     }
                 }
                 break;
@@ -1402,6 +1413,7 @@ const defaultOptions = {
     checkSourceFiles: true,
     checkSuppressedErrors: false,
     failFast: false,
+    fixtureFileMatch: ["**/__fixtures__/*.{ts,tsx}", "**/fixtures/*.{ts,tsx}"],
     plugins: [],
     rejectAnyType: true,
     rejectNeverType: true,
@@ -2742,7 +2754,64 @@ class InputService {
     }
 }
 
-class GlobPattern {
+class Braces {
+    static expand(text) {
+        const start = text.indexOf("{");
+        if (start === -1) {
+            return [text];
+        }
+        let position = start;
+        let depth = 0;
+        for (position; position < text.length; position++) {
+            if (text[position] === "{") {
+                depth++;
+            }
+            else if (text[position] === "}") {
+                depth--;
+            }
+            if (depth === 0) {
+                break;
+            }
+        }
+        if (depth !== 0) {
+            return [text];
+        }
+        const before = text.slice(0, start);
+        const options = Braces.#splitOptions(text.slice(start + 1, position));
+        const after = text.slice(position + 1);
+        const result = [];
+        for (const option of options) {
+            for (const expanded of Braces.expand(option + after)) {
+                result.push(before + expanded);
+            }
+        }
+        return result;
+    }
+    static #splitOptions(optionText) {
+        const options = [];
+        let current = "";
+        let depth = 0;
+        for (const character of optionText) {
+            if (character === "," && depth === 0) {
+                options.push(current);
+                current = "";
+            }
+            else {
+                if (character === "{") {
+                    depth++;
+                }
+                if (character === "}") {
+                    depth--;
+                }
+                current += character;
+            }
+        }
+        options.push(current);
+        return options;
+    }
+}
+
+class Glob {
     static #reservedCharacterRegex = /[^\w\s/]/g;
     static #parse(pattern, usageTarget) {
         const segments = pattern.split("/");
@@ -2761,7 +2830,7 @@ class GlobPattern {
                 optionalSegmentCount++;
             }
             resultPattern += "\\/";
-            const segmentPattern = segment.replace(GlobPattern.#reservedCharacterRegex, GlobPattern.#replaceReservedCharacter);
+            const segmentPattern = segment.replace(Glob.#reservedCharacterRegex, Glob.#replaceReservedCharacter);
             if (segmentPattern !== segment) {
                 resultPattern += "(?!(node_modules)(\\/|$))";
             }
@@ -2781,7 +2850,10 @@ class GlobPattern {
         }
     }
     static toRegex(patterns, target) {
-        const patternText = patterns.map((pattern) => `(${GlobPattern.#parse(pattern, target)})`).join("|");
+        const patternText = patterns
+            .flatMap((pattern) => Braces.expand(pattern))
+            .map((pattern) => `(${Glob.#parse(pattern, target)})`)
+            .join("|");
         return new RegExp(`^(${patternText})$`);
     }
 }
@@ -2839,8 +2911,8 @@ class Select {
         let matchPatterns = Select.#patternsCache.get(globPatterns);
         if (!matchPatterns) {
             matchPatterns = {
-                includedDirectory: GlobPattern.toRegex(globPatterns, "directories"),
-                includedFile: GlobPattern.toRegex(globPatterns, "files"),
+                includedDirectory: Glob.toRegex(globPatterns, "directories"),
+                includedFile: Glob.toRegex(globPatterns, "files"),
             };
             Select.#patternsCache.set(globPatterns, matchPatterns);
         }
@@ -2856,6 +2928,10 @@ class Select {
         }
         return matchPatterns.includedFile.test(filePath);
     }
+    static isFixtureFile(filePath, resolvedConfig) {
+        const matchPatterns = Select.#getMatchPatterns(resolvedConfig.fixtureFileMatch);
+        return Select.#isFileIncluded(Path.relative(resolvedConfig.rootPath, filePath), matchPatterns, resolvedConfig);
+    }
     static isTestFile(filePath, resolvedConfig) {
         const matchPatterns = Select.#getMatchPatterns(resolvedConfig.testFileMatch);
         return Select.#isFileIncluded(Path.relative(resolvedConfig.rootPath, filePath), matchPatterns, resolvedConfig);
@@ -3690,7 +3766,7 @@ class ProjectService {
                 { diagnostics: Diagnostic.fromDiagnostics(configFileErrors) },
             ]);
         }
-        if (this.#resolvedConfig.checkSourceFiles && !this.#seenTestFiles.has(filePath)) {
+        if (!this.#seenTestFiles.has(filePath)) {
             this.#seenTestFiles.add(filePath);
             const languageService = this.getLanguageService(filePath);
             const program = languageService?.getProgram();
@@ -3702,10 +3778,13 @@ class ProjectService {
                 if (program.isSourceFileFromExternalLibrary(sourceFile) || program.isSourceFileDefaultLibrary(sourceFile)) {
                     return false;
                 }
+                if (Select.isFixtureFile(sourceFile.fileName, { ...this.#resolvedConfig, pathMatch: [] })) {
+                    return true;
+                }
                 if (Select.isTestFile(sourceFile.fileName, { ...this.#resolvedConfig, pathMatch: [] })) {
                     return false;
                 }
-                return true;
+                return this.#resolvedConfig.checkSourceFiles;
             });
             const diagnostics = [];
             for (const sourceFile of sourceFilesToCheck) {
@@ -3723,7 +3802,7 @@ class SuppressedDiagnosticText {
         return [
             "Directive requires an argument.",
             "Add a fragment of the expected error message after the directive.",
-            "To ignore the directive, append a '!' character after it.",
+            "To ignore the directive, append the '!' character after it.",
         ];
     }
     static messageDidNotMatch() {
@@ -3956,7 +4035,9 @@ class MatchWorker {
         }
     }
     extendsObjectType(type) {
-        const nonPrimitiveType = { flags: this.#compiler.TypeFlags.NonPrimitive };
+        const nonPrimitiveType = "getNonPrimitiveType" in this.typeChecker
+            ? this.typeChecker.getNonPrimitiveType()
+            : { flags: this.#compiler.TypeFlags.NonPrimitive };
         return this.typeChecker.isTypeAssignableTo(type, nonPrimitiveType);
     }
     getParameterType(signature, index) {
@@ -5022,7 +5103,7 @@ class TaskRunner {
 class Runner {
     #eventEmitter = new EventEmitter();
     #resolvedConfig;
-    static version = "4.1.0";
+    static version = "4.3.0";
     constructor(resolvedConfig) {
         this.#resolvedConfig = resolvedConfig;
     }
@@ -5222,4 +5303,4 @@ class Cli {
     }
 }
 
-export { AssertionNode, BaseReporter, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Directive, EventEmitter, ExitCodeHandler, ExpectResult, ExpectService, FileWatcher, InputService, Line, ListReporter, OptionBrand, OptionGroup, Options, OutputService, Path, PluginService, ProjectResult, ProjectService, Reject, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, Runner, Scribbler, Select, SelectDiagnosticText, SetupReporter, SourceFile, Store, SummaryReporter, SuppressedService, TargetResult, Task, TaskResult, TestResult, TestTree, TestTreeNode, TestTreeNodeBrand, TestTreeNodeFlags, Text, Version, WatchReporter, WatchService, Watcher, WhenNode, WhenService, addsPackageText, argumentIsProvided, argumentOrTypeArgumentIsProvided, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, environmentOptions, fileViewText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, nodeBelongsToArgumentList, summaryText, taskStatusText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };
+export { AssertionNode, BaseReporter, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Directive, EventEmitter, ExitCodeHandler, ExpectResult, ExpectService, FileWatcher, Glob, InputService, Line, ListReporter, OptionBrand, OptionGroup, Options, OutputService, Path, PluginService, ProjectResult, ProjectService, Reject, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, Runner, Scribbler, Select, SelectDiagnosticText, SetupReporter, SourceFile, Store, SummaryReporter, SuppressedService, TargetResult, Task, TaskResult, TestResult, TestTree, TestTreeNode, TestTreeNodeBrand, TestTreeNodeFlags, Text, Version, WatchReporter, WatchService, Watcher, WhenNode, WhenService, addsPackageText, argumentIsProvided, argumentOrTypeArgumentIsProvided, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, environmentOptions, fileViewText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, nodeBelongsToArgumentList, summaryText, taskStatusText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "description": "Everything You Need for Type Testing.",
   "keywords": [
     "typescript",