Grunt-dataset-shim NPM

grunt-dataset-shim

Replace .dataset object accesses in your JavaScript files with backwards-compatible Data.(set|get) calls.
Uses dataset-transpiler for translating dataset property accesses to get/set calls (which in turn, uses Esprima).

Getting Started

This plugin requires Grunt ~0.4.5

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-dataset-shim --save-dev

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

grunt.loadNpmTasks('grunt-dataset-shim');

The "dataset-shim" task

Overview

In your project's Gruntfile, add a section named dataset-dhim to the data object passed into grunt.initConfig().

grunt.initConfig({
  'dataset-shim': {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.runtime

Type: Boolean Default value: false

Prepend the runtime functions to the begining of the concatenated transpiled source?

options.runtimePrefix

Type: String Default value: "Data"

The name of the global runtime object to be used when transpiling dataset property accesses into RuntimePrefix.(get|set) calls.

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  'dataset-shim': {
    options: {},
    files: {
      'dest/out.js': ['src/one.js', 'src/two.js'],
    },
  },
});

Specifying no source will just generate a runtime file

In this example, custom options are used to do something else with whatever else. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result in this case would be Testing: 1 2 3 !!!

grunt.initConfig({
  'dataset-shim': {
    options: {
    },
    files: {
      'dest/dataset_runtime.js': [],
    },
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.1.1 - fixed taskname: dataset-shim (2015.01.16)
0.1.0 - initial release (2015.01.16)

9 years ago

9 years ago