Crxde-pipe NPM

crxde-pipe

CLI

Install crxde-pipe from sources:

$ git clone https://github.com/fortywinkz/crxde-pipe.git
$ cd crxde-pipe
$ npm install
$ npm link

or from npm:

$ npm install crxde-pipe -g

Also it is available as bower package:

$ bower install crxde-pipe

Run:

$ crxde-pipe path/to/project/src

Enable debugging:

$ DEBUG=* crxde-pipe path/to/project/src

or for windows users:

cmd /C "set DEBUG=* && crxde-pipe path/to/project/src"

Also you can specify debugging target:

$ DEBUG=app:error crxde-pipe path/to/project/src

For more information see docs and debug project

Options:

$ crxde-pipe -h

    Usage: crxde-pipe [options] <dir...>

    Options:

    -h, --help                    output usage information
    -V, --version                 output the version number
    -m, --match [regex]           pattern matching CRX root under your files
    -i, --ignore [regex]          pattern used to exclude files from the watch
    -I, --interval [ms]           indicate how often file system should be polled
    -s, --server [host:port]      locate where CRX repository is running
    -d, --dispatcher [host:port]  locate where Dispatcher is running

API

###Index

Modules

crxde-pipe
- crxde-pipe.pipe(paths, options)
logger

Classes

class: CRXDE

Typedefs

type: Server

###crxde-pipe Expose a single function to pipe source files to CQ (CRXDE)

####crxde-pipe.pipe(paths, options) Pipe source files to CQ (CRXDE)

Params

paths Array
options Object

Returns: CRXDE
###logger Expose logging targets

Members

logger

####logger.log app:log Target for base logging

####logger.debug app:debug Target for debugging

####logger.error app:error Target for logging errors

####logger.update crxde:update Target for logging updates of file on CQ (CRXDE)

####logger.create crxde:create Target for logging uploads of file to CQ (CRXDE)

####logger.remove crxde:remove Target for logging removal of file from CQ (CRXDE)

###class: CRXDE Members

class: CRXDE

####new CRXDE(options) Provides piping of source code to CQ (CRXDE)

Params

[options] Object - Watching options
- match RegExp - Matches root path of CQ files. Default: /jcr_root(.*)$/
- ignore RegExp - Matches files which will be ignored from watching. Default: /\.git|\.sass-cache|\.hg|\.idea|\.svn|\.cache|\.project|___jb.*___$|Thumbs\.db$|ehthumbs\.db$|Desktop.ini$|\$RECYCLE.BIN|\.xml|node_modules/
- interval number - Watching interval. Default: 500
- server Server - Server of CRXDE instance. Default: { protocol: 'http', hostname: 'localhost': port: 4502 }
- auth Object - Authentication data for CRXDE instance. Default: { user: 'admin', pass: 'admin' }