@browsercore/dev

Shared build, lint, test, and coverage tooling for every @browsercore/* package. One published package is the single source of truth; consumers extend it live via npm.

Install

npm install -D @browsercore/dev

Usage

tsconfig

{
  "extends": "@browsercore/dev/tsconfig.base.json",
  "compilerOptions": { "rootDir": "src", "outDir": "dist" },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules", "dist", "tests"]
}

For builds that emit declarations, extend @browsercore/dev/tsconfig.build.base.json instead (layers declaration, declarationMap, sourceMap on top of the base).

vitest

import { definePackageConfig } from "@browsercore/dev/vitest";

export default definePackageConfig({ name: "<pkg>" });

definePackageConfig wires in the shared reporters (text, html, json-summary), v8 coverage over src/**/*.ts, and 30s test/hook timeouts. The html + json-summary artifacts are what the coverage report reads. Pass { include, coverage } to override test globs or append coverage excludes.

oxlint

oxlint's JSON extends only resolves relative file paths (not node_modules), so the base is consumed via a TS import:

import { defineConfig } from "oxlint";
import base from "@browsercore/dev/oxlint";

export default defineConfig({ extends: [base] });

Type-aware linting (--type-aware) requires oxlint-tsgolint in the consumer's devDependencies.

coverage-md

After running vitest with coverage, generate a COVERAGE.md report + shields.io badge:

npx vitest run --coverage
npx coverage-md

The bin reads coverage/coverage-summary.json (written by the json-summary reporter) and writes COVERAGE.md and coverage/badge.json to the package root.

Scripts

| Command | Runs | | --- | --- | | npm run typecheck | tsc -p tsconfig.json --noEmit | | npm run lint | oxlint --type-aware src/ | | npm test | vitest run | | npm run build | tsc -p tsconfig.build.json |

Coverage report

To produce a coverage report:

npx vitest run --coverage
node scripts/coverage-md.mjs    # writes COVERAGE.md + coverage/badge.json

Provider is @vitest/coverage-v8. The report is generated from coverage/coverage-summary.json.

License

MIT