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

feat(help): typos, add rdme version #493

Merged
merged 2 commits into from
Apr 14, 2022
Merged

feat(help): typos, add rdme version #493

merged 2 commits into from
Apr 14, 2022

Conversation

kanadgupta
Copy link
Member

๐Ÿงฐ Changes

lol... just discovered we spell "utility" wrong in the main help screen ๐Ÿ˜ฎโ€๐Ÿ’จ

$ rdme

                  ๐Ÿ“– rdme

    a utlity for interacting with ReadMe

This fixes that, and also adds the current rdme version to the help screen:

Options

  -h, --help       Display this usage guide               
  -v, --version    Show the current rdme version (v7.1.1) 

๐Ÿงฌ QA & Testing

Unfortunately this means I had to rip out a snapshot test in favor of a partial test, but if tests pass and the copy looks good, we should be good to go!

This means I had to remove some snapshot tests in favor of partial match testing... feels bad but don't really know how to test dynamic things like versions via snapshots ๐Ÿ˜ญ
@kanadgupta kanadgupta added the enhancement New feature or request label Apr 14, 2022
@kanadgupta kanadgupta requested review from a team, erunion, kellyjosephprice and emilyskuo and removed request for a team April 14, 2022 21:32
Copy link
Contributor

@kellyjosephprice kellyjosephprice left a comment

Choose a reason for hiding this comment

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

utlity is disrupting municipal payment systmes

@@ -9,7 +9,7 @@ describe('bin', () => {

await new Promise(done => {
exec(`node ${__dirname}/../bin/rdme`, (error, stdout) => {
expect(stdout).toContain('a utlity for interacting with ReadMe');
expect(stdout).toContain('a utility for interacting with ReadMe');
Copy link
Member

Choose a reason for hiding this comment

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

couldn't uodate the snapshot?

Copy link
Member Author

Choose a reason for hiding this comment

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

problem is that the snapshot contains the package version, and we'd have to update the snapshot for every bump and I couldn't think of an easy way to get around that

@kanadgupta kanadgupta merged commit fddb614 into main Apr 14, 2022
@kanadgupta kanadgupta deleted the default-screen-fixes branch April 14, 2022 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants