Repository navigation
docs: correct and cut the markdown - #19
Merged
Merged
Conversation
README named the package @stackbox/fp-plugins in all six install and import examples; it is @stackbox-dev/fp-plugins, so following the README could not work. It also documented 168 lines of the event-bus plugin deleted in c001efc, claimed Node 18+ against engines >=22, described the local default as the system temp dir rather than a stackboxwms subdirectory, and gave no registry config for a package published only to GitHub Packages. Rewritten for consumers: 378 -> 154 lines, with env vars checked line by line against file-store.ts, and the automatic FastifyInstance.FileStore typing and lazy SDK loading documented for the first time. CLAUDE.md claimed its list was every script (prepare and prepublishOnly are also defined) and omitted utils.spec.ts. gen-test skill said cloud SDKs are never containerised and there are no Docker-based tests, contradicting the MinIO integration spec. security-reviewer agent reviewed the deleted event-bus — broker connections, the publish endpoint, NATS and RabbitMQ clients. Rescoped to the file store. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Docs-only. No source or config changes; lint, build, 127 tests and
prettier --checkall pass.README was unusable as written
It named the package
@stackbox/fp-pluginsin all six install and import examples. The real name is@stackbox-dev/fp-plugins, so anyone following the README got a package that does not exist.It also carried 168 lines documenting the event-bus plugin deleted in
c001efc— brokers,EventBusoptions,RABBITMQ_URL/EVENT_*env vars,CreateEventConsumer.src/index.tsexports onlyPlugins.FileStore.Three more factual errors: Node 18+ against
engines: >=22; the local default described as the system temp directory when the code uses astackboxwmssubdirectory (file-store.ts:477); and no registry config, though the package publishes only to GitHub Packages so a plaininstallcannot resolve it.Rewritten for consumers, 378 → 154 lines, with every provider env var checked against
src/file-store.ts. Two things consumers were never told are now documented: they getFastifyInstance.FileStoretyping automatically, and the cloud SDKs load lazily.Other files
package.json(prepareandprepublishOnlyare also defined) and omittedutils.spec.ts..claude/skills/gen-test/SKILL.mdsaid cloud SDKs are never containerised and the repo has no Docker-based tests — contradicted byfile-store.minio.integration.spec.ts. The no-testcontainers rule is kept; it now points at the integration spec..claude/agents/security-reviewer.mdreviewed the deleted event-bus: broker connections, the/event-bus/publish/:eventendpoint, NATS and RabbitMQ clients. Rescoped to the file store — credential exposure,filepathtraversal, env-var defaults, resource leaks, SDK misuse..claude/skills/release/SKILL.mdunchanged — every claim verified correct.Noted, not changed
FileInfois not exported fromsrc/index.ts, so consumers cannot name the typegetInforeturns. That is a code change, not a docs fix.