Dabbjs NPM | npm.io

TypeScript Base Library 2021

This's the code of my base library:

template from blog post: Starting a TypeScript Project in 2021.

TypeScript project boilerplate with modern tooling, for Node.js programs, libraries and browser modules. Get started quickly and right-footed 🚀

TypeScript 4
Optionally esbuild to bundle for browsers (and Node.js)
Linting with typescript-eslint (tslint is deprecated)
Testing with Jest (and ts-jest)
Publishing to npm
Continuous integration (GitHub Actions / GitLab CI)
Automatic API documentation with TypeDoc

Getting Started

You can generate a full clean build with pnpm run build-all (which uses both tsc and esbuild).

package.json includes scripts for various esbuild commands
esbuild has a --global-name=xyz flag, to store the exports from the entry point in a global variable. See also the esbuild "Global name" docs.
Read more about the esbuild setup here.
esbuild for the browser uses the IIFE (immediately-invoked function expression) format, which executes the bundled code on load (see also https://github.com/evanw/esbuild/issues/29)

Tests with Jest

You can write Jest tests like this:

import { greet } from "./main";

test("the data is peanut butter", () => {
  expect(1).toBe(1);
});

test("greeting", () => {
  expect(greet("Foo")).toBe("Hello Foo");
});

Run the tests with pnpm run test, no separate compile step is necessary.

See also the Jest documentation.
The tests can be automatically run in CI (GitHub Actions, GitLab CI): .github/workflows/lint-and-test.yml, .gitlab-ci.yml
Take a look at other modern test runners such as ava, uvu and tape

Documentation, published with CI

You can auto-generate API documentation from the TyoeScript source files using TypeDoc. The generated documentation can be published to GitHub / GitLab pages through the CI.

Generate the documentation, using src/index.ts as entrypoint (configured in package.json):