redocly-cli icon indicating copy to clipboard operation
redocly-cli copied to clipboard

Aggregate data regarding rule(set) usage

Open lornajane opened this issue 1 year ago • 2 comments

Is your feature request related to a problem? Please describe.

As tool providers, we don't know how the tool is used, how many people use the published rulesets, which rules are most often disabled, and how the configurable rules are used. When linting, report which rules and rulesets are used (in aggregate, no identifying information).

Describe the solution you'd like

I want to be able to answer the questions:

  • which provided rulesets (such as minimal, recommended) are used and how much? We don't have a "none" option but also identify an empty extends array
  • which built-in rules are used and at what severity?
  • are configurable rules used?

This feature must be disabled when the config/environment variable (see #1044) is set, so that users can easily disable all reporting to us.

Describe alternatives you've considered

We don't currently collect this data, so I considered carrying on without it. But I think the extra context can inform our priorities.

lornajane avatar Jun 19 '23 09:06 lornajane

@adamaltman Does this capture the additional information you had in mind from the configuration settings? I tried to capture our slack conversation, but just chime in if I missed the mark!

lornajane avatar Jun 19 '23 09:06 lornajane

are configurable rules used?

As a follow-on to that, I would also ask:

Which assertions are used? Like "notPattern', "pattern", "const", and so on?

adamaltman avatar Jun 28 '23 22:06 adamaltman