Skip to content

Commit 6c64a09

Browse files
README Corrections (#1709)
* correct spelling errors, link SFC text, singular AST, remove definite article * sfc grammar revisions * Update README.md Co-authored-by: Flo Edelmann <[email protected]> Co-authored-by: Flo Edelmann <[email protected]>
1 parent 5c0cd71 commit 6c64a09

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
1010
## :book: Documentation
1111

12-
Please refer to [official website](https://eslint.vuejs.org).
12+
Please refer to the [official website](https://eslint.vuejs.org).
1313

1414
## :anchor: Versioning Policy
1515

@@ -27,13 +27,13 @@ Contributing is welcome! See the [ESLint Vue Plugin Developer Guide](https://esl
2727

2828
Be sure to read the [official ESLint guide](https://eslint.org/docs/developer-guide/working-with-rules) before you start writing a new rule.
2929

30-
To see what an abtract syntax tree (AST) of your code looks like, you may use [AST Explorer](https://astexplorer.net). After opening [AST Explorer](https://astexplorer.net), select `Vue` as the syntax and `vue-eslint-parser` as the parser.
30+
To see what an abstract syntax tree (AST) of your code looks like, you may use [AST Explorer](https://astexplorer.net). After opening [AST Explorer](https://astexplorer.net), select `Vue` as the syntax and `vue-eslint-parser` as the parser.
3131

32-
The default parser must be replaced since Vue's single file components are not plain JavaScript. `vue-eslint-parser` is a replacement parser that generates an enhanced AST with nodes that represent specific parts of the template syntax, as well as the contents of the `<script>` tag.
32+
The default JavaScript parser must be replaced because [Vue.js single file components](https://v3.vuejs.org/guide/single-file-component.html#single-file-components) are not plain JavaScript, but a custom file format. [`vue-eslint-parser`](https://github.com/vuejs/vue-eslint-parser) is a replacement parser that generates an enhanced AST with nodes that represent specific parts of the template syntax, as well as the contents of the `<script>` tag.
3333

34-
To learn more about certain nodes in the produced ASTs, see the [ESTree project page](https://github.com/estree/estree) and the [vue-eslint-parser AST documentation](https://github.com/vuejs/vue-eslint-parser/blob/master/docs/ast.md).
34+
To learn more about certain nodes in a produced AST, see the [ESTree project page](https://github.com/estree/estree) and the [vue-eslint-parser AST documentation](https://github.com/vuejs/vue-eslint-parser/blob/master/docs/ast.md).
3535

36-
The `vue-eslint-parser` provides a few useful parser services to help traverse the produced AST and access template tokens:
36+
`vue-eslint-parser` provides a few useful parser services to help traverse the produced AST and access template tokens:
3737

3838
- `context.parserServices.defineTemplateBodyVisitor(visitor, scriptVisitor)`
3939
- `context.parserServices.getTemplateBodyTokenStore()`

0 commit comments

Comments
 (0)