-
-
Notifications
You must be signed in to change notification settings - Fork 1
feat: switch code quality setup to ultracite and biome #769
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ahmadk953
wants to merge
11
commits into
development
Choose a base branch
from
ahmadk953/biome-ultracite
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
e605edd
feat: switch to ultracite for code quality
ahmadk953 cdcbf60
feat: readd lint-staged
ahmadk953 4c92148
fix: type check not working for lint-staged + husky improvements
ahmadk953 3b57ab8
docs: update documentation for new code quality setup
ahmadk953 092a355
refactor: update codebase to adhere to new linting/formatting rules
ahmadk953 b5824d4
chore: update devcontainer and workflows for improved formatting and …
ahmadk953 0fd86a2
refactor(db): update database function signatures, table types, and …
ahmadk953 89d2595
refactor: improve error handling in interaction processing and enhanc…
ahmadk953 61df3f4
refactor: general command improvements + finalize migration to safely…
ahmadk953 187eb4b
refactor(counting): enhance message processing with numeric validatio…
ahmadk953 594551b
refactor(telemetry): enhance error field extraction with improved sta…
ahmadk953 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| --- | ||
| name: ultracite | ||
| description: "Ultracite is a zero-config linting and formatting preset for JavaScript/TypeScript projects. Use when: (1) Setting up or initializing Ultracite in a project (ultracite init), (2) Running linting or formatting commands (check, fix, doctor), (3) Writing or reviewing JS/TS code in a project that uses Ultracite — to follow its code standards, (4) Troubleshooting linting/formatting issues, (5) User mentions 'ultracite', 'lint', 'format', 'code quality', or 'biome/eslint/oxlint' in a project with Ultracite installed." | ||
| --- | ||
|
|
||
| # Ultracite | ||
|
|
||
| Zero-config linting and formatting for JS/TS projects. Supports three linter backends: **Biome** (recommended), **ESLint** + Prettier, and **Oxlint** + Oxfmt. | ||
|
|
||
| ## Detecting Ultracite | ||
|
|
||
| Check if `ultracite` is in `package.json` devDependencies. Detect the active linter by looking for: | ||
|
|
||
| - `biome.jsonc` → Biome | ||
| - `eslint.config.mjs` → ESLint | ||
| - `.oxlintrc.json` → Oxlint | ||
|
|
||
| ## CLI Commands | ||
|
|
||
| ```bash | ||
| # Check for issues (read-only) | ||
| bunx ultracite check | ||
|
|
||
| # Auto-fix issues | ||
| bunx ultracite fix | ||
|
|
||
| # Diagnose setup problems | ||
| bunx ultracite doctor | ||
|
|
||
| # Initialize in a new project | ||
| bunx ultracite init | ||
| ``` | ||
|
|
||
| Replace `bunx` with `npx`, `pnpx`, or `yarn dlx` depending on the package manager. | ||
|
|
||
| `check` and `fix` accept optional file paths: `bunx ultracite check src/index.ts`. | ||
|
|
||
| ## Initialization | ||
|
|
||
| `bunx ultracite init` runs an interactive setup. For non-interactive (CI) use, pass flags: | ||
|
|
||
| ```bash | ||
| bunx ultracite init \ | ||
| --pm bun \ | ||
| --linter biome \ | ||
| --editors vscode cursor \ | ||
| --agents claude copilot \ | ||
| --frameworks react next \ | ||
| --integrations husky lint-staged \ | ||
| --quiet | ||
| ``` | ||
|
|
||
| **Flags:** | ||
|
|
||
| - `--pm` — `npm` | `yarn` | `pnpm` | `bun` | ||
| - `--linter` — `biome` (recommended) | `eslint` | `oxlint` | ||
| - `--editors` — `vscode` | `zed` | `cursor` | `windsurf` | `antigravity` | `kiro` | `trae` | `void` | ||
| - `--agents` — `claude` | `codex` | `copilot` | `cline` | `amp` | `gemini` | `cursor-cli` + 19 more | ||
| - `--frameworks` — `react` | `next` | `solid` | `vue` | `svelte` | `qwik` | `remix` | `angular` | `astro` | `nestjs` | ||
| - `--integrations` — `husky` | `lefthook` | `lint-staged` | `pre-commit` | ||
| - `--hooks` — Enable auto-fix hooks for supported agents/editors | ||
| - `--type-aware` — Enable type-aware linting (oxlint only) | ||
| - `--skip-install` — Skip dependency installation | ||
| - `--quiet` — Suppress prompts (auto-detected when `CI=true`) | ||
|
|
||
| Init creates config that extends Ultracite presets: | ||
|
|
||
| ```jsonc | ||
| // biome.jsonc | ||
| { "extends": ["ultracite/biome/core", "ultracite/biome/react"] } | ||
| ``` | ||
|
|
||
| Framework presets available per linter: `core`, `react`, `next`, `solid`, `vue`, `svelte`, `qwik`, `remix`, `angular`, `astro`, `nestjs`. | ||
|
|
||
| ## Code Standards | ||
|
|
||
| When writing code in a project with Ultracite, follow these standards. For the full rules reference, see [references/code-standards.md](references/code-standards.md). | ||
|
|
||
| Key rules at a glance: | ||
|
|
||
| **Formatting:** 2-space indent, semicolons, double quotes, 80-char width, ES5 trailing commas, LF line endings. | ||
|
|
||
| **Style:** Arrow functions preferred. `const` by default, never `var`. `for...of` over `.forEach()`. Template literals over concatenation. No enums (use objects with `as const`). No nested ternaries. Kebab-case filenames. | ||
|
|
||
| **Correctness:** No unused imports/variables. No `any` (use `unknown`). Always `await` promises in async functions. No `console.log`/`debugger`/`alert` in production. | ||
|
|
||
| **React:** Function components only. Hooks at top level. Exhaustive deps. `key` on iterables (no array index). No nested component definitions. Semantic HTML + ARIA. | ||
|
|
||
| **Performance:** No accumulating spread in loops. No barrel files. No namespace imports. Top-level regex. | ||
|
|
||
| **Security:** `rel="noopener"` on `target="_blank"`. No `dangerouslySetInnerHTML`. No `eval()`. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| Run `bunx ultracite doctor` to diagnose. It checks: | ||
|
|
||
| 1. Linter installation (biome/eslint/oxlint binary available) | ||
| 2. Config validity (extends ultracite presets correctly) | ||
| 3. Ultracite in package.json dependencies | ||
| 4. Conflicting tools (old `.eslintrc.*`, `.prettierrc.*` files) | ||
|
|
||
| Common fixes: | ||
|
|
||
| - **Conflicting configs**: Delete legacy `.eslintrc.*` and `.prettierrc.*` files after migrating to Ultracite | ||
| - **Missing dependency**: Run `bunx ultracite init` again or manually add `ultracite` to devDependencies | ||
| - **Rules not applying**: Ensure config file extends the correct presets for your framework |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| # Ultracite Code Standards | ||
|
|
||
| ## Core Principles | ||
|
|
||
| Write code that is **accessible, performant, type-safe, and maintainable**. Focus on clarity and explicit intent over brevity. | ||
|
|
||
| ## Type Safety & Explicitness | ||
|
|
||
| - Use explicit types for function parameters and return values when they enhance clarity | ||
| - Prefer `unknown` over `any` when the type is genuinely unknown | ||
| - Use const assertions (`as const`) for immutable values and literal types | ||
| - Leverage TypeScript's type narrowing instead of type assertions | ||
| - Use meaningful variable names instead of magic numbers — extract constants with descriptive names | ||
|
|
||
| ## Modern JavaScript/TypeScript | ||
|
|
||
| - Use arrow functions for callbacks and short functions | ||
| - Prefer `for...of` loops over `.forEach()` and indexed `for` loops | ||
| - Use optional chaining (`?.`) and nullish coalescing (`??`) for safer property access | ||
| - Prefer template literals over string concatenation | ||
| - Use destructuring for object and array assignments | ||
| - Use `const` by default, `let` only when reassignment is needed, never `var` | ||
|
|
||
| ## Async & Promises | ||
|
|
||
| - Always `await` promises in async functions — don't forget to use the return value | ||
| - Use `async/await` syntax instead of promise chains for better readability | ||
| - Handle errors appropriately in async code with try-catch blocks | ||
| - Don't use async functions as Promise executors | ||
|
|
||
| ## React & JSX | ||
|
|
||
| - Use function components over class components | ||
| - Call hooks at the top level only, never conditionally | ||
| - Specify all dependencies in hook dependency arrays correctly | ||
| - Use the `key` prop for elements in iterables (prefer unique IDs over array indices) | ||
| - Nest children between opening and closing tags instead of passing as props | ||
| - Don't define components inside other components | ||
| - Use semantic HTML and ARIA attributes for accessibility: | ||
| - Provide meaningful alt text for images | ||
| - Use proper heading hierarchy | ||
| - Add labels for form inputs | ||
| - Include keyboard event handlers alongside mouse events | ||
| - Use semantic elements (`<button>`, `<nav>`, etc.) instead of divs with roles | ||
|
|
||
| ## Error Handling & Debugging | ||
|
|
||
| - Remove `console.log`, `debugger`, and `alert` statements from production code | ||
| - Throw `Error` objects with descriptive messages, not strings or other values | ||
| - Use `try-catch` blocks meaningfully — don't catch errors just to rethrow them | ||
| - Prefer early returns over nested conditionals for error cases | ||
|
|
||
| ## Code Organization | ||
|
|
||
| - Keep functions focused and under reasonable cognitive complexity limits (max 20) | ||
| - Extract complex conditions into well-named boolean variables | ||
| - Use early returns to reduce nesting | ||
| - Prefer simple conditionals over nested ternary operators | ||
| - Group related code together and separate concerns | ||
|
|
||
| ## Security | ||
|
|
||
| - Add `rel="noopener"` when using `target="_blank"` on links | ||
| - Avoid `dangerouslySetInnerHTML` unless absolutely necessary | ||
| - Don't use `eval()` or assign directly to `document.cookie` | ||
| - Validate and sanitize user input | ||
|
|
||
| ## Performance | ||
|
|
||
| - Avoid spread syntax in accumulators within loops | ||
| - Use top-level regex literals instead of creating them in loops | ||
| - Prefer specific imports over namespace imports | ||
| - Avoid barrel files (index files that re-export everything) | ||
| - Use proper image components (e.g., Next.js `<Image>`) over `<img>` tags | ||
|
|
||
| ## Formatting | ||
|
|
||
| - 2-space indentation | ||
| - LF line endings | ||
| - 80-character line width | ||
| - Semicolons always | ||
| - Double quotes (single quotes in JSX) | ||
| - ES5 trailing commas | ||
| - Arrow parentheses always | ||
| - Bracket spacing enabled | ||
|
|
||
| ## Style Rules | ||
|
|
||
| - No enums — use objects with `as const` | ||
| - No nested ternary operators | ||
| - No non-null assertions (`!`) | ||
| - Kebab-case filenames enforced | ||
| - `useImportType` for type-only imports | ||
| - Readonly class properties by default | ||
| - Sorted imports, JSX attributes, interface members, and object properties | ||
|
|
||
| ## Framework-Specific | ||
|
|
||
| **Next.js:** Use `<Image>` component for images. Use App Router metadata API for head elements. Use Server Components for async data fetching. | ||
|
|
||
| **React 19+:** Use ref as a prop instead of `React.forwardRef`. | ||
|
|
||
| **Solid/Svelte/Vue/Qwik:** Use `class` and `for` attributes (not `className` or `htmlFor`). | ||
|
|
||
| ## Testing | ||
|
|
||
| - Write assertions inside `it()` or `test()` blocks | ||
| - Avoid done callbacks in async tests — use async/await instead | ||
| - Don't use `.only` or `.skip` in committed code | ||
| - Keep test suites reasonably flat — avoid excessive `describe` nesting | ||
|
|
||
| ## Overrides | ||
|
|
||
| Ultracite relaxes rules in specific contexts: | ||
|
|
||
| - **Config files** (`*.config.{js,ts,...}`): Relaxed export and complexity rules | ||
| - **Test files** (`*.test.*`, `__tests__/**`): No cognitive complexity limit, `console` and `any` allowed | ||
| - **Scripts/bin files**: `console` and `process.env` allowed | ||
| - **Storybook files**: Unused variable/import rules relaxed | ||
| - **Build output** (`dist/`, `.next/`, `node_modules/`): Formatter and linter disabled entirely |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.