feat(npm): enrich @runner-run/* platform metadata for Socket Quality#63
Merged
Conversation
Bare @runner-run/* platform packages scored low on Socket Quality (missing keywords, thin description, ~5-line README). The facade package carried full metadata; the sub-packages did not. - platformPackageJson: add keywords (facade, prebuilt/binary/native/ cli/task-runner + os/cpu/libc) and a descriptive description. - platformReadme: expand to a real README (Do I install this?, Contents, More) explaining the optionalDependencies mechanism and pointing users at the facade. Takes effect on next release build; no version bump.
📝 WalkthroughWalkthroughThe PR updates generated metadata for Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 7 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (7 passed)
Comment |
The platform-package description and README ship to npm; replace the em-dashes with plain punctuation so the published metadata reads clean.
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.
What
Bare
@runner-run/*platform packages (the prebuilt-binary sub-packages npm selects viaoptionalDependencies) scored low on Socket.dev Quality: missingkeywords, a thindescription, and a ~5-line README. The facade package had full metadata; the sub-packages did not.Changes
platformPackageJson: addkeywords(facade +prebuilt/binary/native/cli/task-runner+ os/cpu/libc) and a realdescription.platformReadme: expand to a proper README (Do I install this?, Contents, More) explaining theoptionalDependenciesresolution and pointing at the facade.Notes
npm/dist/is generated.resolve.cjs(the#pkgswap only relocates the Socket URL alert, net-zero) orlaunch.cjs(heuristic AI-anomaly flag, owner-triage in the dashboard, not a code change).node --check+dprint checkclean.