grunt-fs-inline

grunt-fs-inline

This plugin enables you to use brfs without browserify. It's useful if you just want to inline external files like glsl shader code in some of your JavaScript files.

Getting Started

This plugin requires Grunt >= 0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-fs-inline --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks("grunt-fs-inline");

Usage

Directories will be created if they don't exist.

fsinline: {
  taskA: {
    src: "src/a.js",
    dest: "src/a.inlined.js"
  },
  taskB: {
    src: "src/b.js",
    dest: "src/sub/dir/b.inlined.js"
  },
  ...
}

Options

Besides the brfs specific options, you may also provide strings that should be appended to the inlined files.

fsinline: {
  options: {
    // Global options.
    brfs: {
      n: 5,
      foo: function(x) { return x * 100; },
      obj: {x: {y: 666}}
    },
    append: "/** my footer or code snippet **/"
  },
  taskA: {
    options: {
      // Local options.
      brfs: { ... },
      append: ""
    },
    src: "src/*/a.js",
    dest: "**/a.inlined.js"
  }
}

Contributing

Maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

License

Zlib