tstyche 1.0.0-beta.9 → 1.0.0-rc

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.0.0-rc] - 2024-01-28
+
+### Changed
+
+- **Breaking!** Replace the `allowNoTestFiles` option with `disableTestFileLookup` ([#104](https://github.com/tstyche/tstyche/pull/104))
+
+### Added
+
+- **New!** Set default compiler options for inferred (e.g. JavaScript) projects ([#93](https://github.com/tstyche/tstyche/pull/93))
+- Add the `TSTYCHE_NO_INTERACTIVE` environment variable ([#88](https://github.com/tstyche/tstyche/pull/88))
+- Add the `TSTYCHE_TYPESCRIPT_PATH` environment variable ([#84](https://github.com/tstyche/tstyche/pull/84))
+
+### Fixed
+
+- Only select TypeScript and JavaScript files for test run ([#105](https://github.com/tstyche/tstyche/pull/105))
+
 ## [1.0.0-beta.9] - 2024-01-05
 
 ### Fixed
@@ -100,6 +116,7 @@
 
 _First pre-release._
 
+[1.0.0-rc]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-rc
 [1.0.0-beta.9]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.9
 [1.0.0-beta.8]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.8
 [1.0.0-beta.7]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.7

package/README.md

@@ -1,9 +1,9 @@
 # TSTyche
 
-[![version][version-src]][version-href]
-[![license][license-src]][license-href]
-[![packagephobia][packagephobia-src]][packagephobia-href]
-[![coverage][coverage-src]][coverage-href]
+[![version][version-badge]][version-url]
+[![license][license-badge]][license-url]
+[![packagephobia][packagephobia-badge]][packagephobia-url]
+[![coverage][coverage-badge]][coverage-url]
 
 The Essential Type Testing Tool.
 
@@ -77,13 +77,13 @@ Visit [https://tstyche.org](https://tstyche.org) to view the full documentation.
 
 ## License
 
-[MIT][license-href] © TSTyche
+[MIT][license-url] © TSTyche
 
-[version-src]: https://badgen.net/npm/v/tstyche
-[version-href]: https://npmjs.com/package/tstyche
-[license-src]: https://badgen.net/github/license/tstyche/tstyche
-[license-href]: https://github.com/tstyche/tstyche/blob/main/LICENSE.md
-[packagephobia-src]: https://badgen.net/packagephobia/install/tstyche
-[packagephobia-href]: https://packagephobia.com/result?p=tstyche
-[coverage-src]: https://badgen.net/codecov/c/github/tstyche/tstyche
-[coverage-href]: https://app.codecov.io/gh/tstyche/tstyche
+[version-badge]: https://badgen.net/npm/v/tstyche
+[version-url]: https://npmjs.com/package/tstyche
+[license-badge]: https://badgen.net/github/license/tstyche/tstyche
+[license-url]: https://github.com/tstyche/tstyche/blob/main/LICENSE.md
+[packagephobia-badge]: https://badgen.net/packagephobia/install/tstyche
+[packagephobia-url]: https://packagephobia.com/result?p=tstyche
+[coverage-badge]: https://badgen.net/codecov/c/github/tstyche/tstyche
+[coverage-url]: https://app.codecov.io/gh/tstyche/tstyche

package/build/bin.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
+import process from 'node:process';
 import { Cli } from './tstyche.js';
 
-const cli = new Cli(process);
+const cli = new Cli();
 await cli.run(process.argv.slice(2));

package/build/index.d.cts

@@ -170,7 +170,7 @@ interface Expect {
     /**
      * Builds an assertion.
      *
-     * @typeParam Source - The type against which the assertion will be made.
+     * @template Source - The type against which the assertion will be made.
      */
     <Source>(): Modifier;
     /**
@@ -183,7 +183,7 @@ interface Expect {
         /**
          * Mark an assertion as supposed to fail.
          *
-         * @typeParam Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion will be made.
          */
         <Source>(): Modifier;
         /**
@@ -200,7 +200,7 @@ interface Expect {
         /**
          * Marks an assertion as focused.
          *
-         * @typeParam Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion will be made.
          */
         <Source>(): Modifier;
         /**
@@ -213,7 +213,7 @@ interface Expect {
             /**
              * Mark an assertion as supposed to fail.
              *
-             * @typeParam Source - The type against which the assertion will be made.
+             * @template Source - The type against which the assertion will be made.
              */
             <Source>(): Modifier;
             /**
@@ -231,7 +231,7 @@ interface Expect {
         /**
          * Marks an assertion as skipped.
          *
-         * @typeParam Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion will be made.
          */
         <Source>(): Modifier;
         /**
@@ -244,7 +244,7 @@ interface Expect {
             /**
              * Marks an assertion as supposed to fail.
              *
-             * @typeParam Source - The type against which the assertion will be made.
+             * @template Source - The type against which the assertion will be made.
              */
             <Source>(): Modifier;
             /**

package/build/index.d.ts

@@ -170,7 +170,7 @@ interface Expect {
     /**
      * Builds an assertion.
      *
-     * @typeParam Source - The type against which the assertion will be made.
+     * @template Source - The type against which the assertion will be made.
      */
     <Source>(): Modifier;
     /**
@@ -183,7 +183,7 @@ interface Expect {
         /**
          * Mark an assertion as supposed to fail.
          *
-         * @typeParam Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion will be made.
          */
         <Source>(): Modifier;
         /**
@@ -200,7 +200,7 @@ interface Expect {
         /**
          * Marks an assertion as focused.
          *
-         * @typeParam Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion will be made.
          */
         <Source>(): Modifier;
         /**
@@ -213,7 +213,7 @@ interface Expect {
             /**
              * Mark an assertion as supposed to fail.
              *
-             * @typeParam Source - The type against which the assertion will be made.
+             * @template Source - The type against which the assertion will be made.
              */
             <Source>(): Modifier;
             /**
@@ -231,7 +231,7 @@ interface Expect {
         /**
          * Marks an assertion as skipped.
          *
-         * @typeParam Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion will be made.
          */
         <Source>(): Modifier;
         /**
@@ -244,7 +244,7 @@ interface Expect {
             /**
              * Marks an assertion as supposed to fail.
              *
-             * @typeParam Source - The type against which the assertion will be made.
+             * @template Source - The type against which the assertion will be made.
              */
             <Source>(): Modifier;
             /**

package/build/tstyche.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
-
 import type ts from 'typescript';
 
 declare enum DiagnosticCategory {
@@ -51,8 +49,7 @@ declare enum OptionBrand {
     Number = "number",
     Boolean = "boolean",
     True = "true",// an option which does not take a value
-    List = "list",
-    Object = "object"
+    List = "list"
 }
 
 declare enum OptionGroup {
@@ -61,21 +58,16 @@ declare enum OptionGroup {
 }
 
 interface ItemDefinition {
-    brand: OptionBrand.String | OptionBrand.Object;
-    getDefinition?: (optionGroup: OptionGroup) => Map<string, OptionDefinition>;
+    brand: OptionBrand.String;
     name: string;
-    nullable?: boolean;
     pattern?: string;
-    properties?: Array<OptionDefinition>;
 }
-type OptionDefinition = PrimitiveTypeOptionDefinition | ListTypeOptionDefinition | ObjectTypeOptionDefinition;
+type OptionDefinition = PrimitiveTypeOptionDefinition | ListTypeOptionDefinition;
 interface BaseOptionDefinition {
     brand: OptionBrand;
     description: string;
     group: OptionGroup;
     name: string;
-    nullable?: boolean;
-    required?: boolean;
 }
 interface PrimitiveTypeOptionDefinition extends BaseOptionDefinition {
     brand: OptionBrand.String | OptionBrand.Number | OptionBrand.Boolean | OptionBrand.True;
@@ -84,11 +76,6 @@ interface ListTypeOptionDefinition extends BaseOptionDefinition {
     brand: OptionBrand.List;
     items: ItemDefinition;
 }
-interface ObjectTypeOptionDefinition extends BaseOptionDefinition {
-    brand: OptionBrand.Object;
-    getDefinition: (optionGroup: OptionGroup) => Map<string, OptionDefinition>;
-    properties: Array<OptionDefinition>;
-}
 declare class OptionDefinitionsMap {
     #private;
     static for(optionGroup: OptionGroup): Map<string, OptionDefinition>;
@@ -98,10 +85,6 @@ declare class OptionDefinitionsMap {
  * Options passed through the command line.
  */
 interface CommandLineOptions {
-    /**
-     * Do not raise an error, if no test files are selected.
-     */
-    allowNoTestFiles?: boolean;
     /**
      * The path to a TSTyche configuration file.
      */
@@ -157,9 +140,9 @@ interface CommandLineOptions {
  */
 interface ConfigFileOptions {
     /**
-     * Do not raise an error, if no test files are selected.
+     * Do not search for the test files.
      */
-    allowNoTestFiles?: boolean;
+    disableTestFileLookup?: boolean;
     /**
      * Stop running tests after the first failed assertion.
      */
@@ -192,8 +175,7 @@ declare class ConfigService {
     get configFileOptions(): ConfigFileOptions;
     static get defaultOptions(): Required<ConfigFileOptions>;
     parseCommandLine(commandLineArgs: Array<string>): Promise<void>;
-    readConfigFile(filePath?: string, // TODO take URL as well
-    sourceText?: string): Promise<void>;
+    readConfigFile(): Promise<void>;
     resolveConfig(): ResolvedConfig;
     selectTestFiles(): Array<string>;
 }
@@ -208,7 +190,7 @@ declare class TSTyche {
 
 declare class Cli {
     #private;
-    constructor(process: NodeJS.Process);
+    constructor();
     run(commandLineArguments: Array<string>): Promise<void>;
 }
 
@@ -276,14 +258,14 @@ declare class CollectService {
 
 declare class Environment {
     #private;
-    /**
-     * Is `true` if the TypeScript package is installed.
-     */
-    static get isTypeScriptInstalled(): boolean;
     /**
      * Specifies whether color should be disabled in the output.
      */
     static get noColor(): boolean;
+    /**
+     * Specifies whether interactive elements should be disabled in the output.
+     */
+    static get noInteractive(): boolean;
     /**
      * The directory where to store the 'typescript' packages.
      */
@@ -292,6 +274,10 @@ declare class Environment {
      * The number of seconds to wait before giving up stale operations.
      */
     static get timeout(): number;
+    /**
+     * The path to the currently installed TypeScript module.
+     */
+    static get typescriptPath(): string | undefined;
 }
 
 declare class ResultTiming {
@@ -538,6 +524,15 @@ declare class Expect {
     match(assertion: Assertion, expectResult: ExpectResult): MatchResult | undefined;
 }
 
+/**
+ * A stream to output messages.
+ */
+interface WriteStream {
+    /**
+     * @param log - Message to write to the stream.
+     */
+    write: (log: string) => void;
+}
 /**
  * Options to configure an instance of the {@link Logger}.
  */
@@ -547,13 +542,13 @@ interface LoggerOptions {
      */
     noColor?: boolean;
     /**
-     * A stream to write warnings and errors. Default: `process.stdout`.
+     * A stream to write warnings and errors. Default: `process.stderr`.
      */
-    stderr?: NodeJS.WritableStream;
+    stderr?: WriteStream;
     /**
-     * A stream to write informational messages. Default: `process.stderr`.
+     * A stream to write informational messages. Default: `process.stdout`.
      */
-    stdout?: NodeJS.WritableStream;
+    stdout?: WriteStream;
 }
 /**
  * Wraps the provided streams with a set of convenience methods.
@@ -565,14 +560,9 @@ declare class Logger {
      */
     constructor(options?: LoggerOptions);
     /**
-     * Moves the cursor one line up and erases the line when the `stdout` stream
-     * is interactive. Otherwise does nothing.
+     * Moves the cursor one line up in the `stdout` stream and erases that line.
      */
     eraseLastLine(): void;
-    /**
-     * Returns `true` if the `stdout` stream is interactive.
-     */
-    isInteractive(): boolean;
     writeError(body: JSX.Element | Array<JSX.Element>): void;
     writeMessage(body: JSX.Element | Array<JSX.Element>): void;
     writeWarning(body: JSX.Element | Array<JSX.Element>): void;
@@ -610,7 +600,6 @@ declare function usesCompilerStepText(compilerVersion: string, tsconfigFilePath:
 }): JSX.Element;
 
 declare class Path {
-    static basename(filePath: string): string;
     static dirname(filePath: string): string;
     static join(...filePaths: Array<string>): string;
     static normalizeSlashes(filePath: string): string;
@@ -697,7 +686,7 @@ declare global {
                 children?: never;
                 escapes: Color | Array<Color>;
             };
-            newline: {
+            newLine: {
                 children?: never;
             };
             text: {
@@ -711,10 +700,14 @@ declare global {
  * Options to configure an instance of the {@link Scribbler}.
  */
 interface ScribblerOptions {
+    /**
+     * The end of line sequence to be used in the output. Default: `"\n"`.
+     */
+    newLine?: string;
     /**
      * Do not include ANSI color escape codes in the output. Default: `false`.
      */
-    noColors?: boolean;
+    noColor?: boolean;
 }
 /**
  * Provides the JSX factory function and renderer.
@@ -746,4 +739,11 @@ declare class Text implements JSX.ElementClass {
     render(): JSX.Element;
 }
 
-export { Assertion, Cli, CollectService, Color, type CommandLineOptions, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, type DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, Expect, ExpectResult, FileResult, type FileResultStatus, type ItemDefinition, Line, Logger, type LoggerOptions, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, Path, ProjectResult, ProjectService, Reporter, type ResolvedConfig, Result, ResultCount, ResultManager, ResultStatus, ResultTiming, Scribbler, type ScribblerOptions, StoreService, SummaryReporter, TSTyche, TargetResult, TaskRunner, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, ThoroughReporter, type TypeChecker, addsPackageStepText, describeNameText, diagnosticText, fileStatusText, fileViewText, formattedText, helpText, summaryText, testNameText, usesCompilerStepText };
+declare class Version {
+    #private;
+    static isGreaterThan(source: string, target: string): boolean;
+    static isSatisfiedWith(source: string, target: string): boolean;
+    static isVersionTag(target: string): boolean;
+}
+
+export { Assertion, Cli, CollectService, Color, type CommandLineOptions, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, type DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, Expect, ExpectResult, FileResult, type FileResultStatus, type ItemDefinition, Line, Logger, type LoggerOptions, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, Path, ProjectResult, ProjectService, Reporter, type ResolvedConfig, Result, ResultCount, ResultManager, ResultStatus, ResultTiming, Scribbler, type ScribblerOptions, StoreService, SummaryReporter, TSTyche, TargetResult, TaskRunner, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, ThoroughReporter, type TypeChecker, Version, type WriteStream, addsPackageStepText, describeNameText, diagnosticText, fileStatusText, fileViewText, formattedText, helpText, summaryText, testNameText, usesCompilerStepText };