Add Verification Script for widgets.xml - #101
Draft
Lightning11wins wants to merge 62 commits into
Draft
Conversation
Add a defined config section. Move regexes to their own section below the config section. Add a section for types. Move "drift types" to above compute_drift() in preparation removing them. Rename OBSOLETE_WIDGETS to IGNORED_WIDGETS. Add to ignored widgets. Add to widget aliases. Add config options. Add a universal rule for __pycache__ to the .gitignore file. Rename many symbols to improve clarity. Remove unused types. Improve code comments. Clean up slop.
Update widget aliases. Remove skipped widgets from ignored widgets list. Add remotectl and remotemgr to ignored widgets list.
Add IGNORE_MISSING_PROPERTY_DOCS. Reorder configs and improve clarity.
Refactor to remove some unnecessary report types. Improve code style and layout. Rename slug_origin() to get_origin(). Clean up code.
Update report generation to derive origins from ref paths. Remove now unused origin data storage. Display origins above more sources.
…mat commit to the start.
Move sections from Other Notes to Using Doc Reports. Add a list of future improvements.
Refactor to improve readability maintainability. Rename _normalize_child_type() to normalize_child_name(). Clean up unused code.
Fix detection ignoring all but the first widget in htdrv_*.c files. Add a section to the docs documenting assumptions about child widgets.
Replace case-sensitive string check with more-flexible case-insensitive regex. Improve regex. Improve types.
Contributor
Author
|
@greptileai I think I've resolved all of your feedback. Please conduct a thorough re-review of the entire PR and tell me if there are any other issues. |
Contributor
Author
|
This PR is cleared for human review. |
widgets.xml
Lightning11wins
commented
Aug 13, 2026
… block by a comment was completely ignored.
Contributor
Author
|
I'd like to do some more review on this before we merge it. |
Lightning11wins
marked this pull request as draft
August 28, 2026 23:07
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This python3 script detects discrepancies between the
widgets.xmldocs and the widget implementations inwgtr_*.c,htr_*.c, andhtr_*.jsfiles to generate a report. The report summarizes the issues detected and provides links to make it easy for developers to quickly correct them. This branch also includes a documentation file explaining how to read the reports, how to use the script, and a high-level overview of how the script works.Note: Many of the issues detected by running this script are fixed in #100.
Example 1

Example 2

Note 1: As usual, these changes were made on a completely different dev branch, then the commits were cherry-picked to this branch. This prevents the PR being blocked behind 8+ other PRs, however, it was a difficult and technical process. If you notice any bizarre changes on this branch, please let me know.