Skip to content

Commit c1f5d0b

Browse files
feat: sync v8.33.0 (#99)
* feat: sync v8.33.0 * Apply suggestions from code review Co-authored-by: Milos Djermanovic <[email protected]> * chore: update --------- Co-authored-by: Milos Djermanovic <[email protected]>
1 parent c7b77c7 commit c1f5d0b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+685
-414
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ library.json
118118
pages.11tydata.json
119119
static
120120
html-formatter-example.html
121+
html-formatter-example.json
121122
src.json
122123
/package.json
123124
/package-lock.json
125+
.stylelintrc.json

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> Simplified Chinese website
44
5-
The synchronization frequency is the same as the ESLint release frequency (the last sync was [v8.32.0](https://github.com/eslint/eslint/tree/v8.32.0))
5+
The synchronization frequency is the same as the ESLint release frequency (the last sync was [v8.33.0](https://github.com/eslint/eslint/tree/v8.33.0))
66

77
## Contribute
88

src/contribute/architecture/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
title: 架构
33
eleventyNavigation:
44
key: architecture
5-
parent: developer guide
5+
parent: contribute to eslint
66
title: 架构
7-
order: 1
7+
order: 5
88
---
99

10-
<center><img alt="dependency graph" src="../../assets/images/architecture/dependency.svg"></center>
10+
:::img-container
11+
<img alt="dependency graph" src="../../assets/images/architecture/dependency.svg">
12+
:::
1113

1214
在较高层次上看,ESLint 有几个关键部分:
1315

src/contribute/code-of-conduct.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: 行为准则
3+
eleventyNavigation:
4+
key: code of conduct
5+
parent: contribute to eslint
6+
title: 行为准则
7+
order: 0
8+
---
9+
10+
ESLint 欢迎所有遵守 [OpenJS 基金会行为准则](https://eslint.org/conduct)的贡献。我们恳请您在贡献之前仔细阅读此行为准则。

src/contribute/development-environment.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
2-
title: 开发环境
2+
title: 设置开发环境
33
eleventyNavigation:
44
key: set up a development environment
5-
parent: developer guide
5+
parent: contribute to eslint
66
title: 设置开发环境
7-
order: 2
8-
7+
order: 6
98
---
109

11-
ESLint 有个非常轻量的开发环境,这使得更新代码快速而简单。下面是在给项目提交贡献前,关于建立本地开发环境的分步指南。
10+
ESLint 的开发环境十分轻量,这使得更新代码快速而简单。下面是在给项目提交贡献前,关于建立本地开发环境的分步指南。
1211

1312
## 第一步:安装 Node.js
1413

@@ -20,6 +19,12 @@ ESLint 有个非常轻量的开发环境,这使得更新代码快速而简单
2019

2120
进入 <https://github.com/eslint/eslint>,点击“Fork”按钮。然后按照 [GitHub 文档](https://help.github.com/articles/fork-a-repo)进行分叉和克隆。
2221

22+
克隆自己的分叉:
23+
24+
```shell
25+
git clone https://github.com/<你的 Github 用户名>/eslint
26+
```
27+
2328
在克隆仓库后,需要运行 `npm install` 以获得所有必要的依赖。
2429

2530
```shell
@@ -29,11 +34,13 @@ npm install
2934

3035
此步骤必须连接网络。它需要下载很多实用程序。
3136

37+
**注意**:每次从主仓库拉取代码后都重新运行 `npm install` 有助于确保使用最新的开发依赖。
38+
3239
## 第三步:添加上游源码
3340

34-
**上游源码**是指 ESLint 的主要仓库,那里有活跃的开发。虽然你没有上游的推送权限,但你会有拉取权限,你可以随时拉取最新的代码。
41+
**上游源**是指 ESLint 的主要仓库,那里有活跃的开发。虽然你没有上游的推送权限,但你会有拉取权限,你可以随时拉取最新的代码。
3542

36-
要添加 ESLint 的上游源码,请在你的仓库中运行以下程序:
43+
要添加 ESLint 的上游源,请在你的仓库中运行以下程序:
3744

3845
```shell
3946
git remote add upstream [email protected]:eslint/eslint.git
@@ -69,9 +76,24 @@ npm test
6976

7077
## 参考信息
7178

79+
### 目录结构
80+
81+
ESLint 目录和文件结构如下所示:
82+
83+
* `bin` - 在安装 ESLint 后使用的课执行文件
84+
* `conf` - 默认配置信息
85+
* `docs` - 项目文档
86+
* `lib` - 包括源码
87+
* `formatters` - 定义格式化工具的所有源码
88+
* `rules` - 定义规则的所有源码
89+
* `tests` - 主要的单元测试文件夹
90+
* `lib` - 源码的测试
91+
* `formatters` - 格式化工具的测试
92+
* `rules` - 规则的测试
93+
7294
### 工作流程
7395

74-
在安装好开发环境后,你就可以对 ESLint 的源文件进行修改并提交。提交时需要认真遵守我们的 [pull-request 提交工作流程](./pull-requests)
96+
在安装好开发环境后,你就可以对 ESLint 的源文件进行修改并提交。提交时需要认真遵守我们的[拉取请求提交流程](./pull-requests)
7597

7698
### 构建脚本
7799

src/contribute/governance.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
title: 治理
33
eleventyNavigation:
44
key: governance
5-
parent: maintainer guide
5+
parent: contribute to eslint
66
title: 治理
7-
order: 4
8-
7+
order: 10
98
---
109

1110
ESLint 是一个依赖于社区贡献者的开源项目。每个人都可以随时提交代码、参与讨论、提交建议或其他合适的贡献。本文档讲述了 ESLint 项目中几种类型的贡献者。
@@ -37,7 +36,7 @@ ESLint 是一个依赖于社区贡献者的开源项目。每个人都可以随
3736
* 必须为所有修改提交拉取请求。
3837
* 审查者和 TSC 成员会对他们的工作进行审查,然后才会接受到版本库中。
3938
* 可以标记和关闭与网站有关的议题(见[议题管理](../maintain/manage-issues))。
40-
* 可以合并一些拉取请求(见[拉取请求管理](../maintain/review-pull-requests))。
39+
* 可以合并一些拉取请求(见[拉取请求审查](../maintain/review-pull-requests))。
4140

4241
要成为网站团队成员:
4342

@@ -59,8 +58,8 @@ ESLint 是一个依赖于社区贡献者的开源项目。每个人都可以随
5958
* 当他们不再需要时,应删除他们的公开分支
6059
* 必须为所有修改提交拉取请求
6160
* 在 TSC 成员审查后,再合并仓库中
62-
* 可以标记和关闭议题(见[管理议题](../maintain/manage-issues)
63-
* 可以合并一些拉取请求(见[管理拉取请求](../maintain/review-pull-requests)
61+
* 可以标记和关闭议题(见[议题管理](../maintain/manage-issues)
62+
* 可以合并一些拉取请求(见[拉取请求审查](../maintain/review-pull-requests)
6463

6564
要成为提交者:
6665

@@ -142,14 +141,14 @@ TSC 成员可以履行审查者的所有职责,并且还可以:
142141
#### 新增 TSC 成员流程
143142

144143
1. 将 GitHub 用户添加到 GitHub ESLint TSC 团队中。
145-
1. 将 GitHub 用户设置为 ESLint 组织的“owner”角色
146-
1. 发送一封欢迎邮件,并附上[维护者指南](./)的链接和 npm 2FA 的说明。
147-
1. 邀请加入 Discord TSC 频道
148-
1. 让 TSC 成员成为 ESLint 团队邮件列表中的管理员
149-
1. 将 TSC 成员添加到谷歌日历上经常性的 TSC 会议事件中。
150-
1. 在 Tweetdeck 上将 TSC 成员添加为 ESLint Twitter 账户管理员
151-
1. 将 TSC 成员添加到 ESLint TSC 邮件列表中,作为“owner”
152-
1. 用 ESLint Twitter 账户发推向新的 TSC 成员表示祝贺
144+
2. 将 GitHub 用户设置为 ESLint 组织的“owner”角色
145+
3. 发送一封欢迎邮件,并附上[维护 ESLint 文档](../maintain/))的链接和 npm 2FA 的说明。
146+
4. 邀请加入 Discord TSC 频道
147+
5. 让 TSC 成员成为 ESLint 团队邮件列表中的管理员
148+
6. 将 TSC 成员添加到谷歌日历上经常性的 TSC 会议事件中。
149+
7. 在 Tweetdeck 上将 TSC 成员添加为 ESLint Twitter 账户管理员
150+
8. 将 TSC 成员添加到 ESLint TSC 邮件列表中,作为“owner”
151+
9. 用 ESLint Twitter 账户发推向新的 TSC 成员表示祝贺
153152

154153
#### TSC 会议
155154

src/contribute/index.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
title: Contributing
2+
title: 向 ESLint 贡献
33
eleventyNavigation:
4-
key: contributing
5-
parent: developer guide
6-
title: Contributing
7-
order: 10
4+
key: contribute to eslint
5+
title: 向 ESLint 贡献
6+
order: 3
87

98
---
109

@@ -16,34 +15,50 @@ eleventyNavigation:
1615

1716
ESLint 欢迎每个人的贡献,并遵守 [OpenJS 基金会的行为准则](https://eslint.org/conduct)。我们恳请您在投稿前仔细阅读我们的行为准则。
1817

19-
## [错误报告](report-bugs)
18+
## [报告错误](report-bugs)
2019

2120
你认为你发现了一个问题?我们很乐意听到这个问题。本节解释了如何提交一个 bug,我们需要什么样的信息来正确验证它,以及整个过程。
2221

23-
## 提议[新规则](propose-new-rule)
22+
## [提议新规则](propose-new-rule)
2423

2524
我们在 ESLint 中收到很多关于新规则的提议。本节解释了我们如何确定哪些规则被接受,以及你应该提供哪些信息来帮助我们评估你的建议。
2625

27-
## 提议[规则修改](propose-rule-change)
26+
## [提议规则修改](propose-rule-change)
2827

2928
想对现有的规则进行修改?本节解释了这一过程以及我们如何评估此类提案。
3029

31-
## 请求[修改](request-change)
30+
## [请求修改](request-change)
3231

3332
如果你想请求一个除错误修复或新规则之外的变化,本节将解释这一过程。
3433

35-
## 报告安全漏洞
34+
## [架构](architecture)
3635

37-
要报告 ESLint 的安全漏洞,请使用我们的 [HackerOne 程序](https://hackerone.com/eslint)
36+
了解关于 ESLint 项目的架构。
37+
38+
## [设置开发环境](development-environment)
39+
40+
开发 ESLint 和将其在命令行中运行有所差异。此章节想你展示如何设置开发环境并做好写代码的准备。
41+
42+
## [运行测试](tests)
43+
44+
ESLint 包括了许多单元测试以确保我们可以保持高水准的代码质量。此章节解释了如何运行单元测试。
3845

3946
## [专注议题](work-on-issue)
4047

4148
有一些额外的时间并想做出贡献?本节讲述了在议题上工作的过程。
4249

43-
## 提交[拉取请求](pull-requests)
50+
## [提交拉取请求](pull-requests)
4451

4552
我们一直在寻找来自社区的贡献。本节解释了拉动请求的要求和贡献代码的过程。
4653

54+
## [治理](governance)
55+
56+
描述了 ESLint 的治理政策,包括个人在项目中的权利和特权。
57+
58+
## [报告安全漏洞](report-security-vulnerability)
59+
60+
要向 ESLint 报告安全漏洞,请在 GitHub 创建安全通告。
61+
4762
## 签署 CLA
4863

4964
为了向 ESLint 项目提交代码或文档,你需要以电子方式签署我们的贡献者许可协议。CLA 是常用的 Apache 风格的模板,它是你给我们使用你的贡献的许可。对于任何使用 EasyCLA 的 OpenJS 基金会项目,你只需要签署一次 CLA。在您打开的第一个拉动请求中,您将被要求签署 CLA。

src/contribute/propose-new-rule.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
2-
title: 新规则
3-
2+
title: 提议新规则
3+
eleventyNavigation:
4+
key: propose rule
5+
parent: contribute to eslint
6+
title: 提议新规则
7+
order: 2
48
---
59

610
ESLint 是关于规则的。在项目的大部分时间里,我们已经有了超过 200 条规则,而且这个名单还在继续增长。然而,我们不能只是接受任何提议的规则,因为所有的规则都需要凝聚在一起工作。因此,我们有一些指导原则,即哪些规则可以成为 ESLint 核心的一部分,哪些规则最好作为自定义规则和插件。
@@ -42,4 +46,4 @@ ESLint 团队不会实施用户建议的新规则,因为我们的人数有限
4246

4347
## 替代方案:创建你自己的规则
4448

45-
请记住,ESLint 是完全可扩展,这意味着你可以创建你自己的规则并使用插件发布。我们这样做是有目的的,因为我们不想成为所有可能的规则的看门人。即使我们不接受一个规则进入核心,这也不意味着你不能拥有你想要的确切规则。更多信息请参见[创建规则](../extend/custom-rules)[创建插件](../extend/plugins)文档。
49+
请记住,ESLint 是完全可扩展,这意味着你可以创建你自己的规则并使用插件发布。我们这样做是有目的的,因为我们不想成为所有可能的规则的看门人。即使我们不接受一个规则进入核心,这也不意味着你不能拥有你想要的确切规则。更多信息请参见[自定义规则](../extend/custom-rules)[创建插件](../extend/plugins)文档。

src/contribute/propose-rule-change.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
2-
title: Rule Changes
3-
2+
title: 提议规则修改
3+
eleventyNavigation:
4+
key: propose rule change
5+
parent: contribute to eslint
6+
title: 提议规则修改
7+
order: 3
48
---
59

610
有时需要修改 ESLint 核心规则。这不一定是一个错误,而是一个使规则更加可配置的增强。在这些情况下,我们会考虑对规则进行修改。

src/contribute/pull-requests.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
2-
title: 拉取请求
3-
2+
title: 提交拉取请求
3+
eleventyNavigation:
4+
key: submit pull request
5+
parent: contribute to eslint
6+
title: 提交拉取请求
7+
order: 9
48
---
59

610
如果你想为 ESLint 仓库做贡献,请使用 GitHub pull request。这是我们评估你的代码并将其合并到代码库的最快方式。请不要用代码片断来提交问题。这样做意味着我们需要手动合并这些变化,并更新任何适当的测试。这降低了你的代码被及时纳入的可能性。请使用拉动请求。

0 commit comments

Comments
 (0)