# Developer Guide Contributing is welcome. ## :bug: Bug reporting If you think you’ve found a bug in ESLint, please [create a new issue](https://github.com/sxzz/eslint-plugin-vuekit/issues/new?labels=&template=bug_report.md) or a pull request on GitHub. Please include as much detail as possible to help us properly address your issue. If we need to triage issues and constantly ask people for more detail, that’s time taken away from actually fixing issues. Help us be as efficient as possible by including a lot of detail in your issues. ## :seedling: Project Setup To develop locally, fork the eslint-plugin-vue repository and clone it on your local machine. Use [pnpm](https://pnpm.io/) to install dependencies and the LTS version of [Node.js](https://nodejs.org/). To develop and test the `eslint-plugin-vuekit` package: 1. Run `pnpm install` in the project's root folder. 2. Run `pnpm build && pnpm test` to make sure everything is set up correctly. ## Releasing Run `pnpm release` on `main` to choose a version with `bumpp`. The version bump updates rule documentation, creates a commit and a `v*` tag, and pushes them. The tag triggers the release workflow, which builds the package and publishes it through npm trusted publishing. Configure the npm trusted publisher for this repository before the first release. ## :sparkles: Proposing a new rule or a rule change In order to add a new rule or a rule change, you should: - Create issue on GitHub with description of proposed rule - Generate a new rule using the `pnpm new ` command - Write test scenarios & implement logic - Describe the rule in the generated `docs` file - Make sure all tests are passing - Run `pnpm lint` and fix any errors - Run `ppnpm run update` in order to update readme and recommended configuration - Create PR and link created issue in description We're more than happy to see potential contributions, so don't hesitate. If you have any suggestions, ideas or problems feel free to add new [issue](https://github.com/sxzz/eslint-plugin-vuekit/issues), but first please make sure your question does not repeat previous ones. ## :fire: Working with rules Before you start writing new rule, please read the [official ESLint guide](https://eslint.org/docs/developer-guide/working-with-rules). 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. After opening [astexplorer.net], select `Vue` as the syntax and [`vue-eslint-parser`](https://github.com/vuejs/vue-eslint-parser) as the parser. [astexplorer.net]: https://astexplorer.net/ 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`](https://github.com/vuejs/vue-eslint-parser), that generates enhanced AST with nodes that represent specific parts of the template syntax, as well as what's inside the `