typescript-eslint / typescript-eslint/ts-api-utils
📝 Documentation: Add an npm2yarn equivalent for installation instructions in docs site
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 122
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
Bug Report Checklist
- I have pulled the latest
mainbranch of the repository. - I have searched for related issues and found none that matched my issue.
Overview
The three code blocks under Installation on the docs site are a lot of vertical space:
It'd be nice to use something like the popular @docusaurus/remark-plugin-npm2yarn to turn that into a single tabbed area. Accepting PRs!
Additional Info
An example of the npm2yarn plugin in the wild is on https://typescript-eslint.io/getting-started/#step-1-installation:
...though npm2yarn, as its name suggests, doesn't seem to support pnpm in that tab example. Maybe a new package needs to be made? Or a configuration option added somewhere?
I haven't found any TypeDoc plugin that does this (though admittedly I haven't looked very hard). I think finding an existing plugin would be the best solution, or if one doesn't exist creating it. That way other folks can benefit from this!
Contributor guide
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
Start at the docs site's Installation section and compare its current npm, yarn, and pnpm code blocks with the referenced npm2yarn example. Investigate whether an existing TypeDoc or npm2yarn-compatible solution supports pnpm; done means the installation instructions appear in one tabbed area without losing package-manager coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100