sort-keys - include/exclude objects by name

What rule do you want to change? sort-keys

Does this change cause the rule to produce more or fewer warnings? fewer potentially

How will the change be implemented? (New option, new default behavior, etc.)? new option

Please provide some example code that this change will affect:

/*eslint sort-keys: ["error", { includeObjects: ["includeMe"] }]*/

// Examples of incorrect code for this rule:
const includeMe = { b: 'b', a: 'a' }

// Exampes of correct code for this rule
const someObj = { b: 'b', a: 'a' }

/*eslint sort-keys: ["error", { excludeObjects: ["excludeMe"] }]*/

// Examples of incorrect code for this rule:
const foo = { b: 'b', a: 'a' }

// Exampes of correct code for this rule
const excludeMe = { b: 'b', a: 'a' }

What does the rule currently do for this code? Answered above

What will the rule do after it’s changed? Answered above

Are you willing to submit a pull request to implement this change? I will try with some guidance, I’ve never looked into eslint code.

Motivation The biggest use case for me is sorting JSS properties, while NOT linting the rest of the app.

[platinumazure]

Hi @goldylucks, thanks for the issue.

Have you tried using ESLint disable comments? I think that would be a pretty good fit for your use case, especially in the exclude case.

[goldylucks]

so I ended up including instead of excluding. Not very clean, but it works 😃

/* eslint sort-keys: "error" */
const styles = theme => ({
  root: {
    paddingTop: 100,
    paddingRight: theme.containerPadding,
    paddingLeft: theme.containerPadding,
  },
  title: {
    fontSize: 24,
    marginRight: theme.containerPadding,
    marginBottom: theme.spacing(4),
  },
})