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

revert: restore some ESLint rules #9236

Closed
wants to merge 2 commits into from
Closed

Conversation

driskull
Copy link
Member

@driskull driskull commented May 1, 2024

Related Issue: #9235

Summary

  • partially reverts chore(linting): restore some ESLint rules #9123. Basically, just the TSX changes where props were removed. These are all global attributes so they should be settable on any element. However, since we removed them as properties, they won't have any typings or doc associated with them which teams may think is a breaking change. So should we put these properties back and remove them at a major (breaking change) release.
  • Added "@stencil-community/reserved-member-names": "warn", to eslint config because eslint was preventing commits due to these props being reserved global attributes.
  • All the other eslint cleanup was kept and not reverted

@github-actions github-actions bot added the chore Issues with changes that don't modify src or test files. label May 1, 2024
@driskull driskull marked this pull request as ready for review May 1, 2024 17:32
@driskull driskull requested review from benelan, jcfranco, geospatialem and a team as code owners May 1, 2024 17:32
@driskull driskull added the low risk Issues with low risk for consideration in low risk milestones label May 1, 2024
@driskull
Copy link
Member Author

driskull commented May 1, 2024

I was wrong initially, these are all global attributes.

@driskull
Copy link
Member Author

driskull commented May 1, 2024

Closing, I think the maquette VDOM library just needs to update its typings to support inputMode, etc.

@driskull driskull closed this May 1, 2024
@driskull driskull deleted the dris0000/partial-revert-9050 branch May 1, 2024 22:48
Copy link
Member

@benelan benelan left a comment

Choose a reason for hiding this comment

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

👍

The revert type should only be used when fully reverting a previous commit. Maybe we could use docs or chore instead, since that was the problem this PR resolves? For example:

chore: restore ESLint rule that removed ref for global attributes

@benelan
Copy link
Member

benelan commented May 1, 2024

Imo we should still have these documented if our components don't support all global attributes.

@driskull
Copy link
Member Author

driskull commented May 1, 2024

Imo we should still have these documented if our components don't support all global attributes.

Could you clarify this @benelan? What do you mean. Our components are web components which are HTML Elements. They do support all global attributes because of that nature.

@benelan
Copy link
Member

benelan commented May 1, 2024

Okay cool, I wasn't sure if all global attributes were handled correctly or not since this PR was restoring custom logic for two of them. But if all global attributes are handled correctly then we don't need to document them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Issues with changes that don't modify src or test files. low risk Issues with low risk for consideration in low risk milestones
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants