[ Web Proxy ]
URL:
Viewing: https://angular.dev/cli/test [Back]  [Original]

ng test Angular Skip to main content
menu
close
more_horiz
menuAPI
CLI

test

Command
ng test [project] [options]
ng t [project] [options]

Takes the name of the project, as specified in the projects section of the angular.json workspace configuration file. When a project name is not supplied, it will execute for all projects.

On this page

    arrow_upward_alt Back to the top

    Arguments

    project

    The name of the project to build. Can be an application or a library.

    Value Typestring

    Options

    browser-viewport

    Specifies the browser viewport dimensions for browser-based tests in the format widthxheight.

    Value Typestring
    browsers

    Specifies the browsers to use for test execution. When not specified, tests are run in a Node.js environment using jsdom. For both Vitest and Karma, browser names ending with 'Headless' (e.g., 'ChromeHeadless') will enable headless mode.

    Value Typearray
    build-target

    Specifies the build target to use for the unit test build in the format project:target[:configuration]. This defaults to the build target of the current project with the development configuration. You can also pass a comma-separated list of configurations. Example: project:target:production,staging.

    Value Typestring
    configuration
    Aliasc

    One or more named builder configurations as a comma-separated list as specified in the "configurations" section in angular.json. The builder uses the named configurations to run the given target. For more information, see https://angular.dev/reference/configs/workspace-config#alternate-build-configurations.

    Value Typestring
    coverage

    Enables coverage reporting for tests. If not specified, the coverage configuration from a runner configuration file will be used if present. Otherwise, coverage is disabled by default.

    Value Typeboolean
    coverage-exclude

    Specifies glob patterns of files to exclude from the coverage report.

    Value Typearray
    coverage-include

    Specifies glob patterns of files to include in the coverage report.

    Value Typearray
    coverage-reporters

    Specifies the reporters to use for coverage results. Each reporter can be a string representing its name, or a tuple containing the name and an options object. Built-in reporters include 'html', 'lcov', 'lcovonly', 'text', 'text-summary', 'cobertura', 'json', and 'json-summary'.

    Value TypearrayAllowed Valuescobertura, html, json, json-summary, lcov, lcovonly, text, text-summary
    debug

    Enables debugging mode for tests, allowing the use of the Node Inspector.

    Value TypebooleanDefaultfalse
    exclude

    Specifies glob patterns of files to exclude from testing, relative to the project source root.

    Value Typearray
    filter

    Specifies a regular expression pattern to match against test suite and test names. Only tests with a name matching the pattern will be executed. For example, ^App will run only tests in suites beginning with 'App'.

    Value Typestring
    headless

    Forces all configured browsers to run in headless mode. When using the Vitest runner, this option is ignored if no browsers are configured. The Karma runner does not support this option.

    Value Typeboolean
    help

    Shows a help message for this command in the console.

    Value Typeboolean
    include

    Specifies glob patterns of files to include for testing, relative to the project source root. This option also has special handling for directory paths (includes all test files within) and file paths (includes the corresponding test file if one exists).

    Value TypearrayDefault**/*.spec.ts,**/*.test.ts
    isolate

    Enables isolation for test execution. When true, Vitest runs tests in separate threads or processes. This option is only available for the Vitest runner. Defaults to false to align with the Karma/Jasmine experience.

    Value Typeboolean
    list-tests

    Lists all discovered test files and exits the process without building or executing the tests.

    Value TypebooleanDefaultfalse
    output-file

    Specifies a file path for the test report, applying only to the first reporter. To configure output files for multiple reporters, use the tuple format ['reporter-name', { outputFile: '...' }] within the reporters option. When not provided, output is written to the console.

    Value Typestring
    progress

    Shows build progress information in the console. Defaults to the progress setting of the specified buildTarget.

    Value Typeboolean
    providers-file

    Specifies the path to a TypeScript file that provides an array of Angular providers for the test environment. The file must contain a default export of the provider array.

    Value Typestring
    quiet

    Suppresses the verbose build summary and stats table on each rebuild. Defaults to true locally and false in CI environments.

    Value Typeboolean
    reporters

    Specifies the reporters to use during test execution. Each reporter can be a string representing its name, or a tuple containing the name and an options object. Built-in reporters include 'default', 'verbose', 'dots', 'json', 'junit', 'tap', 'tap-flat', and 'html'. You can also provide a path to a custom reporter.

    Value Typearray
    runner

    Specifies the test runner to use for test execution.

    Value TypestringAllowed Valueskarma, vitestDefaultvitest
    runner-config

    Specifies the configuration file for the selected test runner. If a string is provided, it will be used as the path to the configuration file. If true, the builder will search for a default configuration file (e.g., vitest-base.config.mts or karma.conf.js). If false, no external configuration file will be used.\nFor Vitest, this enables advanced options and the use of custom plugins. Please note that while the file is loaded, the Angular team does not provide direct support for its specific contents or any third-party plugins used within it.

    Value Typestring
    setup-files

    A list of paths to global setup files that are executed before the test files. The application's polyfills and the Angular TestBed are always initialized before these files.

    Value Typearray
    splitting

    Enables code splitting for test execution. When enabled, shared code between test files is split into separate chunks. Issues with live ESM bindings in Node.js environments (such as uninitialized exports or mocking failures) can be resolved by disabling splitting. This option is only available for the Vitest runner.

    Value TypebooleanDefaulttrue
    ts-config

    The path to the TypeScript configuration file, relative to the workspace root. Defaults to tsconfig.spec.json in the project root if it exists. If not specified and the default does not exist, the tsConfig from the specified buildTarget will be used.

    Value Typestring
    ui

    Enables the Vitest UI for interactive test execution. This option is only available for the Vitest runner.

    Value Typeboolean
    watch

    Enables watch mode, which re-runs tests when source files change. Defaults to true in TTY environments and false otherwise.

    Value Typeboolean
    Jump to details

    Web Proxy Viewer  |  New URL  |  Original Page