feat(directory): create the workflows directory

Author: travi

package-lock.json

@@ -56,6 +56,7 @@
   "devDependencies": {
     "@cucumber/cucumber": "10.3.1",
     "@form8ion/commitlint-config": "1.0.76",
+    "@form8ion/core": "4.2.1",
     "@form8ion/eslint-config": "7.0.9",
     "@form8ion/eslint-config-cucumber": "1.4.1",
     "@form8ion/remark-lint-preset": "6.0.2",
@@ -79,5 +80,8 @@
     "rollup": "4.13.0",
     "rollup-plugin-auto-external": "2.0.0",
     "vitest": "1.4.0"
+  },
+  "dependencies": {
+    "make-dir": "^4.0.0"
   }
 }

package.json

@@ -1,3 +1,7 @@
-export default function () {
-  return undefined;
+import makeDir from 'make-dir';
+
+export default async function ({projectRoot}) {
+  await makeDir(`${projectRoot}/.github/workflows`);
+
+  return {};
 }

src/scaffolder.js

@@ -0,0 +1,22 @@
+import makeDir from 'make-dir';
+
+import any from '@travi/any';
+import {vi, describe, it, expect, afterEach} from 'vitest';
+
+import scaffold from './scaffolder.js';
+
+vi.mock('make-dir');
+
+describe('scaffolder', () => {
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should create the workflows directory', async () => {
+    const projectRoot = any.string();
+
+    expect(await scaffold({projectRoot})).toEqual({});
+
+    expect(makeDir).toHaveBeenCalledWith(`${projectRoot}/.github/workflows`);
+  });
+});

src/scaffolder.test.js

@@ -2,3 +2,4 @@ Feature: Scaffolder
 
   Scenario: Scaffold
     When the project is scaffolded
+    Then the workflows directory will be created

test/integration/features/scaffolder.feature

@@ -10,6 +10,7 @@ const stubbedNodeModules = stubbedFs.load(resolve(__dirname, '..', '..', '..', '
 let scaffold;
 
 Before(async function () {
+  this.projectRoot = process.cwd();
   // eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
   ({scaffold} = await import('@form8ion/github-workflows'));
 

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

@@ -0,0 +1,8 @@
+import {directoryExists} from '@form8ion/core';
+
+import {Then} from '@cucumber/cucumber';
+import assert from 'node:assert';
+
+Then('the workflows directory will be created', async function () {
+  assert.equal(await directoryExists(`${this.projectRoot}/.github/workflows`), true);
+});