Skip to content

Commit 752a028

Browse files
authored
Update Developer Guide (#1210)
1 parent bbcc1f0 commit 752a028

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

Diff for: README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,12 @@ See [The ESLint Vue Plugin Developer Guide](https://eslint.vuejs.org/developer-g
3737

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

40-
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:
41-
- [astexplorer.net](https://astexplorer.net/) - the best tool to inspect ASTs, but it doesn't support Vue template yet
42-
- [ast.js.org](https://ast.js.org/) - not fully featured, but supports Vue template syntax
40+
Next, in order to get an idea how does the AST of the code that you want to check looks like, use the [astexplorer.net].
41+
The [astexplorer.net] is a great tool to inspect ASTs, also Vue templates are supported.
42+
43+
After opening [astexplorer.net], select `Vue` as the syntax and `vue-eslint-parser` as the parser.
44+
45+
[astexplorer.net]: https://astexplorer.net/
4346

4447
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.
4548

Diff for: docs/developer-guide/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,12 @@ We're more than happy to see potential contributions, so don't hesitate. If you
2828

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

31-
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:
32-
- [astexplorer.net](https://astexplorer.net/) - best tool to inspect ASTs, but it doesn't support Vue templates yet
33-
- [ast.js.org](https://ast.js.org/) - not fully featured, but supports Vue templates syntax
31+
Next, in order to get an idea how does the AST of the code that you want to check looks like, use the [astexplorer.net].
32+
The [astexplorer.net] is a great tool to inspect ASTs, also Vue templates are supported.
33+
34+
After opening [astexplorer.net], select `Vue` as the syntax and `vue-eslint-parser` as the parser.
35+
36+
[astexplorer.net]: https://astexplorer.net/
3437

3538
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.
3639

0 commit comments

Comments
 (0)