crxde-pipe4

This project is not maintained anymore. Use aemsync instead.

clone of crxde-pipe https://www.npmjs.com/package/crxde-pipe with node 4+ support

crxde-pipe4

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

Modules

crxde-pipe

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

logger

Expose logging targets

Classes

CRXDE

Typedefs

Server : Object

crxde-pipe

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

crxde-pipe.pipe(paths, options) ⇒ CRXDE

Pipe source files to CQ (CRXDE)

Kind: static method of crxde-pipe

Param	Type
paths	Array
options	Object

logger

Expose logging targets

• logger
  • .log
  • .debug
  • .error
  • .update
  • .create
  • .remove

logger.log

app:log Target for base logging

Kind: static property of logger

logger.debug

app:debug Target for debugging

Kind: static property of logger

logger.error

app:error Target for logging errors

Kind: static property of logger

logger.update

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

Kind: static property of logger

logger.create

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

Kind: static property of logger

logger.remove

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

Kind: static property of logger

CRXDE

Kind: global class

• CRXDE
  • new CRXDE([options])
  • .update ⇒ CRXDE
  • .pipe(paths) ⇒ CRXDE
  • .add(jcrUrl, type) ⇒ CRXDE
  • .upload(jcrUrl, resource) ⇒ CRXDE
  • .remove(jcrUrl) ⇒ CRXDE

new CRXDE([options])

Provides piping of source code to CQ (CRXDE)

Param	Type	Description
[options]	Object	Watching options
options.match	RegExp	Matches root path of CQ files. Default: /jcr_root(.*)$/
options.ignore	RegExp	Matches files which will be ignored from watching. Default: `/.git
options.interval	number	Watching interval. Default: 500
options.server	Server	Server of CRXDE instance. Default: { protocol: 'http', hostname: 'localhost': port: 4502 }
options.auth	Object	Authentication data for CRXDE instance. Default: { user: 'admin', pass: 'admin' }

crxdE.update ⇒ CRXDE

Deprecated

Updates a file on CQ (CRXDE)

Kind: instance property of CRXDE

Param	Type	Description
jcrUrl	string	Path to file (relative to root)
resource	string	Path to file in file system

crxdE.pipe(paths) ⇒ CRXDE

Syncs files from source code to CQ (CRXDE)

Kind: instance method of CRXDE

Param	Type	Description
paths	Array	Watching paths

crxdE.add(jcrUrl, type) ⇒ CRXDE

Creates a new node in CQ (CRXDE)

Kind: instance method of CRXDE

Param	Type	Description
jcrUrl	string	Path to file (relative to root)
type	string	Type of file (nt:file, nt:folder, etc.)

crxdE.upload(jcrUrl, resource) ⇒ CRXDE

Uploads a file on CQ (CRXDE)

Kind: instance method of CRXDE

Param	Type	Description
jcrUrl	string	Path to file (relative to root)
resource	string	Path to file in file system

crxdE.remove(jcrUrl) ⇒ CRXDE

Removes a file from CQ (CRXDE)

Kind: instance method of CRXDE

Param	Type	Description
jcrUrl	string	Path to file (relative to root)

Server : Object

Kind: global typedef
Link: http://nodejs.org/api/url.html
Properties

Name	Type	Description
protocol	string	Server protocol
hostname	string	Hostname portion of server host
port	number	Port number portion of server host

documented by jsdoc-to-markdown