docs: catch the README, skill, and test-header notes up to the code - #71
Open
Ref34t wants to merge 1 commit into
Open
docs: catch the README, skill, and test-header notes up to the code#71Ref34t wants to merge 1 commit into
Ref34t wants to merge 1 commit into
Conversation
Four places still describe states the repo has moved past: - README called the Warlock a CommonJS package and explained scan()'s asyncness via the CJS/ESM bridge. It has been ESM since the 0.2.x migration; the dynamic import survives for lazy WASM init, so describe that instead. - README's Category reference listed 6 of the 7 CATEGORIES values — hardcoded_secret was missing. - README described the wizard's scanner replacement in future tense and pointed at src/lib/yara-scanner.ts, deleted when wizard#804 landed the migration. - rules.test.ts's header said four rule categories were 'coming in future PRs'; they shipped and live in per-rule files under __tests__/rules/ — say so, so new rule tests land in the right place. Also drop the two references to INTEGRATING.md in the warlock skill — the file does not exist; point at README's API sections instead.
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
2 participants
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.
Four prose spots still describe states the repo has moved past. Each fix is verified against the code at main:
scan()'s asyncness via the CJS/ESM bridge.package.jsonhas"type": "module"since the 0.2.x ESM migration — the dynamicimport('@virustotal/yara-x')survives for lazy WASM init, so the section now describes that (and the real cost: CJS consumers need a dynamic import of their own).Categoryreference listed 6 of the 7 values inCATEGORIES—hardcoded_secretwas missing.src/lib/yara-scanner.ts, which was deleted when wizard#804 landed. Now past tense, pointing at the wizard's actual wiring (yara-hooks.ts).rules.test.ts's header said four categories were "coming in future PRs" — they shipped and moved to per-rule files under__tests__/rules/. The header now routes new rule tests to the right place.Also: the warlock skill referenced
INTEGRATING.mdtwice as authoritative, but the file doesn't exist — the references now point at README's API sections. If an INTEGRATING.md is still planned, happy to swap these back (or draft it).Deliberately not touched: the
actionenum values in README/CONTRIBUTING — #34 already covers those.pnpm test(530 passing) andpnpm buildpass.