grunt-eiffel

Eiffel Grunt plugin

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

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

grunt.loadNpmTasks('grunt-eiffel');

The "compile" task

Overview

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

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

Options

options.ecf

Type: String
Default value: basename of the current working directory + .ecf

ECF file name.

options.target

Type: String
Default value: undefined

Target name.

Usage Examples

Default Options

In this example, the default options are used to compile an Eiffel project using EiffelStudio.

grunt.initConfig({
  compile: {
    ise: {}
  }
});

Custom Options

In this example, custom options are used to compile an Eiffel project using EiffelStudio. So if the ecf option has the content project.ecf and the target option has the content fcgi, the generated result in this case would be to compile the fcgi target using the ECF file project.ecf.

grunt.initConfig({
  compile: {
    ise: {
      options: {
        ecf: 'project.ecf',
        target: 'fcgi'
      }
    }
  }
});

The "estudio" task

Overview

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

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

Options

options.ecf

Type: String
Default value: basename of the current working directory + .ecf

ECF file name.

options.target

Type: String
Default value: undefined

Target name.

Usage Examples

Default Options

In this example, the default options are used to lauch EiffelStudio.

grunt.initConfig({
  estudio: {
    main: {}
  }
});

Custom Options

In this example, custom options are used to launch EiffelStudio. So if the ecf option has the content project.ecf and the target option has the content nino, the generated result in this case would be to launch EiffelStudio using nino as the target and project.ecf as the ECF file.

grunt.initConfig({
  estudio: {
    nino: {
      options: {
        ecf: 'project.ecf',
        target: 'nino'
      }
    }
  }
});

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)