cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nikhilkh <...@git.apache.org>
Subject [GitHub] cordova-cli pull request: Update help docs - add examples and make...
Date Tue, 26 Jan 2016 20:49:20 GMT
Github user nikhilkh commented on a diff in the pull request:

    https://github.com/apache/cordova-cli/pull/232#discussion_r50897700
  
    --- Diff: doc/plugin.txt ---
    @@ -4,41 +4,49 @@ Synopsis
     
     Manage project plugins
     
    -    add <pluginid>|<directory>|<giturl> [...] ..... add specified plugins
    -                                                    pluginid will be matched in --searchpath
/ registry
    -                                                    directory is a directory containing
a plugin
    -                                                    giturl is a git repo containing a
plugin
    -
    -        [--searchpath <directory>] ................ when looking up plugins by
ID, look in this directory and
    -                                                    each of its subdirectories for the
plugin before hitting the registry.
    -                                                    Multiple search paths can be used
by either specifying the flag multiple
    -                                                    times, or by separating paths with
a delimiter (: on 'nix, ; on Windows).
    -
    -        [--noregistry] ............................ don't search the registry for plugins
    -
    -        [--link] .................................. when installing from a local path,
creates a symbolic link to the plugin
    -                                                    instead of copying files. The extent
to which files are linked vs copied
    -                                                    varies by platform. Useful for plugin
development.
    -        [--save] .................................. save the information for specified
plugin into config.xml
    -        [--shrinkwrap] ............................ used together with --save, saves
the installed version number to config.xml
    -
    -
    -
    -    remove <pluginid> [...] ....................... remove plugins with the given
IDs
    +    add <plugin-spec> [...] ............ Add specified plugins
    +        --searchpath <directory> ....... When looking up plugins by ID, look in
this directory and
    +                                         each of its subdirectories before hitting the
registry.
    +                                         Multiple search paths can be specified.
    +
    +        --noregistry ................... Don't search the registry for plugins
    +
    +        --link ......................... When installing from a local path, creates a
symbolic link 
    +                                         instead of copying files. The extent to which
files are linked
    +                                         varies by platform. Useful for plugin development.
    +        --save ......................... Save the information for specified plugin into
config.xml
    +        --shrinkwrap ................... Used together with --save, saves the 
    +                                         installed version numbers to config.xml
    +        --browserify ................... Compile plugin JS at build time using 
    +                                         browserify instead of runtime.
    +
    +    remove <pluginid>|<name> [...] ..... Remove plugins with the given IDs/name.
           
    -        [--save] ................................... remove the information for specified
plugin into config.xml
    +        --save ......................... Remove the information for specified plugin
into config.xml
    +
     
    +    list .............................. List currently installed plugins
    +    search [<keyword>] [...] .......... Search http://plugins.cordova.io for plugins
matching the keywords
    +    
    +Syntax
    +    <plugin-spec> : <pluginID>[@<version>]|<directory>|<url>[#<commit-ish>]
     
    -    list .......................................... list currently installed plugins
    -    search [<keyword>] [...] ...................... search the plugin registry
for plugins matching the keywords
    +    <plugin> .......................... Plugin id (id of plugin in npm registry
or --searchPath)
    +    <directory> ....................... Directory containing plugin.xml
    +    <url> ............................. Url to a git repository containing a plugin.xml
    +    <version> ......................... Major.minor.patch version specifier using
semver
    +    <commit-ish> ...................... Commit/tag reference. If none is specified,
'master' is used
     
    -aliases:
    +Aliases
         plugins -> plugin
         rm -> remove
         ls -> list
     
    -
    -Experimental Flags
    -
    -    --browserify .......................... Plugins javascript gets loaded at build time
instead of runtime using browserify.
    -                                            Replaces cordovajs file with one that includes
the JS of the installed plugins.
    +Examples
    --- End diff --
    
    Done!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

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


Mime
View raw message