Typescript Dev Server

A lightweight development server for typescript projects. The server will watch your files, reboot on changes, and allow you to run auxiliary services used by your development workflow.

Installation

npm i -D @figliolia/typescript-dev-server
# or
yarn add -D @figliolia/typescript-dev-server

Basic Usage

import { DevServer } from "@figliolia/typescript-dev-server";

(async () => {
  const Server = new DevServer({
    entryPoint: "src/index.ts",
  });
  await Server.run();
})().catch(console.log);

Advanced Usage

import { DevServer } from "@figliolia/typescript-dev-server";

(async () => {
  const Server = new DevServer({
    entryPoint: "src/index.ts",
    // An optional custom path to your tsconfig for development 
    tsconfig: "path/to/yourTsconfig.json",
    // A color for your dev server's stdout logs
    color: "magenta",
    // Environment variables to pass to your node.js runtime
    nodeOptions: {
      NODE_ENV: "development",
      NODE_OPTIONS: "--enable-source-maps"
    },
    // Auxiliary services to start with your dev server
    serviceCommands: {
      Redis: "brew services start redis",
      Postgres: "brew services start postgresql@16",
    },
    // Commands to shut down auxiliary services when your
    // server stops
    killCommands: {
      Redis: "brew services stop redis",
      Postgres: "brew services stop postgresql@16",
    }
  });
  await Server.run();
}).catch(console.log);

Running your Dev Server

To run your dev server, you can simply run node path/to/yourDevServer.js. If you're writing your dev server in typescript, you can compile and run it using tsc and node or opt for an all-in-one solution such as ts-node or tsx.