microsoft / microsoft/boll

Output name of failing rules

Open
#131 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
20
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Problem

When running using the "runBoll" funciton, it only return true/false in regards to the success or not, and relying on custom error messages for debug purposes. I think it would be super helpful to get to know the name of the rules that are failing, to make it easier to find identify and debug what is going on.

The current setup can lead to scenarios where it boll is failing and the develop having very little insight into what actually happened.

Solution

Write all the names of the rules that are failing

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 locating the runBoll function and tracing how rules report their results; inspect any existing tests for rule evaluation and output. Done means the result exposes the names of every failing rule while preserving the existing success or failure behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.