TSCX

A tsc wrapper with many convenient options. Bring the nodemon + JavaScript development experience to TypeScript.

Why

Developing a backend application using TypeScript needs some other third-party library. It's tedious and hard to config 🤦‍♂️.

{
  "scripts": {
    "clean": "rimraf dist",
    "compile": "tsc -p tsconfig.build.json",
    "copy-files": "copyfiles -u 1 src/**/*.njk dist",
    "build": "npm run clean && npm run compile && npm run copy-files",
    "dev": "NODE_ENV=local nodemon -w src -e ts --exec 'npm run build && node bootstrap.js'"
  },
  "devDependencies": {
    "copyfiles": "2.4.1",
    "nodemon": "3.1.0",
    "rimraf": "5.0.5",
    "typescript": "5.6.3"
  }
}

Now you can simplify your package.json by using this library 😄.

{
  "scripts": {
    "dev": "NODE_ENV=local tscx -rwc -p tsconfig.build.json -e bootstrap.js"
  },
  "devDependencies": {
    "@rnm/tscx": "*",
    "typescript": "5.6.3"
  }
}

Highlight

• Same usages as tsc.
• Respect tsconfig.json.
• ESM.

Differences with tsc

• ✅ Additionally support --remove for removing output folder before every compilation.
• ✅ Additionally support --copyfiles for copying non-ts and non-js files to output folder after every compilation.
• ✅ Additionally support --exec <path> for executing js file after compilation success.
• ✅ Additionally support --exclude <patterns...> for excluding files from compilation. Inspired by this issue.
• ✅ Additionally support --include <patterns...> for including files in compilation.
• 🚨 outDir is required in tsconfig if you are using --remove, --copyfiles or --watch.

Install

npm install typescript @rnm/tscx -D

Usage

# Equivalent to `npx tsc`
$ npx tscx

# Equivalent to `npx tsc --noEmit`
$ npx tscx --noEmit

# Equivalent to `npx tsc --project tsconfig.build.json --watch`
$ npx tscx --project tsconfig.build.json --watch

# Remove output folder before compilation and then compile ts code.
$ npx tscx --remove

# Compile ts code and then copy non-ts files to output folder after compilation.
$ npx tscx --copyfiles

# Compile ts code and execute bootstrap.js after successful compilation.
$ npx tscx --exec bootstrap.js

# Compile ts code in watch mode and execute bootstrap.js after every successful compilation.
$ npx tscx --project tsconfig.build.json --watch --exec bootstrap.js

# Remove => Compile => Copy => Bootstrap => Edit any file to repeat it
$ npx tscx --project tsconfig.build.json --remove --copyfiles --watch --exec bootstrap.js

Note: If the values of --include or --exclude are glob patterns, you need to wrap them with single quotes. For example:

npx tscx --include src --exclude '**/*.test.ts' '**/*.spec.ts'

Contributing

• Clone this repository.
• Enable Corepack using corepack enable.
• Install dependencies using pnpm install.
• Run pnpm build to build and pnpm test to test.

License

MIT