Skip to content
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

chore: refactor render-rules tool #432

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Conversation

Foxeye-Rinx
Copy link
Contributor

Context:

To prepare for the new doc that is going to be made in #429, it needs to re-organize some functions in render-rules.ts - The file responsible for generating rule tables

An example table is generated by this file:

Rule ID Description
astro/no-set-html-directive disallow use of set:html to prevent XSS attack

Changes:

  • render-rules.tsrender-rules-table.ts
  • Type fix: typeof (categories)[number]RuleCategory
  • Coding methodology:
    • Current problem: functions that are returning a template string for markdown require us to put the content of the markdown next to the left border of the file, it broke the indentations
image
  • The fix is to make those content generator functions become arrow functions, which are fit for generating markdown string
image

Copy link

changeset-bot bot commented Oct 21, 2024

⚠️ No Changeset found

Latest commit: 8d93cc1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Owner

@ota-meshi ota-meshi left a comment

Choose a reason for hiding this comment

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

Thank you!

@ota-meshi
Copy link
Owner

Memo: I have confirmed that the CI error is not related to this PR.

@ota-meshi ota-meshi merged commit 0566384 into ota-meshi:main Oct 21, 2024
3 of 8 checks passed
@Foxeye-Rinx Foxeye-Rinx deleted the starlight branch October 22, 2024 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants