Skip to content

chore: npm module packaging#33

Merged
homanp merged 4 commits intomainfrom
cursor/npm-module-packaging-6b70
Feb 5, 2026
Merged

chore: npm module packaging#33
homanp merged 4 commits intomainfrom
cursor/npm-module-packaging-6b70

Conversation

@homanp
Copy link
Contributor

@homanp homanp commented Feb 5, 2026

What

This PR introduces an npm package (@superagent/sus) to allow JavaScript developers to install the sus CLI tool via npm.

Why

To simplify the installation process for sus within JavaScript projects, providing a standard and convenient way to distribute pre-built binaries for supported platforms (Linux/macOS, x64/arm64).

Test plan

  • Tests pass locally
  • Tested manually

Open in Cursor Open in Web

- Add package.json with @superagent/sus npm package configuration
- Create postinstall.js script to download platform-specific binaries from GitHub releases
- Add bin/sus.js wrapper to execute the sus binary from npm
- Add .npmignore to exclude unnecessary files from npm package
- Update README.md with npm installation instructions
- Add LICENSE file (MIT)
- Add NPM_PUBLISHING.md guide for maintainers

This enables JavaScript developers to install sus via:
  npm install -g @superagent/sus

The postinstall script automatically downloads the appropriate binary
for the user's platform (Linux/macOS, x64/arm64) from GitHub releases.

Co-authored-by: Ismail Pelaseyed <homanp@users.noreply.github.com>
@cursor
Copy link

cursor bot commented Feb 5, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@homanp
Copy link
Contributor Author

homanp commented Feb 5, 2026

@cursoragent can we just call it sus?

@cursor
Copy link

cursor bot commented Feb 5, 2026

Done! I've renamed the npm package from @superagent/sus to just sus. This makes it much simpler and more memorable:

Before:

npm install -g @superagent/sus

Now:

npm install -g sus

The changes include:

  • Updated package.json to use the unscoped package name sus
  • Updated README.md with the simpler installation commands
  • Updated NPM_PUBLISHING.md to remove references to scoped packages and the --access public flag

All changes have been committed and pushed to the branch!

View PR

Open in Cursor Open in Web

Simplified package name for easier installation:
- npm install -g sus (instead of @superagent/sus)
- Updated README.md with simpler installation commands
- Updated NPM_PUBLISHING.md to reflect unscoped package

Co-authored-by: Ismail Pelaseyed <homanp@users.noreply.github.com>
@homanp homanp changed the title Npm module packaging chore: npm module packaging Feb 5, 2026
@homanp homanp marked this pull request as ready for review February 5, 2026 18:41
@homanp
Copy link
Contributor Author

homanp commented Feb 5, 2026

@cursoragent npm warn deprecated tar@6.2.1: Old versions of tar are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me

@cursor
Copy link

cursor bot commented Feb 5, 2026

Done! I've updated the tar dependency from ^6.2.0 to ^7.5.7 (the latest version) to address the security vulnerabilities mentioned in the deprecation warning. This ensures the package uses a secure, up-to-date version of tar for extracting the downloaded binaries.

The change has been committed and pushed to the branch.

View PR

Open in Cursor Open in Web

cursoragent and others added 2 commits February 5, 2026 18:44
Resolves npm deprecation warning about tar@6.2.1 security issues

Co-authored-by: Ismail Pelaseyed <homanp@users.noreply.github.com>
The name 'sus' is taken on npm. Using 'sus-pm' to match the domain.
Binary command remains 'sus' via the bin field.
@homanp homanp linked an issue Feb 5, 2026 that may be closed by this pull request
@homanp homanp self-assigned this Feb 5, 2026
@homanp homanp merged commit 17a141a into main Feb 5, 2026
5 checks passed
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.

[Feature]: Add support for npm install command

2 participants

Comments