Skip to content

Latest commit

 

History

History
70 lines (55 loc) · 1.73 KB

README.md

File metadata and controls

70 lines (55 loc) · 1.73 KB
Raw

grunt-rsimulatorjs

Grunt plugin for rsimulatorjs-server

Getting Started

This plugin requires Grunt ~0.4.1

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-rsimulatorjs --save-dev

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

grunt.loadNpmTasks('grunt-rsimulatorjs');

The "rsimulatorjs" task

Overview

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

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

Options

options.simulator

Type: Object Default value: simulator: { port: 9005, rootPath: './mocked-rest-api', useRootRelativePath: true }

options.proxy

Type: Object Default value: proxy: { port : 9004, pathnameOnly : true, router : { '/service' : '127.0.0.1:' + 9005, '' : '127.0.0.1:' + 9001 } }

options.logLevel

Type: String Default value: debug
Levels: debug | info | error

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

(Nothing yet)