ts-node-starter

Typescript CLI project based on ts-node.

Table of Contents

1. Step 1: Create an empty Readers project

Step 1: Create an empty typesript project

Create an empty npm project,

npm init

Fill in some information then we get a package.json file:

{
  "name": "ts-node-starter",
  "version": "1.0.0",
  "description": "Typescript CLI project based on ts-node",
  "main": "index.ts",
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/soulmachine/ts-node-starter.git"
  },
  "keywords": [
    "ts-node",
    "typescript",
    "starter"
  ],
  "author": "soulmachine",
  "license": "Apache-2.0",
}

Install ts-node and typescript,

npm install -D typescript ts-node @types/node

And add a script field to package.json:

{
  "scripts": {
    "start": "ts-node ./src/cli/cli.ts"
  }
}

Here is the complete package.json file:

{
  "name": "ts-node-starter",
  "version": "1.0.0",
  "description": "Typescript CLI project based on ts-node",
  "main": "index.ts",
  "dependencies": {},
  "devDependencies": {
    "ts-node": "^8.4.1",
    "typescript": "^3.7.2"
  },
  "scripts": {
  	"start": "ts-node ./src/cli/cli.ts",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/soulmachine/ts-node-starter.git"
  },
  "keywords": [
    "ts-node",
    "typescript",
    "starter"
  ],
  "author": "soulmachine",
  "license": "Apache-2.0",
}

Create a file ./src/cli/cli.ts:

// define the class with constructor
class Author {
    constructor (public Name: string) { }
}
// create the instance of the class
let author = new Author("Kunal Chowdhury");
// print the information in the console
console.log("\nHello Readers,");
console.log("Thanks for visiting my blog");
console.log(`\t~ ${author.Name}`);

Run this project by npm start, you'll see some greeting messages.

There is another way, first compile typescript code to javascript code, then run it via node.

Create a tsconfig.json file:

{
  "compilerOptions": {
    "target": "es2017",
    "outDir": "build/main",
    "rootDir": "src",
    "moduleResolution": "node",
    "module": "commonjs",
    "declaration": true,
    "inlineSourceMap": true,
    "strict": true /* Enable all strict type-checking options. */,
    "lib": ["es2017"],
    "types": ["node"],
    "typeRoots": ["node_modules/@types", "src/types"]
  },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules/**"],
  "compileOnSave": false
}

And add a command build:main in package.json:

"build:main": "tsc -p tsconfig.json",

Now we can compile this project:

npm run build:main

And run:

node ./build/main/cli/cli.js