Skip to content

chore: align package description with repo - #132

Merged
slgoodrich merged 1 commit into
mainfrom
chore/align-package-description
May 3, 2026
Merged

slgoodrich merged 1 commit into
mainfrom
chore/align-package-description

Conversation

@slgoodrich

Copy link
Copy Markdown
Owner

Summary

Updates package.json description from the original Polly.js-comparison tagline to "Snapshot testing for subprocess output", matching the GitHub repo description.

Why

The repo description on GitHub was changed via the web UI (no commit), so the npm-published description was never refreshed. npm metadata is locked per published version, so downstream scanners (Socket, etc.) keep showing the old line until a new version publishes with the new field.

This PR is the first half: get the change into the repo. The npm side updates whenever the next version (v0.6.2 or v0.7) publishes.

Test Plan

  • npm run lint: clean
  • npm run typecheck: clean
  • npm test: 777 passed, 2 skipped
  • description string verified: Snapshot testing for subprocess output

Notes

No code or schema changes. README and docs were already free of the old tagline; only package.json carried it.

`package.json` carried the original "Polly.js, but for shell commands"
tagline; the GitHub repo description was updated to "Snapshot testing
for subprocess output" via the web UI, but the npm-published
description was never refreshed because npm metadata is locked per
published version. This change pulls the package.json line in line with
the repo so the next published version updates the npm description and
downstream scanners (Socket, etc.).

No code or schema changes.
@slgoodrich
slgoodrich merged commit e1cacd7 into main May 3, 2026
5 checks passed
@slgoodrich
slgoodrich deleted the chore/align-package-description branch May 3, 2026 20:10
@slgoodrich slgoodrich mentioned this pull request May 3, 2026
3 of 4 tasks
slgoodrich added a commit that referenced this pull request May 3, 2026
Metadata-only refresh. Republishes v0.6.1's package contents under a
new version so the npm registry picks up the description change merged
in #132 ("Snapshot testing for subprocess output", aligned with the
GitHub repo description). npm metadata is locked per published version,
so a republish is the only way to update the description that Socket
and similar scanners read.

No code, schema, or test changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant