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

feat!: Add missing deprecated/replacedBy properties to meta-property-ordering rule #320

Merged

Conversation

bmish
Copy link
Member

@bmish bmish commented Oct 21, 2022

The deprecated, replacedBy rule metadata properties were mentioned in the rule doc but not actually enforced by the rule.

I have inserted these properties into the default list right after fixable/hasSuggestions. I'm leaving schema/messages last in the list since these are potentially large objects/arrays, and we should keep the essential, concise/one-line properties together.

This is a breaking change that can go in with #269.

@@ -12,7 +12,7 @@ This rule enforces that meta properties of a rule are placed in a consistent ord

This rule has an array option:

* `['type', 'docs', 'fixable', 'hasSuggestions', 'schema', 'messages', 'deprecated', 'replacedBy']` (default): The order that the properties of `meta` should be placed in.
* `['type', 'docs', 'fixable', 'hasSuggestions', 'deprecated', 'replacedBy', 'schema', 'messages']` (default): The order that the properties of `meta` should be placed in.
Copy link
Contributor

Choose a reason for hiding this comment

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

imo, the two props should be highlighted, what do you think change them to be in the 1st place?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, I would be open to that.

@aladdin-add aladdin-add changed the title Add missing deprecated/replacedBy properties to meta-property-ordering rule feat!: Add missing deprecated/replacedBy properties to meta-property-ordering rule Apr 9, 2024
@aladdin-add aladdin-add merged commit 1692fe2 into main Apr 9, 2024
12 checks passed
@aladdin-add aladdin-add deleted the meta-property-ordering-missing-deprecated-replacedBy branch April 9, 2024 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BREAKING CHANGE This change will require a major version bump
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants