Setting up a new TypeScript/JavaScript project is too hard. Here's my opinion of what a reasonable TypeScript template project looks like for writing a library (if you need a framework template you'll need to look somewhere else).
Run:
npx degit disnet/ts-template my-new-projectand then change:
name,description, andauthor, inpackage.jsonprivateinpackage.jsonwhen ready to publish (prevents accidentally publishing early)[name]and[year]inLICENSE.txt(and potentially the entire thing if you want something other than MIT)
- TypeScript with
strictchecking enabled - Babel to do the actual compiling
- Eslint to do the linting with mostly the
eslint:recommendedrules - Ava to do testing
- A Prettier config file if your editor is looking for one but not as an actual dependency
src/is where all your source files gotest/is where all your test files godist/is where all the built files go
It is assumed that the main entrypoint to your library is at src/index.ts so package.json points to the built file dist/index.js is the main script.
The only npm script you need to actually use is npm test.
Note that importantly npm t does not run type checking or linting. Often, while trying to debug something you need to write code that violates "good" style 😬 or is even not type safe 😱.
This is fine.
If you're using any reasonable editor your sins have already been noted and underlined. Style and types are enforced when publishing since by then you've hopefully atoned.
Sources are compiled to CommonJS modules because trying to publish a library that uses ES modules that can be either required or imported safely is just too hard and complicated. So, cjs forever 😞.