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

docs(local-usage): added instructions for local installation #50

Closed
wants to merge 1 commit into from

Conversation

travi
Copy link
Contributor

@travi travi commented Dec 5, 2019

Related Issue

based on conversation from form8ion/javascript-scaffolder#24 (comment)

happy to tie to an issue that is local to this project if you'd prefer

Motivation and Context

while this tool is useful as a global install or through npx, it can also be useful as a local install in combination with an npm script.

How Has This Been Tested?

i've wired it into the verification script for my personal site

Screenshots (if appropriate):

https://twitter.com/liran_tal/status/1202339318334930944 :)

Checklist:

  • I have updated the documentation (if required).
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I added a picture of a cute animal cause it's fun

@travi
Copy link
Contributor Author

travi commented Dec 5, 2019

i'm not fully sure that this grouping is the most clear, but seemed like the simplest first stab. happy to iterate if you have other ideas

@lirantal lirantal self-requested a review December 5, 2019 14:37
@lirantal lirantal added the documentation Improvements or additions to documentation label Dec 5, 2019
@lirantal
Copy link
Owner

lirantal commented Dec 5, 2019

@travi I think these specifically don't add much to the docs as I assume that anyone whose been using npm would know about npx, or do you feel this isn't the case?

@travi
Copy link
Contributor Author

travi commented Dec 5, 2019

I assume that anyone whose been using npm would know about npx

i think that is true, but the reverse did leave some questions in my mind about using it as a local script. with a global install or with npx from the terminal, you use a tool like this interactively and are mostly looking for readable output. with a script that is part of a build, exit code is most important and readable output is secondary. you are exiting non-zero, but i wasnt confident of that until i looked at the source code since the example was suggesting using through npx.

my goal with this was to highlight that it can be used both from the terminal and as a non-interactive script. i agree that having both may not do a great job at clarifying that. i'm ok leaving as is since i do agree that most that are comfortable with cli tools would at least be aware of what to look for.

@lirantal
Copy link
Owner

lirantal commented Dec 7, 2019

Yep, will leave it as-is.
Thanks @travi ❤️

@lirantal lirantal closed this Dec 7, 2019
@travi travi deleted the local-usage branch December 7, 2019 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants