Open editor and used generated content in your grunt configuration.

Usage no npm install needed!

<script type="module">
  import gruntOpenEditor from '';



Open editor and use generated content in your grunt configuration.

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

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


The "open_editor" task


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

  open_editor: {
    options: {
      // Task-specific options go here.
    your_target: {
      // Target-specific file lists and/or options go here.



Type: String Default value: 'grunt-open-editor'

Temporary file prefix.


Type: String Default value: '.txt'

Temporary file suffix.


Type: String Default value: 'editor'

The variable inside the grunt configuration that should be used.


Type: Boolean Default value: false

If the previous editor content should be keeped when running the task again.


Type: String Default value: '.tmp/grunt-open-editor.txt'

If keepPrevious is set to true this is the filepath that is used for storing the content. The default value is concatinated by using the prefix and suffix values in the configuration.


Run the task and use the <%= editor %> (or the value defined in options.configVariable) grunt template variable some where in your configuration.


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)