@form8ion/github-workflows-core 5.7.0 → 5.7.1

package/package.json

@@ -2,7 +2,7 @@
   "name": "@form8ion/github-workflows-core",
   "description": "core functionality for form8ion plugins that manage github workflows",
   "license": "MIT",
-  "version": "5.7.0",
+  "version": "5.7.1",
   "type": "commonjs",
   "engines": {
     "node": "^18.17 || >=20.6.1"
@@ -52,7 +52,8 @@
   },
   "files": [
     "example.js",
-    "lib/"
+    "lib/",
+    "src/"
   ],
   "publishConfig": {
     "access": "public",

package/src/index.js

@@ -0,0 +1,14 @@
+export {
+  executeVerification as scaffoldVerificationStep,
+  installDependencies as scaffoldDependencyInstallationStep,
+  setupNode as scaffoldNodeSetupStep,
+  checkout as scaffoldCheckoutStep
+} from './steps/scaffolders.js';
+export {
+  fileExists as workflowFileExists,
+  load as loadWorkflowFile,
+  write as writeWorkflowFile,
+  rename as renameWorkflowFile
+} from './workflow-file/index.js';
+export {default as test} from './tester.js';
+export {removeActionFromJobs} from './jobs/remover.js';

package/src/jobs/remover.js

@@ -0,0 +1,13 @@
+import {removeActionFromSteps} from '../steps/remover.js';
+
+export function removeActionFromJobs(jobs, actionName) {
+  return Object.fromEntries(
+    Object.entries(jobs).map(([jobName, job]) => ([
+      jobName,
+      {
+        ...job,
+        .../* job.steps &&  */{steps: removeActionFromSteps(job.steps, actionName)}
+      }
+    ]))
+  );
+}

package/src/jobs/remover.test.js

@@ -0,0 +1,26 @@
+import {describe, it, expect, vi} from 'vitest';
+import {when} from 'vitest-when';
+import any from '@travi/any';
+import zip from 'lodash.zip';
+
+import {removeActionFromSteps} from '../steps/remover.js';
+import {removeActionFromJobs} from './remover.js';
+
+vi.mock('../steps/remover.js');
+
+describe('jobs-level remover', () => {
+  const anySteps = () => any.listOf(any.simpleObject);
+
+  it('should remove an action by name from an indexed list of jobs', async () => {
+    const actionName = any.word();
+    const jobNames = any.listOf(any.word);
+    const jobs = jobNames.map(() => ({...any.simpleObject(), steps: anySteps()}));
+    const updatedJobs = jobs.map(job => ({...job, steps: anySteps()}));
+    zip(jobs, updatedJobs).forEach(([job, updatedJob]) => {
+      when(removeActionFromSteps).calledWith(job.steps, actionName).thenReturn(updatedJob.steps);
+    });
+
+    expect(removeActionFromJobs(Object.fromEntries(zip(jobNames, jobs)), actionName))
+      .toEqual(Object.fromEntries(zip(jobNames, updatedJobs)));
+  });
+});

package/src/scaffolder.js

@@ -0,0 +1,3 @@
+export default function () {
+  return undefined;
+}

package/src/steps/remover.js

@@ -0,0 +1,3 @@
+export function removeActionFromSteps(steps, actionName) {
+  return steps.filter(step => !step.uses?.includes(actionName));
+}

package/src/steps/remover.test.js

@@ -0,0 +1,20 @@
+import {describe, it, expect} from 'vitest';
+import any from '@travi/any';
+
+import {removeActionFromSteps} from './remover.js';
+
+describe('steps-level remover', () => {
+  const anyStep = ({actionName} = {}) => ({
+    ...any.simpleObject(),
+    ...actionName && {uses: `${any.string()}${actionName}${any.string()}`}
+  });
+
+  it('should remove an action by name from a list of steps', async () => {
+    const stepsBeforeRemoved = any.listOf(anyStep);
+    const stepsAfterRemoved = any.listOf(anyStep);
+    const actionName = any.word();
+    const steps = [...stepsBeforeRemoved, anyStep({actionName}), ...stepsAfterRemoved];
+
+    expect(removeActionFromSteps(steps, actionName)).toEqual([...stepsBeforeRemoved, ...stepsAfterRemoved]);
+  });
+});

package/src/steps/scaffolders.js

@@ -0,0 +1,28 @@
+export function setupNode({versionDeterminedBy}) {
+  return {
+    name: 'Setup node',
+    uses: 'actions/setup-node@v6.1.0',
+    with: {
+      ...'nvmrc' === versionDeterminedBy && {'node-version-file': '.nvmrc'},
+      // eslint-disable-next-line no-template-curly-in-string
+      ...'matrix' === versionDeterminedBy && {'node-version': '${{ matrix.node }}'},
+      cache: 'npm'
+    }
+  };
+}
+
+export function executeVerification() {
+  return {run: 'npm test'};
+}
+
+export function installDependencies() {
+  return [
+    {run: 'npm clean-install'},
+    {run: 'npm install --global corepack@latest'},
+    {run: 'corepack npm audit signatures'}
+  ];
+}
+
+export function checkout() {
+  return {uses: 'actions/checkout@v6.0.1'};
+}

package/src/steps/scaffolders.test.js

@@ -0,0 +1,38 @@
+import {describe, expect, it} from 'vitest';
+
+import {checkout, executeVerification, installDependencies, setupNode} from './scaffolders.js';
+
+describe('step scaffolders', () => {
+  it('should scaffold the details of the checkout step', () => {
+    expect(checkout()).toEqual({uses: 'actions/checkout@v6.0.1'});
+  });
+
+  it('should set up node correctly when the version is determined from the `.nvmrc`', () => {
+    expect(setupNode({versionDeterminedBy: 'nvmrc'})).toEqual({
+      name: 'Setup node',
+      uses: 'actions/setup-node@v6.1.0',
+      with: {'node-version-file': '.nvmrc', cache: 'npm'}
+    });
+  });
+
+  it('should set up node correctly when the version is determined based on a matrix', () => {
+    expect(setupNode({versionDeterminedBy: 'matrix'})).toEqual({
+      name: 'Setup node',
+      uses: 'actions/setup-node@v6.1.0',
+      // eslint-disable-next-line no-template-curly-in-string
+      with: {'node-version': '${{ matrix.node }}', cache: 'npm'}
+    });
+  });
+
+  it('should install dependencies correctly', () => {
+    expect(installDependencies()).toEqual([
+      {run: 'npm clean-install'},
+      {run: 'npm install --global corepack@latest'},
+      {run: 'corepack npm audit signatures'}
+    ]);
+  });
+
+  it('should execute verification correctly', () => {
+    expect(executeVerification()).toEqual({run: 'npm test'});
+  });
+});

package/src/tester.js

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

package/src/tester.test.js

@@ -0,0 +1,25 @@
+import any from '@travi/any';
+import {directoryExists} from '@form8ion/core';
+
+import {it, expect, describe, vi} from 'vitest';
+import {when} from 'vitest-when';
+
+import projectUsesGithubWorkflows from './tester.js';
+
+vi.mock('@form8ion/core');
+
+describe('workflows predicate', () => {
+  const projectRoot = any.string();
+
+  it('should return `true` when the project uses GitHub workflows', async () => {
+    when(directoryExists).calledWith(`${projectRoot}/.github/workflows`).thenResolve(true);
+
+    expect(await projectUsesGithubWorkflows({projectRoot})).toEqual(true);
+  });
+
+  it('should return `false` when the project does not use GitHub workflows', async () => {
+    when(directoryExists).calledWith(`${projectRoot}/.github/workflows`).thenResolve(false);
+
+    expect(await projectUsesGithubWorkflows({projectRoot})).toEqual(false);
+  });
+});

package/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`);
+}

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

@@ -0,0 +1,20 @@
+import {fileExists} from '@form8ion/core';
+
+import {when} from 'vitest-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`).thenResolve(exists);
+
+    expect(await workflowFileExists({projectRoot, name})).toBe(exists);
+  });
+});

package/src/workflow-file/index.js

@@ -0,0 +1,4 @@
+export {default as fileExists} from './existence-checker.js';
+export {default as load} from './loader.js';
+export {default as write} from './writer.js';
+export {default as rename} from './renamer.js';

package/src/workflow-file/loader.js

@@ -0,0 +1,5 @@
+import {fileTypes, loadConfigFile} from '@form8ion/core';
+
+export default function ({projectRoot, name}) {
+  return loadConfigFile({path: `${projectRoot}/.github/workflows`, name, format: fileTypes.YAML});
+}

package/src/workflow-file/loader.test.js

@@ -0,0 +1,22 @@
+import {fileTypes, loadConfigFile} from '@form8ion/core';
+
+import {when} from 'vitest-when';
+import any from '@travi/any';
+import {describe, expect, it, vi} from 'vitest';
+
+import loadWorkflowFile from './loader.js';
+
+vi.mock('@form8ion/core');
+
+describe('workflow loader', () => {
+  it('should load the workflow from the workflows directory', async () => {
+    const projectRoot = any.string();
+    const name = any.word();
+    const workflowDetails = any.simpleObject();
+    when(loadConfigFile)
+      .calledWith({path: `${projectRoot}/.github/workflows`, name, format: fileTypes.YAML})
+      .thenResolve(workflowDetails);
+
+    expect(await loadWorkflowFile({projectRoot, name})).toEqual(workflowDetails);
+  });
+});

package/src/workflow-file/renamer.js

@@ -0,0 +1,8 @@
+import {promises as fs} from 'node:fs';
+
+export default function ({projectRoot, oldName, newName}) {
+  return fs.rename(
+    `${projectRoot}/.github/workflows/${oldName}.yml`,
+    `${projectRoot}/.github/workflows/${newName}.yml`
+  );
+}

package/src/workflow-file/renamer.test.js

@@ -0,0 +1,23 @@
+import {promises as fs} from 'node:fs';
+
+import any from '@travi/any';
+import {describe, expect, it, vi} from 'vitest';
+
+import renameWorkflowFile from './renamer.js';
+
+vi.mock('node:fs');
+
+describe('workflow file renamer', () => {
+  it('should rename the workflow file in the workflows directory', async () => {
+    const projectRoot = any.string();
+    const oldName = any.word();
+    const newName = any.word();
+
+    await renameWorkflowFile({projectRoot, oldName, newName});
+
+    expect(fs.rename).toHaveBeenCalledWith(
+      `${projectRoot}/.github/workflows/${oldName}.yml`,
+      `${projectRoot}/.github/workflows/${newName}.yml`
+    );
+  });
+});

package/src/workflow-file/writer.js

@@ -0,0 +1,5 @@
+import {fileTypes, writeConfigFile} from '@form8ion/core';
+
+export default function ({projectRoot, name, config}) {
+  return writeConfigFile({path: `${projectRoot}/.github/workflows`, name, config, format: fileTypes.YAML});
+}

package/src/workflow-file/writer.test.js

@@ -0,0 +1,25 @@
+import {fileTypes, writeConfigFile} from '@form8ion/core';
+
+import any from '@travi/any';
+import {describe, expect, it, vi} from 'vitest';
+
+import writeWorkflowFile from './writer.js';
+
+vi.mock('@form8ion/core');
+
+describe('workflow writer', () => {
+  it('should write the workflow to the workflows directory as a yaml file', async () => {
+    const projectRoot = any.string();
+    const name = any.word();
+    const config = any.simpleObject();
+
+    await writeWorkflowFile({projectRoot, config, name});
+
+    expect(writeConfigFile).toHaveBeenCalledWith({
+      path: `${projectRoot}/.github/workflows`,
+      name,
+      config,
+      format: fileTypes.YAML
+    });
+  });
+});