Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add install command #32

Merged
merged 4 commits into from
Feb 4, 2025
Merged

Feature: Add install command #32

merged 4 commits into from
Feb 4, 2025

Conversation

YonicDev
Copy link
Contributor

@YonicDev YonicDev commented Feb 2, 2025

Motivation

The add command on pnpm (pnpm add), when supplied on its own, does not act like in other package managers do.

  • For the other package managers, it acts as an alias to a package-less install command (i.e. installs all dependencies as defined in package.lock.json).
  • In pnpm, it causes a command syntax error.

This PR solves this issue by adding the install command, which has consistent behavior between package managers. It also allows for a more semantically accurate markdown syntax.

Usage

<PackageManagers type="install" />

Resulting commands:

npm install
yarn install
pnpm install
bun install
ni

Copy link

changeset-bot bot commented Feb 2, 2025

🦋 Changeset detected

Latest commit: 2342fee

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
starlight-package-managers Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Feb 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
starlight-package-managers ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 4, 2025 10:39am

Copy link
Owner

@HiDeoo HiDeoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super interesting, I don't think I've ever needed to document a pure install command but definitely a totally valid use case I missed.

Super thorough pull request, from code to tests and documentation. I only pushed a few nit pick changes, e.g. to update the changeset to follow the format I usually use and re-order some sections so we can release this right away.

Thanks a lot for your contribution 🙌

@HiDeoo HiDeoo merged commit 78ba376 into HiDeoo:main Feb 4, 2025
3 checks passed
@github-actions github-actions bot mentioned this pull request Feb 4, 2025
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.

2 participants