Skip to content

docs(website): mention how rule options should be handled #7713

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
Merged
merged 1 commit into from
Oct 8, 2023
Merged

docs(website): mention how rule options should be handled #7713

merged 1 commit into from
Oct 8, 2023

Conversation

Josh-Cena
Copy link
Member

PR Checklist

Overview

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @Josh-Cena!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

@netlify
Copy link

netlify bot commented Oct 1, 2023 •
edited
Loading

❌ Deploy Preview for typescript-eslint failed.

Name Link
🔨 Latest commit 8626d02
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6519bb89a10ece0008a0e55e

Josh-Cena
Josh-Cena commented Oct 1, 2023
View reviewed changes
docs/developers/Custom_Rules.mdx Outdated
Comment on lines 135 to 139
type Options = [
{
preferredCase?: 'lower' | 'upper';
},
];
Copy link
Member Author

Choose a reason for hiding this comment

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

I have one question: should this be the type before or after validation (and applying defaults)? My guess is "after", but I don't know if it's used elsewhere than checking defaultOptions and typing the options parameter.

@nx-cloud
Copy link

nx-cloud bot commented Oct 1, 2023 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8626d02. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 20 targets

Sent with 💌 from NxCloud.

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Oct 8, 2023
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Nice example! 💯

@JoshuaKGoldberg JoshuaKGoldberg merged commit d072902 into typescript-eslint:main Oct 8, 2023
@Josh-Cena Josh-Cena deleted the handling-options branch October 9, 2023 00:00
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Bug: defaultOptions does not provide default options
2 participants
@Josh-Cena @JoshuaKGoldberg