fix: remove auto-generated header from adapter files#225
Merged
Conversation
The `<!-- AUTO-GENERATED ... -->` HTML comment before frontmatter prevented tools like agnix from parsing YAML frontmatter on line 1. Removed the header entirely - the adapters/ directory is self-explanatory. Drops agnix errors from 83 to 8.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Summary of ChangesHello @avifenesh, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a critical issue where an auto-generated header comment in adapter files was interfering with frontmatter parsing by external tools. By completely removing this header, the system now ensures that YAML frontmatter correctly starts on the first line, resolving parsing errors and improving compatibility. The change also updates the generation script and associated tests to align with the new file format, streamlining the adapter generation process. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request successfully removes an auto-generated HTML comment header from adapter files, which was causing frontmatter parsing issues. The changes are clean, well-tested, and address the problem effectively. Please note that the security review for __tests__/gen-adapters.test.js could not be completed as the file was empty, preventing analysis.
Contributor
There was a problem hiding this comment.
Pull request overview
Removes the HTML AUTO-GENERATED header that was being prepended before YAML frontmatter in generated adapter markdown files, so downstream tools that require --- on line 1 can parse frontmatter correctly.
Changes:
- Updated
scripts/gen-adapters.jsto stop prepending the auto-generated header to adapter outputs. - Updated
__tests__/gen-adapters.test.jsto assert frontmatter starts on line 1. - Regenerated adapter markdown files to remove the header line.
Reviewed changes
Copilot reviewed 100 out of 100 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/gen-adapters.js | Stop prepending the auto-generated header and remove the exported constant. |
| tests/gen-adapters.test.js | Update integration assertions to expect frontmatter on line 1 (no leading header). |
| adapters/opencode/skills/validate-delivery/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/sync-docs/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/repo-mapping/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/perf-theory-tester/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/perf-theory-gatherer/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/perf-profiler/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/perf-investigation-logger/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/perf-code-paths/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/perf-benchmarker/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/perf-baseline-manager/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/perf-analyzer/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/orchestrate-review/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/learn/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/enhance-skills/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/enhance-prompts/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/enhance-plugins/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/enhance-orchestrator/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/enhance-hooks/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/enhance-docs/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/enhance-cross-file/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/enhance-claude-memory/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/enhance-agent-prompts/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/drift-analysis/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/discover-tasks/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/deslop/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/debate/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/consult/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/skills/agnix/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/sync-docs.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/ship.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/ship-error-handling.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/ship-deployment.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/ship-ci-review-loop.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/repo-map.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/perf.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/next-task.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/learn.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/enhance.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/drift-detect.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/deslop.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/delivery-approval.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/debate.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/consult.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/audit-project.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/audit-project-github.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/audit-project-agents.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/commands/agnix.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/worktree-manager.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/test-coverage-checker.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/task-discoverer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/sync-docs-agent.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/skills-enhancer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/simple-fixer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/prompt-enhancer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/plugin-enhancer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/planning-agent.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/plan-synthesizer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/perf-theory-tester.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/perf-theory-gatherer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/perf-orchestrator.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/perf-investigation-logger.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/perf-code-paths.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/perf-analyzer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/map-validator.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/learn-agent.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/implementation-agent.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/hooks-enhancer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/exploration-agent.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/docs-enhancer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/deslop-agent.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/delivery-validator.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/debate-orchestrator.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/cross-file-enhancer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/consult-agent.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/claudemd-enhancer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/ci-monitor.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/ci-fixer.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/agnix-agent.md | Remove auto-generated header line before frontmatter. |
| adapters/opencode/agents/agent-enhancer.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/sync-docs/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/ship/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/ship-error-handling/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/ship-deployment/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/ship-ci-review-loop/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/repo-map/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/perf/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/next-task/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/learn/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/enhance/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/drift-detect/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/deslop/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/delivery-approval/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/debate/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/consult/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/audit-project/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/audit-project-github/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/audit-project-agents/SKILL.md | Remove auto-generated header line before frontmatter. |
| adapters/codex/skills/agnix/SKILL.md | Remove auto-generated header line before frontmatter. |
Comments suppressed due to low confidence (1)
tests/gen-adapters.test.js:366
- This test also relies on "---\n" checks (includes/startsWith). For cross-platform robustness, consider using the same CRLF-tolerant frontmatter detection here (normalize to \n or use /^---\r?\n/) so the format validation runs consistently on all OSes.
const content = files.get(cmdPath);
if (content.includes('---\n')) {
// Files with frontmatter should have the OpenCode format
if (content.startsWith('---\n')) {
expect(content).toContain('agent: general');
expect(content).not.toContain('argument-hint');
expect(content).not.toContain('codex-description');
checkedCount++;
}
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
28
to
+59
| @@ -57,7 +56,7 @@ function computeAdapters() { | |||
| content = transforms.transformCommandFrontmatterForOpenCode(content); | |||
|
|
|||
| const relPath = normalizePath(path.join('adapters', 'opencode', 'commands', target)); | |||
| files.set(relPath, GENERATED_HEADER + content); | |||
| files.set(relPath, content); | |||
There was a problem hiding this comment.
Removing the auto-generated header makes CONTRIBUTING.md's guidance about “Files with AUTO-GENERATED headers” inaccurate, and also removes the only in-file indication that adapters are generated. Consider either updating the documentation to match this new behavior, or reintroducing a generation marker in a way that doesn’t break frontmatter parsing (e.g., placing it after the closing frontmatter block).
Comment on lines
+340
to
+347
| test('generated files start with frontmatter (no header before ---)', () => { | ||
| const { files } = genAdapters.computeAdapters(); | ||
| for (const [, content] of files) { | ||
| expect(content).toContain('AUTO-GENERATED'); | ||
| expect(content).toContain('DO NOT EDIT'); | ||
| for (const [filePath, content] of files) { | ||
| if (content.includes('---\n')) { | ||
| // Files with frontmatter must start with --- on line 1 | ||
| // (no auto-generated header before frontmatter) | ||
| expect(content.startsWith('---\n')).toBe(true); | ||
| } |
There was a problem hiding this comment.
These assertions hard-code LF line endings ("---\n"). On Windows/CRLF checkouts, generated content may start with "---\r\n", causing this test to skip the check or fail incorrectly. Consider normalizing line endings before assertions or using a regex like /^---\r?\n/ to keep the test platform-independent.
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.
Summary
The
<!-- AUTO-GENERATED by scripts/gen-adapters.js - DO NOT EDIT -->HTML comment was prepended before YAML frontmatter in all adapter files. This broke frontmatter parsing for tools like agnix that expect---on line 1.Removed the header entirely - the
adapters/directory name is self-explanatory. Drops agnix errors from 83 to 8 (remaining 8 are pre-existing unrelated issues).Changes
scripts/gen-adapters.js: RemovedGENERATED_HEADERconstant and prepend logic__tests__/gen-adapters.test.js: Updated test to verify frontmatter starts on line 1 instead of checking for headerTest plan