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

[Other]: Add a PackageManager component #1018

Open
amirhhashemi opened this issue Jan 10, 2025 · 1 comment
Open

[Other]: Add a PackageManager component #1018

amirhhashemi opened this issue Jan 10, 2025 · 1 comment
Labels
pending review Awaiting review by team members.

Comments

@amirhhashemi
Copy link
Contributor

amirhhashemi commented Jan 10, 2025

📋 Explain your issue

There are a lot of package-manager related instructions in the docs. For example, when a package needs to be installed we add tab like this:

image

The documentation for these is written manually, which results in a significant amount of boilerplate and inconsistency. For example, some sections do not include instructions for Deno or Bun, or both. Additionally, some parts instruct users to use pnpm add while others suggest pnpm install for installing packages with Pnpm.

Moreover, there is a lot of room for error due to wired Prettier behaviors.

I propose adding a component called PackageManager (or a similar name) that renders a tab with instructions for each package manager we want to support. The API could look like this:

<PackageManager command="install" args={["@solidjs/router", "@solidjs/meta"]} />
<PackageManager command="run" args={["dev"]} />

This approach ensures consistency and minimizes repetitive code.

Feel free to assign this to me if you’d like.

@amirhhashemi amirhhashemi added the pending review Awaiting review by team members. label Jan 10, 2025
@LadyBluenotes
Copy link
Member

Thank you for bringing this up - I'm going to bring this to the team and talk to them about it and I will update you with what we decide to do and if it's something you can assist with!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pending review Awaiting review by team members.
Projects
None yet
Development

No branches or pull requests

2 participants