[READ-ONLY] Mirror of https://github.com/sxzz/eslint-plugin-vuekit. Modern ESLint plugin for Vue 3 eslint-plugin-vuekit.sxzz.dev
eslint plugin vue
4.8 kB · 75 lines
Markdown
at main

Developer Guide #

Contributing is welcome.

🐛 Bug reporting #

If you think you’ve found a bug in ESLint, please create a new issue 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.

🌱 Project Setup #

To develop locally, fork the eslint-plugin-vue repository and clone it on your local machine. Use pnpm to install dependencies and the LTS version of Node.js.

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.

✨ 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 <rule name> <author name> 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, but first please make sure your question does not repeat previous ones.

🔥 Working with rules #

Before you start writing new rule, please read the official ESLint guide.

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 as the parser.

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.

To know more about certain nodes in produced ASTs, go here:

The vue-eslint-parser provides few useful parser services, to help traverse the produced AST and access tokens of the template:

  • context.parserServices.defineTemplateBodyVisitor(visitor, scriptVisitor)
  • context.parserServices.getTemplateBodyTokenStore()

Check out an example rule to get a better understanding of how these work.

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

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!

✅ JSDoc type checking with TypeScript #

We have type checking enabled via TypeScript and JSDoc.
The command to perform type checking is: pnpm tsc

Some tests import the built plugin from dist, so run pnpm build first. CI runs the type check on every pull request, and it has to pass.

This is just to help you write the rules, not to do strict type checking. If you find it difficult to resolve type checking errors, feel free to suppress them using the // @ts-nocheck and // @ts-ignore comment.