Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    static-jade-brunchpublic

    build status

    static-jade-brunch

    Adds Jade support to brunch without wrapping the compiled html in modules of type commonjs/amd.

    With it you can get rid of index.html and use index.jade instead.

    If before the brunch compilation the directory structure is something like:

    app
    | assets
    | | font
    | | img
    | scripts
    | styles
    | partials
    | | presentation.jade
    | index.jade

    after the brunch build the content of app directory would be like:

    | assets
    | | font
    | | img
    | | partials
    | | | presentation.html
    | | index.html
    | scripts
    | styles
    | partials
    | | presentation.jade
    | index.jade

    and the content of the public/ directory:

    css
    | ...
    js
    | app.js
    | templates.js
    | vendor.js
    partials
    | presentatin.html
    index.html

    Usage

    Add "jade-brunch": "x.y.z" and "static-jade-brunch": "x.y.z" to package.json of your brunch app.

    Pick a plugin version that corresponds to your minor (y) brunch version.

    If you want to use git version of plugin, add:

    • "jade-brunch": "git+ssh://git@github.com:brunch/jade-brunch.git"
    • "static-jade-brunch": "git+ssh://git@github.com:ilkosta/static-jade-brunch.git"

    Useful convensions

    Brunch concatenates all your files in app/, test/ and vendor/ directories to two files by default:

    • app.js contains your application code.
    • vendor.js contains code of libraries you depend on (e.g. jQuery).

    To avoid the inclusion of compiled jade file in app.js by the jade-brunch plugin, is possible to add a template file handler that point to a different output file. Inside config.coffee:

    templates:
          joinTo:
            'js/templates.js': /.+\.jade$/

    The brunch compiler ignore each file starting with _ (underscore) and that is useful for the chunks of jade that are included or extended.

    The brunch compiler copy the content of the assets/ directory without recompile it. To permit others plugin (eg. auto-reload-brunch plugin) to manage the files generated by static-jade-brunch, all the generated files are placed inside the assets/ directory.

    Configuration Options

    The plugin can be configured to filter wich file to compile and to place in the assets directory, it can:

    • build only the files inside the directories that match a regular expression in the config.plugins.static_jade.path array. (best)
    • build only the files that end with the extension specified by config.plugins.static_jade.extension string.
    • place the output files in the relative path specified in asset option (app/assets by default). It can be useful when the project is using more assets directories (see config.conventions.assets)

    Config example:

      plugins:
        jade:
          options:          # can be added all the supported jade options 
            pretty: yes     # Adds pretty-indentation whitespaces to output (false by default) 
            compiler: funny # Compiler to replace jade's default 
                            # ... 
          locals:           # locals can be added 
            foo: 'jade is cool'
        static_jade:                        # all optionals 
          extension:  ".static.jade"        # static-compile each file with this extension in `assets` 
          path:       [ /app(\/|\\)docs/ ]  # static-compile each file in this directories 
          asset:      "app/jade_asset"      # specify the compilation output 

    but is supported this configuration too (for backwards compatibility):

      plugins:
        jade:
          pretty: yes # Adds pretty-indentation whitespaces to output (false by default) 
        static_jade:                        # all optionals 
          extension:  ".static.jade"        # static-compile each file with this extension in `assets` 
          path:       [ /app(\/|\\)docs/ ]  # static-compile each file in this directories 
          asset:      "app/jade_asset"     # specify the compilation output 

    help?

    If in doubt, you can play with the project static-jade-brunch-bootstrap

    License

    Copyright (c) 2012 "ilkosta" Costantino Giuliodori.

    Licensed under the MIT license.

    Keywords

    none

    install

    npm i static-jade-brunch

    Downloadsweekly downloads

    12

    version

    2.7.0

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar