feat(qualify): expose a qualify predicate to enable only using in the context of github workflows

Author: travi

src/index.js

@@ -1,2 +1,3 @@
 export {default as scaffold} from './scaffolder/index.js';
 export * from './lifter/index.js';
+export {default as qualify} from './qualifier.js';

src/qualifier.js

@@ -0,0 +1,5 @@
+import {test as workflowsConfigured} from '@form8ion/github-workflows-core';
+
+export default function qualify({projectRoot}) {
+  return workflowsConfigured({projectRoot});
+}

src/qualifier.test.js

@@ -0,0 +1,19 @@
+import {test as workflowsConfigured} from '@form8ion/github-workflows-core';
+
+import {describe, it, vi, expect} from 'vitest';
+import {when} from 'vitest-when';
+import any from '@travi/any';
+
+import qualify from './qualifier.js';
+
+vi.mock('@form8ion/github-workflows-core');
+
+describe('qualifier', () => {
+  it('should qualify the use of this plugin based on the workflows-core predicate', async () => {
+    const projectRoot = any.simpleObject();
+    const workflowsAreConfigured = any.boolean();
+    when(workflowsConfigured).calledWith({projectRoot}).thenResolve(workflowsAreConfigured);
+
+    expect(await qualify({projectRoot})).toEqual(workflowsAreConfigured);
+  });
+});

test/integration/features/scaffold/verify.feature

@@ -1,13 +1,20 @@
 Feature: Verify Workflow
 
   Scenario: new project
+    Given the workflows directory exists
     When the project is scaffolded
     Then the verification workflow is created
     And the jobs use "ubuntu-latest" as the runners
     And the status badge is returned
 
+  Scenario: new project without github workflows
+    Given the workflows directory does not exist
+    When the project is scaffolded
+    Then the verification workflow is not created
+
   Scenario: new project with specific runner preference
-    Given the project prefers to use the "foo" runner
+    Given the workflows directory exists
+    And the project prefers to use the "foo" runner
     When the project is scaffolded
     Then the verification workflow is created
     And the jobs use "foo" as the runners

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

@@ -4,7 +4,7 @@ import {
   scaffoldCheckoutStep,
   scaffoldDependencyInstallationStep,
   scaffoldNodeSetupStep,
-  scaffoldVerificationStep,
+  scaffoldVerificationStep, workflowFileExists,
   writeWorkflowFile
 } from '@form8ion/github-workflows-core';
 
@@ -20,6 +20,14 @@ Before(async function () {
   this.injectedJobs = [];
 });
 
+Given('the workflows directory exists', async function () {
+  await fs.mkdir(`${process.cwd()}/.github/workflows`, {recursive: true});
+});
+
+Given('the workflows directory does not exist', async function () {
+  return undefined;
+});
+
 Given('a CI workflow exists', async function () {
   await fs.mkdir(`${process.cwd()}/.github/workflows`, {recursive: true});
 
@@ -103,6 +111,10 @@ Then('the verification workflow is created', async function () {
   );
 });
 
+Then('the verification workflow is not created', async function () {
+  assert.isFalse(await workflowFileExists({projectRoot: this.projectRoot, name: ciWorkflowName}));
+});
+
 Then('the workflow-result job exists', async function () {
   const {jobs} = await loadWorkflowFile({projectRoot: this.projectRoot, name: ciWorkflowName});
 

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

@@ -9,7 +9,7 @@ import * as td from 'testdouble';
 const __dirname = dirname(fileURLToPath(import.meta.url));        // eslint-disable-line no-underscore-dangle
 const stubbedNodeModules = stubbedFs.load(resolve(__dirname, '..', '..', '..', '..', 'node_modules'));
 
-let lift, test, scaffold;
+let lift, test, scaffold, qualify;
 
 Before(async function () {
   this.existingBranches = any.listOf(any.word);
@@ -20,7 +20,7 @@ Before(async function () {
   this.jsCore = await td.replaceEsm('@form8ion/javascript-core');
 
   // eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
-  ({lift, test, scaffold} = await import('@form8ion/github-actions-node-ci'));
+  ({lift, test, scaffold, qualify} = await import('@form8ion/github-actions-node-ci'));
 
   stubbedFs({
     node_modules: stubbedNodeModules,
@@ -34,11 +34,13 @@ After(function () {
 });
 
 When('the project is scaffolded', async function () {
-  this.results = await scaffold({
-    projectRoot: this.projectRoot,
-    vcs: {owner: this.vcsOwner, name: this.vcsName},
-    ...this.preferredRunner && {runner: this.preferredRunner}
-  });
+  if (await qualify({projectRoot: this.projectRoot})) {
+    this.results = await scaffold({
+      projectRoot: this.projectRoot,
+      vcs: {owner: this.vcsOwner, name: this.vcsName},
+      ...this.preferredRunner && {runner: this.preferredRunner}
+    });
+  }
 });
 
 When('the project is lifted', async function () {