Kickstart your Node.js + TypeScript projects with zero configuration.
NodeTSP is a CLI scaffolding tool that automates the setup of Node.js projects with TypeScript, ESLint, Prettier, and Git. Spend less time on boilerplate and more time writing code.
npm install -g nodetsp
# or
pnpm add -g nodetsp
# Create a new project to start the cli prompts
nodetsp init
# Choose pnpm instead of npm
nodetsp init my-project --pm pnpm
# Use CommonJS and create extra folders
nodetsp init my-project \
--ms cjs \
--fd utils,types \
--git
# Non-interactive (all options in one go)
nodetsp init my-project \
--pm pnpm \
--ms esm \
--fd lib,utils,config,types \
--git
Option | Description | Default |
---|---|---|
-p, --pm <manager> |
Package manager: npm or pnpm |
npm |
-m, --ms <system> |
Module system: esm or cjs |
esm |
-f, --fd <folders> |
Comma-separated extra folders: lib,utils,config,types |
none |
-g, --git |
Initialize a Git repository | false |
-v, --version |
Display version | โ |
-h, --help |
Show help | โ |
Note: The CLI uses the following flags:
-p, --pm
for package manager (e.g.,--pm pnpm
)-m, --ms
for module system (e.g.,--ms esm
or--ms cjs
)-f, --fd
for folders (e.g.,--fd lib,utils
)-g, --git
to initialize a git repository The long flags are two characters, not full words.
my-project/
โโโ src/
โ โโโ index.ts
โโโ dist/
โโโ .prettierrc
โโโ .gitignore
โโโ tsconfig.json
โโโ package.json
To contribute or run the CLI locally:
cd packages/cli
pnpm install
pnpm run build
pnpm link --global # Makes the CLI available as 'nodetsp' on your system
We welcome contributions! Please read our Contributing Guidelines before opening an issue or pull request.
This project is licensed under the MIT License.