Skip to content

Help for plugin commands #534

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

Merged
merged 2 commits into from
Jun 9, 2015
Merged

Help for plugin commands #534

merged 2 commits into from
Jun 9, 2015

Conversation

Fatme
Copy link
Contributor

@Fatme Fatme commented Jun 8, 2015

No description provided.

@ns-bot
Copy link

ns-bot commented Jun 8, 2015

@Fatme
Copy link
Contributor Author

Fatme commented Jun 8, 2015

ping @ikoevska

[library](library.html) | You must run the library command with a related command.
[plugin](plugin.html) | You must run the plugin command with a related command.
[plugin add](plugin-add.html) | Installs a plugin and any packages that it depends on.
<% } %>
Copy link
Contributor

Choose a reason for hiding this comment

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

you have closing }, but there's no opening tag, this will cause build failure

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, the opening isHtml check is missing before Related Commands.

@Fatme Fatme force-pushed the fatme/help-for-plugin-commands branch from 18d7772 to 2e3895c Compare June 8, 2015 13:15
@ns-bot
Copy link

ns-bot commented Jun 8, 2015

@@ -0,0 +1,28 @@
plugin add
Copy link
Contributor

Choose a reason for hiding this comment

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

plugin add
==========

Usage | Synopsis
------|-------
General | `$ tns plugin add <Plugin>`

<% if(isConsole) { %>Installs the specified plugin and any packages that it depends on.<% } %>  
<% if(isHtml) { %>Installs the specified plugin and its dependencies in the local `node_modules` folder, adds it to the `dependencies` section in `package.json`, and prepares the plugin for all installed platforms. For more information about working with plugins, see [NativeScript Plugins](https://github.com/NativeScript/nativescript-cli/PLUGINS.md).<% } %>

### Attributes

* `<Plugin>` is a valid NativeScript plugin, specified by any of the following.
    * A `<Name>` or `<Name>@<Version>` where `<Name>` is the name of a plugin that is published in the npm registry and `<Version>` is a valid version of this plugin.
    * A `<Local Path>` to the directory which contains the plugin, including its `package.json` file.
    * A `<Local Path>` to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
    * A `<URL>` which resolves to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
    * A `<git Remote URL>` which resolves to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.

<% if(isHtml) { %>
### Prerequisites

* Verify that the plugin that you want to add contains a valid `package.json` file. Valid `package.json` files contain a `nativescript` section.

### Related Commands

Command | Description
----------|----------
[library](library.html) | You must run the library command with a related command.
[library add](library-add.html) | Adds a native library to the current project.
[plugin](plugin.html) | Lists all installed plugins for your project or lets you manage the plugins for your project.
[plugin remove](plugin-remove.html) | Uninstalls the specified plugin and its dependencies.
<% } %>

@ikoevska
Copy link
Contributor

ikoevska commented Jun 8, 2015

Note that index.md also needs to be changed - you need to add the following entry:

[plugin](plugin.html) | Lists all installed plugins for your project or lets you manage the plugins for your project.

@Fatme Fatme force-pushed the fatme/help-for-plugin-commands branch from 2e3895c to 6121dcb Compare June 8, 2015 15:19
@ns-bot
Copy link

ns-bot commented Jun 8, 2015

@Fatme Fatme force-pushed the fatme/help-for-plugin-commands branch from 6121dcb to b08a565 Compare June 8, 2015 15:20
@ns-bot
Copy link

ns-bot commented Jun 8, 2015

@Fatme Fatme force-pushed the fatme/help-for-plugin-commands branch from b08a565 to 1246860 Compare June 9, 2015 07:04
@ns-bot
Copy link

ns-bot commented Jun 9, 2015

@ikoevska
Copy link
Contributor

ikoevska commented Jun 9, 2015

👍 I will fix plugins.md in a separate PR

Fatme pushed a commit that referenced this pull request Jun 9, 2015
@Fatme Fatme merged commit 9e48db9 into release Jun 9, 2015
@Fatme Fatme deleted the fatme/help-for-plugin-commands branch June 9, 2015 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants