feat(workflow): enabled creation of the workflow when the project doesnt have other workflows

Author: travi

package-lock.json

@@ -66,7 +66,6 @@
     "husky": "8.0.3",
     "jest-when": "3.5.2",
     "lockfile-lint": "4.10.5",
-    "make-dir": "3.1.0",
     "mock-fs": "5.2.0",
     "npm-run-all": "4.1.5",
     "publint": "0.1.12",
@@ -79,6 +78,7 @@
     "vitest": "0.31.3"
   },
   "dependencies": {
-    "js-yaml": "^4.1.0"
+    "js-yaml": "^4.1.0",
+    "make-dir": "^3.1.0"
   }
 }

package.json

@@ -1,9 +1,10 @@
 import {promises as fs} from 'node:fs';
 import {dump} from 'js-yaml';
+import mkdir from 'make-dir';
 
 export default async function ({projectRoot}) {
   await fs.writeFile(
-    `${projectRoot}/.github/workflows/scorecard.yml`,
+    `${await mkdir(`${projectRoot}/.github/workflows`)}/scorecard.yml`,
     dump({
       name: 'OpenSSF Scorecard',
       on: {

src/workflow/scaffolder.js

@@ -1,5 +1,6 @@
 import {promises as fs} from 'node:fs';
 import jsYaml from 'js-yaml';
+import mkdir from 'make-dir';
 
 import {afterEach, expect, describe, it, vi} from 'vitest';
 import any from '@travi/any';
@@ -9,6 +10,7 @@ import scaffold from './scaffolder.js';
 
 vi.mock('node:fs');
 vi.mock('js-yaml');
+vi.mock('make-dir');
 
 describe('workflow scaffolder', () => {
   const projectRoot = any.string();
@@ -19,7 +21,9 @@ describe('workflow scaffolder', () => {
 
   it('should scaffold the scorecard workflow', async () => {
     const dumpedYaml = any.string();
+    const pathToCreatedWorkflowsDirectory = any.string();
 
+    when(mkdir).calledWith(`${projectRoot}/.github/workflows`).mockResolvedValue(pathToCreatedWorkflowsDirectory);
     when(jsYaml.dump)
       .calledWith({
         name: 'OpenSSF Scorecard',
@@ -73,6 +77,6 @@ describe('workflow scaffolder', () => {
 
     await scaffold({projectRoot});
 
-    expect(fs.writeFile).toHaveBeenCalledWith(`${projectRoot}/.github/workflows/scorecard.yml`, dumpedYaml);
+    expect(fs.writeFile).toHaveBeenCalledWith(`${pathToCreatedWorkflowsDirectory}/scorecard.yml`, dumpedYaml);
   });
 });

src/workflow/scaffolder.test.js

@@ -1,7 +1,15 @@
 Feature: Scaffolder
 
-  Scenario: Scaffold a GitHub project
+  Scenario: Scaffold a GitHub project where other workflows already exist
     Given the project is hosted on "GitHub"
+    And Actions workflows exist
+    When the project is scaffolded
+    Then the score badge is added to the status zone
+    And the workflow is defined
+
+  Scenario: Scaffold a GitHub project where no other workflows exist
+    Given the project is hosted on "GitHub"
+    But no Actions workflows exist
     When the project is scaffolded
     Then the score badge is added to the status zone
     And the workflow is defined

test/integration/features/scaffolder.feature

@@ -1,9 +1,5 @@
-import mkdir from 'make-dir';
-
 import {Given} from '@cucumber/cucumber';
 
 Given('the project is hosted on {string}', async function (vcsHost) {
   this.vcsHost = vcsHost.toLowerCase();
-
-  await mkdir(`${this.projectRoot}/.github/workflows`);
 });

test/integration/features/step_definitions/vcs-host-steps.js

@@ -1,8 +1,17 @@
 import {fileExists} from '@form8ion/core';
+import mkdir from 'make-dir';
 
-import {Then} from '@cucumber/cucumber';
+import {Given, Then} from '@cucumber/cucumber';
 import {assert} from 'chai';
 
+Given('Actions workflows exist', async function () {
+  await mkdir(`${this.projectRoot}/.github/workflows`);
+});
+
+Given('no Actions workflows exist', async function () {
+  return undefined;
+});
+
 Then('the workflow is defined', async function () {
   assert.isTrue(await fileExists(`${this.projectRoot}/.github/workflows/scorecard.yml`));
 });