/npm-ts-template

Template for TypeScript npm packages

Primary LanguageJavaScriptMIT LicenseMIT

Template for TypeScript npm packages

Config is for browser, ESM target.

Uses typescript for type checking & declaration, and esbuild for transpilation and bundling.

To start off a new package:

# clone this repo
git clone git@github.com:mitschabaude/npm-ts-template.git my-repo
cd my-repo

# remove git history and init new repo
rm -rf .git
git init
git checkout -b main
git add . && git commit -m "init"

# install packages and see if it works
yarn && yarn build && yarn size

# add lockfile
git add . && git commit -m "add lockfile"

# start kicking ass
code .

Don't forget to adapt LICENSE.md and package.json (name, author, homepage, repo).

If you need a more complex build command (e.g. for not bundling npm dependencies), you can start off build.js or look into tsup.