urequire-rc-teacup-js

Introduction

uRequire ResourceConverter that converts each *.teacup to a *.js module, automagically importing teacup exported keys (i.e. no need to {head, body, div, ..} = teacup).

Also it decorates your exported function with a renderable, which never harms!

Each template is treated as a Module (that exports a simple function) and can participate like all other modules in the bundle.

Teacup modules can be written in 'coffee-script', but also 'coco', 'LiveScript', 'iced-coffee-script' via the compiler option.

Note: teacup dependency must be available when you invoke the .js exported function in your package.

Install

    $ npm install urequire-rc-teacup-js --save

Authoring

Each template/module source must be a nodejs module that module.exports = (...)-> a single template Function.

Assuming file 'persons.teacup' :

    module.exports = (names)-> ul -> li name for name in names

and 'home.teacup' :

    persons = require './persons'

    module.exports = (greeting = "Mars...! Its seems no args were passed.")->
      doctype 'html'
      html ->
        body ->
          div '#Hello, ',-> greeting
          persons ['Leonardo', 'Da Vinci']

Note there's no need to import any teacup keys as vars, eg {div, body} = teacup etc - they are imported by urequire-rc-teacup-js

How to use (in your uRequire config)

To convert all .teacup files in your 'path' a corresponding .js module in your 'dstPath'.

    resources: [ ..., `teacup-js` , ...]

Limit imported tags

If you want to limit which tags get imported as variables from teacup, use the tags option:

    resources: [
        ...
        [ 'teacup-js', tags: 'html, doctype, body, div, ul, li' ]
        ...
    ]

Use a different language compiler

You can use options.compiler which defaults to 'coffee-script', but also can also be 'coco', 'LiveScript' or 'iced-coffee-script'.

    resources: [ `teacup-js`, compiler: 'coco' ]

Note these extra compilers are NOT in the dependencies, you need to npm install them in your project.

Convert to HTML

To convert them all to .html as well, use teacup-js2html.

    resources: [ ..., `teacup-js` , 'teacup-js2html'...]

License

The MIT License

Copyright (c) 2014 Agelos Pikoulas ([email protected])

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.