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

fix: inconsistency and grammar in help messages #22

Merged
merged 4 commits into from
Feb 29, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/bin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ function printHelp() {
Usage:
${
prettyPrintRow([
["jsr add @std/log", 'Install the "@std/log" package from jsr.io'],
["jsr remove @std/log", 'Remove the "@std/log" package from the project'],
["jsr add @std/log", 'Install the "@std/log" package from jsr.io.'],
["jsr remove @std/log", 'Remove the "@std/log" package from the project.'],
Copy link
Contributor

@rojvv rojvv Feb 29, 2024

Choose a reason for hiding this comment

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

Personal suggestion, feel free to ignore.

Suggested change
["jsr add @std/log", 'Install the "@std/log" package from jsr.io.'],
["jsr remove @std/log", 'Remove the "@std/log" package from the project.'],
["jsr add @std/log", "Install the package @std/log."],
["jsr remove @std/log", "Remove the package @std/log from the project."],

])
}

Commands:
${
prettyPrintRow([
["i, install, add", "Install one or more jsr packages"],
["r, uninstall, remove", "Remove one or more jsr packages"],
["i, install, add", "Install one or more jsr packages."],
["r, uninstall, remove", "Remove one or more jsr packages."],
Copy link
Contributor

Choose a reason for hiding this comment

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

We also need to figure out if the official casing is jsr or JSR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, thanks for spotting this. I checked the docs and it looks like the official casing is JSR, so this should be corrected as well.

Screenshot 2024-02-29 at 20 59 47

["publish", "Publish a package to the JSR registry."],
])
}
Expand Down Expand Up @@ -66,7 +66,7 @@ ${
prettyPrintRow([
[
"--token <Token>",
"The API token to use when publishing. If unset, interactive authentication is be used.",
"The API token to use when publishing. If unset, interactive authentication will be used.",
],
[
"--dry-run",
Expand All @@ -79,7 +79,7 @@ ${
Environment variables:
${
prettyPrintRow([
["JSR_URL", "Use a different registry url for the publish command"],
["JSR_URL", "Use a different registry url for the publish command."],
marvinhagemeister marked this conversation as resolved.
Show resolved Hide resolved
])
}
`);
Expand Down