flamingo-carotene-pug
Provide the pug compiler used in a setup using the flamingo.me/pugtemplate render engine with integration into the flamingo-carotene-dev-server module
Last updated a month ago by benjamin.egner .
OSL-3.0 · Repository · Original npm · Tarball · package.json
$ cnpm install flamingo-carotene-pug 
SYNC missed versions from official npm registry.

Module flamingo-carotene-pug

The pug module compiles the pug templates in a Flamingo Carotene project. It takes all the files defined by a glob pattern and saves the AST (abstract syntax tree) compilation to the configured dist folder.

The Flamingo framework will then take care of rendering these AST files to HTML.

How to use

npm i -D flamingo-carotene-pug

The pug module will listen to the following commands: buildTemplates, build, watchPug.

How it works

A child process will be opened to execute the compilation of the pug files and store the AST to the configured dist location.

How to configure

This module exposes the following config

config.paths.pug = {
  fileMode: 'ast',
  src: path.join(config.paths.src, 'page'),
  dist: path.join(config.paths.dist, 'template', 'page')
}

ast Target filemode. 'ast' and 'html' is supported.

  • 'ast' Renders a JSON-AST representation of the pug file (default)
  • 'html' Renders HTML

src Path to the pug source files

dist Path to the AST files

config.pug = {
  filesPattern: '/{*,.,*/page/*}/{.,*,*/*.partial}/*.pug',
  buildCallback: null || function,
  useRelativeSrc: false,
  breakOnError: false
}

filesPattern Glob pattern to find the files inside the src path

useRelativeSrc If set to true, the compiled files will be stored to 'paths.pug.dist' relative to its sourc.

Example:

config.paths.src = '/foo' config.paths.pug.src = '/foo/pugPages' config.paths.pug.dist = '/htdocs'

useRelativeSrc = FALSE

a template called "index" will be stored into '/htdocs/pugPages' a template called "test/index" will be stored into '/htdocs/pugPages/test'

useRelativeSrc = TRUE

a template called "index" will be stored into '/htdocs' a template called "test/index" will be stored into '/htdocs/test'

buildCallback The callback function to execute when the template compilation was finished

breakOnError True to break the process when an error occurred, false to only write it to output. Will be set to true for production build automatically.

Current Tags

  • 6.7.0                                ...           latest (a month ago)

20 Versions

  • 6.7.0                                ...           a month ago
  • 6.5.22                                ...           4 months ago
  • 6.5.21                                ...           4 months ago
  • 6.5.17                                ...           6 months ago
  • 6.5.0                                ...           8 months ago
  • 6.3.1                                ...           a year ago
  • 6.3.0                                ...           a year ago
  • 6.2.17                                ...           a year ago
  • 6.2.16                                ...           a year ago
  • 6.2.15                                ...           a year ago
  • 6.2.13                                ...           a year ago
  • 6.2.12                                ...           a year ago
  • 6.2.8                                ...           a year ago
  • 6.2.7                                ...           a year ago
  • 6.2.6                                ...           a year ago
  • 6.2.5                                ...           a year ago
  • 6.2.4                                ...           a year ago
  • 6.2.2                                ...           a year ago
  • 6.2.1                                ...           2 years ago
  • 6.2.0                                ...           2 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 20
Dependencies (4)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |