Skip to content

Commit 60950d8

Browse files
JinjiangJustineo
andauthored
Lint & typo (vuejs#1073)
* linted cookbook/serverless-blog.md * linted guide/migration.md * linted guide/list.md * linted guide/installation.md * linted cookbook/debugging-in-vscode.md * linted style-guild/index.md * linted guide/installation.md * linted api/index.md * Apply suggestions from code review Co-Authored-By: GU Yiling <[email protected]> Co-authored-by: GU Yiling <[email protected]>
1 parent 9c864ff commit 60950d8

File tree

5 files changed

+34
-29
lines changed

5 files changed

+34
-29
lines changed

src/v2/api/index.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ type: api
55

66
## 全局配置
77

8-
`Vue.config` 是一个对象,包含 Vue 的全局配置。可以在启动应用之前修改下列属性:
8+
`Vue.config` 是一个对象,包含 Vue 的全局配置。可以在启动应用之前修改下列属性:
99

1010
### silent
1111

@@ -45,7 +45,7 @@ type: api
4545

4646
合并策略选项分别接收在父实例和子实例上定义的该选项的值作为第一个和第二个参数,Vue 实例上下文被作为第三个参数传入。
4747

48-
- **参考** [自定义选项的混入策略](../guide/mixins.html#自定义选项混入策略)
48+
- **参考**[自定义选项的混入策略](../guide/mixins.html#自定义选项混入策略)
4949

5050
### devtools
5151

@@ -340,7 +340,7 @@ type: api
340340

341341
- **用法**
342342

343-
注册或获取全局组件。注册还会自动使用给定的`id`设置组件的名称
343+
注册或获取全局组件。注册还会自动使用给定的 `id` 设置组件的名称
344344

345345
``` js
346346
// 注册组件,传入一个扩展过的构造器
@@ -467,7 +467,7 @@ type: api
467467

468468
实例创建之后,可以通过 `vm.$data` 访问原始数据对象。Vue 实例也代理了 data 对象上所有的属性,因此访问 `vm.a` 等价于访问 `vm.$data.a`
469469

470-
`_``$` 开头的属性 **不会** 被 Vue 实例代理,因为它们可能和 Vue 内置的属性、API 方法冲突。你可以使用例如 `vm.$data._property` 的方式访问这些属性。
470+
`_``$` 开头的属性**不会**被 Vue 实例代理,因为它们可能和 Vue 内置的属性、API 方法冲突。你可以使用例如 `vm.$data._property` 的方式访问这些属性。
471471

472472
当一个**组件**被定义,`data` 必须声明为返回一个初始数据对象的函数,因为组件可能被用来创建多个实例。如果 `data` 仍然是一个纯粹的对象,则所有的实例将**共享引用**同一个数据对象!通过提供 `data` 函数,每次创建一个新实例后,我们能够调用 `data` 函数,从而返回初始数据的一个全新副本数据对象。
473473

@@ -510,12 +510,12 @@ type: api
510510
props 可以是数组或对象,用于接收来自父组件的数据。props 可以是简单的数组,或者使用对象作为替代,对象允许配置高级选项,如类型检测、自定义验证和设置默认值。
511511

512512
你可以基于对象的语法使用以下选项:
513-
- `type`: 可以是下列原生构造函数中的一种:`String``Number``Boolean``Array``Object``Date``Function``Symbol`、任何自定义构造函数、或上述内容组成的数组。会检查一个 prop 是否是给定的类型,否则抛出警告。Prop 类型的[更多信息在此](../guide/components-props.html#Prop-类型)
514-
- `default`: `any`
513+
- `type`可以是下列原生构造函数中的一种:`String``Number``Boolean``Array``Object``Date``Function``Symbol`、任何自定义构造函数、或上述内容组成的数组。会检查一个 prop 是否是给定的类型,否则抛出警告。Prop 类型的[更多信息在此](../guide/components-props.html#Prop-类型)
514+
- `default``any`
515515
为该 prop 指定一个默认值。如果该 prop 没有被传入,则换做用这个值。对象或数组的默认值必须从一个工厂函数返回。
516-
- `required`: `Boolean`
516+
- `required``Boolean`
517517
定义该 prop 是否是必填项。在非生产环境中,如果这个值为 truthy 且该 prop 没有被传入的,则一个控制台警告将会被抛出。
518-
- `validator`: `Function`
518+
- `validator``Function`
519519
自定义验证函数会将该 prop 的值作为唯一的参数代入。在非生产环境下,如果该函数返回一个 falsy 的值 (也就是验证失败),一个控制台警告将会被抛出。你可以在[这里](../guide/components-props.html#Prop-验证)查阅更多 prop 验证的相关信息。
520520

521521
- **示例**
@@ -734,7 +734,7 @@ type: api
734734

735735
- **详细**
736736

737-
一个字符串模板作为 Vue 实例的标识使用。模板将会 **替换** 挂载的元素。挂载元素的内容都将被忽略,除非模板的内容有分发插槽。
737+
一个字符串模板作为 Vue 实例的标识使用。模板将会**替换**挂载的元素。挂载元素的内容都将被忽略,除非模板的内容有分发插槽。
738738

739739
 如果值以 `#` 开始,则它将被用作选择符,并使用匹配元素的 innerHTML 作为模板。常用的技巧是用 `<script type="x-template">` 包含模板。
740740

@@ -829,7 +829,7 @@ type: api
829829

830830
- **详细**:
831831

832-
实例被挂载后调用,这时 `el` 被新创建的 `vm.$el` 替换了。 如果根实例挂载到了一个文档内的元素上,当`mounted`被调用时`vm.$el`也在文档内。
832+
实例被挂载后调用,这时 `el` 被新创建的 `vm.$el` 替换了。如果根实例挂载到了一个文档内的元素上,当 `mounted` 被调用时 `vm.$el` 也在文档内。
833833

834834
注意 `mounted` **不会**保证所有的子组件也都一起被挂载。如果你希望等到整个视图都渲染完毕,可以在 `mounted` 内部使用 [vm.$nextTick](#vm-nextTick):
835835

@@ -1033,7 +1033,7 @@ type: api
10331033
10341034
- **详细**:
10351035
1036-
允许声明扩展另一个组件(可以是一个简单的选项对象或构造函数),而无需使用 `Vue.extend`。这主要是为了便于扩展单文件组件。
1036+
允许声明扩展另一个组件 (可以是一个简单的选项对象或构造函数),而无需使用 `Vue.extend`。这主要是为了便于扩展单文件组件。
10371037
10381038
这和 `mixins` 类似。
10391039
@@ -1389,9 +1389,9 @@ type: api
13891389
13901390
- **详细**:
13911391
1392-
用来访问被[插槽分发](../guide/components.html#通过插槽分发内容)的内容。每个[具名插槽](../guide/components-slots.html#具名插槽) 有其相应的属性 (例如:`v-slot:foo` 中的内容将会在 `vm.$slots.foo` 中被找到)。`default` 属性包括了所有没有被包含在具名插槽中的节点,或 `v-slot:default` 的内容。
1392+
用来访问被[插槽分发](../guide/components.html#通过插槽分发内容)的内容。每个[具名插槽](../guide/components-slots.html#具名插槽)有其相应的属性 (例如:`v-slot:foo` 中的内容将会在 `vm.$slots.foo` 中被找到)。`default` 属性包括了所有没有被包含在具名插槽中的节点,或 `v-slot:default` 的内容。
13931393
1394-
**注意:** `v-slot:foo` 在 2.6 以上的版本才支持。对于之前的版本,你可以使用[废弃了的语法](../guide/components-slots.html#废弃了的语法).
1394+
**注意:**`v-slot:foo` 在 2.6 以上的版本才支持。对于之前的版本,你可以使用[废弃了的语法](../guide/components-slots.html#废弃了的语法)
13951395
13961396
在使用[渲染函数](../guide/render-function.html)书写一个组件时,访问 `vm.$slots` 最有帮助。
13971397
@@ -1559,7 +1559,7 @@ type: api
15591559
15601560
- **选项:deep**
15611561
1562-
为了发现对象内部值的变化,可以在选项参数中指定 `deep: true` 。注意监听数组的变动不需要这么做。
1562+
为了发现对象内部值的变化,可以在选项参数中指定 `deep: true`。注意监听数组的变动不需要这么做。
15631563
15641564
``` js
15651565
vm.$watch('someObject', callback, {
@@ -1646,7 +1646,7 @@ type: api
16461646
16471647
- **用法**:
16481648
1649-
监听当前实例上的自定义事件。事件可以由`vm.$emit`触发。回调函数会接收所有传入事件触发函数的额外参数。
1649+
监听当前实例上的自定义事件。事件可以由 `vm.$emit` 触发。回调函数会接收所有传入事件触发函数的额外参数。
16501650
16511651
- **示例**:
16521652
@@ -1922,7 +1922,7 @@ type: api
19221922
19231923
- **详细**:
19241924
1925-
更新元素的 `textContent`。如果要更新部分的 `textContent` ,需要使用 `{% raw %}{{ Mustache }}{% endraw %}` 插值。
1925+
更新元素的 `textContent`。如果要更新部分的 `textContent`,需要使用 `{% raw %}{{ Mustache }}{% endraw %}` 插值。
19261926
19271927
- **示例**:
19281928
@@ -1940,7 +1940,7 @@ type: api
19401940
19411941
- **详细**:
19421942
1943-
更新元素的 `innerHTML` 。**注意:内容按普通 HTML 插入 - 不会作为 Vue 模板进行编译** 。如果试图使用 `v-html` 组合模板,可以重新考虑是否通过使用组件来替代。
1943+
更新元素的 `innerHTML`。**注意:内容按普通 HTML 插入 - 不会作为 Vue 模板进行编译**。如果试图使用 `v-html` 组合模板,可以重新考虑是否通过使用组件来替代。
19441944
19451945
<p class="tip">在网站上动态渲染任意 HTML 是非常危险的,因为容易导致 [XSS 攻击](https://en.wikipedia.org/wiki/Cross-site_scripting)。只在可信内容上使用 `v-html`,**永不**用在用户提交的内容上。</p>
19461946
@@ -1972,7 +1972,7 @@ type: api
19721972
19731973
- **用法**:
19741974
1975-
根据表达式的值的 [truthiness](https://developer.mozilla.org/zh-CN/docs/Glossary/Truthy) 来有条件地渲染元素。在切换时元素及它的数据绑定 / 组件被销毁并重建。如果元素是 `<template>` ,将提出它的内容作为条件块。
1975+
根据表达式的值的 [truthiness](https://developer.mozilla.org/zh-CN/docs/Glossary/Truthy) 来有条件地渲染元素。在切换时元素及它的数据绑定 / 组件被销毁并重建。如果元素是 `<template>`,将提出它的内容作为条件块。
19761976
19771977
当条件变化时该指令触发过渡效果。
19781978
@@ -2011,7 +2011,7 @@ type: api
20112011
20122012
- **用法**:
20132013
2014-
表示 `v-if` 的 "else if 块"。可以链式调用。
2014+
表示 `v-if` 的else if 块。可以链式调用。
20152015
20162016
```html
20172017
<div v-if="type === 'A'">
@@ -2036,7 +2036,7 @@ type: api
20362036
20372037
- **用法**:
20382038
2039-
基于源数据多次渲染元素或模板块。此指令之值,必须使用特定语法 `alias in expression` ,为当前遍历的元素提供别名:
2039+
基于源数据多次渲染元素或模板块。此指令之值,必须使用特定语法 `alias in expression`,为当前遍历的元素提供别名:
20402040
20412041
``` html
20422042
<div v-for="item in items">
@@ -2170,7 +2170,7 @@ type: api
21702170
21712171
- **修饰符**:
21722172
- `.prop` - 作为一个 DOM property 绑定而不是作为 attribute 绑定。([差别在哪里?](https://stackoverflow.com/questions/6003819/properties-and-attributes-in-html#answer-6004028))
2173-
- `.camel` - (2.1.0+) 将 kebab-case attribute 名转换为 camelCase. (从 2.1.0 开始支持)
2173+
- `.camel` - (2.1.0+) 将 kebab-case attribute 名转换为 camelCase(从 2.1.0 开始支持)
21742174
- `.sync` (2.3.0+) 语法糖,会扩展成一个更新父组件绑定值的 `v-on` 侦听器。
21752175
21762176
- **用法**:
@@ -2518,7 +2518,7 @@ type: api
25182518
### transition
25192519
25202520
- **Props**:
2521-
- `name` - string,用于自动生成 CSS 过渡类名。例如:`name: 'fade'` 将自动拓展为`.fade-enter`,`.fade-enter-active`等。默认类名为 `"v"`
2521+
- `name` - string,用于自动生成 CSS 过渡类名。例如:`name: 'fade'` 将自动拓展为 `.fade-enter`,`.fade-enter-active` 等。默认类名为 `"v"`
25222522
- `appear` - boolean,是否在初始渲染时使用过渡。默认为 `false`。
25232523
- `css` - boolean,是否使用 CSS 过渡类。默认为 `true`。如果设置为 `false`,将只通过组件事件触发注册的 JavaScript 钩子。
25242524
- `type` - string,指定过渡事件类型,侦听过渡何时结束。有效值为 `"transition"` 和 `"animation"`。默认 Vue.js 将自动检测出持续时间长的为过渡事件类型。
@@ -2599,9 +2599,9 @@ type: api
25992599
26002600
`<transition-group>` 元素作为多个元素/组件的过渡效果。`<transition-group>` 渲染一个真实的 DOM 元素。默认渲染 `<span>`,可以通过 `tag` 属性配置哪个元素应该被渲染。
26012601
2602-
注意,每个 `<transition-group>` 的子节点必须有 **独立的 key** ,动画才能正常工作
2602+
注意,每个 `<transition-group>` 的子节点必须有**独立的 key**,动画才能正常工作
26032603
2604-
`<transition-group>` 支持通过 CSS transform 过渡移动。当一个子节点被更新,从屏幕上的位置发生变化,它会被应用一个移动中的 CSS 类 (通过 `name` 属性或配置 `move-class` 属性自动生成)。如果 CSS `transform` 属性是“可过渡”属性,当应用移动类时,将会使用 [FLIP 技术](https://aerotwist.com/blog/flip-your-animations/) 使元素流畅地到达动画终点。
2604+
`<transition-group>` 支持通过 CSS transform 过渡移动。当一个子节点被更新,从屏幕上的位置发生变化,它会被应用一个移动中的 CSS 类 (通过 `name` 属性或配置 `move-class` 属性自动生成)。如果 CSS `transform` 属性是“可过渡”属性,当应用移动类时,将会使用 [FLIP 技术](https://aerotwist.com/blog/flip-your-animations/)使元素流畅地到达动画终点。
26052605
26062606
```html
26072607
<transition-group tag="ul" name="slide">
@@ -2713,3 +2713,6 @@ type: api
27132713
## 服务端渲染
27142714
27152715
- 请参考 [vue-server-renderer package documentation](https://github.com/vuejs/vue/tree/dev/packages/vue-server-renderer)。
2716+
2717+
<!-- zhlint ignore: { `enter`: number, `leave`: number } -->
2718+
<!-- zhlint ignore: ( , ) -->

src/v2/cookbook/debugging-in-vscode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ module.exports = {
9191
npm run serve
9292
```
9393

94-
3. 来到 Debug 视图,选择**vuejs:chrome/firefox**配置,然后按 <kbd>F5</kbd> 或点击那个绿色的 play 按钮。
94+
3. 来到 Debug 视图,选择**vuejs:chrome/firefox**配置,然后按 <kbd>F5</kbd> 或点击那个绿色的 play 按钮。
9595

9696
4. 随着一个新的浏览器实例打开 `http://localhost:8080`,你的断点现在应该被命中了。
9797

src/v2/guide/installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,3 +285,5 @@ $ bower install vue
285285
**译者注**
286286
<a id="footnote-1"></a>[1] 对于中国大陆用户,建议将 NPM 源设置为[国内的镜像](https://npm.taobao.org/),可以大幅提升安装速度。
287287
</small>
288+
289+
<!-- zhlint ignore: min+gzip -->

src/v2/guide/migration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -564,7 +564,7 @@ data: {
564564
}
565565
```
566566

567-
将渲染 model 为bar而不是foo。同样,对 `<textarea>` 已有的值来说:
567+
将渲染 model 为bar而不是foo。同样,对 `<textarea>` 已有的值来说:
568568

569569
``` html
570570
<textarea v-model="text">
@@ -688,7 +688,7 @@ strings.map(function (str) {
688688
显要的改变有如下几点:
689689

690690
- 指令不再拥有实例。意思是,在指令的钩子函数中不再拥有实例的 `this`。替代的是,你可以在参数中接受你需要的任何数据。如果确实需要,可以通过 `el` 来访问实例。
691-
- 类似 `acceptStatement``deep``priority` 等都已被弃用。为了替换 `双向` 指令,见[示例](#双向过滤器-替换)
691+
- 类似 `acceptStatement``deep``priority` 等都已被弃用。为了替换“双向”指令,见[示例](#双向过滤器-替换)
692692
- 现在有些钩子的意义和以前不一样了,并且多了两个钩子函数。
693693

694694
幸运的是,新钩子更加简单,更加容易掌握。详见[自定义指令指南](custom-directive.html)
@@ -1051,7 +1051,7 @@ text.toLowerCase()
10511051

10521052
#### 替换 `pluralize` 过滤器
10531053

1054-
NPM 上的 [pluralize](https://www.npmjs.com/package/pluralize) 库可以很好的实现这个功能。如果仅仅想将特定的词格式化成复数形式或者想给特定的值 (‘0’) 指定特定的输出,也可以很容易地自定义复数格式化过滤器:
1054+
npm 上的 [pluralize](https://www.npmjs.com/package/pluralize) 库可以很好的实现这个功能。如果仅仅想将特定的词格式化成复数形式或者想给特定的值 (`0`) 指定特定的输出,也可以很容易地自定义复数格式化过滤器:
10551055

10561056
``` js
10571057
function pluralizeKnife (count) {

src/v2/style-guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ data: function () {
319319

320320
- 为了过滤一个列表中的项目 (比如 `v-for="user in users" v-if="user.isActive"`)。在这种情形下,请将 `users` 替换为一个计算属性 (比如 `activeUsers`),让其返回过滤后的列表。
321321

322-
- 为了避免渲染本应该被隐藏的列表 (比如 `v-for="user in users" v-if="shouldShowUsers"`)。这种情形下,请将 `v-if` 移动至容器元素上 (比如 `ul``ol`)。
322+
- 为了避免渲染本应该被隐藏的列表 (比如 `v-for="user in users" v-if="shouldShowUsers"`)。这种情形下,请将 `v-if` 移动至容器元素上 (比如 `ul``ol`)。
323323

324324
{% raw %}
325325
<details>

0 commit comments

Comments
 (0)