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

fix(@stylex/eslint-plugin): Change message when a property is disallowed #283

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tjosepo
Copy link

@tjosepo tjosepo commented Dec 30, 2023

What changed / motivation ?

  • Moved the logic that display the line {key} value must be one of:\n further down the codebase to be able to display a different message when a property is disallowed.
  • Add a Property {key} is not allowed. message.

This results in error messages more specific to the error its reporting.

This is a very naive attempt from my part to solve the problem with minimal changes and there might be more maintainable solutions.

Let me know if you think this is the right approach.

Also, feel free to suggest text for the error message.

Linked PR/Issues

Fixes #282

Additional Context

Tests where modified to reflect the changes:

Before:

grid value must be one of:
grid properties disallowed for testing

After:

Property grid is not allowed. grid properties disallowed for testing

Pre-flight checklist

@facebook-github-bot
Copy link

Hi @tjosepo!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@tjosepo tjosepo changed the title @stylex/eslint-plugin: Change message when a property is disallowed fix(@stylex/eslint-plugin): Change message when a property is disallowed Dec 30, 2023
@tjosepo
Copy link
Author

tjosepo commented Dec 30, 2023

CLA signed.

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Dec 30, 2023
@@ -50,6 +50,7 @@ export type RuleCheck = (
node: $ReadOnly<Expression | Pattern>,
variables?: Variables,
prop?: $ReadOnly<Property>,
key?: string,
Copy link
Author

@tjosepo tjosepo Dec 30, 2023

Choose a reason for hiding this comment

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

I made this argument optional because I don't know how RuleCheck is being used throughout the codebase.

Should I make it required?

Copy link
Contributor

Choose a reason for hiding this comment

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

This OK to start. We can make this stricter in the future if it makes sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

@stylexjs/eslint-plugin: Confusing error message when a value is disallowed with null
3 participants