grunt-editor

Open an editor as a grunt task

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

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

grunt.loadNpmTasks('grunt-editor');

The "editor" task

Overview

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

grunt.initConfig({
  'editor': {
    options: {
      // Task-specific options go here.
    },
    src: []
  },
});

Options

options.editor

Type: String Default value: process.env.VISUAL || process.env.EDITOR

A command to invoke an editor of your choice.

Usage Examples

Default Options

In this example, the default options are used to open an editor.

grunt.initConfig({
  'editor': {
    all: {
      options: {},
      src: ['files/*']
    }
  }
});

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.2.0 - update peerDependencies to support grunt 1.0
• 0.1.0 - initial functionality

License

(The MIT License)

Copyright 2014 Cameron Lakenen