A Grunt task to luanch an Express server for project testing
This plugin requires Grunt
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-edge-express --save-dev
In your project's Gruntfile, add a section named
express to the data object passed into
The port on which the express server will respond. The task will fail if the specified port is already in use. You can use the special values 0 or '?' to use a system-assigned port.
The hostname the express server will use.
String appended to the end of the
hostname:port URL, must start with a leading slash.
Location of the
server.js file used to include project specific express configuration rules.
Flag to determine if
stdout of server process will be displayed.
Please note that
baseURL are passed as options to your server configuration file defined at
configPath. Failing to provide option parsing and implementing injection of these options into your server configuration may result in issues or errors with your Express server.
It is recommended using modules such as nopt for option parsing within your server configuration file.
// include the nopt modulevar nopt = ;// get options based on a specific configuration// plase see for// additional usage examplesvar options =;// supply default values if option values are not presentvar port = optionsport || 3000hostname = optionshostname || 'localhost'baseURL = optionsbaseURL || '/';...// use in your server configuraitonserver;
In this example, an Express server instance will be setup based on the default configuraiton parameters.
In this example, custom options are used to configure the Express server with port
9000 and a base url of
/plugin. This produces a destination of
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.