Skip to content

Commit 0f4861a

Browse files
MichaelFossmysticatea
authored andcommitted
Docs: update README.md (#806)
1 parent 4359288 commit 0f4861a

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,45 +9,45 @@
99
1010
## :book: Documentation
1111

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

1414
## :anchor: Versioning Policy
1515

1616
This plugin is following [Semantic Versioning](https://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
1717

1818
## :newspaper: Changelog
1919

20-
We're using [GitHub Releases](https://github.com/vuejs/eslint-plugin-vue/releases).
20+
This project uses [GitHub Releases](https://github.com/vuejs/eslint-plugin-vue/releases).
2121

22-
## :beers: Contribution guide
22+
## :beers: Contribution Guide
2323

24-
Contributing is welcome!
24+
Contribution is welcome!
2525

26-
See https://eslint.vuejs.org/developer-guide/
26+
See [The ESLint Vue Plugin Developer Guide](https://eslint.vuejs.org/developer-guide/).
2727

28-
### Working with rules
28+
### Working with Rules
2929

30-
Before you start writing new rule, please read the [official ESLint guide](https://eslint.org/docs/developer-guide/working-with-rules).
30+
Before you start writing a new rule, please read [the official ESLint guide](https://eslint.org/docs/developer-guide/working-with-rules).
3131

32-
Next in order to get an idea how does the AST of the code that you want to check looks like, you can use one of the following applications:
33-
- [astexplorer.net](https://astexplorer.net/) - best tool to inspect ASTs, but it doesn't support Vue templates yet
34-
- [ast.js.org](https://ast.js.org/) - not fully featured, but supports Vue templates syntax
32+
Next, in order to get an idea how does the AST of the code that you want to check looks like, use one of the following applications:
33+
- [astexplorer.net](https://astexplorer.net/) - the best tool to inspect ASTs, but it doesn't support Vue template yet
34+
- [ast.js.org](https://ast.js.org/) - not fully featured, but supports Vue template syntax
3535

36-
Since single file components in Vue are not plain JavaScript, we can't use the default parser, and we had to introduce additional one: `vue-eslint-parser`, that generates enhanced AST with nodes that represent specific parts of the template syntax, as well as what's inside the `<script>` tag.
36+
Since single file components in Vue are not plain JavaScript, the default parser couldn't be used, so a new one was introduced. `vue-eslint-parser` generates enhanced AST with nodes that represent specific parts of the template syntax, as well as what's inside the `<script>` tag.
3737

3838
To know more about certain nodes in produced ASTs, go here:
3939
- [ESTree docs](https://github.com/estree/estree)
4040
- [vue-eslint-parser AST docs](https://github.com/mysticatea/vue-eslint-parser/blob/master/docs/ast.md)
4141

42-
The `vue-eslint-parser` provides few useful parser services, to help traverse the produced AST and access tokens of the template:
42+
The `vue-eslint-parser` provides a few useful parser services that help traverse the produced AST and access tokens of the template:
4343
- `context.parserServices.defineTemplateBodyVisitor(visitor, scriptVisitor)`
4444
- `context.parserServices.getTemplateBodyTokenStore()`
4545

46-
Check out an [example rule](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/mustache-interpolation-spacing.js) to get a better understanding of how these work.
46+
Check out [an example rule](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/mustache-interpolation-spacing.js) to get a better understanding of how these work.
4747

48-
Please be aware that regarding what kind of code examples you'll write in tests, you'll have to accordingly setup the parser in `RuleTester` (you can do it on per test case basis though). [See an example here](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/attribute-hyphenation.js#L19)
48+
Please be aware that regarding what kind of code examples you'll write in tests, you'll have to accordingly set up the parser in `RuleTester` (you can do it on a per test case basis). See an example [here](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/attribute-hyphenation.js#L19).
4949

50-
If you'll stuck, remember there are plenty of rules you can learn from already, and if you can't find the right solution - don't hesitate to reach out in issues. We're happy to help!
50+
If you'll stuck, remember there are plenty of rules you can learn from already. If you can't find the right solution, don't hesitate to reach out in [issues](https://github.com/vuejs/eslint-plugin-vue/issues) – we're happy to help!
5151

5252
## :lock: License
5353

0 commit comments

Comments
 (0)