Skip to content

Proposal: Adding 'since' attribute to rules documenation #1379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
ajmas opened this issue Dec 16, 2020 · 4 comments
Closed

Proposal: Adding 'since' attribute to rules documenation #1379

ajmas opened this issue Dec 16, 2020 · 4 comments

Comments

@ajmas
Copy link
Contributor

ajmas commented Dec 16, 2020 •
edited
Loading

Proposing the addition of a 'since' attribute to be added to the front-matter of the rules documentation. This would be used to indicate since what version of eslint-plugin-vue a given rule exists.

This proposal is in the context that not everyone has the latest version of eslint-plugin-vue (such as in a corporate environment), but may be looking at the documentation. It would give them a hint whether the rule was addd prior or after the version of eslint-plugin-vue being used in the project.

Example

---
pageClass: rule-details
sidebarDepth: 0
title: vue/no-unused-properties
description: disallow unused properties
since: v7.1.0
---
...
@ota-meshi
Copy link
Member

Thank you for posting this issue.

You can refer to the release notes to find out when the rule was added.
https://github.com/vuejs/eslint-plugin-vue/releases

You can also refer to the tag to check for old documents.
https://github.com/vuejs/eslint-plugin-vue/blob/v6.2.2/docs/rules/README.md

If you still need since, could you open a PR?

@ajmas
Copy link
Contributor Author

ajmas commented Dec 17, 2020

I’ll do the work and make a PR.

ajmas added a commit to ajmas/eslint-plugin-vue that referenced this issue Dec 17, 2020
@ajmas
Fixes vuejs#1379 Add since attribute
7f821f6
@ajmas
Copy link
Contributor Author

ajmas commented Dec 17, 2020

The current PR adds the since tag, but not familiar enough with VuePress to have it reflected on the rendered page.

@ota-meshi ota-meshi mentioned this issue Dec 24, 2020
Merged
@ota-meshi
Copy link
Member

Thank you for your contribution.
I also changed it to add a version at the bottom of the documentation for each rule.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ajmas @ota-meshi