Add ignore config to no-unused-fields rule
#2281
Conversation
🦋 Changeset detectedLatest commit: 0a2deaa The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| type: 'object', | ||
| additionalProperties: false, | ||
| properties: { | ||
| ignoredFieldSelectors: { |
There was a problem hiding this comment.
A few other names I considered here were:
allowedUnusedFieldsallowedUnusedFieldSelectorsignoredFields
I think ignoredFieldSelectors avoids some of the oxymoronic qualities of allowedUnused* and provides useful context that this configuration uses ESLint selectors, but am open to other options.
| description: [ | ||
| 'Fields that will be ignored and are allowed to be unused.', | ||
| '', | ||
| '> These fields are defined by ESLint [`selectors`](https://eslint.org/docs/developer-guide/selectors). Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.', |
There was a problem hiding this comment.
The naming-convention rule already makes use of ESLint selectors within configurations and it felt good to follow suit here. While this adds some clunkiness to the configuration (allowing an individual field looks like "FieldDefinition[name.value=field]" instead of "field"), there are benefits in that allowing fields with wildcards, based on their parent object, etc. are implicitly supported.
Description
Changes here add a
ignoredFieldSelectorsconfiguration to theno-unused-fieldsrule such that some fields are allowed to be unused.Fixes #2280
Type of change
Please delete options that are not relevant.
Checklist:
CONTRIBUTING doc and the
style guidelines of this project