node-gradle / node-gradle/gradle-node-plugin
pnpm functionality is not documented
Nobody has claimed this yet.
- Dominant language
- Groovy
- Stars
- 677
- Forks
- 120
- PR merge metrics
- No merged PRs in 30d
Description
Hello,
I had to switch package manager from yarn to pnpm in one of my projects and it was bit confusing:
- pnpm is mentioned as supported in the README but then in the usage documentation: https://github.com/node-gradle/gradle-node-plugin/blob/main/docs/usage.md it is not mentioned
- I assumed pnpm would work like yarn as they are both external package managers, but they don't: yarn is always downloaded regardless if download is true or false, but pnpm is downloaded only if download=true
Small thing but bit confusing. I would send a pr but I am not sure what is the correct fix here, just documenting the pnpm functionality or aligning yarn and pnpm functionality (and if so should they respect the download setting or not)
Anyway thanks for an awesome opensource project!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the README with docs/usage.md, then verify the described pnpm behavior for the download setting in a small Gradle plugin project. Clarify the intended relationship between pnpm and yarn, and update the usage documentation to state the agreed behavior and configuration expectations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- groovy, nodejs
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100