Code Monkey home page Code Monkey logo

bs-compile-middleware's Introduction

bs-compile-middleware

Compilation middleware for Browsersync

Installation

npm install --save-dev bs-compile-middleware

Usage

In case of the following configuration, if you request to http://localhost:3000/index.html, bs-compile-middleware get path/to/src/index.pug and compile it. Finally, the compiled html is returned from the Browsersync server.

const browserSync = require('browser-sync').create()
const compileMiddleware = require('bs-compile-middleware').compileMiddleware

// any preprocessor you want to use
const pug = require('pug')

browserSync({
  server: true,
  middleware: compileMiddleware({
    srcDir: 'path/to/src',
    compilers: [
      {
        // a requested extention you want to hook some compilations
        reqExt: 'html',

        // source file extention
        srcExt: 'pug',

        // you can compile a requested source file in compile hook
        // It expects compiled data as return value
        // src - Buffer of the source file
        // filename - file name of the source
        compile: (src, filename) => {
          // example compiling pug
          return pug.render(src.toString(), { filename })
        }
      }
    ]
  })
})

Contribution

Feel free to open issues and pull requests if you find any bugs, want to add any features or so on.

License

MIT

bs-compile-middleware's People

Contributors

ktsn avatar yuheiy avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.