Minimalist TypeScript package initializer - like
npm init, but for TS.
npm i -g ts-init
From now, whenever you want to create a new TypeScript project, just run:
What does it actually do? Well, not a lot! It will:
- Install dev dependencies: typescript, ts-node and rimraf (for cross-platform
- Create npm scripts to build your project with TS compiler and run it with
ts-node. Build files will be also properly declared in your
package.jsonand added to
- Create a minimalist
tsconfig.jsonfile with sane defaults: ES6 with the following flags set to true:
npm run build- build your project
npm run ts- run your project with
src/- your source files, must contain
test/- your test files
es/- ES6 build using ES modules
lib/- ES5 build using CommonJS (npm) modules. This directory contains
*.d.tsdeclaration files too.
This project is meant to provide everything you need in order to create an npm library (and potentially any other JS project) with modern TypeScript compiler. This way you can use modern ES6 features and static types without any cost.
In the same time, it tries not to force you to use something which is just an opinionated tool. It doesn't include a linter, testing library like Jest or some heavy TS configuration. Everything is kept as minimal as it's possible.