get-alex / alex

Catch insensitive, inconsiderate writing
https://alexjs.com
MIT License
4.82k stars 207 forks source link

Add install instructions for yarn users #227

Closed ghost closed 6 years ago

ghost commented 6 years ago

Hey,

This is just a really small documentation change, but it basically just adds the command to install alex using yarn:

$ yarn global add alex

This might help new developers etc that use yarn at the recommendation of friends or colleagues, as npm can often be a bit tricky to understand πŸ™‚

ghost commented 6 years ago

Hey @wooorm, I'm a bit lost here. I can't seem to find any info about preferred markdown formatting etc and it seems to be rendering fine? πŸ™‚

Murderlon commented 6 years ago

@ItsPugle Check the output of npm run test, resolve the errors and commit them. Everything should be fine then :)

ghost commented 6 years ago

@Murderlon πŸ‘‹ I've looked through the test results, and I'm absolutely lost. I'm not proficient in Node.JS, let alone JavaScript, myself at all and the output for npm run test has no guidance towards any obvious thing that's the issue.

I'm really perplexed, since the only thing I've changed in the Markdown in README - nothing else.

Murderlon commented 6 years ago

I'm really perplexed, since the only thing I've changed in the Markdown in README

Yes, remark does stylistic markdown checking as well and deviating from the rules results in warnings.

These warning are currently failing the CI checks:

readme.md
  42:1-42:16  warning  Missing blank line before block node  no-missing-blank-lines  remark-lint
  43:1-45:4  warning  Missing blank line before block node  no-missing-blank-lines  remark-lint

Check the lines 42 and 43 locally, add blank lines, and npm run test again to see if everything passes.

codecov-io commented 6 years ago

Codecov Report

Merging #227 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #227   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           3      3           
  Lines          71     71           
=====================================
  Hits           71     71

Continue to review full report at Codecov.

Legend - Click here to learn more Ξ” = absolute <relative> (impact), ΓΈ = not affected, ? = missing data Powered by Codecov. Last update e28e161...50c6791. Read the comment docs.

ghost commented 6 years ago

Okay, I think I've gotten the hang of Node and might have resolved this πŸŽ‰ Thank you so much @Murderlon, I've never worked with using remark or Node (other than using it for global packages and once for playing around with dependencies)!

Murderlon commented 6 years ago

@ItsPugle congrats on landing your first PR in alex! πŸŽ‰

ghost commented 6 years ago

Thanks, I'm super happy I was able to help (even though it's such a small change) πŸ˜„