feat(ci-service): scaffold a qualified service rather than prompting for a choice

since the project is already set up for the service and the javascript-project specific additions
can be added based on that context

BREAKING CHANGE: the ci service is no longer chosen based on a prompt. instead it is scaffolded
based on the `qualify` predicate of the plugin passing. this means that only plugins that provide a
`qualify` predicate will still be possible to scaffold in this context

Author: travi

package-lock.json

@@ -69,9 +69,9 @@
     "@form8ion/husky": "^8.0.0-beta.3",
     "@form8ion/javascript-core": "^13.0.0",
     "@form8ion/overridable-prompts": "^1.2.0",
+    "@form8ion/plugins-core": "^1.0.0-beta.1",
     "@form8ion/prettier": "^3.0.0",
     "@hapi/hoek": "^11.0.0",
-    "@travi/language-scaffolder-prompts": "^2.0.0-beta.1",
     "camelcase": "^9.0.0",
     "deepmerge": "^4.2.2",
     "execa": "^9.5.1",

package.json

@@ -1,9 +1,5 @@
-import {questionNames as languageScaffolderPromptsQuestionNames} from '@travi/language-scaffolder-prompts';
-
-import {questionNames as jsScaffolderQuestionNames} from './prompts/question-names.js';
-
+export {questionNames} from './prompts/question-names.js';
 export {scaffold as scaffoldUnitTesting} from './testing/unit/index.js';
 export {default as scaffold} from './scaffolder.js';
 export {default as lift} from './lifter.js';
 export {default as test} from './tester.js';
-export const questionNames = {...languageScaffolderPromptsQuestionNames, ...jsScaffolderQuestionNames};

src/index.js

@@ -1,5 +1,4 @@
 import {projectTypes} from '@form8ion/javascript-core';
-import {questionNames as commonQuestionNames} from '@travi/language-scaffolder-prompts';
 
 import {questionNames} from './question-names.js';
 
@@ -32,8 +31,8 @@ export function scopePromptShouldBePresentedFactory(visibility) {
 }
 
 export function lintingPromptShouldBePresented({
-  [commonQuestionNames.UNIT_TESTS]: unitTested,
-  [commonQuestionNames.INTEGRATION_TESTS]: integrationTested
+  [questionNames.UNIT_TESTS]: unitTested,
+  [questionNames.INTEGRATION_TESTS]: integrationTested
 }) {
   return !unitTested && !integrationTested;
 }

src/prompts/conditionals.js

@@ -1,4 +1,3 @@
-import {questionNames as commonQuestionNames} from '@travi/language-scaffolder-prompts';
 import {projectTypes} from '@form8ion/javascript-core';
 
 import {describe, expect, it} from 'vitest';
@@ -99,17 +98,17 @@ describe('javascript prompt conditionals', () => {
 
   describe('transpilation/linting', () => {
     it('should not show the prompt if the project is unit tested ', () => {
-      expect(lintingPromptShouldBePresented({[commonQuestionNames.UNIT_TESTS]: true})).toBe(false);
+      expect(lintingPromptShouldBePresented({[questionNames.UNIT_TESTS]: true})).toBe(false);
     });
 
     it('should not show the prompt if the project is integration tested', () => {
-      expect(lintingPromptShouldBePresented({[commonQuestionNames.INTEGRATION_TESTS]: true})).toBe(false);
+      expect(lintingPromptShouldBePresented({[questionNames.INTEGRATION_TESTS]: true})).toBe(false);
     });
 
     it('should show the prompt if the project is not tested', () => {
       expect(lintingPromptShouldBePresented({
-        [commonQuestionNames.INTEGRATION_TESTS]: false,
-        [commonQuestionNames.UNIT_TESTS]: false
+        [questionNames.INTEGRATION_TESTS]: false,
+        [questionNames.UNIT_TESTS]: false
       })).toBe(true);
     });
   });

src/prompts/conditionals.test.js

@@ -1,4 +1,6 @@
 export const questionNames = {
+  UNIT_TESTS: 'unitTests',
+  INTEGRATION_TESTS: 'integrationTests',
   UNIT_TEST_FRAMEWORK: 'unitTestFramework',
   INTEGRATION_TEST_FRAMEWORK: 'integrationTestFramework',
   NODE_VERSION_CATEGORY: 'nodeVersionCategory',

src/prompts/question-names.js

@@ -1,6 +1,5 @@
 import {packageManagers, projectTypes} from '@form8ion/javascript-core';
 import {prompt as promptWithInquirer} from '@form8ion/overridable-prompts';
-import {questionNames as commonQuestionNames, questions as commonQuestions} from '@travi/language-scaffolder-prompts';
 
 import {execa} from 'execa';
 import npmConfFactory from '../../thirdparty-wrappers/npm-conf.js';
@@ -36,7 +35,6 @@ function authorQuestions({name, email, url}) {
 }
 
 export async function prompt(
-  ciServices,
   hosts,
   visibility,
   vcs,
@@ -58,10 +56,9 @@ export async function prompt(
   }
 
   const {
-    [commonQuestionNames.UNIT_TESTS]: unitTested,
-    [commonQuestionNames.INTEGRATION_TESTS]: integrationTested,
+    [questionNames.UNIT_TESTS]: unitTested,
+    [questionNames.INTEGRATION_TESTS]: integrationTested,
     [questionNames.PROJECT_TYPE]: projectType,
-    [commonQuestionNames.CI_SERVICE]: ci,
     [questionNames.HOST]: chosenHost,
     [questionNames.SCOPE]: scope,
     [questionNames.NODE_VERSION_CATEGORY]: nodeVersionCategory,
@@ -120,7 +117,18 @@ export async function prompt(
       email: npmConf.get('init.author.email'),
       url: npmConf.get('init.author.url')
     }),
-    ...commonQuestions(({vcs, ciServices, pathWithinParent})),
+    {
+      name: questionNames.UNIT_TESTS,
+      message: 'Will this project be unit tested?',
+      type: 'confirm',
+      default: true
+    },
+    {
+      name: questionNames.INTEGRATION_TESTS,
+      message: 'Will this project be integration tested?',
+      type: 'confirm',
+      default: true
+    },
     {
       name: questionNames.CONFIGURE_LINTING,
       message: 'Will there be source code that should be linted?',
@@ -145,7 +153,6 @@ export async function prompt(
   return {
     tests: {unit: unitTested, integration: integrationTested},
     projectType,
-    ci,
     chosenHost,
     scope,
     nodeVersionCategory,

src/prompts/questions.js

@@ -1,9 +1,8 @@
 import {execa} from 'execa';
-import * as commonPrompts from '@travi/language-scaffolder-prompts';
 import * as prompts from '@form8ion/overridable-prompts';
 import {packageManagers, projectTypes} from '@form8ion/javascript-core';
 
-import {expect, describe, it, vi, beforeEach} from 'vitest';
+import {describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 import {when} from 'vitest-when';
 
@@ -15,19 +14,16 @@ import {prompt} from './questions.js';
 import * as validators from './validators.js';
 
 vi.mock('execa');
-vi.mock('@travi/language-scaffolder-prompts');
 vi.mock('@form8ion/overridable-prompts');
 vi.mock('../../thirdparty-wrappers/npm-conf.js');
 vi.mock('../dialects/prompt-choices.js');
 vi.mock('./validators.js');
 vi.mock('./conditionals.js');
 
 describe('prompts', () => {
-  const commonQuestions = any.listOf(any.simpleObject);
   const decisions = any.simpleObject();
   const vcs = any.simpleObject();
   const pathWithinParent = any.string();
-  const ciServices = any.simpleObject();
   const visibility = any.word();
   const integrationTested = any.boolean();
   const unitTested = any.boolean();
@@ -45,10 +41,10 @@ describe('prompts', () => {
   const scope = any.word();
   const provideExample = any.boolean();
   const answers = {
-    [commonPrompts.questionNames.UNIT_TESTS]: unitTested,
-    [commonPrompts.questionNames.INTEGRATION_TESTS]: integrationTested,
+    [questionNames.UNIT_TESTS]: unitTested,
+    [questionNames.INTEGRATION_TESTS]: integrationTested,
     [questionNames.PROJECT_TYPE]: projectType,
-    [commonPrompts.questionNames.CI_SERVICE]: ci,
+    [questionNames.CI_SERVICE]: ci,
     [questionNames.HOST]: chosenHost,
     [questionNames.SCOPE]: scope,
     [questionNames.NODE_VERSION_CATEGORY]: nodeVersionCategory,
@@ -61,12 +57,6 @@ describe('prompts', () => {
   };
   const logger = {info: () => undefined, warn: () => undefined};
 
-  beforeEach(() => {
-    when(commonPrompts.questions)
-      .calledWith({vcs, ciServices, pathWithinParent: undefined})
-      .thenReturn(commonQuestions);
-  });
-
   it('should prompt the user for the necessary details', async () => {
     const npmUser = any.word();
     const get = vi.fn();
@@ -144,7 +134,18 @@ describe('prompts', () => {
           message: 'What is the author\'s website url?',
           default: authorUrl
         },
-        ...commonQuestions,
+        {
+          name: questionNames.UNIT_TESTS,
+          message: 'Will this project be unit tested?',
+          type: 'confirm',
+          default: true
+        },
+        {
+          name: questionNames.INTEGRATION_TESTS,
+          message: 'Will this project be integration tested?',
+          type: 'confirm',
+          default: true
+        },
         {
           name: questionNames.CONFIGURE_LINTING,
           message: 'Will there be source code that should be linted?',
@@ -167,10 +168,9 @@ describe('prompts', () => {
       ], decisions)
       .thenResolve({...answers, [questionNames.CONFIGURE_LINTING]: any.word()});
 
-    expect(await prompt(ciServices, hosts, visibility, vcs, decisions, configs, undefined, {logger})).toEqual({
+    expect(await prompt(hosts, visibility, vcs, decisions, configs, undefined, {logger})).toEqual({
       tests,
       projectType,
-      ci,
       chosenHost,
       scope,
       nodeVersionCategory,
@@ -189,10 +189,9 @@ describe('prompts', () => {
     when(execa).calledWith('npm', ['whoami']).thenResolve({stdout: npmUser});
     prompts.prompt.mockResolvedValue({...answers, [questionNames.CONFIGURE_LINTING]: false});
 
-    expect(await prompt(ciServices, {}, visibility, vcs, decisions, undefined, undefined, {logger})).toEqual({
+    expect(await prompt({}, visibility, vcs, decisions, undefined, undefined, {logger})).toEqual({
       tests,
       projectType,
-      ci,
       chosenHost,
       scope,
       nodeVersionCategory,
@@ -207,12 +206,9 @@ describe('prompts', () => {
   it('should not ask about node version for sub-projects since the parent project already defines', async () => {
     when(execa).calledWith('npm', ['whoami']).thenResolve({stdout: any.word()});
     npmConfFactory.mockReturnValue({get: () => undefined});
-    when(commonPrompts.questions)
-      .calledWith({vcs, ciServices, pathWithinParent})
-      .thenReturn(commonQuestions);
     prompts.prompt.mockResolvedValue(answers);
 
-    await prompt(ciServices, {}, 'CS', vcs, null, null, pathWithinParent, {logger});
+    await prompt({}, 'CS', vcs, null, null, pathWithinParent, {logger});
 
     const [questions] = prompts.prompt.mock.lastCall;
     expect(questions.filter(question => questionNames.NODE_VERSION_CATEGORY === question.name).length).toEqual(0);
@@ -221,12 +217,9 @@ describe('prompts', () => {
   it('should not ask whether closed source packages should be scoped', async () => {
     when(execa).calledWith('npm', ['whoami']).thenResolve({stdout: any.word()});
     npmConfFactory.mockReturnValue({get: () => undefined});
-    when(commonPrompts.questions)
-      .calledWith({vcs, ciServices, pathWithinParent})
-      .thenReturn(commonQuestions);
     prompts.prompt.mockResolvedValue(answers);
 
-    await prompt(ciServices, {}, 'CS', vcs, null, null, pathWithinParent, {logger});
+    await prompt({}, 'CS', vcs, null, null, pathWithinParent, {logger});
 
     const [questions] = prompts.prompt.mock.lastCall;
     expect(questions.filter(question => questionNames.SHOULD_BE_SCOPED === question.name).length).toEqual(0);
@@ -235,12 +228,9 @@ describe('prompts', () => {
   it('should not ask whether inner source packages should be scoped', async () => {
     when(execa).calledWith('npm', ['whoami']).thenResolve({stdout: any.word()});
     npmConfFactory.mockReturnValue({get: () => undefined});
-    when(commonPrompts.questions)
-      .calledWith({vcs, ciServices, pathWithinParent})
-      .thenReturn(commonQuestions);
     prompts.prompt.mockResolvedValue(answers);
 
-    await prompt(ciServices, {}, 'ISS', vcs, null, null, pathWithinParent, {logger});
+    await prompt({}, 'ISS', vcs, null, null, pathWithinParent, {logger});
 
     const [questions] = prompts.prompt.mock.lastCall;
     expect(questions.filter(question => questionNames.SHOULD_BE_SCOPED === question.name).length).toEqual(0);
@@ -249,12 +239,9 @@ describe('prompts', () => {
   it('should handle a non-logged-in user gracefully', async () => {
     when(execa).calledWith('npm', ['whoami']).thenReject(new Error());
     npmConfFactory.mockReturnValue({get: () => undefined});
-    when(commonPrompts.questions)
-      .calledWith({vcs, ciServices, pathWithinParent})
-      .thenReturn(commonQuestions);
     prompts.prompt.mockResolvedValue(answers);
 
-    await prompt(ciServices, {}, 'OSS', vcs, {}, null, pathWithinParent, {logger});
+    await prompt({}, 'OSS', vcs, {}, null, pathWithinParent, {logger});
 
     const [questions] = prompts.prompt.mock.lastCall;
     expect(questions.filter(question => questionNames.SHOULD_BE_SCOPED === question.name).length).toEqual(1);

src/prompts/questions.test.js

@@ -1,5 +1,6 @@
 import deepmerge from 'deepmerge';
 import {projectTypes, scaffoldChoice} from '@form8ion/javascript-core';
+import {scaffold as scaffoldPlugins} from '@form8ion/plugins-core';
 import {scaffold as scaffoldCommitConvention} from '@form8ion/commit-convention';
 
 import {validate} from './options/validator.js';
@@ -45,7 +46,6 @@ export default async function scaffoldJavascript(options, {logger}) {
   const {
     tests,
     projectType,
-    ci,
     chosenHost,
     scope,
     nodeVersionCategory,
@@ -54,7 +54,7 @@ export default async function scaffoldJavascript(options, {logger}) {
     provideExample,
     packageManager,
     dialect
-  } = await prompt(ciServices, hosts, visibility, vcs, decisions, configs, pathWithinParent, {logger});
+  } = await prompt(hosts, visibility, vcs, decisions, configs, pathWithinParent, {logger});
 
   logger.info('Writing project files', {level: 'secondary'});
 
@@ -134,7 +134,10 @@ export default async function scaffoldJavascript(options, {logger}) {
         chosenHost,
         {buildDirectory: `./${projectTypeResults.buildDirectory}`, projectRoot, projectName, nodeVersion}
       ),
-      scaffoldChoice(ciServices, ci, {projectRoot, vcs, visibility, projectType, projectName, nodeVersion, tests}),
+      scaffoldPlugins.qualifiedOption(
+        ciServices,
+        {projectRoot, vcs, visibility, projectType, projectName, nodeVersion, tests}
+      ),
       scaffoldCommitConvention({projectRoot, projectType, configs, pathWithinParent})
     ])),
     projectTypeResults,

src/scaffolder.js

@@ -1,5 +1,6 @@
 import deepmerge from 'deepmerge';
 import {projectTypes, scaffoldChoice} from '@form8ion/javascript-core';
+import {scaffold as scaffoldPlugins} from '@form8ion/plugins-core';
 import {scaffold as scaffoldCommitConvention} from '@form8ion/commit-convention';
 
 import {beforeEach, describe, expect, it, vi} from 'vitest';
@@ -24,6 +25,7 @@ import scaffold from './scaffolder.js';
 
 vi.mock('deepmerge');
 vi.mock('@form8ion/javascript-core');
+vi.mock('@form8ion/plugins-core');
 vi.mock('@form8ion/commit-convention');
 vi.mock('./package/index.js');
 vi.mock('./code-style/index.js');
@@ -122,7 +124,7 @@ describe('javascript project scaffolder', () => {
         }
       });
     when(prompt)
-      .calledWith(ciServices, hosts, visibility, vcs, decisions, configs, pathWithinParent, {logger})
+      .calledWith(hosts, visibility, vcs, decisions, configs, pathWithinParent, {logger})
       .thenResolve({
         packageManager,
         dialect,
@@ -184,10 +186,9 @@ describe('javascript project scaffolder', () => {
     when(scaffoldCodeStyle)
       .calledWith({projectRoot, projectType, configs, vcs, configureLinting})
       .thenResolve(codeStyleResults);
-    when(scaffoldChoice)
+    when(scaffoldPlugins.qualifiedOption)
       .calledWith(
         ciServices,
-        ciChoice,
         {projectRoot, vcs, visibility, projectType, projectName, nodeVersion: nodeVersionResults, tests}
       )
       .thenResolve(ciServiceResults);