@schematics/angular/refactor/jasmine-vitest/utils/todo-notes.js

Schematics specific to Angular

"use strict";
/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.TODO_NOTES = void 0;
/**
 * @fileoverview This file is the single source of truth for all "TODO" notes
 * generated by the Jasmine to Vitest schematic.
 *
 * It defines the `TODO_NOTES` constant, which contains the message and optional
 * documentation URL for each category of manual migration task.
 *
 * The file also exports advanced mapped types (`TodoCategory`, `TodoContextMap`)
 * that are inferred directly from the `TODO_NOTES` object. This creates a
 * maintainable, type-safe system that ensures consistency across all
 * transformers and prevents runtime errors.
 */
/**
 * The central configuration for all "TODO" notes. Each key represents a unique
 * `TodoCategory`.
 *
 * Each entry is an object with:
 * - `message`: A string or a function that returns a string. If it's a function,
 *   it receives a `context` object to generate a dynamic message.
 * - `url`: An optional documentation URL that will be appended to the message.
 */
exports.TODO_NOTES = {
    'pending': {
        message: 'The pending() function was converted to a skipped test (`it.skip`).',
        url: 'https://vitest.dev/api/vi.html#it-skip',
    },
    'toHaveSpyInteractions': {
        message: 'Unsupported matcher ".toHaveSpyInteractions()" found. ' +
            'Please migrate this manually by checking the `mock.calls.length` of the individual spies.',
    },
    'toThrowMatching': {
        message: (context) => `Unsupported matcher ".${context.name}()" found. Please migrate this manually.`,
        url: 'https://vitest.dev/api/expect.html#tothrowerror',
    },
    'toBePending': {
        message: 'Unsupported matcher ".toBePending()" found. Vitest does not have a direct equivalent. ' +
            'Please migrate this manually, for example by using `Promise.race` to check if the promise settles within a short timeout.',
    },
    'unsupported-expect-async-matcher': {
        message: (context) => `Unsupported expectAsync matcher ".${context.name}()" found. Please migrate this manually.`,
    },
    'arrayWithExactContents-dynamic-variable': {
        message: 'Cannot transform jasmine.arrayWithExactContents with a dynamic variable. Please migrate this manually.',
    },
    'arrayWithExactContents-check': {
        message: "Verify this matches strict array content (multiset equality). Vitest's arrayContaining is a subset check.",
    },
    'expect-nothing': {
        message: 'expect().nothing() has been removed because it is redundant in Vitest. Tests without assertions pass by default.',
    },
    'unsupported-global-function': {
        message: (context) => `Unsupported global function \`${context.name}\` found. This function is used for custom reporters in Jasmine ` +
            'and has no direct equivalent in Vitest.',
    },
    'addMatchers': {
        message: 'jasmine.addMatchers is not supported. Please manually migrate to expect.extend().',
        url: 'https://vitest.dev/api/expect.html#expect-extend',
    },
    'addCustomEqualityTester': {
        message: 'jasmine.addCustomEqualityTester is not supported. Please manually migrate to expect.addEqualityTesters().',
        url: 'https://vitest.dev/api/expect.html#expect-addequalitytesters',
    },
    'mapContaining': {
        message: 'jasmine.mapContaining is not supported. Vitest does not have a built-in matcher for Maps.' +
            ' Please manually assert the contents of the Map.',
    },
    'setContaining': {
        message: 'jasmine.setContaining is not supported. Vitest does not have a built-in matcher for Sets.' +
            ' Please manually assert the contents of the Set.',
    },
    'unknown-jasmine-property': {
        message: (context) => `Unsupported jasmine property "${context.name}" found. Please migrate this manually.`,
    },
    'spyOnAllFunctions': {
        message: 'Vitest does not have a direct equivalent for jasmine.spyOnAllFunctions().' +
            ' Please spy on individual methods manually using vi.spyOn().',
        url: 'https://vitest.dev/api/vi.html#vi-spyon',
    },
    'createSpyObj-single-argument': {
        message: 'jasmine.createSpyObj called with a single argument is not supported for transformation.',
        url: 'https://vitest.dev/api/vi.html#vi-fn',
    },
    'createSpyObj-dynamic-variable': {
        message: 'Cannot transform jasmine.createSpyObj with a dynamic variable. Please migrate this manually.',
        url: 'https://vitest.dev/api/vi.html#vi-fn',
    },
    'createSpyObj-dynamic-property-map': {
        message: 'Cannot transform jasmine.createSpyObj with a dynamic property map. Please migrate this manually.',
        url: 'https://vitest.dev/api/vi.html#vi-fn',
    },
    'unsupported-spy-strategy': {
        message: (context) => `Unsupported spy strategy ".and.${context.name}()" found. Please migrate this manually.`,
        url: 'https://vitest.dev/api/mocked.html#mock',
    },
    'mostRecent-without-args': {
        message: 'Direct usage of mostRecent() is not supported.' +
            ' Please refactor to access .args directly or use vi.mocked(spy).mock.lastCall.',
        url: 'https://vitest.dev/api/mocked.html#mock-lastcall',
    },
    'unhandled-done-usage': {
        message: "The 'done' callback was used in an unhandled way. Please migrate manually.",
    },
};
//# sourceMappingURL=todo-notes.js.map