Redesign heading-health plugin to match Crawlith plugin standards#83
Merged
Conversation
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.
Motivation
heading-healthplugin to follow the Crawlith plugin architecture, lifecycle hooks, and secure DB/config patterns described in the agent docs.ctx.dbAPI and allow a force-refresh option for recomputations.Description
src/layout and exportedHeadingHealthPluginfromindex.tsdelegating tosrc/modules (plugin.ts,cli.ts,HeadingHealthService.ts,Output.ts,types.ts,analyzer.ts).onInitregisters schema viactx.db.schema.define,onMetricscomputes per-page payloads, reads 24h cached rows viactx.db.data.find(..., { maxAge: '24h', global: true }), persists viactx.db.data.save, and publishes a snapshot summary toctx.metadata, andonReportattaches the snapshot summary toresult.plugins.headingHealth.HeadingHealthServiceand improved analyzer code with clearer types and utility functions (jaccardSimilarity, entropy calculation, duplicate-risk enrichment); addedHeadingHealthOutputfor logging andregisterHeadingHealthClifor CLI options including--heading-force-refresh.src/types.ts, expanded JSDoc comments across modules, and updated tests to assert DBfind/savecalls, per-page payload attachment, and report summary behavior.Testing
pnpm --filter @crawlith/plugin-heading-health testand all tests passed (5 passed (5)), validating analyzer behavior and plugin hooks. ✅pnpm --filter @crawlith/plugin-heading-health buildbut the isolated TypeScript compile failed because the environment could not resolve the workspace package@crawlith/coreduring an isolated packagetscrun; this is an environment workspace resolution issue and does not affect the plugin unit tests.Codex Task