Merge pull request #201 from form8ion/alpha

docs/api/scaffold.md

@@ -108,6 +108,11 @@ for defining [package-type plugin options](https://github.com/form8ion/awesome#p
 A [`choices` object](https://github.com/form8ion/javascript-core#choices-object-required)
 for defining monorepo-type plugin options
 
+### `packageBundlers` __object__ (_optional_)
+
+A [`choices` object](https://github.com/form8ion/javascript-core#choices-object-required)
+for defining package bundler options
+
 ### `unitTestFrameworks` __object__ (_required_)
 
 A [`choices` object](https://github.com/form8ion/javascript-core#choices-object-required)

src/options-validator-test.js

@@ -831,6 +831,7 @@ suite('options validator', () => {
           hosts: {},
           applicationTypes: {},
           packageTypes: {},
+          packageBundlers: {},
           registries: {}
         }
       );

src/prompts/question-names.js

@@ -2,6 +2,7 @@ export const questionNames = {
   UNIT_TEST_FRAMEWORK: 'unitTestFramework',
   NODE_VERSION_CATEGORY: 'nodeVersionCategory',
   PACKAGE_MANAGER: 'packageManager',
+  PACKAGE_BUNDLER: 'packageBundler',
   PROJECT_TYPE: 'projectType',
   PROJECT_TYPE_CHOICE: 'projectTypeChoice',
   SHOULD_BE_SCOPED: 'shouldBeScoped',

src/scaffolder/project-type/options-schemas-test.js

@@ -34,5 +34,9 @@ suite('project-type options validation', () => {
     test('that a provided bundler scaffolder is valid if an options object is provided', () => {
       validateOptions(packageBundlersSchema, {[key]: {scaffolder: options => options}});
     });
+
+    test('that an empty object is provided by default', async () => {
+      assert.deepEqual(validateOptions(packageBundlersSchema, undefined), {});
+    });
   });
 });

src/scaffolder/project-type/options-schemas.js

@@ -2,4 +2,4 @@ import * as joi from 'joi';
 
 export const packageBundlersSchema = joi.object().pattern(/^/, joi.object({
   scaffolder: joi.func().arity(1).required()
-}));
+})).default({});

src/scaffolder/project-type/package/build-details-test.js

@@ -1,7 +1,6 @@
 import {promises as fsPromises, promises as fs} from 'fs';
 import mustache from 'mustache';
-import {dialects, projectTypes} from '@form8ion/javascript-core';
-import * as rollupScaffolder from '@form8ion/rollup';
+import * as jsCore from '@form8ion/javascript-core';
 
 import {assert} from 'chai';
 import sinon from 'sinon';
@@ -11,6 +10,7 @@ import * as touch from '../../../../thirdparty-wrappers/touch';
 import * as mkdir from '../../../../thirdparty-wrappers/make-dir';
 import * as camelcase from '../../../../thirdparty-wrappers/camelcase';
 import * as templatePath from '../../../template-path';
+import * as bundlerPrompt from './prompt';
 import buildDetails from './build-details';
 
 suite('package build details', () => {
@@ -19,11 +19,13 @@ suite('package build details', () => {
   const projectName = any.word();
   const pathToExample = `${projectRoot}/example.js`;
   const pathToCreatedSrcDirectory = any.string();
-  const rollupResults = any.simpleObject();
+  const bundlerResults = any.simpleObject();
   const exampleContent = any.string();
   const pathToExampleTemplate = any.string();
   const exampleTemplateContent = any.string();
   const camelizedProjectName = any.word();
+  const packageBundlers = any.simpleObject();
+  const decisions = any.simpleObject();
 
   setup(() => {
     sandbox = sinon.createSandbox();
@@ -33,9 +35,10 @@ suite('package build details', () => {
     sandbox.stub(touch, 'default');
     sandbox.stub(mkdir, 'default');
     sandbox.stub(templatePath, 'default');
-    sandbox.stub(rollupScaffolder, 'scaffold');
+    sandbox.stub(jsCore, 'scaffoldChoice');
     sandbox.stub(mustache, 'render');
     sandbox.stub(camelcase, 'default');
+    sandbox.stub(bundlerPrompt, 'default');
 
     mkdir.default.withArgs(`${projectRoot}/src`).resolves(pathToCreatedSrcDirectory);
     templatePath.default.withArgs('example.mustache').returns(pathToExampleTemplate);
@@ -47,23 +50,25 @@ suite('package build details', () => {
   teardown(() => sandbox.restore());
 
   test('that common-js project is defined correctly', async () => {
-    assert.deepEqual(await buildDetails({dialect: dialects.COMMON_JS, projectRoot, projectName}), {});
+    assert.deepEqual(await buildDetails({dialect: jsCore.dialects.COMMON_JS, projectRoot, projectName}), {});
     assert.calledWith(fsPromises.writeFile, pathToExample, `const ${camelizedProjectName} = require('.');\n`);
     assert.calledWith(touch.default, `${projectRoot}/index.js`);
   });
 
   test('that a modern-js project is defined correctly', async () => {
-    const dialect = dialects.BABEL;
-    rollupScaffolder.scaffold
-      .withArgs({projectRoot, dialect, projectType: projectTypes.PACKAGE})
-      .resolves(rollupResults);
+    const dialect = jsCore.dialects.BABEL;
+    const chosenBundler = any.word();
+    bundlerPrompt.default.withArgs({bundlers: packageBundlers, decisions}).resolves(chosenBundler);
+    jsCore.scaffoldChoice
+      .withArgs(packageBundlers, chosenBundler, {projectRoot, dialect, projectType: jsCore.projectTypes.PACKAGE})
+      .resolves(bundlerResults);
 
-    const results = await buildDetails({dialect, projectRoot, projectName});
+    const results = await buildDetails({dialect, projectRoot, projectName, packageBundlers, decisions});
 
     assert.deepEqual(
       results,
       {
-        ...rollupResults,
+        ...bundlerResults,
         devDependencies: ['rimraf'],
         scripts: {
           clean: 'rimraf ./lib',
@@ -84,7 +89,7 @@ suite('package build details', () => {
     const packageName = any.word();
 
     const {badges} = await buildDetails({
-      dialect: dialects.BABEL,
+      dialect: jsCore.dialects.BABEL,
       projectRoot,
       projectName,
       packageName,

src/scaffolder/project-type/package/build-details.js

@@ -1,12 +1,12 @@
 import {promises as fs} from 'fs';
 import deepmerge from 'deepmerge';
 import mustache from 'mustache';
-import {dialects, projectTypes} from '@form8ion/javascript-core';
-import {scaffold as scaffoldRollup} from '@form8ion/rollup';
+import {dialects, projectTypes, scaffoldChoice as scaffoldChosenBundler} from '@form8ion/javascript-core';
 
 import camelcase from '../../../../thirdparty-wrappers/camelcase';
 import mkdir from '../../../../thirdparty-wrappers/make-dir';
 import touch from '../../../../thirdparty-wrappers/touch';
+import chooseBundler from './prompt';
 import determinePathToTemplateFile from '../../../template-path';
 
 const defaultBuildDirectory = 'lib';
@@ -30,18 +30,28 @@ async function buildDetailsForCommonJsProject({projectRoot, projectName}) {
   return {};
 }
 
-export default async function ({projectRoot, projectName, visibility, packageName, dialect}) {
+export default async function ({
+  projectRoot,
+  projectName,
+  visibility,
+  packageName,
+  packageBundlers,
+  dialect,
+  decisions
+}) {
   if (dialects.COMMON_JS === dialect) return buildDetailsForCommonJsProject({projectRoot, projectName});
 
+  const chosenBundler = await chooseBundler({bundlers: packageBundlers, decisions});
+
   const pathToCreatedSrcDirectory = await mkdir(`${projectRoot}/src`);
-  const [rollupResults] = await Promise.all([
-    scaffoldRollup({projectRoot, dialect, projectType: projectTypes.PACKAGE}),
+  const [bundlerResults] = await Promise.all([
+    scaffoldChosenBundler(packageBundlers, chosenBundler, {projectRoot, dialect, projectType: projectTypes.PACKAGE}),
     await createExample(projectRoot, projectName),
     touch(`${pathToCreatedSrcDirectory}/index.js`)
   ]);
 
   return deepmerge(
-    rollupResults,
+    bundlerResults,
     {
       devDependencies: ['rimraf'],
       scripts: {

src/scaffolder/project-type/package/prompt-test.js

@@ -0,0 +1,40 @@
+import inquirer from 'inquirer';
+import * as prompts from '@form8ion/overridable-prompts';
+import any from '@travi/any';
+import {assert} from 'chai';
+import sinon from 'sinon';
+import {questionNames} from '../../../prompts/question-names';
+import prompt from './prompt';
+
+suite('bundler prompt', () => {
+  let sandbox;
+
+  setup(() => {
+    sandbox = sinon.createSandbox();
+
+    sandbox.stub(prompts, 'prompt');
+  });
+
+  teardown(() => sandbox.restore());
+
+  test('that the choice of package bundlers is presented', async () => {
+    const chosenType = any.word();
+    const decisions = any.simpleObject();
+    const answers = {...any.simpleObject(), [questionNames.PACKAGE_BUNDLER]: chosenType};
+    const bundlers = any.simpleObject();
+    prompts.prompt
+      .withArgs([{
+        name: questionNames.PACKAGE_BUNDLER,
+        type: 'list',
+        message: 'Which bundler should be used?',
+        choices: [...Object.keys(bundlers), new inquirer.Separator(), 'Other']
+      }], decisions)
+      .resolves(answers);
+
+    assert.equal(await prompt({bundlers, decisions}), chosenType);
+  });
+
+  test('that the prompt is skipped and `Other` is returned when no options ar provided ', async () => {
+    assert.equal(await prompt({bundlers: {}}), 'Other');
+  });
+});

src/scaffolder/project-type/package/prompt.js

@@ -0,0 +1,16 @@
+import {Separator} from 'inquirer';
+import {prompt} from '@form8ion/overridable-prompts';
+import {questionNames} from '../../../prompts/question-names';
+
+export default async function ({bundlers, decisions}) {
+  if (!Object.keys(bundlers).length) return 'Other';
+
+  const answers = await prompt([{
+    name: questionNames.PACKAGE_BUNDLER,
+    type: 'list',
+    message: 'Which bundler should be used?',
+    choices: [...Object.keys(bundlers), new Separator(), 'Other']
+  }], decisions);
+
+  return answers[questionNames.PACKAGE_BUNDLER];
+}

src/scaffolder/project-type/package/scaffolder-test.js

@@ -12,6 +12,7 @@ suite('package project-type', () => {
   let sandbox;
   const projectRoot = any.string();
   const packageTypes = any.simpleObject();
+  const packageBundlers = any.simpleObject();
   const projectName = any.word();
   const packageName = any.word();
   const packageManager = any.word();
@@ -63,7 +64,7 @@ suite('package project-type', () => {
     const dialect = jsCore.dialects.BABEL;
     defineBadges.default.withArgs(packageName, visibility).returns(badges);
     buildDetails.default
-      .withArgs({projectRoot, projectName, visibility, packageName, dialect})
+      .withArgs({projectRoot, projectName, packageBundlers, visibility, packageName, dialect, decisions})
       .resolves(buildDetailsResults);
 
     assert.deepEqual(
@@ -75,6 +76,7 @@ suite('package project-type', () => {
         visibility,
         scope,
         packageTypes,
+        packageBundlers,
         tests,
         decisions,
         dialect
@@ -104,7 +106,7 @@ suite('package project-type', () => {
     const dialect = jsCore.dialects.ESM;
     defineBadges.default.withArgs(packageName, visibility).returns(badges);
     buildDetails.default
-      .withArgs({projectRoot, projectName, visibility, packageName, dialect})
+      .withArgs({projectRoot, projectName, packageBundlers, visibility, packageName, dialect, decisions})
       .resolves(buildDetailsResults);
 
     assert.deepEqual(
@@ -117,6 +119,7 @@ suite('package project-type', () => {
         scope,
         packageManager,
         packageTypes,
+        packageBundlers,
         decisions,
         tests
       }),
@@ -144,7 +147,7 @@ suite('package project-type', () => {
     const dialect = jsCore.dialects.TYPESCRIPT;
     defineBadges.default.withArgs(packageName, visibility).returns(badges);
     buildDetails.default
-      .withArgs({projectRoot, projectName, visibility, packageName, dialect})
+      .withArgs({projectRoot, projectName, packageBundlers, visibility, packageName, dialect, decisions})
       .resolves(buildDetailsResults);
 
     assert.deepEqual(
@@ -156,6 +159,7 @@ suite('package project-type', () => {
         visibility,
         scope,
         packageTypes,
+        packageBundlers,
         tests,
         decisions,
         dialect
@@ -185,7 +189,7 @@ suite('package project-type', () => {
     const dialect = jsCore.dialects.COMMON_JS;
     defineBadges.default.withArgs(packageName, visibility).returns(badges);
     buildDetails.default
-      .withArgs({projectRoot, projectName, visibility, packageName, dialect})
+      .withArgs({projectRoot, projectName, packageBundlers, visibility, packageName, dialect, decisions})
       .resolves(buildDetailsResults);
 
     assert.deepEqual(
@@ -198,6 +202,7 @@ suite('package project-type', () => {
         scope,
         decisions,
         packageTypes,
+        packageBundlers,
         tests,
         dialect
       }),

src/scaffolder/project-type/package/scaffolder.js

@@ -14,14 +14,23 @@ export default async function ({
   visibility,
   scope,
   packageTypes,
+  packageBundlers,
   tests,
   decisions,
   dialect,
   publishRegistry
 }) {
   info('Scaffolding Package Details');
 
-  const detailsForBuild = await buildDetails({projectRoot, projectName, visibility, packageName, dialect});
+  const detailsForBuild = await buildDetails({
+    projectRoot,
+    projectName,
+    packageBundlers,
+    visibility,
+    packageName,
+    dialect,
+    decisions
+  });
   const details = {
     ...dialects.BABEL === dialect && {
       packageProperties: {

src/scaffolder/project-type/scaffolder-test.js

@@ -36,6 +36,7 @@ suite('project-type scaffolder', () => {
   test('that the package-type scaffolder is applied when the project-type is `Package`', async () => {
     const scope = any.word();
     const packageTypes = any.simpleObject();
+    const packageBundlers = any.simpleObject();
 
     packageTypeScaffolder.default
       .withArgs({
@@ -46,6 +47,7 @@ suite('project-type scaffolder', () => {
         visibility,
         scope,
         packageTypes,
+        packageBundlers,
         tests,
         vcs,
         decisions,
@@ -64,6 +66,7 @@ suite('project-type scaffolder', () => {
         visibility,
         scope,
         packageTypes,
+        packageBundlers,
         tests,
         vcs,
         decisions,

src/scaffolder/project-type/scaffolder.js

@@ -13,6 +13,7 @@ export default async function ({
   visibility,
   applicationTypes,
   packageTypes,
+  packageBundlers,
   monorepoTypes,
   scope,
   tests,
@@ -31,6 +32,7 @@ export default async function ({
         visibility,
         scope,
         packageTypes,
+        packageBundlers,
         tests,
         vcs,
         decisions,