Skip to content
This repository was archived by the owner on Oct 26, 2026. It is now read-only.

Temme build

Oussama Essamadi edited this page Oct 25, 2026 · 4 revisions

Build

Requirements

  • Node.js 24 or later
  • pnpm 12 (the repository refuses npm and yarn)
git clone https://github.com/eoussama/temmejs.git
cd temmejs
pnpm install
pnpm build

pnpm build builds every distribution format into dist/ with tsdown, then checks the package with publint and Are the Types Wrong.

Available scripts

Command Description
pnpm build Builds ESM, CommonJS, browser ESM, UMD and IIFE bundles and their types into dist/.
pnpm dev Rebuilds on change.
pnpm build:site Assembles the documentation website (docs/ and the browser build) into _site/.
pnpm typecheck Type checks with the TypeScript 7 native compiler.
pnpm lint Lints with @eoussama/dx; pnpm lint:fix applies automatic fixes.
pnpm test Runs the unit and integration tests with coverage.
pnpm test:smoke Tests the built package.
pnpm test:e2e Runs the browser end-to-end tests.
pnpm test:mutation Runs the mutation tests.
pnpm check Runs everything above, plus pnpm audit, the way CI does.

More about the test suites in Tests.

Documentation website

The website is built from docs/ and deployed to GitHub Pages by the Pages workflow on every push to master. To preview it locally:

pnpm build
pnpm build:site

Then serve _site/ with any static file server.

Releases

Publishing a GitHub release from a tag (e.g. v1.0.8, matching the package.json version) runs the Publish workflow, which checks, builds and publishes the package to npm (with provenance) and to GitHub Packages.

Clone this wiki locally