Nocturnal Parakeet Monitor

    fusile

    2.0.0 • Public • Published

    fusile

    NPM Version Linux Build Test Coverage Dependency Status devDependency Status Join the chat

    A web asset precompiling file system proxy. See the JSConf.eu talk: Transpiling Recomposed

    Mounts a fuse file system on a target directory, auto loads available compilers, compiles assets on request, caches compiled assets if source file is unmodified, watches original file for changes on demand.

    Turn your setup of custom configured transpiler plugins for all your different tools from this:

    +---------------+
    | Source.es6.js |  -+--> Transpiler --> Module loader --> Browser
    +---------------+   |
                        +--> Watcher --> Transpiler --> Livereload
                        |
                        +--> Transpiler --> Linter
                        |
                        +--> Transpiler --> Test runner
                        |
                        +--> Transpiler --> Build system
    

    into this:

    +---------------+      +--------------------------+
    | Source.es6.js |  --> | Source.transpiled.es6.js | -+--> Module loader --> Browser
    +---------------+      +--------------------------+  |
                                                         +--> Watcher --> Livereload
                                                         |
                                                         +--> Linter
                                                         |
                                                         +--> Test runner
                                                         |
                                                         +--> Build system
    

    Installation

    Prerequisites: Fuse

    npm install -g fusile
    

    Usage

    General usage: fusile <sourceDir> <mountPoint>

    Fusile is a compiling file system proxy. In order to get it to compile your assets you need to install one or more of these precompilers: LiveScript, babel-core, coco, coffee-script, dogescript, less, marked, myth, node-sass, stylus, swig

    When any of the above precompilers are available in the context of fusile (in your project root or globally installed), fusile will automatically load it and start compiling files with the corresponding file extension when you read the files from the mountpoint.

    Once you've mounted the new transpiled source directory, point your browser, web server, linter, test runner directly at the files in it, and you are ready to go.

    Project status

    Status: Fairly well tested. Need real world exposure. Feedback appreciated!

    Roadmap

    v1.x

    • Autoload installed transpilers
    • Asset compiling on demand
    • Intelligent caching of compiled assets
    • File watcher based cache busting (optional)
    • Autoprefixer
    • Sourcemaps
    • Compiled file extension rewriting to target extension
    • Isolate Accord transpiler autoloading into separate module

    v2.x

    • Expose a compile lifecycle callback to let people hook in their own pipeline
    • Configuration: Options for individual transpiler
    • Configuration: File extension / glob pattern to transpiler mapping
    • Detect compiled dir file watcher init events and proxy them through to source dir

    v3.x

    • Refactoring and documentation
    • Stability research and improvements
    • Performance research and improvements

    File watching

    General usage: fusile <sourceDir> <mountPoint> --watch "**/*.jsx" --watch "**/*.less" -w "**/*.stylus" -w "**/*.scss"

    You can add file watches to files in the Fusile mountpoint. Because Fusile can't yet pick up your file watchin events you will need to specify glob patterns like above, which will set up file watchers on the matching patterns.

    File watchers will be set up per individual file, and only at the time when you open a file for reading. This should ensure a miniumum amount of inode watches, and a minimum amount of recompiles.

    Note that watcher glob patterns are quoted to avoid shell expansion of the glob patterns at execution time.

    License

    MIT

    Install

    npm i fusile

    DownloadsWeekly Downloads

    12

    Version

    2.0.0

    License

    MIT

    Last publish

    Collaborators

    • munter