Skip to content

Commit

Permalink
feat: sync v8.33.0 (#99)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
kecrily and mdjermanovic committed May 30, 2023
1 parent c7b77c7 commit c1f5d0b
Show file tree
Hide file tree
Showing 51 changed files with 685 additions and 414 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ library.json
pages.11tydata.json
static
html-formatter-example.html
html-formatter-example.json
src.json
/package.json
/package-lock.json
.stylelintrc.json
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Simplified Chinese website
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))
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))

## Contribute

Expand Down
8 changes: 5 additions & 3 deletions src/contribute/architecture/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
title: 架构
eleventyNavigation:
key: architecture
parent: developer guide
parent: contribute to eslint
title: 架构
order: 1
order: 5
---

<center><img alt="dependency graph" src="../../assets/images/architecture/dependency.svg"></center>
:::img-container
<img alt="dependency graph" src="../../assets/images/architecture/dependency.svg">
:::

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

Expand Down
10 changes: 10 additions & 0 deletions src/contribute/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 行为准则
eleventyNavigation:
key: code of conduct
parent: contribute to eslint
title: 行为准则
order: 0
---

ESLint 欢迎所有遵守 [OpenJS 基金会行为准则](https://eslint.org/conduct)的贡献。我们恳请您在贡献之前仔细阅读此行为准则。
38 changes: 30 additions & 8 deletions src/contribute/development-environment.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
title: 开发环境
title: 设置开发环境
eleventyNavigation:
key: set up a development environment
parent: developer guide
parent: contribute to eslint
title: 设置开发环境
order: 2

order: 6
---

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

## 第一步:安装 Node.js

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

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

克隆自己的分叉:

```shell
git clone https://github.com/<你的 Github 用户名>/eslint
```

在克隆仓库后,需要运行 `npm install` 以获得所有必要的依赖。

```shell
Expand All @@ -29,11 +34,13 @@ npm install

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

**注意**:每次从主仓库拉取代码后都重新运行 `npm install` 有助于确保使用最新的开发依赖。

## 第三步:添加上游源码

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

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

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

## 参考信息

### 目录结构

ESLint 目录和文件结构如下所示:

* `bin` - 在安装 ESLint 后使用的课执行文件
* `conf` - 默认配置信息
* `docs` - 项目文档
* `lib` - 包括源码
* `formatters` - 定义格式化工具的所有源码
* `rules` - 定义规则的所有源码
* `tests` - 主要的单元测试文件夹
* `lib` - 源码的测试
* `formatters` - 格式化工具的测试
* `rules` - 规则的测试

### 工作流程

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

### 构建脚本

Expand Down
27 changes: 13 additions & 14 deletions src/contribute/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: 治理
eleventyNavigation:
key: governance
parent: maintainer guide
parent: contribute to eslint
title: 治理
order: 4

order: 10
---

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

要成为网站团队成员:

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

要成为提交者:

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

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

#### TSC 会议

Expand Down
39 changes: 27 additions & 12 deletions src/contribute/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
title: Contributing
title: 向 ESLint 贡献
eleventyNavigation:
key: contributing
parent: developer guide
title: Contributing
order: 10
key: contribute to eslint
title: 向 ESLint 贡献
order: 3

---

Expand All @@ -16,34 +15,50 @@ eleventyNavigation:

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

## [错误报告](report-bugs)
## [报告错误](report-bugs)

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

## 提议[新规则](propose-new-rule)
## [提议新规则](propose-new-rule)

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

## 提议[规则修改](propose-rule-change)
## [提议规则修改](propose-rule-change)

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

## 请求[修改](request-change)
## [请求修改](request-change)

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

## 报告安全漏洞
## [架构](architecture)

要报告 ESLint 的安全漏洞,请使用我们的 [HackerOne 程序](https://hackerone.com/eslint)
了解关于 ESLint 项目的架构。

## [设置开发环境](development-environment)

开发 ESLint 和将其在命令行中运行有所差异。此章节想你展示如何设置开发环境并做好写代码的准备。

## [运行测试](tests)

ESLint 包括了许多单元测试以确保我们可以保持高水准的代码质量。此章节解释了如何运行单元测试。

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

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

## 提交[拉取请求](pull-requests)
## [提交拉取请求](pull-requests)

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

## [治理](governance)

描述了 ESLint 的治理政策,包括个人在项目中的权利和特权。

## [报告安全漏洞](report-security-vulnerability)

要向 ESLint 报告安全漏洞,请在 GitHub 创建安全通告。

## 签署 CLA

为了向 ESLint 项目提交代码或文档,你需要以电子方式签署我们的贡献者许可协议。CLA 是常用的 Apache 风格的模板,它是你给我们使用你的贡献的许可。对于任何使用 EasyCLA 的 OpenJS 基金会项目,你只需要签署一次 CLA。在您打开的第一个拉动请求中,您将被要求签署 CLA。
10 changes: 7 additions & 3 deletions src/contribute/propose-new-rule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: 新规则

title: 提议新规则
eleventyNavigation:
key: propose rule
parent: contribute to eslint
title: 提议新规则
order: 2
---

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

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

请记住,ESLint 是完全可扩展,这意味着你可以创建你自己的规则并使用插件发布。我们这样做是有目的的,因为我们不想成为所有可能的规则的看门人。即使我们不接受一个规则进入核心,这也不意味着你不能拥有你想要的确切规则。更多信息请参见[创建规则](../extend/custom-rules)[创建插件](../extend/plugins)文档。
请记住,ESLint 是完全可扩展,这意味着你可以创建你自己的规则并使用插件发布。我们这样做是有目的的,因为我们不想成为所有可能的规则的看门人。即使我们不接受一个规则进入核心,这也不意味着你不能拥有你想要的确切规则。更多信息请参见[自定义规则](../extend/custom-rules)[创建插件](../extend/plugins)文档。
8 changes: 6 additions & 2 deletions src/contribute/propose-rule-change.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: Rule Changes

title: 提议规则修改
eleventyNavigation:
key: propose rule change
parent: contribute to eslint
title: 提议规则修改
order: 3
---

有时需要修改 ESLint 核心规则。这不一定是一个错误,而是一个使规则更加可配置的增强。在这些情况下,我们会考虑对规则进行修改。
Expand Down
8 changes: 6 additions & 2 deletions src/contribute/pull-requests.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: 拉取请求

title: 提交拉取请求
eleventyNavigation:
key: submit pull request
parent: contribute to eslint
title: 提交拉取请求
order: 9
---

如果你想为 ESLint 仓库做贡献,请使用 GitHub pull request。这是我们评估你的代码并将其合并到代码库的最快方式。请不要用代码片断来提交问题。这样做意味着我们需要手动合并这些变化,并更新任何适当的测试。这降低了你的代码被及时纳入的可能性。请使用拉动请求。
Expand Down
8 changes: 6 additions & 2 deletions src/contribute/report-bugs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: Reporting Bugs

title: 报告漏洞
eleventyNavigation:
key: report bugs
parent: contribute to eslint
title: 报告漏洞
order: 1
---

如果你认为你发现了 ESLint 中的漏洞,请在 GitHub 上[创建新议题](https://github.com/eslint/eslint/issues/new/choose)[拉动请求](pull-requests)
Expand Down
10 changes: 10 additions & 0 deletions src/contribute/report-security-vulnerability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 报告安全漏洞
eleventyNavigation:
key: report security vulnerability
parent: contribute to eslint
title: 报告安全漏洞
order: 11
---

要报告 ESLint 中的安全漏洞,请使用我们在 GitHub 的[创建建议表单](https://github.com/eslint/eslint/security/advisories/new)
14 changes: 9 additions & 5 deletions src/contribute/request-change.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: 修改请求

title: 请求修改
eleventyNavigation:
key: request change
parent: contribute to eslint
title: 请求修改
order: 4
---

如果你想请求对 ESLint 进行修改,请在 GitHub 上 [创建新议题](https://github.com/eslint/eslint/issues/new/choose)。请务必包括以下信息:

1. 你所使用的 ESLint 的版本。
1. 你想解决的问题。
1. 你对问题的正确解决方案的看法。
2. 你想解决的问题。
3. 你对问题的正确解决方案的看法。

如果你要求改变一个规则,包括这些信息也很有帮助:

Expand All @@ -17,4 +21,4 @@ title: 修改请求

请包括尽可能多的细节,以帮助我们正确解决你的问题。如果我们需要对问题进行分流,并不断要求人们提供更多的细节,这就占用了实际解决问题的时间。通过在你的问题中包含大量的细节,帮助我们尽可能地提高工作效率。

**注意**:如果你只是有一个不一定会导致 ESLint 改变的问题,比如问某个东西如何工作或如何贡献,请使用[邮件列表](https://groups.google.com/group/eslint或[聊天](https://eslint.org/chat)而不是提交问题
**注意**:如果你只是有一个不一定会导致 ESLint 改变的问题,比如问某个东西如何工作或如何贡献,请使用[邮件列表](https://groups.google.com/group/eslint)[聊天](https://eslint.org/chat)而不是提交议题
52 changes: 0 additions & 52 deletions src/contribute/source-code.md

This file was deleted.

0 comments on commit c1f5d0b

Please sign in to comment.