Skip to content

Improved rule list doc #1860

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.

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

Merged
merged 13 commits into from
Apr 22, 2022
Merged

Improved rule list doc #1860

merged 13 commits into from
Apr 22, 2022

Conversation

ota-meshi
Copy link
Member

@ota-meshi ota-meshi commented Apr 22, 2022

This PR improves the rule list documentation.

There are quite a lot of rules now. I have made the following changes to make the rules easier for users to access.

  • Changed layout so that rules do not duplicate in multiple tables.
  • Placed icon on the rule to indicate the type of the rule.
  • Added checkboxes so that user can highlight by the type of rule.

https://deploy-preview-1860--eslint-plugin-vue.netlify.app/rules/

Copy link
Member

@FloEdelmann FloEdelmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really cool changes!

Maybe the layout of only this docs page can be adjusted, so it is wider (on screens with more horizontal space) and thus better uses the available space?

@ota-meshi
Copy link
Member Author

I think I made the changes you requested. Could you check it again?

@ota-meshi ota-meshi requested a review from FloEdelmann April 22, 2022 11:38
</template>

<script>
const emojis = ['3️⃣', '2️⃣', '⚠️']
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Intl.Segmenter is required to properly split these emojis, but FireFox doesn't support it, so we'll handle it ourselves.

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter

@ota-meshi ota-meshi merged commit cdcf75e into master Apr 22, 2022
@ota-meshi ota-meshi deleted the rule-list branch April 22, 2022 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants