-
-
Notifications
You must be signed in to change notification settings - Fork 111
Add TODO/FIXME drift checker and fix checker count docs #60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
theDakshJaitly
merged 1 commit into
mex-memory:main
from
advancedresearcharray:feat/todo-fixme-checker-issue-54
Jun 4, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| import { readFileSync } from "node:fs"; | ||
| import { relative } from "node:path"; | ||
| import type { DriftIssue } from "../../types.js"; | ||
|
|
||
| const MARKER_RE = /\b(TODO|FIXME)\b/g; | ||
|
|
||
| /** Scan scaffold markdown for unresolved TODO/FIXME markers. */ | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tiny cosmetic note: the comment says "scaffold markdown," but |
||
| export function checkTodoFixme( | ||
| scaffoldFiles: string[], | ||
| projectRoot: string | ||
| ): DriftIssue[] { | ||
| const issues: DriftIssue[] = []; | ||
|
|
||
| for (const filePath of scaffoldFiles) { | ||
| const source = relative(projectRoot, filePath); | ||
| let content: string; | ||
| try { | ||
| content = readFileSync(filePath, "utf-8"); | ||
| } catch { | ||
| continue; | ||
| } | ||
|
|
||
| const lines = content.split("\n"); | ||
| for (let i = 0; i < lines.length; i++) { | ||
| const line = lines[i]; | ||
| MARKER_RE.lastIndex = 0; | ||
| let match: RegExpExecArray | null; | ||
| while ((match = MARKER_RE.exec(line)) !== null) { | ||
| const marker = match[1]; | ||
| issues.push({ | ||
| code: "TODO_FIXME", | ||
| severity: "warning", | ||
| file: source, | ||
| line: i + 1, | ||
| message: `Unresolved ${marker} marker in scaffold`, | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return issues; | ||
| } | ||
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Non-blocking, just flagging two behaviors of the match for posterity:
TODO/FIXMEliterally anywhere, including inside fenced code blocks or apatterns/*.mdthat documents the convention (e.g. an example showing// TODO). That's exactly what Add a TODO/FIXME drift checker #54 asked for (warning per occurrence), so it's correct as-is — just noting that code-fence/inline-code skipping could be a nice v2 to cut noise.TODO/FIXMEmatch;todo/Fixmeare ignored. That's the conventional marker form, so probably intended — confirming it was a deliberate choice.(FYI the
MARKER_RE.lastIndex = 0reset per line is a good defensive touch on a reused/gregex.)