Noodles, Poodles and More!

    @peerigon/typescript-exercises-tools
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.1 • Public • Published

    @peerigon/typescript-exercises-tools

    Tools for writing and validating TypeScript exercises.

    Dependency Status Build Status Coverage Status Known Vulnerabilities

    This module allows you to annotate expected type errors in your TypeScript code like this:

    export const add = (a: number, b: string) => {
        return a + b;
    };
    
    // 💥 Expect error 2345: Argument of type '4' is not assignable to parameter of type...
    add(3, 4);

    With the TypeScript language service plugin provided by this module, these expected type errors will show up as a suggestion instead of an error:

    Screenshot of an editor that shows a type error as a suggestion Screenshot of an editor that shows the suggestion popup

    Furthermore, these comments will cause the editor to show an error if there is no type error at this location:

    Screenshot of an editor that shows an error when there is no type error

    At the time of writing, only editors use TypeScript language service plugins. Calling tsc from the command line will not execute the plugin. That's why there is also a programmatic API that allows you to do assertions on the program:

    import {assertProgramToOnlyHaveExpectedErrors} from "@peerigon/typescript-exercises-tools/tests";
    
    test("The program has only expected errors", () => {
        assertProgramToOnlyHaveExpectedErrors("/path/to/module.ts");
    });

    This module is ideal for:

    • testing types by doing assertions on the behavior of types
    • creating TypeScript exercises

    Installation

    npm install @peerigon/typescript-exercises-tools
    

    Now you need to add the TypeScript language service plugin to your tsconfig.json:

    {
        "compilerOptions": {
            "plugins": [{
                "name": "@peerigon/typescript-exercises-tools"
            }]
        }
    }

    Please note that you need to configure your editor to use your local TypeScript version. Otherwise TypeScript may not find the plugin. If you're using VSCode, create a file in your repository at .vscode/settings.json and add this:

    {
        "typescript.tsdk": "node_modules/typescript/lib"
    }

    Support for multiple errors

    If you expect more than one error, you can add multiple comments, like this:

    type Person = {
        readonly name: string;
    };
    
    const person: Person = {
        name: "Bob",
    };
    
    // 💥 Expect error 2704: … cannot be a read-only property.
    // 💥 Expect error 2790: … must be optional.
    delete person.name;

    API

    assertProgramToOnlyHaveExpectedErrors(
        programPath: string,
        compilerOptions?: ts.CompilerOptions,
    ): void

    Compiles the program at the given programPath and throws the first unexpected error it encounters. It's recommended to use an absolute path. If you don't pass any compilerOptions to this function, it uses TypeScript's internal findConfigFile() to locate the closest tsconfig.json to programPath.

    import {assertProgramToOnlyHaveExpectedErrors} from "@peerigon/typescript-exercises-tools/tests";
    
    assertProgramToOnlyHaveExpectedErrors("/path/to/module.ts"); // may throw
    
    assertProgramToOnlyHaveExpectedErrors(
        "/path/to/module.ts",
        {strict: true} // custom compiler options
    );

    License

    Unlicense

    Sponsors

    Install

    npm i @peerigon/typescript-exercises-tools

    DownloadsWeekly Downloads

    3

    Version

    1.1.1

    License

    Unlicense

    Unpacked Size

    27.9 kB

    Total Files

    26

    Last publish

    Collaborators

    • thois
    • jhnns
    • meaku
    • peeri
    • matthaias
    • leomelzer
    • antosan
    • moritzjacobs
    • hpohlmeyer