A foundational NodeJS program in TypeScript featuring a structured client-utility-definition setup with adherence to stringent coding guidelines

Question

A foundational NodeJS program in TypeScript featuring a structured client-utility-definition setup with adherence to stringent coding guidelines

What is the best way to set up a basic TypeScript framework for starting a program with strict settings, based on the following program structure?

An initial "client" code containing the actual program logic
A separate "utility" module for defining functions and extensions (which can be used to create additional modules)
A definition file that allows for extensions from the utility module mentioned in point 2.

This setup should adhere to strict TypeScript rules to fully utilize TypeScript features instead of relying solely on plain JavaScript. This involves using a tsconfig.json configuration similar to the one below:

{
  "compilerOptions": {
    "strictNullChecks": true,
    "allowJs": false,
    "alwaysStrict": true,
    "noImplicitAny": true,
    "types": [
      "node"
    ]
  }
}

To summarize, the project will enforce strict null checks, disallow plain js files, maintain consistent strict mode, eliminate implicit any types, and explicitly define each imported type within the project.

The only flexibility allowed is in the "relaxed" sections related to include, exclude, and files in the TypeScript project file. These sections ensure that only relevant .ts, .d.ts, and .tsx files located in the current directory are included in the build process, avoiding any unnecessary or unrelated source code cluttering the folder.

typescript module sample strict

Answer 1

Answer №1

It took some effort, but I finally managed to create this structure. Sharing it for those who are new to TypeScript and looking for something similar.

Since this is a NodeJS application, the bare minimum requirements include having the @types/Node package installed using npm -i @types/Node

NPM Tasks to Complete

Create package.json by running npm init
Install @types/node with npm install @types/node

TypeScript Tasks to Complete

Create an identical tsconfig.json file as the one provided in the question:

tsconfig.json

{
  "compilerOptions": {
    "strictNullChecks": true,
    "allowJs": false,
    "alwaysStrict": true,
    "noImplicitAny": true,
    "types": [
      "node"
    ]
  }
}

Create a sample .d.ts file (extending a string with a 'test' function)

string.d.ts

interface String {
  test(this: string) : string;
}

Create the utility module

utils.ts

String.prototype.test = function (this : string) : string {
  var str = this;
  str = str + " - test";
  return str;
}

function textIsTest(what : string) : boolean {
  return what == "test";
}

export { textIsTest };

Your main code goes here:

index.ts

import * as util from "./utils";

let params = process.argv.slice(2); // split commandline arguments

let testString = params[0];

console.log("Commandline parameter: " + testString);
console.log("Extended string: " + testString.test());
console.log("Is 'test': " + util.textIsTest(testString));

I hope this guide will be helpful for others starting out with TypeScript!

Extra: watch + runner

A batch (bash) script to watch and run the project. It should work on cygwin, linux, and mac (tested on cygwin only):

#!/bin/bash

# Functions for spinner

... (rest of the content remains the same) ...

This script will monitor changes in files within the current directory based on their last changed time stamp. It includes a nice spinning animation while checking for changes, gracefully interrupts if ctrl+c is pressed, and will stop if the script itself is modified. Adjustments may be needed to monitor changes in subdirectories.

Answer 2

It took some effort, but I finally managed to create this structure. Sharing it for those who are new to TypeScript and looking for something similar.

Since this is a NodeJS application, the bare minimum requirements include having the @types/Node package installed using npm -i @types/Node

NPM Tasks to Complete

Create package.json by running npm init
Install @types/node with npm install @types/node

TypeScript Tasks to Complete

Create an identical tsconfig.json file as the one provided in the question:

tsconfig.json

{
  "compilerOptions": {
    "strictNullChecks": true,
    "allowJs": false,
    "alwaysStrict": true,
    "noImplicitAny": true,
    "types": [
      "node"
    ]
  }
}

Create a sample .d.ts file (extending a string with a 'test' function)

string.d.ts

interface String {
  test(this: string) : string;
}

Create the utility module

utils.ts

String.prototype.test = function (this : string) : string {
  var str = this;
  str = str + " - test";
  return str;
}

function textIsTest(what : string) : boolean {
  return what == "test";
}

export { textIsTest };

Your main code goes here:

index.ts

import * as util from "./utils";

let params = process.argv.slice(2); // split commandline arguments

let testString = params[0];

console.log("Commandline parameter: " + testString);
console.log("Extended string: " + testString.test());
console.log("Is 'test': " + util.textIsTest(testString));

I hope this guide will be helpful for others starting out with TypeScript!

Extra: watch + runner

A batch (bash) script to watch and run the project. It should work on cygwin, linux, and mac (tested on cygwin only):

#!/bin/bash

# Functions for spinner

... (rest of the content remains the same) ...

This script will monitor changes in files within the current directory based on their last changed time stamp. It includes a nice spinning animation while checking for changes, gracefully interrupts if ctrl+c is pressed, and will stop if the script itself is modified. Adjustments may be needed to monitor changes in subdirectories.

A foundational NodeJS program in TypeScript featuring a structured client-utility-definition setup with adherence to stringent coding guidelines

Answer №1

NPM Tasks to Complete

TypeScript Tasks to Complete

Extra: watch + runner

Similar questions

I want my Angular 2 application to redirect to the appropriate page when a user who is logged out attempts to access a page that requires them to be logged in

Run a script in a newly opened tab using the chrome.tabs.create() method

Utilizing ReactJS and TypeScript to retrieve a random value from an array

The JSONP request failed with an error stating: ReferenceError: document is not defined

What is the reason behind TypeScript enclosing a class within an IIFE (Immediately Invoked Function

Angular - Implementing filter functionality for an array of objects based on multiple dropdown selections

Create allowances for specific areas

Find the variance between today's date and a selected date, then initiate the timer based on this variance

Top technique for verifying the presence of duplicates within an array of objects

...additional properties in React function components using TypeScript

What is the best way to send props to a styled component without needing to convert them to transient props beforehand

Display the number of objects in an array using Angular and render it on HTML

Setting up a variable with no operation assigned to it

How can I retrieve a certain type of object property in TypeScript?

The Keyup Filter in the FromEvent function is malfunctioning and not behaving as anticipated

What is the procedure for setting up the typings folder in AngularJS 1.5 with TypeScript?

Data object constructor is not triggered during JSON parsing

What is the reason behind having to refresh the page or switch to another tab for the field to display?

Even after ensuring the proper type checking, I am still receiving the error message "Property 'message' does not exist on type 'object'"

Is there a way to eliminate the line that appears during TypeScript compilation of a RequireJS module which reads: Object.defineProperty(exports, "__esModule", { value: true });?