feat: specify lang via cli #187

JounQin · 2025-10-13T09:52:52Z

close IDP-1325

Summary by CodeRabbit

New Features
- Added a global CLI option --lang to set the documentation language when starting the dev server.
Documentation
- Updated English and Chinese start guides to include and explain the new --lang option.
- Refreshed CLI help examples to reflect language selection.
Chores
- Added a changeset entry for a patch release documenting the new CLI language option.

close IDP-1325

changeset-bot · 2025-10-13T09:52:56Z

🦋 Changeset detected

Latest commit: 53f5d12

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@alauda/doom	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copilot

Pull Request Overview

This PR adds a new CLI option to specify the documentation language via the --lang parameter, allowing users to override the language configuration from the command line.

Adds a new lang CLI option to specify documentation language
Integrates the language parameter through the configuration loading pipeline
Updates documentation to reflect the new CLI option

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
packages/doom/src/types.ts	Adds `lang` property to `GlobalCliOptions` interface
packages/doom/src/cli/load-config.ts	Implements language override logic in configuration loading
packages/doom/src/cli/index.ts	Adds the `--lang` CLI option definition
docs/zh/start.mdx	Documents the new CLI option in Chinese documentation
docs/en/start.mdx	Documents the new CLI option in English documentation

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

coderabbitai · 2025-10-13T09:53:30Z

Walkthrough

Adds a new global CLI option (--lang) to specify documentation language, threads it through config loading, updates types, and refreshes English/Chinese docs. Introduces a changeset marking @alauda/doom for a patch release.

Changes

Cohort / File(s)	Summary of Changes
Release metadata `\.changeset/good-wombats-study.md`	Adds changeset: patch release for `@alauda/doom`; notes feature “specify lang via cli”.
Documentation updates `docs/*/start.mdx` (`docs/en/start.mdx`, `docs/zh/start.mdx`)	Documents new CLI option `--lang <language>` in start command help.
CLI wiring `packages/doom/src/cli/index.ts`, `packages/doom/src/cli/load-config.ts`	Introduces `--lang` option; accepts and propagates `lang` through `loadConfig` into common config.
Type definitions `packages/doom/src/types.ts`	Adds `lang?: string` to `GlobalCliOptions`.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant CLI as Doom CLI
  participant LC as loadConfig
  participant GCC as getCommonConfig
  participant Plugins as Plugins/Transformers

  User->>CLI: doom start --lang en
  CLI->>LC: loadConfig({ lang: "en", ... })
  LC->>GCC: getCommonConfig({ lang: "en", ... })
  note over GCC: Set config.lang if provided<br/>Affects locale resolution and defaults
  GCC-->>LC: merged config (lang respected)
  LC-->>CLI: final config
  CLI->>Plugins: initialize with config.lang
  Plugins-->>CLI: ready
  CLI-->>User: Dev server starts with selected language

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

chore(deps): bump rspress to v2.0.0-beta.29 #166 — Also edits load-config; introduces publicPath/dead-link checks and fs sync usage, overlapping config-loading code paths.
feat: support algolia alauda preset #51 — Adjusts CLI option flow and config loading (algolia/preset parsing), similar surface area for option threading.

Suggested labels

feature

Poem

I twitch my ears—bonjour, 你好, hello!
A flag of tongues to choose before we go.
Hop, hop, config threads the way,
Leading docs in bright array.
Patch-sized nibble, feature glow—
Carrot-shaped options, onward we go! 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title “feat: specify lang via cli” succinctly highlights the addition of a new CLI feature for language specification, directly reflecting the main change in the pull request without extraneous detail or noise. It follows conventional commit style, is clear to teammates scanning history, and focuses on the primary enhancement.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/lang

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1ef6f3d and 53f5d12.

📒 Files selected for processing (6)

.changeset/good-wombats-study.md (1 hunks)
docs/en/start.mdx (2 hunks)
docs/zh/start.mdx (1 hunks)
packages/doom/src/cli/index.ts (1 hunks)
packages/doom/src/cli/load-config.ts (4 hunks)
packages/doom/src/types.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (6)

**/*.{ts,tsx,js,jsx,md,yml,yaml,json}