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

docs(lint/style/useFilenamingConvention): fix example options #2144

Merged
merged 4 commits into from
Mar 21, 2024

Conversation

zauni
Copy link
Contributor

@zauni zauni commented Mar 20, 2024

Summary

Just a small change that corrects the example option in the documentation.

Test Plan

@github-actions github-actions bot added the A-Website Area: website label Mar 20, 2024
Copy link

netlify bot commented Mar 20, 2024

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit 15b28bc
🔍 Latest deploy log https://app.netlify.com/sites/biomejs/deploys/65fbea450d4ab800088e3c88
😎 Deploy Preview https://deploy-preview-2144--biomejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 93 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@arendjr
Copy link
Contributor

arendjr commented Mar 20, 2024

Can you run just gen-lint so the generated docs are updated?

@zauni
Copy link
Contributor Author

zauni commented Mar 20, 2024

@arendjr thanks for the heads up 🙂

@Sec-ant
Copy link
Member

Sec-ant commented Mar 21, 2024

@zauni The markdown doc of this rule is auto generated from the doc comments in the source code. So you'll have to update the comments in the source to reliably update them:

/// "enumMemberCase": ["camelCase", "export"]

And there's also another option requireAscii that is missing in the example, would you mind updating it as well?

Once you've updated the comments in the source, just gen-lint will handle the rest for you.

@github-actions github-actions bot added A-Linter Area: linter L-JavaScript Language: JavaScript and super languages labels Mar 21, 2024
Copy link
Contributor

@arendjr arendjr left a comment

Choose a reason for hiding this comment

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

Thanks!

@zauni
Copy link
Contributor Author

zauni commented Mar 21, 2024

@arendjr Thanks for the patience 🙂 Also adjusted some code comments after you approved, hope they are okay

@arendjr
Copy link
Contributor

arendjr commented Mar 21, 2024

No problem, all changes look good 👍 Thanks for your contribution!

@arendjr arendjr merged commit 958a9a1 into biomejs:main Mar 21, 2024
1 check passed
@zauni zauni deleted the patch-1 branch March 21, 2024 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Linter Area: linter A-Website Area: website L-JavaScript Language: JavaScript and super languages
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants