Skip to content

Commit 7fa582b

Browse files
dcloud-wandldcloud-wandl
committed
调整 翻译及修改.editorconfig.md
1 parent 60d53b3 commit 7fa582b

File tree

5 files changed

+63
-52
lines changed

5 files changed

+63
-52
lines changed

‎en/Tutorial/UserGuide/editorconfig.md‎

Lines changed: 59 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
> HBuilderX 2.0.3+起支持
1+
# EditorConfig
22

3-
## editorconfig是什么？
3+
> Supported from HBuilderX 2.0.3+
44
5-
很多公司都要求各开发成员使用相同的编码风格，比如缩进是空格还是tab。
5+
## What is EditorConfig?
66

7-
`editorconfig`是一套解决这个问题的业内通用规范，通过在项目下存放配置文件`.editorconfig`，并在这个配置文件中描述规则，然后把这个配置文件和其他代码一起提交git/svn，所有项目成员，都会遵循相同的编码规范。
7+
EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.
88

9-
`HBuilderX`直接支持该规范，无需下载插件，开箱即用。sublime、vscode支持该规范的话需要先下载插件。
9+
The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles.
1010

11-
`editorconfig`的官网是[https://editorconfig.org/](https://editorconfig.org/)
12-
`editorconfig`可以帮助开发者在不同的编辑器和IDE之间定义和维护一致的代码风格。
13-
`editorconfig`包含一个用于定义代码格式的文件和一批编辑器插件，这些插件可以让编辑器读取配置文件并依此格式化代码。
14-
`editorconfig`的配置文件十分易读，并且可以在各个操作系统、编辑器下工作。
11+
EditorConfig files are easily readable and they work nicely with version control systems.
1512

16-
## editorconfig的配置文件是怎样的？
13+
The official website of `editorconfig` is [https://editorconfig.org/](https://editorconfig.org/)
1714

18-
以下是一个用于设置Python和JavaScript行尾和缩进风格的配置文件。
15+
## HBuilderX EditorConfig
16+
17+
`HBuilderX` directly supports this specification, no need to download plug-ins, it can be used out of the box. If sublime and vscode support this specification, you need to download the plug-in first.
18+
19+
## What's an EditorConfig file look like?
20+
21+
Below is an example .editorconfig file setting end-of-line and indentation styles for Python and JavaScript files.
1922

2023
```
2124
# EditorConfig is awesome: http://EditorConfig.org
@@ -48,11 +51,11 @@ indent_style = space
4851
indent_size = 2
4952
```
5053

51-
## 案例
54+
## Case
5255

53-
很多开源项目都用到了`editorconfig`
56+
Many open source projects use `editorconfig`
5457

55-
比如[jQuery](https://github.com/jquery/jquery/blob/master/.editorconfig), `jQuery`在`Github`上的`.editorconfig`配置文件如下：
58+
For example[jQuery](https://github.com/jquery/jquery/blob/master/.editorconfig), `jQuery` `.editorconfig` configuration file on `Github`
5659

5760
```ini
5861
root = true
@@ -69,55 +72,63 @@ indent_style = space
6972
indent_size = 2
7073
```
7174

72-
如上，可以看到，JQuery配置了：编码格式、缩进风格等
75+
As in the above example, JQuery is configured: encoding format, indentation style, etc.
76+
7377

78+
## Where are these files stored?
7479

75-
## 在哪里存放配置文件
76-
当打开一个文件时，`editorconfig`插件会在打开文件的目录和其每一级父目录查找.`editorconfig`文件，直到有一个配置文件`root=true`。
80+
When opening a file, EditorConfig plugins look for a file named `.editorconfig` in the directory of the opened file and in every parent directory. A search for .editorconfig files will stop if the root filepath is reached or an EditorConfig file with `root=true` is found.
7781

78-
如果一个工程中出现多个配置文件，EditorConfig配置文件的读取层级是自上而下的，最深层的配置文件，最后读取。配置规则也是 按照读取的顺序来生效，所以路径上离代码最近的配置规则，优先级最高。
82+
EditorConfig files are read top to bottom and the most recent rules found take precedence. Properties from matching EditorConfig sections are applied in the order they were read, so properties in closer files take precedence.
7983

8084
相对于其他开发工具（如vscode），HBuilderX对editorconfig更完善。在其他工具中，项目外层如果有editorconfig文件，也会影响这个项目，经常让人莫名其妙。HBuilderX没有这个bug。
8185

8286

83-
## 文件格式详情
84-
`editorconfig`文件使用INI格式（译注：请参考维基百科），目的是可以与Python ConfigParser Library兼容，但是允许在分段名（译注：原文是section names）中使用“and”。
85-
分段名是全局的文件路径，格式类似于`gitignore`。斜杠`/`作为路径分隔符，`#`或者`;`作为注释。注释应该单独占一行。`editorconfig`文件使用`UTF-8`格式、`CRLF`或`LF`作为换行符。
87+
## File Format Details
88+
89+
EditorConfig files use an `INI` format that is compatible with the format used by Python ConfigParser Library, but [ and ] are allowed in the section names.
90+
91+
The section names are filepath globs (case sensitive), similar to the format accepted by gitignore. Only forward slashes (`/`, not backslashes) are used as path separators and octothorpes (`#`) or semicolons (`;`) are used for comments.
92+
93+
Comments should go on their own lines. EditorConfig files should be `UTF-8` encoded, with either `CRLF` or `LF` line separators.
94+
95+
### Wildcard Patterns
8696

87-
### 通配符
88-
| 通配符 | 说明 |
89-
| ---------- | ------------------------------------ |
90-
| * | 匹配除/之外的任意字符串 |
91-
| ** | 匹配任意字符串 |
92-
| ？ | 匹配任意单个字符 |
93-
| [name] | 匹配name字符 |
94-
| [!name] | 匹配非name字符 |
95-
| {s1,s3,s3} | 匹配任意给定的字符串（0.11.0起支持） |
97+
| Wildcard Patterns | Description |
98+
| ---------- | ------------------------------------ |
99+
| * | Matches any string of characters, except path separators (/) |
100+
| ** | Matches any string of characters |
101+
| ？ | Matches any single character |
102+
| [name] | Matches any single character in name |
103+
| [!name] | Matches any single character not in name |
104+
| {s1,s3,s3} | Matches any of the strings given (separated by commas) (Available since EditorConfig Core 0.11.0) |
105+
|{num1..num2} |Matches any integer numbers between num1 and num2, where num1 and num2 can be either positive or negative|
96106

97-
特殊字符可以用`\`转义，以使其不被认为是通配符。
107+
**Notes:** Special characters can be escaped with a backslash so they won't be interpreted as wildcard patterns.
98108

99-
### 支持的属性
109+
### Supported Properties
100110

101-
| 属性说明 | 说明 |
102-
| ------------------------ | ------------------------------------------------------------ |
103-
| indent_style | tab为hard-tabs，space为soft-tabs |
104-
| indent_size | 设置整数表示规定每级缩进的列数和soft-tabs的宽度（译注：空格数）。如果设定为tab，则会使用tab_width的值（如果已指定） |
105-
| tab_width | 设置整数用于指定替代tab的列数。默认值就是indent_size的值，一般无需指定。 |
106-
| end_of_line | 定义换行符，支持lf、cr和crlf。 |
107-
| trim_trailing_whitespace | 设为true表示会除去换行行首的任意空白字符，false反之 |
108-
| insert_final_newline | 设为true表明使文件以一个空白行结尾，false反之 |
109-
| root | 表明是最顶层的配置文件，发现设为true时，才会停止查找.`editorconfig`文件。 |
111+
| Properties | Description |
112+
| ------------------------| ------------------------------------------------------------ |
113+
| indent_style | set to tab or space to use hard tabs or soft tabs respectively. |
114+
| indent_size | a whole number defining the number of columns used for each indentation level and the width of soft tabs (when supported). When set to tab, the value of tab_width (if specified) will be used. |
115+
| tab_width | a whole number defining the number of columns used to represent a tab character. This defaults to the value of indent_size and doesn't usually need to be specified. |
116+
| end_of_line | set to lf, cr, or crlf to control how line breaks are represented. |
117+
|charset |set to latin1, utf-8, utf-8-bom, utf-16be or utf-16le to control the character set. |
118+
| trim_trailing_whitespace| set to true to remove any whitespace characters preceding newline characters and false to ensure it doesn't. |
119+
| insert_final_newline | set to true to ensure file ends with a newline when saving and false to ensure it doesn't. |
120+
| root | special property that should be specified at the top of the file outside of any sections. Set to true to stop .editorconfig files search on current file. |
110121

111-
### 注意
122+
### Notes
112123

113-
1. 在HBuilderX内， 所有的属性名和属性值对`大小写敏感`。通常，如果没有明确指定某个属性，则会使用编辑器的配置，而`editorconfig`不会处理。
114-
2. 推荐不要指定某些`editorconfig`属性。比如，tab_width不需要特别指定，除非它与`indent_size`不同。同样的，当`indent_style`设为`tab`时，不需要配置`indent_size`，这样才方便阅读者使用他们习惯的缩进格式。另外，如果某些属性并没有规范化（比如`end_of_line`），就最好不要设置它。
115-
3. 如果你不需要editorconfig的功能，可以在工具-设置中关闭这个功能。
124+
1. Currently all properties and values are case-insensitive. They are lowercased when parsed. Generally, if a property is not specified, the editor settings will be used, i.e. EditorConfig takes no effect on that part.
125+
2. It is acceptable and often preferred to leave certain EditorConfig properties unspecified. For example, tab_width need not be specified unless it differs from the value of `indent_size`. Also, when indent_style is set to tab, it may be desirable to leave `indent_size` unspecified so readers may view the file using their preferred indentation width. Additionally, if a property is not standardized in your project (`end_of_line` for example), it may be best to leave it blank.
126+
3. If you don't need the function of editorconfig, you can turn off this function in [Settings].
116127

117-
## 启用或关闭editorconfig配置
128+
## HBuilderX editorconfig configuration
118129

119-
在【设置】中，有个editorconfig开关，您可以自由选择开启与关闭`.editorconfig`
130+
In HBuilderX [Settings], there is an editorconfig switch, you can freely choose to turn on or off `.editorconfig`
120131

121-
<img src="/static/snapshots/tutorial/editorconfig.png" />
132+
<img src="/static/snapshots/tutorial/settings/editorconfig_en.png" style="zoom: 45%;border: 1px solid #eee; border-radius: 10px;" />
122133

123134

‎static/snapshots/tutorial/editorconfig.png‎ renamed to ‎static/snapshots/tutorial/settings/editorconfig.png‎

File renamed without changes.

‎static/snapshots/tutorial/settings/editorconfig_en.png‎

24 KB
Loading

‎zh-cn/Tutorial/UserGuide/editorconfig.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,14 @@ indent_size = 2
110110

111111
### 注意
112112

113-
1. 在HBuilderX内， 所有的属性名和属性值对`大小写敏感`。通常，如果没有明确指定某个属性，则会使用编辑器的配置，而`editorconfig`不会处理。
113+
1. 所有的属性名和属性值对`大小写不敏感`。通常，如果没有明确指定某个属性，则会使用编辑器的配置，而`editorconfig`不会处理。
114114
2. 推荐不要指定某些`editorconfig`属性。比如，tab_width不需要特别指定，除非它与`indent_size`不同。同样的，当`indent_style`设为`tab`时，不需要配置`indent_size`，这样才方便阅读者使用他们习惯的缩进格式。另外，如果某些属性并没有规范化（比如`end_of_line`），就最好不要设置它。
115115
3. 如果你不需要editorconfig的功能，可以在工具-设置中关闭这个功能。
116116

117117
## 启用或关闭editorconfig配置
118118

119119
在【设置】中，有个editorconfig开关，您可以自由选择开启与关闭`.editorconfig`
120120

121-
<img src="/static/snapshots/tutorial/editorconfig.png" />
121+
<img src="/static/snapshots/tutorial/settings/editorconfig.png" />
122122

123123

‎zh-hant/Tutorial/UserGuide/editorconfig.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,14 @@ indent_size = 2
110110

111111
### 注意
112112

113-
1. 在HBuilderX內， 所有的屬性名和屬性值對`大小寫敏感`。通常，如果沒有明確指定某個屬性，則會使用編輯器的配置，而`editorconfig`不會處理。
113+
1. 所有的屬性名和屬性值對`大小寫不敏感`。通常，如果沒有明確指定某個屬性，則會使用編輯器的配置，而`editorconfig`不會處理。
114114
2. 推薦不要指定某些`editorconfig`屬性。比如，tab_width不需要特別指定，除非它與`indent_size`不同。同樣的，當`indent_style`設爲`tab`時，不需要配置`indent_size`，這樣才方便閱讀者使用他們習慣的縮進格式。另外，如果某些屬性並沒有規範化（比如`end_of_line`），就最好不要設置它。
115115
3. 如果你不需要editorconfig的功能，可以在工具-設置中關閉這個功能。
116116

117117
## 啓用或關閉editorconfig配置
118118

119119
在【設置】中，有個editorconfig開關，您可以自由選擇開啓與關閉`.editorconfig`
120120

121-
<img src="/static/snapshots/tutorial/editorconfig.png" />
121+
<img src="/static/snapshots/tutorial/settings/editorconfig.png" />
122122

123123

0 commit comments

Comments
 (0)