md-footer-template: "No markdown files found in project" when includes.global simply does not list .md

Open Beginner friendly
#436 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
tooling

Research direction

Start with findMarkdownFiles in md-footer-template.ts (lines 133–161) and the detectionLimits text in documentation-laws.ts (line 101). Trace how an empty result from includes.global is reported, then update the message to distinguish a filter that selects no Markdown files from a project with none. Done when the issue's example produces the clearer message.

Written by the indexing model from the issue text.

Description

bug

Found in the 8.0.0 self-audit triage: RoC 7.29.1 (npm, 5fc54afe) on a clean clone of develop at 2d2fa9a, with typescript resolvable (verdict compliance, 0 failed / 46 warnings). The bucket method and per-law tables are kept by QA; counts are from that run.

What happens

findMarkdownFiles (md-footer-template.ts:133-161) applies includes.global. In a project whose includes list only code (src/**/*.ts, scripts/**/*.js, tests/**/*.ts) the law says "No markdown files found in project" although 7 markdown files are tracked. The card's detectionLimits line saying the law bypasses the configured ignore paths (documentation-laws.ts:101) is out of date.

Suggested direction

When the user's filter leaves nothing, report "nothing judged (includes.global selects no markdown)" rather than "the project has none".

Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
38m
Merged PRs (30d)
96

Getting set up

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.

More from Rule-Of-Code/RoC

All issues in Rule-Of-Code/RoC

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.