CB-13342 : Updated README.md regarding package.json #27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
After reviewing the conversation from #24, I created this PR. Let me know if there's anything to change otherwise I can merge. @stevengill |
stevengill
suggested changes
Sep 29, 2017
README.md
Outdated
| @@ -62,6 +62,10 @@ Add a directory named `tests` to the root of your plugin. Within this directory, | |||
|
|
|||
| For example, the `cordova-plugin-device` plugin has this nested [`plugin.xml`](https://github.com/apache/cordova-plugin-device/blob/master/tests/plugin.xml). | |||
|
|
|||
| Create a `package.json` inside your project's `tests/` folder. The latest version of the tools ensure to run `npm install` on any plugin added to a project and pull in any dependencies. Therefore, plugin authors can now put npm dependencies around their tests into the `package.json` file. | |||
|
|
|||
| For example,the `cordova-plugin-device` plugin contains a [`package.json`](https://github.com/apache/cordova-plugin-device/blob/736c7b9dfdfa25a924ffc3d1e409450633a8c00f/tests/package.json). | |||
There was a problem hiding this comment.
can you replace this link with the master version. https://github.com/apache/cordova-plugin-device/blob/master/tests/package.json
README.md
Outdated
| @@ -62,6 +62,10 @@ Add a directory named `tests` to the root of your plugin. Within this directory, | |||
|
|
|||
| For example, the `cordova-plugin-device` plugin has this nested [`plugin.xml`](https://github.com/apache/cordova-plugin-device/blob/master/tests/plugin.xml). | |||
|
|
|||
| Create a `package.json` inside your project's `tests/` folder. The latest version of the tools ensure to run `npm install` on any plugin added to a project and pull in any dependencies. Therefore, plugin authors can now put npm dependencies around their tests into the `package.json` file. | |||
There was a problem hiding this comment.
Maybe before the second sentence, add a sentence about plugins requiring package.json now and tests are considered their own plugins.
|
Thanks for the feedback- made the updates! Let me know if there's anything else! @stevengill |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Platforms affected
What does this PR do?
Updated README.md regarding package.json
What testing has been done on this change?
Checklist