crxde-pipe

CLI

Install crxde-pipe from sources:

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

Run:

crxde-pipe path/to/project/src

Enable debugging:

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]           Regex for matching CQ path
    -i, --ignore [regex]          Regex for excluding files from watching
    -I, --interval [ms]           Interval of watching
    -s, --server [host:port]      CQ (CRXDE) server
    -d, --dispatcher [host:port]  Dispatcher server
    -P, --preprocess              Enables preprocessors

API

###Index

Modules

• crxde-pipe
  • crxde-pipe.pipe(paths, options)
• logger
  • logger.log
  • logger.error
  • logger.preproc
  • logger.update
  • logger.create
  • logger.remove
• preproc
  • preproc.isFileCanBePreproc
  • preproc.preproc

Classes

• class: CRXDE
  • new CRXDE([options])
  • cRXDE.pipe(paths, [options])
  • cRXDE.preproc(path)
  • cRXDE.add(path, type)
  • cRXDE.update(path, resource)
  • cRXDE.remove(path)
  • cRXDE.flush([path])

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
  • logger.error
  • logger.preproc
  • logger.update
  • logger.create
  • logger.remove

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

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

####logger.preproc app:preproc Target for logging preprocessing

####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)

###preproc Expose preprocessing functions

Members

• preproc
  • preproc.isFileCanBePreproc
  • preproc.preproc

####preproc.isFileCanBePreproc Checks if file could be preprocessed

Params

• path string - Path to file in file system

Returns: boolean
####preproc.preproc Runs preprocessing

Params

• path string - Path to file in file system

###class: CRXDE Members

• class: CRXDE
  • new CRXDE([options])
  • cRXDE.pipe(paths, [options])
  • cRXDE.preproc(path)
  • cRXDE.add(path, type)
  • cRXDE.update(path, resource)
  • cRXDE.remove(path)
  • cRXDE.flush([path])

####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__bak___|Thumbs.db$|ehthumbs.db$|Desktop.ini$|\$RECYCLE.BIN/
  • interval number - Watching interval. Default: 500
  • server Server - Server of CRXDE instance. Default: { host: 'localhost': port: 4502 }
  • dispatcher Server - Server of dispatcher instance. Needed for flushing a cache. Default: false
  • auth string - Authentication data for CRXDE instance. Default: admin:admin

####cRXDE.pipe(paths, [options]) Syncs files from source code to CQ (CRXDE)

Params

• paths Array - Watching paths
• [options] Object - Watching options

Returns: CRXDE
####cRXDE.preproc(path) Runs preprocessing

Params

• path string - Path to file in file system

####cRXDE.add(path, type) Uploads a new file to CQ (CRXDE)

Params

• path string - Path to file (relative to root)
• type string - Type of file (nt:file, nt:folder, etc.)

Returns: CRXDE
####cRXDE.update(path, resource) Updates a file on CQ (CRXDE)

Params

• path string - Path to file (relative to root)
• resource string - Path to file in file system

Returns: CRXDE
####cRXDE.remove(path) Removes a file from CQ (CRXDE)

Params

• path string - Path to file (relative to root)

Returns: CRXDE
####cRXDE.flush([path]) Flushes cache on CQ (CRXDE)

Params

• [path] string - Path to file (relative to root)

Returns: CRXDE
###type: Server Type: Object

documented by jsdoc-to-markdown