MagicMirrorOrg / MagicMirrorOrg/MagicMirror-3rd-Party-Modules

[feat] Ability to "Ignore" Certain Errors

Open
#138 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
48
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Hello! I really like how this project surfaces suggestions. It has been very helpful for fixing issues with my modules.

The perfectionist in me wants to be able to work through the entire list, but occasionally there are items that for whatever reason I may choose to not resolve, or are not relevant to the current module.

Would you be open to a sort of "Ignore" list? Similar to ESLint ignores or similar features in static analysis tools.

Proposed process

Parsing ignores inline may be fairly difficult, but we could add something like a .mmmignore file with a list of identifiers. Then give each error a unique, preferably immutable, id. So copy changes don't become breaking changes to the ignore file.

I think this could be relatively straight forward to add something like this. the addIssue would track issues as a Map instead of just an array, and then at the end of processing, remove all keys found in .mmmignore.

If there is any appetite for this as a feature I would not mind taking a stab at it, let me know!

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 addIssue and reviewing how issues are collected and identified. Then examine the proposed .mmmignore process and existing error-processing flow. Done would mean the project has an agreed, stable way to define ignored issue identifiers and exclude them from results, with the scope clarified before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.