Skip to content

About

Shared Biome configuration for Crowdin apps

Resources

Code of conduct

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

5 Commits

Folders and files

Repository files navigation

@crowdin/apps-biome-config

Shared Biome configuration for Crowdin apps.

Usage

npm install --save-dev @crowdin/apps-biome-config

Biome is a pinned peer dependency and installs with this package. Do not add @biomejs/biome separately.

With pnpm, add to pnpm-workspace.yaml:

publicHoistPattern:
  - '@biomejs/biome'

pnpm does not link the biome command of a peer dependency that it installs automatically. Hoisting links it and lets editor extensions find Biome.

biome.json:

{
  "$schema": "./node_modules/@crowdin/apps-biome-config/schema.json",
  "extends": ["@crowdin/apps-biome-config/biome"]
}

package.json scripts:

{
  "lint": "biome check --error-on-warnings",
  "lint-fix": "biome check --write",
  "prepare": "husky || true"
}

In CI, run biome ci --error-on-warnings: the same check as lint.

Pre-commit hook

Formats and fixes staged files on every commit, also when an AI agent makes the commit.

npm install --save-dev husky

.husky/pre-commit:

biome check --write --staged --no-errors-on-unmatched
git update-index --again

|| true in prepare keeps installs without dev dependencies, such as production Docker images, from failing.

Settings

Only settings that differ from Biome's defaults. Each one needs a reason here.

Setting Value Biome default Why
vcs.useIgnoreFile true false Skips what .gitignore skips.
files.ignoreUnknown true false No errors on unsupported file types.
formatter.indentStyle space tab Same look in every editor and review tool.
formatter.lineWidth 120 80 Room for TypeScript signatures, still fits side-by-side diffs.
javascript.formatter.quoteStyle single double No escaping in strings that contain HTML, JSON or quoted text.
assist.actions.source.organizeImports off on Sorting moves imports with side effects, such as Sentry setup, below the code that must run after them.
linter.rules.style.useThrowOnlyError error off Throwing a string or object loses the stack trace.
yaml.formatter.enabled false true Helm chart templates are not valid YAML until rendered; formatting breaks {{ }} expressions.
css.parser.tailwindDirectives true false Parses Tailwind at-rules such as @theme and @apply.
--error-on-warnings (CI) on off Warnings that never fail the build get ignored.

License

MIT

About

Shared Biome configuration for Crowdin apps

Resources

Code of conduct

Stars

1 star

Watchers

1 watching

Forks

Releases

Contributors