README

This repository contains the source for BMC Compuware's ISPW extension for VS Code. The extension can be installed from here.

Getting started using the repository

1. Install nodejs
2. Clone this repository
3. From the ispw folder, run npm install
4. Open VSCode, set the ispw folder as your workspace root
5. To compile your changes, in the terminal view run npm run compile
6. To launch a new VSCode window that is running with your changes, go to the Run view, then select "Launch ISPW Extension" and press the play button.

Running tests

Before attempting to run tests, update the settings file at %APPDATA%\Code\User\settings.json to have the following:

    "ISPW.Assignment Description": "${user}-${project_name}",
    "ISPW.Level": "DEV1",
    "ISPW.Topaz CLI Installation Path": "your cli path",

Then, add a file to your ispw/src/test folder called credentials.json and add the following:

{
    "username": "myUsername",
    "password": "myPassword"
}

Where the username and password are the one you want to have used when running the tests.

Once the files have been set up, you can execute the tests. To do so, open a command line window inside the ispw folder of this repository and run npm run test

You can also launch the tests from within VS Code by using the launch configuration "Test ISPW Extension with Demo"

Other development tips

• To format your code changes, use Alt + Shift + F

• If you add any new dependencies on external libraries which will be needed at runtime, make sure the library name is added to the dependencies section of the package.json file not just the devDependencies section. If you do not do this, the extension will fail to activate when it is installed.