README.md

TypeScript API for TestComplete

Inspired by https://github.com/falafelsoftware/testcomplete-typescript

How to use

1. Clone this repo somewhere around, for example in ./tools/ inside your TestComplete project folder

# add as submodule
git submodule add https://github.com/deitry/testcomplete-ts-api ./tools/

# or clone full repo
git clone https://github.com/deitry/testcomplete-ts-api ./tools/

2. Run code generation scripts that will expose project-dependent things:

# name mappings
python3.exe ./tools/scripts/nameMapping.gen.py "./NameMapping/NameMapping.tcNM" "./tools/api/nameMapping.d.ts"

# project variables
python3.exe ./tools/scripts/project.gen.py "./ProjectName.mds" "./tools/api/project.d.ts"

# tested apps
python3.exe ./tools/scripts/testedApps.gen.py "./TestedApps/TestedApps.tcTAs" "./tools/api/testedApps.d.ts"

If you have several projects in your project suite, consider moving generated modules in according ./Script/lib/ folder for each project.

3. Add jsconfig.json to your Script folder where you can set path to TypeScript API modules and whatever you like:

{
    "compilerOptions": {
        "target": "es5",
        "checkJs": true,
        "strict": true,
        "strictFunctionTypes": true,
        "baseUrl": ".",
    },
    "include": [
        "./*.js",
        "../tools/api/*.ts",
    ],
}

In case you created project-dependent modules inside project's ./Script/lib/ folder, you should create additional ./Script/lib/tsconfig.json in order to properly link common and project-dependent API:

{
    "compilerOptions": {
        "noLib": false,
        "target": "es5",
        "baseUrl": ".",
        "strict": true,
        "strictFunctionTypes": true,
        "diagnostics": true,
        "noImplicitAny": true,
        "noEmitHelpers": true,
        "declaration": false
    },
    "include": [
        "../../tools/api/*.ts",
        "./*.ts",
    ],
}

4. Use the power of type checking in your Script/*.js! Search through TestComplete API via IntelliSense in VS Code!