You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by GitBox <gi...@apache.org> on 2019/05/09 20:40:08 UTC

[GitHub] [cordova-docs] oliversalzburg opened a new pull request #987: Prefer local cordova CLI with npx

oliversalzburg opened a new pull request #987: Prefer local cordova CLI with npx
URL: https://github.com/apache/cordova-docs/pull/987
 
 
   <!--
   Please make sure the checklist boxes are all checked before submitting the PR. The checklist is intended as a quick reference, for complete details please see our Contributor Guidelines:
   
   http://cordova.apache.org/contribute/contribute_guidelines.html
   
   Thanks!
   -->
   
   ### Platforms affected
   
   None
   
   ### Motivation and Context
   <!-- Why is this change required? What problem does it solve? -->
   <!-- If it fixes an open issue, please link to the issue here. -->
   
   See #838 for discussion about this change.
   
   ### Description
   <!-- Describe your changes in detail -->
   
   This changes the documentation to recommend using a project-local installation of `cordova`, instead of relying on a global installation.
   
   The thinking that went into this change was:
   
   - When a command or script is simply mentioned, to refer to the task it handles, no `npx` should **not** be prefixed.
   - If the given command is an example of invocation, `npx` should be prefixed.
   
   I tried to be consistent with this, hopefully, I didn't fail.
   
   I also tried to bring more consistency to syntax highlighting and prefixing CLI usages with `$`. I hope that wasn't completely out of scope for this change.
   
   ### Testing
   <!-- Please describe in detail how you tested your changes. -->
   
   
   
   ### Checklist
   
   - [ ] I've run the tests to see all new and existing tests pass
   - [ ] I added automated test coverage as appropriate for this change
   - [ ] Commit is prefixed with `(platform)` if this change only applies to one platform (e.g. `(android)`)
   - [ ] If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct [keyword to close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
   - [ ] I've updated the documentation if necessary
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org