A TypeScript CLI utility that works on-top of the ServiceNow Extension for VS Code. This tool activates a TypeScript-based workflow for ServiceNow developers using VS Code.
Using TypeScript, the CLI provides an enhanced developer workflow.
- Work in modern JavaScript ES2015 (ES6) and beyond
- Extend JavaScript by using types
- Unlock code navigation and intelligent code completion
- Catch bugs before syncing to the instance
- Node.js
- ServiceNow Extension for VS Code
- An imported application in VS Code
Install the npm package.
npm install -g sn-typescript-utilBuild the TypeScript and configuration files. This only needs to be done once for an application.
snts -bIn the application directory created by the ServiceNow Extension for VS Code, the build creates a ts directory from the JavaScript files in the src directory. This is where all the TypeScript code resides and where the workflow begins.
After installation & setup, simply run the TypeScript compiler --watch command to start looking for TypeScript code changes in the ts directory.
tsc --watchThe TypeScript will get transpiled and moved to the src directory. Then changes are ready to sync with the target instance using the ServiceNow Extension for VS Code.
Installing the CLI globally provides access to the snts command.
snts [command]Build project utility files and package dependencies. Creates a ts directory from the JavaScript files in the src directory.
snts --build
# or
snts -bCompile TypeScript files in the ts directory to JavaScript ES5 and moves them to the src directory.
snts --compile
# or
snts -cDisplay help for the command.
snts --help
# or
snts -hRemove & clean the ts build directory.
snts --remove
# or
snts -rSync new instance-based src files to the ts directory.
snts --sync
# or
snts -sOutput the version number.
snts --version
# or
snts -vInside of the application directory (after the build), the project structure will look something like this.
/
├── background scripts/
├── scratch/
├── src/
│ ├── Server Development/
│ │ └── Script Includes/
│ │ └── DataService.script.js
│ │ └── Utils.script.js
│ └── Service Portal/
│ └── Widgets/
│ └── Dashboard/
│ └── Dashboard.client_script.js
│ └── Dashboard.css.scss
│ └── Dashboard.demo_data.json
│ └── Dashboard.link.js
│ └── Dashboard.option_schema.json
│ └── Dashboard.script.js
│ └── Dashboard.template.html
├── system/
├── ts/
│ ├── Server Development/
│ │ └── Script Includes/
│ │ └── DataService.script.ts
│ │ └── Utils.script.ts
│ ├── Service Portal/
│ │ └── Widgets/
│ │ └── Dashboard/
│ │ └── Dashboard.client_script.ts
│ │ └── Dashboard.link.ts
│ │ └── Dashboard.script.ts
│ └── Types/
│ └── BaseTable.ts
│ └── User.ts
├── .eslintrc
└── app.config.json
This example project has two script includes, a widget, and a Types directory for interfaces & types.