GithubHelp home page GithubHelp logo

Comments (2)

pinkfloydx33 avatar pinkfloydx33 commented on May 26, 2024

To give an idea why I would like this, here's my use case:

We run inspectcode.exe as part of our PR pipelines and the only plugin we add to the vanilla run is Structured Logging. We generate a nice html report of all issues but we also perform analysis on a category/severity/issue basis for things we are really concerned about. We display a summary of those results in our PRs (with a link to full report) and choose to pass/fail in part.

When we analyze the results, we allow certain thresholds based on severity/category and sometimes the issue Id. One thing we would like to enforce is that there are zero structured Logging warnings. Because all of the issues are in the general "Compiler Warnings" category, I need to add individual overrides for each IssueId this plugin can raise. It'd be nice to be able to do it at the subcategory (or category) level, which has the added bonus that I don't need to monitor for new rules.

Adding a sub-category also means I'd get a nice "english" piece of text to display in the summary. Right now for this plugin (or any issues I'm explicitly watching for that don't have a subcategory) I display the cryptic Issue Id. I choose not to display the description of the issue itself since sometimes they're not very helpful on their own. (The ones that come from here usually have format strings in them ie Property name '{0}' does not naming rules'. Suggested name is '{1}' which doesn't really tell someone looking at the summary it's referring to logging. This also impacts our html report where we group by Issue and show the issue's description, unfortunately with format string placeholders. But that's a seperate topic)

from resharper-structured-logging.

olsh avatar olsh commented on May 26, 2024

Hi @pinkfloydx33,

Great suggestion! 👍
I think it will be helpful in cases when you manually analyze warnings in VS too.

The PR is welcome.

It'd be nice to be able to do it at the subcategory (or category) level, which has the added bonus that I don't need to monitor for new rules.

What's the difference between category and sub-category? I thought that only GroupId (category) could be specified.

[assembly:
RegisterConfigurableSeverity(
AnonymousObjectDestructuringWarning.SeverityId,
null,
HighlightingGroupIds.CompilerWarnings,
AnonymousObjectDestructuringWarning.Message,
AnonymousObjectDestructuringWarning.Message,
Severity.WARNING)]

from resharper-structured-logging.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.