Consistent usage of running pnpm and yarn scripts across documentation
#14173
trueberryless
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Domain knowledge
pnpmandyarnoffer two ways to run scripts from yourpackage.json:I will refer to the
runversion as "explicit variant". And I'll call the version withoutrun"short variant" within this discussion.Documentation for this is available for pnpm and yarn.
Proposal
I am proposing to consistently use either the explicit or short variant throughout all of Astro documentation to avoid confusion.
After discussion this initially with @ArmandPhilippot in this PR, I am strongly leaning toward using the explicit variant everywhere because of two reasons:
The reason I think the Astro docs would benefit from such a refactor is to avoid confusion because of the inconsistency.
The refactor also wouldn't even be as big as I initially expected.
Please let me know your opinions and takes on this in the comments.
Footnotes
I checked out
f8c0d55and used this RegEx:(pnpm|yarn)\s+(?!(?:add|exec|create|astro))(\S+)to go through all 124 occurrences and counted manually.These are the detailed results:
pnpmyarnPlease do not ask me why
pnpmoccurs one more time thanyarnin total 😅One interesting fact I noticed while counting is: The different variants often occur in the same files and not - as I would have expected - separated in different files. In other words: The inconsistencies happen within files, and can not be grouped by files. ↩
All reactions