From 1d08a7cd1984bc767e69f625371c9e2e8c75f04c Mon Sep 17 00:00:00 2001 From: Cameron Huntington Date: Thu, 11 Nov 2021 15:33:44 -0600 Subject: [PATCH] grammar fixes, rule guide reconstruction, rename changelog to releases --- README.md | 36 ++++++++++++++---------------------- 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index c8951f0a3..d62fff037 100644 --- a/README.md +++ b/README.md @@ -9,49 +9,41 @@ ## :book: Documentation -See [the official website](https://eslint.vuejs.org). +Please refer to [official website](https://eslint.vuejs.org). ## :anchor: Versioning Policy -This plugin is following [Semantic Versioning](https://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy). +This plugin follows [Semantic Versioning](https://semver.org) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy). -## :newspaper: Changelog +## :newspaper: Releases This project uses [GitHub Releases](https://github.com/vuejs/eslint-plugin-vue/releases). ## :beers: Contribution Guide -Contribution is welcome! +Contributing is welcome! See the [ESLint Vue Plugin Developer Guide](https://eslint.vuejs.org/developer-guide). -See [The ESLint Vue Plugin Developer Guide](https://eslint.vuejs.org/developer-guide/). +### Working With Rules -### Working with Rules +Be sure to read the [official ESLint guide](https://eslint.org/docs/developer-guide/working-with-rules) before you start writing a new rule. -Before you start writing a new rule, please read [the official ESLint guide](https://eslint.org/docs/developer-guide/working-with-rules). +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. -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]. -The [astexplorer.net] is a great tool to inspect ASTs, also Vue templates are supported. +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 `