wtf project

Why

Each repo of TypeScript packages needs a tsconfig, a lint config, a format config, a test config and a docs config. When you copy them from repo to repo, they drift apart, and a fix in one repo does not reach the others.

With @wtf/project, each config extends a shared preset, and states only what is different in your repo. You install only the presets that you use. An update of a preset reaches every repo that extends it.

// vitest.config.ts, at the root
import { rootConfig } from '@wtf/project-vitest/config'

export default rootConfig()

{
  "extends": "@wtf/project-typescript/strict",
  "compilerOptions": { "composite": true, "rootDir": "src", "outDir": "dist" },
  "include": ["src"]
}

Run from source, test the build

You do not build before you test. The resolve hook runs the TypeScript of the workspace straight from src, and the TypeScript, Vite and Vitest configs resolve each workspace package to its source in the same way. In CI, the same tests run on the build, with coverage mapped back to the source.

pnpm test        # from the source, with nothing built
pnpm test:dist   # from the build, as CI does

The configs

@wtf/project-typescriptThe TypeScript configs that a package extends: base, strict for a library, test, and bundler.

@wtf/project-oxlintThe oxlint config: correctness rules as errors, and import cycles, loose equality and explicit any as errors too.

@wtf/project-oxfmtThe oxfmt config: 100 columns, single quotes, no semicolons and no trailing commas.

@wtf/project-viteThe base Vite config that every Vite config of the workspace starts from, with compressed copies of the files of a site.

@wtf/project-vitestThe Vitest configs: tests from the source or from the build, with coverage, in Node, in a browser or as Storybook stories.

@wtf/project-typedocThe TypeDoc config of a docs package: the reference of the workspace in markdown, with an llms.txt.

The tools

@wtf/project-resolveA Node resolve hook that runs the TypeScript of the workspace from its source, with nothing built.

@wtf/project-wptRun the Web Platform Tests of a standard against your implementation of it, in Vitest.

What you get

One preset for each tool

TypeScript, oxlint, oxfmt, Vite, Vitest and TypeDoc each have a package of their own. Install the ones you use, and extend them.

No build before a test

Each package of your workspace exports its TypeScript by the @wtf/source condition. The resolve hook, Vite and Vitest read it, so a test runs the source as it is.

Coverage of the build

CI tests what you publish, the build, and maps the coverage back to the source by the source maps.

Held to the standards

Run the Web Platform Tests of a standard in Vitest, at a pinned commit, with a list of the known failures of your implementation.

Learn more

Getting startedSet up a new workspace with its tooling, scripts and configs, and lay out a package that the presets fit.

The presetsExtend the TypeScript, oxlint, oxfmt and TypeDoc configs, and see what each one sets.

The testsRun the tests from the source or from the build, with coverage, in a browser, as stories, and against the Web Platform Tests.

TestingRun each suite from the source on your machine and from the build in CI, with the pair of scripts that each suite needs.

Vite, and sitesStart every Vite config from one base, ship compressed copies of a site, and know which Vite and Vitest a repo names.

API referenceEvery package, module and member, at the version that you install.