Skip to content

denalisk/typescript-node-skeleton

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Node typescript skeleton

This is a skeleton for node scripts using typescript

Pre-requisites

Current skeleton was created with:

  • Node 18.2.0
  • npm 8.9.0

The "test" script option is most useful with VS Code. Possible the npm script won't work from a non-windows machine, haven't tested...

N.B. strongly advised to use a node version manager (such as NVM for windows)

Project setup

To setup the project, navigate to the same directory as this README and run npm install.

Available commands

  • "npm run build": transpiles the typescript files, output to the ./dist directory
  • "npm run execute": runs the current transpiled script with node, through entry ./dist/main.js
  • "npm run clean": deletes the ./dist directory and all contents
  • "npm run start": cleans, builds, and executes
  • "npm run test": cleans, builds, and runs all tests (spec.ts files)
  • "npm run debug": cleans, builds, and runs with the --inspect flag. Automatically hooks up the debugger and breakpoints if run from a VSCODE terminal at the base directory

About

Skeleton project for node script using typescript

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published