question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Ability to summarize rule data

See original GitHub issue

It would be useful to have a --summary flag or similar that can output a summary of which rules have failures and a count of how many exist in the files that were linted.

For example:

yarn ember-template-lint . --summary
> no-action - 34 errors
> no-implicit-this - 69 errors
> no-curly-component-invocation - 125 errors

This would be useful to help teams know how widespread a particular problem is, so they can make reasonable estimates for planning work to address linting failures.

This feature can work in tandem with the --include-todo flag to include TODOs in the summary, perhaps like so:

yarn ember-template-lint . --summary --include-todo
> no-action - 54 errors (20 todo)
> no-implicit-this - 70 errors (1 todo)
> no-curly-component-invocation - 125 errors (0 todo)

It could also output a range of due dates for each rule, based on the individual TODOs:

yarn ember-template-lint . --summary --include-todo
> no-action - 54 errors (20 todo - Due in 20-34 days)
> no-implicit-this - 70 errors (1 todo - Due in 15 days)
> no-curly-component-invocation - 125 errors (0 todo)

It may also be useful to have a way to output this summary only for TODOs, but I think the above suggestion that displays how many of the errors came from TODOs might solve that nicely without needing another command specific to TODOs. However, I could see there being additional TODO-related enhancements like sorting the summary by due date to help prioritize TODOs that will become errors soon.

If I were to simplify it, I’d say we need a formatter that clearly displays the following information, grouped by rule:

  • # of Errors
  • # of Warnings
  • # of TODOs
  • Due Date Range for the TODOs in that group

The exact text format is less important to me as long as we’re able to cover those pieces of data.

Issue Analytics

  • State:open
  • Created 2 years ago
  • Reactions:3
  • Comments:15 (15 by maintainers)

github_iconTop GitHub Comments

1reaction
DingoEatingFuzzcommented, Oct 23, 2021

Right now using the external formatter, but that’s presumably because I need to update ember-template-lint (currently on 3.5.x and getting an “invalid time value” error).

Assuming upgrading fixes my issues then nothing technically is preventing me from using the external formatter, but the performance issue is disappointing and even though this is a good enough workaround for me there’s still the discoverability issue.

Again, I’m happy to help here if the timeline issue is bandwidth.

0reactions
elwayman02commented, Dec 9, 2021

I updated the proposed “spec” above to include displaying a range of due dates for TODOs for each rule.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Summarize Data with Summary Variables Unit - Trailhead
After completing this unit, you'll be able to: Describe how summary variables represent a summary of data. Apply a summary variable to a...
Read more >
Statistics: Power from Data! Five-number summary
A summary consists of five values: the most extreme values in the data set (the maximum and minimum values), the lower and upper...
Read more >
Guide to the Rulemaking Process - Federal Register
The final rule published in the Federal Register begins with a “Summary” of the societal problems and regulatory goals and explains why the...
Read more >
Data Protection Law: An Overview - CRS Reports
The report lastly contains an Appendix, which contains a table summarizing the federal data protection laws discussed in the report.
Read more >
What is GDPR? The summary guide to GDPR compliance in ...
General Data Protection Regulation, or GDPR, became law in May 2018. Our need-to-know GDPR summary explains what the changes mean for you.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found