# vscode-test-cli

**Repository Path**: mirrors_SAP/vscode-test-cli

## Basic Information

- **Project Name**: vscode-test-cli
- **Description**: A CLI wrapper for vscode-test with additional capabilities.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-07
- **Last Updated**: 2026-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# VS Code Test Command Line Interface

[![CircleCI](https://circleci.com/gh/SAP/vscode-test-cli.svg?style=svg)](https://circleci.com/gh/SAP/vscode-test-cli)
[![Coverage Status](https://coveralls.io/repos/github/SAP/vscode-test-cli/badge.svg?branch=main)](https://coveralls.io/github/SAP/vscode-test-cli?branch=main)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/SAP/vscode-test-cli.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/SAP/vscode-test-cli/context:javascript)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![DependentBot](https://api.dependabot.com/badges/status?host=github&repo=SAP/vscode-test-cli)](https://dependabot.com/)
[![REUSE status](https://api.reuse.software/badge/github.com/SAP/vscode-test-cli)](https://api.reuse.software/info/github.com/SAP/vscode-test-cli)

This repository contains packages which provide tools for testing VS Code extensions in a VS Code environment in a simple way.

## Running tests in a VS Code environment

By running the tests in a VS Code environment, you can use [VS Code APIs](https://code.visualstudio.com/api/references/vscode-api) from the tested code without the need for mocking it, and you can also use VS Code APIs directly from the tests.

This allows the tests to run in a production-like environment, where the result of the APIs is the actual result and not a mock that might not reflect the real runtime behavior of the extension.

This also allows you to test the integration of the extension with VS Code, for example:

- Checking that your extension correctly searches for files in the workspace (including a multi-root workspace)
- Checking that a command is properly registered by running it from VS Code APIs
- Checking that a task provider is properly registered by fetching its tasks from VS Code APIs and running them
- Checking that your extension responds correctly to file system events and other VS Code events, like workspace changes and editor focus changes
- Checking that your extensions adds diagnostics correctly by fetching them from VS Code APIs

## Requirements

To use the packages listed below, a supported [Node.js](https://nodejs.org/en/about/releases/) version and a package manager for Node.js such as [npm](https://www.npmjs.com/get-npm) or [yarn](https://yarnpkg.com/) is required.

You must also have access to the sources of the VS Code extension which you want to test and run on an operating system for which there is a [VS Code](https://code.visualstudio.com/download) version available.

## Download and Installation

See the specific package documentation for details.

## Packages

The following packages are included in this repository:

### [![npm-vscode-test-cli](https://img.shields.io/npm/v/@sap_oss/vscode-test-cli)](https://www.npmjs.com/package/@sap_oss/vscode-test-cli) [`@sap_oss/vscode-test-cli`](packages/vscode-test-cli)

This package helps you run the tests for your VS Code extension in a VS Code environment by configuring the extension parameters in a configuration file and running the tests from the `scripts` section of the `package.json`, using a command line interface.

## Limitations and Known Issues

See the specific package documentation for details.

## Support

For support requests, please open an [issue](https://github.com/SAP/vscode-test-cli/issues) on Github.

## Contributing

Contributions are welcome. Please see the [contribution guide](CONTRIBUTING.md) for details.

Before implementing a major contribution please open an issue to discuss your contribution first.