Implement TypeScript pro-code projects

Prerequisites

Node.js

Currently, only Node.js 16.13.x is supported.

Further information: Node.js

TypeScript

TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.

Further information: TypeScript

ESLint

A tool used to check the quality of the code.

Further information: ES Lint

EditorConfig

This is used to overwrite the settings of the user workspace in VS Code (IDE).

Further information: VS Code Marketplace

Running/building projects

Create pro-code projects

Open Solution Designer and create a new project by clicking on the Create button. Fill out the project-specific details but from the Type drop-down make sure to select Pro-Code Project and set Implementation Language to TypeScript. Once this is created the project should appear in the Solution Designer. Optional: Open that project in Solution Designer and write a proper documentation.

Clone Git project to local machine

In order to build and run the project, the Git project should be cloned to the user's workspace. In order to check out a pro-code project open the project after creation, navigate to the General Information and copy the Git Repository URI.

  1. Alter the URL and add the Git user, so it looks like the following:

    • Before: https://auto-devops-url/managed-solutions/SOLTS.git

    • After: https://git@auto-devops-url/managed-solutions/SOLTS.git

  2. Open a terminal and clone the project. You will be prompted for a password. Please use your personal access token as password:

    git clone https://git@auto-devops-url/managed-solutions/SOLTS.git
Note: In order to be able to interact with the Git repository you have to provide the credentials for your Git system in advance.

Install dependencies

In order to install all the needed dependencies to run a pro-code TypeScript project on a local machine this command needs to be run in the project directory:

npm install

Unit tests for pro-code projects

It's highly recommended writing unit tests for your TypeScript projects. The unit tests will be executed during the project pipeline execution.

By default, the unit test step Enable Unit Test Execution is disabled

But once you enable Enable Unit Test Execution, the script (mentioned below) is ran. This script is configurable from package.json file in the repository.

npm run test:unit
Note: We are using mocha and chai as test framework but in case you need to use different module you have to add those modules in package.json and use it in your test files.

Health Check with Readiness

To verify that a container in a pod is healthy and ready to handle traffic, there are several mechanisms. If it is determined that the Pod is not healthy, it is restarted. Currently, the health status check is done by checking if the file /dist/src/index.js exists. By default, this file is created in the build process from the src/index.ts file. If you deviate from this case, you must ensure that this file is present after a build process, otherwise the Pod cannot start.