feat(workflow-file): expose a function to check for existence of a wo…

…rkflow file

README.md

@@ -55,7 +55,8 @@ import {
   scaffoldDependencyInstallationStep,
   scaffoldVerificationStep,
   loadWorkflowFile,
-  writeWorkflowFile
+  writeWorkflowFile,
+  workflowFileExists
 } from '@form8ion/github-workflows-core';
 ```
 
@@ -73,7 +74,10 @@ const projectRoot = process.cwd();
 
   scaffoldVerificationStep();
 
-  await loadWorkflowFile({projectRoot, name: 'existing-workflow-name'});
+  if (await workflowFileExists({projectRoot, name: 'existing-workflow-name'})) {
+    await loadWorkflowFile({projectRoot, name: 'existing-workflow-name'});
+  }
+
   await writeWorkflowFile({projectRoot, name: 'workflow-name', config: {}});
 })();
 ```

example.js

@@ -7,7 +7,8 @@ import {
   scaffoldDependencyInstallationStep,
   scaffoldVerificationStep,
   loadWorkflowFile,
-  writeWorkflowFile
+  writeWorkflowFile,
+  workflowFileExists
 } from './lib/index.js';
 
 // remark-usage-ignore-next 4
@@ -29,6 +30,9 @@ const projectRoot = process.cwd();
 
   scaffoldVerificationStep();
 
-  await loadWorkflowFile({projectRoot, name: 'existing-workflow-name'});
+  if (await workflowFileExists({projectRoot, name: 'existing-workflow-name'})) {
+    await loadWorkflowFile({projectRoot, name: 'existing-workflow-name'});
+  }
+
   await writeWorkflowFile({projectRoot, name: 'workflow-name', config: {}});
 })();

src/index.js

@@ -4,4 +4,8 @@ export {
   setupNode as scaffoldNodeSetupStep,
   checkout as scaffoldCheckoutStep
 } from './steps/scaffolders.js';
-export {load as loadWorkflowFile, write as writeWorkflowFile} from './workflow-file/index.js';
+export {
+  fileExists as workflowFileExists,
+  load as loadWorkflowFile,
+  write as writeWorkflowFile
+} from './workflow-file/index.js';

src/workflow-file/existence-checker.js

@@ -0,0 +1,5 @@
+import {fileExists} from '@form8ion/core';
+
+export default function ({projectRoot, name}) {
+  return fileExists(`${projectRoot}/.github/workflows/${name}.yml`);
+}

src/workflow-file/existence-checker.test.js

@@ -0,0 +1,20 @@
+import {fileExists} from '@form8ion/core';
+
+import {when} from 'jest-when';
+import any from '@travi/any';
+import {describe, expect, it, vi} from 'vitest';
+
+import workflowFileExists from './existence-checker.js';
+
+vi.mock('@form8ion/core');
+
+describe('workflow existence checker', () => {
+  it('should check for existence of the workflow file in the workflows directory', async () => {
+    const projectRoot = any.string();
+    const name = any.word();
+    const exists = any.boolean();
+    when(fileExists).calledWith(`${projectRoot}/.github/workflows/${name}.yml`).mockResolvedValue(exists);
+
+    expect(await workflowFileExists({projectRoot, name})).toBe(exists);
+  });
+});

src/workflow-file/index.js

@@ -1,2 +1,3 @@
+export {default as fileExists} from './existence-checker.js';
 export {default as load} from './loader.js';
 export {default as write} from './writer.js';