feat(cli): defined proper config for a cli project

Author: travi

src/config-scaffolder.js

@@ -17,7 +17,10 @@ export default async function ({projectRoot, dialect, projectType}) {
     `${projectRoot}/rollup.config.${(determineExtensionFor({dialect}))}`,
     mustache.render(
       await fs.readFile(resolve(__dirname, '..', 'templates', 'rollup.config.mustache'), 'utf-8'),
-      {dualMode: dialect !== dialects.ESM}
+      {
+        dualMode: dialect !== dialects.ESM,
+        cli: projectTypes.CLI === projectType
+      }
     )
   );
 

src/config-scaffolder.test.js

@@ -24,15 +24,15 @@ describe('config scaffolder', () => {
 
   it('should generate the file and determine additional plugins', async () => {
     const dialect = any.word();
-    when(mustache.render).calledWith(template, {dualMode: true}).mockReturnValue(renderedTemplate);
+    when(mustache.render).calledWith(template, {dualMode: true, cli: false}).mockReturnValue(renderedTemplate);
 
     expect(await scaffoldConfig({projectRoot, dialect})).toEqual({});
 
     expect(fs.writeFile).toHaveBeenCalledWith(`${projectRoot}/rollup.config.mjs`, renderedTemplate);
   });
 
   it('should use a `.js` extension for the config when the dialect is ESM', async () => {
-    when(mustache.render).calledWith(template, {dualMode: false}).mockReturnValue(renderedTemplate);
+    when(mustache.render).calledWith(template, {dualMode: false, cli: false}).mockReturnValue(renderedTemplate);
 
     await scaffoldConfig({projectRoot, dialect: dialects.ESM});
 
@@ -41,9 +41,11 @@ describe('config scaffolder', () => {
 
   it('should adjust for CLI projects', async () => {
     const dialect = any.word();
+    when(mustache.render).calledWith(template, {dualMode: true, cli: true}).mockReturnValue(renderedTemplate);
 
     expect(await scaffoldConfig({projectRoot, dialect, projectType: projectTypes.CLI})).toEqual({
       devDependencies: ['@rollup/plugin-json', 'rollup-plugin-executable']
     });
+    expect(fs.writeFile).toHaveBeenCalledWith(`${projectRoot}/rollup.config.mjs`, renderedTemplate);
   });
 });

templates/rollup.config.mustache

@@ -1,10 +1,17 @@
-import autoExternal from 'rollup-plugin-auto-external';
+import autoExternal from 'rollup-plugin-auto-external';{{#cli}}
+import json from '@rollup/plugin-json';
+import executable from 'rollup-plugin-executable';{{/cli}}
 
 export default {
   input: 'src/index.js',
-  plugins: [autoExternal()],
-  output: [{{#dualMode}}
+  plugins: [
+    autoExternal(){{#cli}},
+    json(),
+    executable(){{/cli}}
+  ],
+  output: [{{^cli}}{{#dualMode}}
     {file: 'lib/index.js', format: 'cjs', sourcemap: true},{{/dualMode}}
-    {file: 'lib/index.mjs', format: 'esm', sourcemap: true}
+    {file: 'lib/index.mjs', format: 'esm', sourcemap: true}{{/cli}}{{#cli}}
+    {file: 'bin/travi.js', format: 'esm', sourcemap: true, banner: '#!/usr/bin/env node'}{{/cli}}
   ]
 };

test/integration/features/cli.feature

@@ -5,3 +5,4 @@ Feature: Scaffold for a CLI project-type
     When the project is scaffolded
     Then dependencies are installed for a "CLI" project-type
     And the config is generated with an "mjs" extension
+    And an CLI bundle is generated

test/integration/features/step_definitions/config-steps.js

@@ -2,7 +2,7 @@ import {assert} from 'chai';
 import {promises as fs} from 'fs';
 import {Then} from '@cucumber/cucumber';
 
-import {autoExternal} from './dependencies-steps.js';
+import {autoExternal, pluginExecutable, pluginJson} from './dependencies-steps.js';
 
 Then('the config is generated with a(n) {string} extension', async function (extension) {
   this.config = await fs.readFile(`${process.cwd()}/rollup.config.${extension}`, 'utf-8');
@@ -15,7 +15,9 @@ Then('dual-mode bundles are generated', async function () {
 
 export default {
   input: 'src/index.js',
-  plugins: [autoExternal()],
+  plugins: [
+    autoExternal()
+  ],
   output: [
     {file: 'lib/index.js', format: 'cjs', sourcemap: true},
     {file: 'lib/index.mjs', format: 'esm', sourcemap: true}
@@ -32,11 +34,35 @@ Then('an ESM bundle is generated', async function () {
 
 export default {
   input: 'src/index.js',
-  plugins: [autoExternal()],
+  plugins: [
+    autoExternal()
+  ],
   output: [
     {file: 'lib/index.mjs', format: 'esm', sourcemap: true}
   ]
 };
 `
   );
 });
+
+Then('an CLI bundle is generated', async function () {
+  assert.equal(
+    this.config,
+    `import autoExternal from '${autoExternal}';
+import json from '${pluginJson}';
+import executable from '${pluginExecutable}';
+
+export default {
+  input: 'src/index.js',
+  plugins: [
+    autoExternal(),
+    json(),
+    executable()
+  ],
+  output: [
+    {file: 'bin/travi.js', format: 'esm', sourcemap: true, banner: '#!/usr/bin/env node'}
+  ]
+};
+`
+  );
+});

test/integration/features/step_definitions/dependencies-steps.js

@@ -4,6 +4,8 @@ import {Then} from '@cucumber/cucumber';
 import {assert} from 'chai';
 
 export const autoExternal = 'rollup-plugin-auto-external';
+export const pluginJson = '@rollup/plugin-json';
+export const pluginExecutable = 'rollup-plugin-executable';
 
 Then('dependencies are installed', async function () {
   const {devDependencies} = this.scaffoldResult;
@@ -16,8 +18,8 @@ Then('dependencies are installed for a {string} project-type', async function (p
   const {devDependencies} = this.scaffoldResult;
 
   if (projectTypes.CLI === projectType) {
-    assert.include(devDependencies, '@rollup/plugin-json');
-    assert.include(devDependencies, 'rollup-plugin-executable');
+    assert.include(devDependencies, pluginJson);
+    assert.include(devDependencies, pluginExecutable);
   }
 });