Skip to content

日本語

configs ​

Shared configuration and check packages published to npm.

Packages ​

PackageDescription
@yuu1111/biome-configShared Biome configuration
@yuu1111/knip-configShared Knip configuration
@yuu1111/quality-checkIntegrated CLI with the check engines built into it
@yuu1111/tsconfigShared TypeScript configurations

The individual check engines code-style-check, comment-check, document-style-check, and tsdoc-check live under packages/engine/ as private workspace packages and are bundled into @yuu1111/quality-check, together with @yuu1111/shared.

Documents ​

DocumentPurpose
ArchitectureWhy the packages are layered and bundled the way they are
AdoptionInstalling the packages into a project, from config to CI
Engine contractThe contract the built-in engines and the integrated runner share
Engine referenceThe options and rules of each built-in engine

Development ​

Bun workspace monorepo. Biome is self-hosted (the repo lints itself with its own config).

bash
bun install            # install + link workspaces
bun run build          # bundle the check engines and their dependencies into @yuu1111/quality-check
bunx biome check .     # lint / format check
bunx biome check --write .   # auto-fix

Release ​

Publishing runs through npm Trusted Publisher when a GitHub Release is published. Use a package-specific tag whose version matches the selected package.

bash
cd packages/config/biome-config
bun pm version patch --no-git-tag-version
# Commit and push the version change, then publish biome-config-vX.Y.Z on GitHub.

Name the tag after the package being released, for example biome-config-vX.Y.Z. Do not run npm publish locally.