Skip to content
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

doc(website): upgrade doc for cn #1525

Merged
merged 2 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion website/src/content/docs/zh-cn/guides/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ import PackageManagerCommand from "@src/components/PackageManagerCommand.astro";
bun="add --dev --exact @biomejs/biome"
/>

> **注意**:也可以全局安装Biome,而不是本地安装。但不推荐这样做。
:::note
也可以全局安装Biome,而不是本地安装。但不推荐这样做。
:::

强烈建议在安装Biome时不要使用范围运算符。有关更多信息,请查看[版本页面](/internals/versioning/)。

Expand Down
2 changes: 2 additions & 0 deletions website/src/content/docs/zh-cn/guides/how-biome-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: 学习如何使用Biome设置新项目。

import DefaultConfiguration from "@src/components/generated/DefaultConfiguration.mdx";

这一指南旨在解释工具是如何工作的,原理以及在配置项目和配置文件时有所帮助的内部信息。

## 配置

配置文件被认为是**可选的**,Biome有很好的默认值。使用配置文件来更改这些默认值。
Expand Down
66 changes: 66 additions & 0 deletions website/src/content/docs/zh-cn/guides/integrate-in-vcs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: 与版本控制系统集成
description: 了解 Biome 是如何工作的,如原理、配置等。
---

版本控制系统(VCS,Version Control System)旨在增加仅能由版本控制系统提供的额外特性,允许更多地定制个性化的开发体验。

集成是一个可选项,它有两个必填参数。`vcs.enabled` 字段,以及 `vcs.clientKind` 字段,二者都在配置文件中:

```json title="biome.json"
{
"vcs": {
"enabled": true,
"clientKind": "git"
}
}
```

这个配置不会执行任何操作。你必须选择额外的特性。

### 使用 ignore 文件

这是一个让 Biome 读取版本控制系统的 ignore 文件并忽略其指定的所有文件和文件夹。这是一个可选的特性,同时必须支持 `vcs.useIgnoreFile` 字段:

```json title="biome.json" ins={5}
{
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
}
}
```

### 仅处理变更文件

这是一个仅能通过命令行工具(CLI)使用的特性,能够**只**处理有内容**变更**的文件。

首先,你必须更新配置文件并通过 Biome 的 `vcs.defaultBranch` 字段配置默认分支:

```json title="biome.json" ins={6}
{
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true,
"defaultBranch": "main"
}
}
```

然后,在命令行中增加 `--changed` 选项,来处理那些被版本控制系统标记为“变更”的文件。Biome 会在版本控制系统的帮助下,会判断出 `main` 分支的变更文件以及当前修订内容:

```shell
biome format --changed
```

:::caution
Biome 不会检查变更内容,这意味着即使是在文件里增加了空格或新的一行,都会将该文件标记为“变更”
:::

或者,可以通过 `--since` 选项来制定任意一个分支。这个选项**优先**于 `vcs.defaultBranch` 选项。例如,你可能想要针对 `next` 分支来来检查变更:

```shell
biome format --changed --since=next
```
6 changes: 4 additions & 2 deletions website/src/content/docs/zh-cn/guides/manual-installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ description: 手动安装Biome
如果您还没有使用Node或npm(或任何其他软件包管理器),那么使用Biome的独立CLI二进制文件可能是一个很好的选择。
换句话说,Biome不应该是您拥有`package.json`的唯一原因。

> 注意:如果您已经使用npm或其他软件包管理器,则使用软件包管理器是[安装](/guides/getting-started#installation) Biome的[首选方式](/guides/getting-started#installation)。
> 您已经熟悉工具链,并且安装和更新更加简单。
:::note
如果您已经使用npm或其他软件包管理器,则使用软件包管理器是[安装](/guides/getting-started#installation) Biome的[首选方式](/guides/getting-started#installation)。
您已经熟悉工具链,并且安装和更新更加简单。
:::

### Homebrew

Expand Down
Loading