Add ES module option.

README.md

@@ -54,6 +54,7 @@ This generator can also be further configured with the following command line fl
         --no-view        use static html instead of view engine
     -c, --css <engine>   add stylesheet <engine> support (less|stylus|compass|sass) (defaults to plain css)
         --git            add .gitignore
+        --es6            generate ES6 code and module-type project (requires Node 14.x or higher)
     -f, --force          force on non-empty directory
     -h, --help           output usage information
 

bin/express-cli.js

@@ -14,6 +14,7 @@ var MODE_0666 = parseInt('0666', 8)
 var MODE_0755 = parseInt('0755', 8)
 var TEMPLATE_DIR = path.join(__dirname, '..', 'templates')
 var VERSION = require('../package').version
+var MIN_ES6_VERSION = 14
 
 // parse args
 var unknown = []
@@ -26,7 +27,7 @@ var args = parseArgs(process.argv.slice(2), {
     H: 'hogan',
     v: 'view'
   },
-  boolean: ['ejs', 'force', 'git', 'hbs', 'help', 'hogan', 'pug', 'version'],
+  boolean: ['ejs', 'es6', 'force', 'git', 'hbs', 'help', 'hogan', 'pug', 'version'],
   default: { css: true, view: true },
   string: ['css', 'view'],
   unknown: function (s) {
@@ -93,9 +94,10 @@ function createApplication (name, dir, options, done) {
   var pkg = {
     name: name,
     version: '0.0.0',
+    type: options.es6 ? 'module' : 'commonjs',
     private: true,
     scripts: {
-      start: 'node ./bin/www'
+      start: options.es6 ? 'node ./bin/www.js' : 'node ./bin/www'
     },
     dependencies: {
       debug: '~2.6.9',
@@ -110,6 +112,10 @@ function createApplication (name, dir, options, done) {
   // App name
   www.locals.name = name
 
+  // App module type
+  app.locals.es6 = options.es6
+  www.locals.es6 = options.es6
+
   // App modules
   app.locals.localModules = Object.create(null)
   app.locals.modules = Object.create(null)
@@ -160,7 +166,9 @@ function createApplication (name, dir, options, done) {
 
   // copy route templates
   mkdir(dir, 'routes')
-  copyTemplateMulti('js/routes', dir + '/routes', '*.js')
+  copyTemplateMulti(
+    options.es6 ? 'mjs/routes' : 'js/routes',
+    dir + '/routes', '*.js')
 
   if (options.view) {
     // Copy view templates
@@ -286,7 +294,7 @@ function createApplication (name, dir, options, done) {
   write(path.join(dir, 'app.js'), app.render())
   write(path.join(dir, 'package.json'), JSON.stringify(pkg, null, 2) + '\n')
   mkdir(dir, 'bin')
-  write(path.join(dir, 'bin/www'), www.render(), MODE_0755)
+  write(path.join(dir, options.es6 ? 'bin/www.js' : 'bin/www'), www.render(), MODE_0755)
 
   var prompt = launchedFromCmd() ? '>' : '$'
 
@@ -433,6 +441,10 @@ function main (options, done) {
     usage()
     error('option `-v, --view <engine>\' argument missing')
     done(1)
+  } else if (options.es6 && process.versions.node.split('.')[0] < MIN_ES6_VERSION) {
+    usage()
+    error('option `--es6\' requires Node version ' + MIN_ES6_VERSION + '.x or higher')
+    done(1)
   } else {
     // Path
     var destinationPath = options._[0] || '.'
@@ -521,6 +533,7 @@ function usage () {
   console.log('        --no-view        use static html instead of view engine')
   console.log('    -c, --css <engine>   add stylesheet <engine> support (less|stylus|compass|sass) (defaults to plain css)')
   console.log('        --git            add .gitignore')
+  console.log('        --es6            generate ES6 code and module-type project (requires Node 14.x or higher)')
   console.log('    -f, --force          force on non-empty directory')
   console.log('    --version            output the version number')
   console.log('    -h, --help           output usage information')

templates/js/app.js.ejs

@@ -1,3 +1,20 @@
+<% if (es6) { -%>
+<% if (view) { -%>
+import createError from 'http-errors';
+<% } -%>
+import express from 'express';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+<% Object.keys(modules).sort().forEach(function (variable) { -%>
+import <%- variable %> from '<%- modules[variable] %>';
+<% }); -%>
+
+<% Object.keys(localModules).sort().forEach(function (variable) { -%>
+import <%- variable %> from '<%- localModules[variable] %>.js';
+<% }); -%>
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+<% } else { -%>
 <% if (view) { -%>
 var createError = require('http-errors');
 <% } -%>
@@ -10,8 +27,9 @@ var <%- variable %> = require('<%- modules[variable] %>');
 <% Object.keys(localModules).sort().forEach(function (variable) { -%>
 var <%- variable %> = require('<%- localModules[variable] %>');
 <% }); -%>
+<% } -%>
 
-var app = express();
+<%- es6 ? 'const' : 'var' %> app = express();
 
 <% if (view) { -%>
 // view engine setup
@@ -32,12 +50,12 @@ app.use(<%= mount.path %>, <%- mount.code %>);
 
 <% if (view) { -%>
 // catch 404 and forward to error handler
-app.use(function(req, res, next) {
+app.use(<%- es6 ? '' : 'function' %>(req, res, next)<%- es6 ? ' =>' : '' %> {
   next(createError(404));
 });
 
 // error handler
-app.use(function(err, req, res, next) {
+app.use(<%- es6 ? '' : 'function' %>(err, req, res, next)<%- es6 ? ' =>' : '' %> {
   // set locals, only providing error in development
   res.locals.message = err.message;
   res.locals.error = req.app.get('env') === 'development' ? err : {};
@@ -48,4 +66,8 @@ app.use(function(err, req, res, next) {
 });
 
 <% } -%>
+<% if (es6) { -%>
+export default app;
+<% } else { -%>
 module.exports = app;
+<% } -%>

templates/js/www.ejs

@@ -4,22 +4,29 @@
  * Module dependencies.
  */
 
+<% if (es6) { -%>
+import app from '../app.js';
+import http from 'node:http';
+import debugFunction from 'debug';
+const debug = debugFunction('<%- name %>:server');  
+<% } else { -%>
 var app = require('../app');
 var debug = require('debug')('<%- name %>:server');
 var http = require('http');
+<% } -%>
 
 /**
  * Get port from environment and store in Express.
  */
 
-var port = normalizePort(process.env.PORT || '3000');
+<%- es6 ? 'const' : 'var' %> port = normalizePort(process.env.PORT || '3000');
 app.set('port', port);
 
 /**
  * Create HTTP server.
  */
 
-var server = http.createServer(app);
+<%- es6 ? 'const' : 'var' %> server = http.createServer(app);
 
 /**
  * Listen on provided port, on all network interfaces.
@@ -34,7 +41,7 @@ server.on('listening', onListening);
  */
 
 function normalizePort(val) {
-  var port = parseInt(val, 10);
+  <%- es6 ? 'const' : 'var' %> port = parseInt(val, 10);
 
   if (isNaN(port)) {
     // named pipe
@@ -58,7 +65,7 @@ function onError(error) {
     throw error;
   }
 
-  var bind = typeof port === 'string'
+  <%- es6 ? 'const' : 'var' %> bind = typeof port === 'string'
     ? 'Pipe ' + port
     : 'Port ' + port;
 
@@ -82,8 +89,8 @@ function onError(error) {
  */
 
 function onListening() {
-  var addr = server.address();
-  var bind = typeof addr === 'string'
+  <%- es6 ? 'const' : 'var' %> addr = server.address();
+  <%- es6 ? 'const' : 'var' %> bind = typeof addr === 'string'
     ? 'pipe ' + addr
     : 'port ' + addr.port;
   debug('Listening on ' + bind);

templates/mjs/routes/index.js

@@ -0,0 +1,9 @@
+import express from 'express';
+const router = express.Router();
+
+/* GET home page. */
+router.get('/', (req, res, next) => {
+  res.render('index', { title: 'Express' });
+});
+
+export default router;

templates/mjs/routes/users.js

@@ -0,0 +1,9 @@
+import express from 'express';
+const router = express.Router();
+
+/* GET users listing. */
+router.get('/', (req, res, next) => {
+  res.send('respond with a resource');
+});
+
+export default router;

test/cmd.js

@@ -17,6 +17,7 @@ var BIN_PATH = path.resolve(path.dirname(PKG_PATH), require(PKG_PATH).bin.expres
 var NPM_INSTALL_TIMEOUT = 300000 // 5 minutes
 var STDERR_MAX_BUFFER = 5 * 1024 * 1024 // 5mb
 var TEMP_DIR = utils.tmpDir()
+var MIN_ES6_VERSION = 14
 
 describe('express(1)', function () {
   after(function (done) {
@@ -66,6 +67,7 @@ describe('express(1)', function () {
       assert.strictEqual(contents, '{\n' +
         '  "name": "express-1-no-args",\n' +
         '  "version": "0.0.0",\n' +
+        '  "type": "commonjs",\n' +
         '  "private": true,\n' +
         '  "scripts": {\n' +
         '    "start": "node ./bin/www"\n' +
@@ -484,6 +486,143 @@ describe('express(1)', function () {
     })
   })
 
+  describe('--es6', function () {
+    var ctx = setupTestEnvironment(this.fullTitle())
+
+    if (process.versions.node.split('.')[0] < MIN_ES6_VERSION) {
+      it('should exit with code 1', function (done) {
+        runRaw(ctx.dir, ['--es6'], function (err, code, stdout, stderr) {
+          if (err) return done(err)
+          assert.strictEqual(code, 1)
+          done()
+        })
+      })
+
+      it('should print usage and error message', function (done) {
+        runRaw(ctx.dir, ['--es6'], function (err, code, stdout, stderr) {
+          if (err) return done(err)
+          assert.ok(/Usage: express /.test(stdout))
+          assert.ok(/--help/.test(stdout))
+          assert.ok(/--version/.test(stdout))
+          var reg = RegExp('error: option `--es6\' requires Node version ' + MIN_ES6_VERSION)
+          assert.ok(reg.test(stderr))
+          done()
+        })
+      })
+    } else {
+      it('should create basic app', function (done) {
+        run(ctx.dir, ['--es6'], function (err, stdout, warnings) {
+          if (err) return done(err)
+          ctx.files = utils.parseCreatedFiles(stdout, ctx.dir)
+          ctx.stdout = stdout
+          ctx.warnings = warnings
+          assert.strictEqual(ctx.files.length, 16)
+          done()
+        })
+      })
+
+      it('should print jade view warning', function () {
+        assert.ok(ctx.warnings.some(function (warn) {
+          return warn === 'the default view engine will not be jade in future releases\nuse `--view=jade\' or `--help\' for additional options'
+        }))
+      })
+
+      it('should provide debug instructions', function () {
+        assert.ok(/DEBUG=express-1---es6:\* (?:& )?npm start/.test(ctx.stdout))
+      })
+
+      it('should have basic files', function () {
+        assert.notStrictEqual(ctx.files.indexOf('bin/www.js'), -1)
+        assert.notStrictEqual(ctx.files.indexOf('app.js'), -1)
+        assert.notStrictEqual(ctx.files.indexOf('package.json'), -1)
+      })
+
+      it('should have jade templates', function () {
+        assert.notStrictEqual(ctx.files.indexOf('views/error.jade'), -1)
+        assert.notStrictEqual(ctx.files.indexOf('views/index.jade'), -1)
+        assert.notStrictEqual(ctx.files.indexOf('views/layout.jade'), -1)
+      })
+
+      it('should have a package.json file with type "module"', function () {
+        var file = path.resolve(ctx.dir, 'package.json')
+        var contents = fs.readFileSync(file, 'utf8')
+        assert.strictEqual(contents, '{\n' +
+          '  "name": "express-1---es6",\n' +
+          '  "version": "0.0.0",\n' +
+          '  "type": "module",\n' +
+          '  "private": true,\n' +
+          '  "scripts": {\n' +
+          '    "start": "node ./bin/www.js"\n' +
+          '  },\n' +
+          '  "dependencies": {\n' +
+          '    "cookie-parser": "~1.4.5",\n' +
+          '    "debug": "~2.6.9",\n' +
+          '    "express": "~4.17.1",\n' +
+          '    "http-errors": "~1.7.2",\n' +
+          '    "jade": "~1.11.0",\n' +
+          '    "morgan": "~1.10.0"\n' +
+          '  }\n' +
+          '}\n')
+      })
+
+      it('should have installable dependencies', function (done) {
+        this.timeout(NPM_INSTALL_TIMEOUT)
+        npmInstall(ctx.dir, done)
+      })
+
+      it('should export an express app from app.js', function (done) {
+        // Use eval since otherwise early Nodes choke on import reserved word
+        // eslint-disable-next-line no-eval
+        eval(
+          'const { pathToFileURL } = require("node:url");' +
+          'const file = path.resolve(ctx.dir, "app.js");' +
+          'import(pathToFileURL(file).href)' +
+          '.then(moduleNamespaceObject => {' +
+            'const app = moduleNamespaceObject.default;' +
+            'assert.strictEqual(typeof app, "function");' +
+            'assert.strictEqual(typeof app.handle, "function");' +
+            'done();' +
+          '})' +
+          '.catch(reason => done(reason))'
+        )
+      })
+
+      describe('npm start', function () {
+        before('start app', function () {
+          this.app = new AppRunner(ctx.dir)
+        })
+
+        after('stop app', function (done) {
+          this.timeout(APP_START_STOP_TIMEOUT)
+          this.app.stop(done)
+        })
+
+        it('should start app', function (done) {
+          this.timeout(APP_START_STOP_TIMEOUT)
+          this.app.start(done)
+        })
+
+        it('should respond to HTTP request', function (done) {
+          request(this.app)
+            .get('/')
+            .expect(200, /<title>Express<\/title>/, done)
+        })
+
+        it('should respond to /users HTTP request', function (done) {
+          request(this.app)
+            .get('/users')
+            .expect(200, /respond with a resource/, done)
+        })
+
+        it('should generate a 404', function (done) {
+          request(this.app)
+            .get('/does_not_exist')
+            .expect(404, /<h1>Not Found<\/h1>/, done)
+        })
+      })
+    }
+  })
+
   describe('--git', function () {
     var ctx = setupTestEnvironment(this.fullTitle())