Redocly / Redocly/redocly-cli

Aggregate data regarding rule(set) usage

Open
#1,135 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the linting path that loads rulesets and rules, then read the configuration and environment-variable opt-out described in #1044. Define the aggregate data to report for built-in rules, severities, configurable rules, rulesets, and empty extends arrays; done means reporting is non-identifying and fully disabled by that opt-out.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
analytics
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.