@form8ion/javascript 15.6.1 → 15.7.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@form8ion/javascript",
   "description": "JavaScript language plugin for the @form8ion toolset",
   "license": "MIT",
-  "version": "15.6.1",
+  "version": "15.7.0",
   "type": "module",
   "engines": {
     "node": "^20.19.0 || >=22.14.0"
@@ -94,7 +94,7 @@
     "@form8ion/remark-lint-preset": "6.0.7",
     "@rollup/plugin-node-resolve": "16.0.3",
     "@travi/any": "3.1.3",
-    "@vitest/coverage-v8": "4.1.0",
+    "@vitest/coverage-v8": "4.1.1",
     "ban-sensitive-files": "1.10.11",
     "chai": "6.2.2",
     "cz-conventional-changelog": "3.3.0",
@@ -110,10 +110,10 @@
     "remark-toc": "9.0.0",
     "remark-usage": "11.0.1",
     "rimraf": "6.1.3",
-    "rollup": "4.59.0",
+    "rollup": "4.60.0",
     "rollup-plugin-auto-external": "2.0.0",
     "testdouble": "3.20.2",
-    "vitest": "4.1.0",
+    "vitest": "4.1.1",
     "vitest-when": "0.10.0"
   }
 }

package/src/coverage/scaffolder.js

@@ -2,6 +2,6 @@ import deepmerge from 'deepmerge';
 import {scaffold as scaffoldCodecov} from '@form8ion/codecov';
 import {scaffold as scaffoldC8} from '@form8ion/c8';
 
-export default async function scaffoldCoverage({projectRoot, vcs, visibility, pathWithinParent}) {
-  return deepmerge(await scaffoldC8({projectRoot}), await scaffoldCodecov({vcs, visibility, pathWithinParent}));
+export default async function scaffoldCoverage({projectRoot}) {
+  return deepmerge(await scaffoldC8({projectRoot}), await scaffoldCodecov({projectRoot}));
 }

package/src/coverage/scaffolder.test.js

@@ -1,7 +1,7 @@
 import {scaffold as scaffoldCodecov} from '@form8ion/codecov';
 import {scaffold as scaffoldC8} from '@form8ion/c8';
 
-import {describe, vi, it, expect, afterEach} from 'vitest';
+import {describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 import {when} from 'vitest-when';
 
@@ -11,21 +11,14 @@ vi.mock('@form8ion/codecov');
 vi.mock('@form8ion/c8');
 
 describe('coverage scaffolder', () => {
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
   it('should scaffold coverage measurement and reporting', async () => {
-    const vcs = any.simpleObject();
-    const visibility = any.word();
     const projectRoot = any.string();
     const c8Results = any.simpleObject();
     const codecovResults = any.simpleObject();
-    const pathWithinParent = any.string();
     when(scaffoldC8).calledWith({projectRoot}).thenResolve(c8Results);
-    when(scaffoldCodecov).calledWith({vcs, visibility, pathWithinParent}).thenResolve(codecovResults);
+    when(scaffoldCodecov).calledWith({projectRoot}).thenResolve(codecovResults);
 
-    const results = await scaffold({vcs, visibility, projectRoot, pathWithinParent});
+    const results = await scaffold({projectRoot});
 
     expect(results).toEqual({...c8Results, ...codecovResults});
   });

package/src/options/validator.js

@@ -32,6 +32,7 @@ export function validate(options) {
     }).default({registries: {}}),
     plugins: {
       unitTestFrameworks: pluginsSchema,
+      integrationTestFrameworks: pluginsSchema,
       packageBundlers: pluginsSchema,
       applicationTypes: pluginsSchema,
       packageTypes: pluginsSchema,

package/src/options/validator.test.js

@@ -62,6 +62,7 @@ describe('options validator', () => {
         configs,
         plugins: {
           unitTestFrameworks: pluginsSchema,
+          integrationTestFrameworks: pluginsSchema,
           packageBundlers: pluginsSchema,
           applicationTypes: pluginsSchema,
           packageTypes: pluginsSchema,

package/src/scaffolder.js

@@ -37,6 +37,7 @@ export default async function scaffoldJavascript(options) {
       monorepoTypes,
       packageBundlers,
       unitTestFrameworks,
+      integrationTestFrameworks,
       hosts,
       ciServices
     }
@@ -89,12 +90,12 @@ export default async function scaffoldJavascript(options) {
   const verificationResults = await scaffoldVerification({
     projectRoot,
     dialect,
-    visibility,
     packageManager,
     vcs,
     registries: configs.registries,
     tests,
     unitTestFrameworks,
+    integrationTestFrameworks,
     decisions,
     pathWithinParent
   });

package/src/scaffolder.test.js

@@ -82,6 +82,7 @@ describe('javascript project scaffolder', () => {
     const monorepoTypes = any.simpleObject();
     const packageBundlers = any.simpleObject();
     const unitTestFrameworks = any.simpleObject();
+    const integrationTestFrameworks = any.simpleObject();
     const testFilenamePattern = any.string();
     const buildDirectory = any.string();
     const packageResults = {...any.simpleObject(), packageName};
@@ -108,7 +109,16 @@ describe('javascript project scaffolder', () => {
         visibility,
         license,
         decisions,
-        plugins: {ciServices, hosts, applicationTypes, packageTypes, monorepoTypes, packageBundlers, unitTestFrameworks}
+        plugins: {
+          ciServices,
+          hosts,
+          applicationTypes,
+          packageTypes,
+          monorepoTypes,
+          packageBundlers,
+          unitTestFrameworks,
+          integrationTestFrameworks
+        }
       });
     when(prompt)
       .calledWith(ciServices, hosts, visibility, vcs, decisions, configs, pathWithinParent)
@@ -155,14 +165,14 @@ describe('javascript project scaffolder', () => {
       .calledWith({
         projectRoot,
         dialect,
-        visibility,
         packageManager,
         vcs,
         registries,
         tests,
         decisions,
         pathWithinParent,
-        unitTestFrameworks
+        unitTestFrameworks,
+        integrationTestFrameworks
       })
       .thenResolve(verificationResults);
     when(scaffoldNodeVersion).calledWith({projectRoot, nodeVersionCategory}).thenResolve(nodeVersionResults);

package/src/testing/integration/index.js

@@ -0,0 +1 @@
+export {default as scaffold} from './scaffolder.js';

package/src/testing/integration/scaffolder.js

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

package/src/testing/integration/scaffolder.test.js

@@ -0,0 +1,9 @@
+import {describe, it, expect} from 'vitest';
+
+import scaffoldIntegrationTesting from './scaffolder.js';
+
+describe('integration testing scaffolder', () => {
+  it('should scaffold the chosen framework', async () => {
+    expect(scaffoldIntegrationTesting()).toEqual({});
+  });
+});

package/src/testing/scaffolder.js

@@ -1,31 +1,26 @@
 import deepmerge from 'deepmerge';
 
 import {scaffold as scaffoldUnitTesting} from './unit/index.js';
+import {scaffold as scaffoldIntegrationTesting} from './integration/index.js';
 
 export default async function scaffoldTesting({
   projectRoot,
-  visibility,
   tests: {unit, integration},
-  vcs,
   unitTestFrameworks,
+  integrationTestFrameworks,
   decisions,
-  dialect,
-  pathWithinParent
+  dialect
 }) {
-  const unitResults = unit
-    ? await scaffoldUnitTesting({
-      projectRoot,
-      visibility,
-      vcs,
-      frameworks: unitTestFrameworks,
-      decisions,
-      dialect,
-      pathWithinParent
-    })
-    : {};
+  const [unitResults, integrationResults] = await Promise.all([
+    unit ? scaffoldUnitTesting({projectRoot, frameworks: unitTestFrameworks, decisions, dialect}) : {},
+    integration
+      ? scaffoldIntegrationTesting({projectRoot, frameworks: integrationTestFrameworks, decisions, dialect})
+      : {}
+  ]);
 
-  return deepmerge(
+  return deepmerge.all([
     {dependencies: {javascript: {development: [...(unit || integration) ? ['@travi/any'] : []]}}, eslint: {}},
-    unitResults
-  );
+    unitResults,
+    integrationResults
+  ]);
 }

package/src/testing/scaffolder.test.js

@@ -1,63 +1,99 @@
+import deepmerge from 'deepmerge';
+
 import any from '@travi/any';
 import {it, expect, describe, vi, beforeEach} from 'vitest';
 import {when} from 'vitest-when';
 
 import {scaffold as scaffoldUnitTesting} from './unit/index.js';
+import {scaffold as scaffoldIntegrationTesting} from './integration/index.js';
 import scaffoldTesting from './scaffolder.js';
 
+vi.mock('deepmerge');
 vi.mock('./unit/index.js');
+vi.mock('./integration/index.js');
 
 describe('testing scaffolder', () => {
   const projectRoot = any.string();
-  const visibility = any.word();
   const dialect = any.word();
-  const unitTestingDevDependencies = any.listOf(any.string);
-  const unitTestNextSteps = any.listOf(any.simpleObject);
-  const unitTestScripts = any.simpleObject();
-  const unitTestFilesToIgnoreFromVcs = any.listOf(any.string);
-  const unitTestDirectoriesToIgnoreFromVcs = any.listOf(any.string);
-  const vcs = any.simpleObject();
   const unitTestFrameworks = any.simpleObject();
+  const integrationTestFrameworks = any.simpleObject();
   const decisions = any.simpleObject();
-  const pathWithinParent = any.string();
+  const unitTestScaffoldResults = any.simpleObject();
+  const integrationTestScaffoldResults = any.simpleObject();
+  const mergedResults = any.simpleObject();
 
   beforeEach(() => {
     when(scaffoldUnitTesting)
-      .calledWith({projectRoot, visibility, vcs, frameworks: unitTestFrameworks, decisions, dialect, pathWithinParent})
-      .thenResolve({
-        dependencies: {javascript: {development: unitTestingDevDependencies}},
-        scripts: unitTestScripts,
-        vcsIgnore: {files: unitTestFilesToIgnoreFromVcs, directories: unitTestDirectoriesToIgnoreFromVcs},
-        nextSteps: unitTestNextSteps
-      });
+      .calledWith({projectRoot, frameworks: unitTestFrameworks, decisions, dialect})
+      .thenResolve(unitTestScaffoldResults);
+    when(scaffoldIntegrationTesting)
+      .calledWith({projectRoot, frameworks: integrationTestFrameworks, decisions, dialect})
+      .thenResolve(integrationTestScaffoldResults);
   });
 
   it('should scaffold unit testing if the project will be unit test', async () => {
+    when(deepmerge.all)
+      .calledWith([
+        {dependencies: {javascript: {development: ['@travi/any']}}, eslint: {}},
+        unitTestScaffoldResults,
+        {}
+      ])
+      .thenReturn(mergedResults);
+
     expect(await scaffoldTesting({
       projectRoot,
-      visibility,
-      tests: {unit: true},
-      vcs,
+      tests: {unit: true, integration: false},
       unitTestFrameworks,
+      integrationTestFrameworks,
       decisions,
-      dialect,
-      pathWithinParent
-    })).toEqual({
-      dependencies: {javascript: {development: ['@travi/any', ...unitTestingDevDependencies]}},
-      scripts: unitTestScripts,
-      vcsIgnore: {files: unitTestFilesToIgnoreFromVcs, directories: unitTestDirectoriesToIgnoreFromVcs},
-      eslint: {},
-      nextSteps: unitTestNextSteps
-    });
+      dialect
+    })).toEqual(mergedResults);
   });
 
-  it('should not scaffold unit testing if the project will not be unit tested', async () => {
-    expect(await scaffoldTesting({projectRoot, visibility, tests: {unit: false, integration: true}, pathWithinParent}))
-      .toEqual({dependencies: {javascript: {development: ['@travi/any']}}, eslint: {}});
+  it('should scaffold integration testing if the project will be integration tested', async () => {
+    when(deepmerge.all)
+      .calledWith([
+        {dependencies: {javascript: {development: ['@travi/any']}}, eslint: {}},
+        {},
+        integrationTestScaffoldResults
+      ])
+      .thenReturn(mergedResults);
+
+    expect(await scaffoldTesting({
+      projectRoot,
+      tests: {unit: false, integration: true},
+      unitTestFrameworks,
+      integrationTestFrameworks,
+      decisions,
+      dialect
+    })).toEqual(mergedResults);
+  });
+
+  it('should scaffold both unit testing and integration testing if both layers are planned', async () => {
+    when(deepmerge.all)
+      .calledWith([
+        {dependencies: {javascript: {development: ['@travi/any']}}, eslint: {}},
+        unitTestScaffoldResults,
+        integrationTestScaffoldResults
+      ])
+      .thenReturn(mergedResults);
+
+    expect(await scaffoldTesting({
+      projectRoot,
+      tests: {unit: true, integration: true},
+      unitTestFrameworks,
+      integrationTestFrameworks,
+      decisions,
+      dialect
+    })).toEqual(mergedResults);
   });
 
   it('should not scaffold testing if the project will not be tested', async () => {
-    expect(await scaffoldTesting({projectRoot, visibility, tests: {unit: false, integration: false}, pathWithinParent}))
-      .toEqual({dependencies: {javascript: {development: []}}, eslint: {}});
+    when(deepmerge.all)
+      .calledWith([{dependencies: {javascript: {development: []}}, eslint: {}}, {}, {}])
+      .thenReturn(mergedResults);
+
+    expect(await scaffoldTesting({projectRoot, tests: {unit: false, integration: false}}))
+      .toEqual(mergedResults);
   });
 });

package/src/testing/unit/scaffolder.js

@@ -6,20 +6,12 @@ import {scaffold as scaffoldCoverage} from '../../coverage/index.js';
 import chooseFramework from './prompt.js';
 import {pluginsSchema} from '../../plugins-schemas.js';
 
-export default async function scaffoldUnitTesting({
-  projectRoot,
-  frameworks,
-  decisions,
-  visibility,
-  vcs,
-  pathWithinParent,
-  dialect
-}) {
+export default async function scaffoldUnitTesting({projectRoot, frameworks, decisions, dialect}) {
   const validatedFrameworks = validateOptions(pluginsSchema, frameworks);
   const [framework, coverage] = await Promise.all([
     chooseFramework({frameworks: validatedFrameworks, decisions})
       .then(chosenFramework => scaffoldFrameworkChoice(validatedFrameworks, chosenFramework, {projectRoot, dialect})),
-    scaffoldCoverage({projectRoot, vcs, visibility, pathWithinParent})
+    scaffoldCoverage({projectRoot})
   ]);
 
   return deepmerge.all([

package/src/testing/unit/scaffolder.test.js

@@ -19,27 +19,22 @@ vi.mock('./prompt.js');
 
 describe('unit testing scaffolder', () => {
   const projectRoot = any.string();
-  const vcs = any.simpleObject();
   const frameworks = any.simpleObject();
   const decisions = any.simpleObject();
   const chosenFramework = any.word();
   const dialect = any.word();
-  const pathWithinParent = any.string();
   const coverageResults = any.simpleObject();
   const unitTestFrameworkResults = any.simpleObject();
   const mergedResults = any.simpleObject();
 
   it('should scaffold the chosen framework', async () => {
-    const visibility = any.word();
     const validatedFrameworks = any.simpleObject();
     when(validateOptions).calledWith(pluginsSchema, frameworks).thenReturn(validatedFrameworks);
     when(prompt).calledWith({frameworks: validatedFrameworks, decisions}).thenResolve(chosenFramework);
     when(scaffoldChoice)
       .calledWith(validatedFrameworks, chosenFramework, {projectRoot, dialect})
       .thenResolve(unitTestFrameworkResults);
-    when(scaffoldCoverage)
-      .calledWith({projectRoot, vcs, visibility, pathWithinParent})
-      .thenResolve(coverageResults);
+    when(scaffoldCoverage).calledWith({projectRoot}).thenResolve(coverageResults);
     when(deepmerge.all)
       .calledWith([
         {scripts: {'test:unit': 'cross-env NODE_ENV=test c8 run-s test:unit:base'}},
@@ -48,7 +43,6 @@ describe('unit testing scaffolder', () => {
       ])
       .thenReturn(mergedResults);
 
-    expect(await scaffoldUnitTesting({projectRoot, frameworks, decisions, vcs, visibility, pathWithinParent, dialect}))
-      .toEqual(mergedResults);
+    expect(await scaffoldUnitTesting({projectRoot, frameworks, decisions, dialect})).toEqual(mergedResults);
   });
 });

package/src/verification/scaffolder.js

@@ -7,26 +7,17 @@ import {scaffold as scaffoldLinting} from '../linting/index.js';
 export async function scaffoldVerification({
   projectRoot,
   dialect,
-  visibility,
   packageManager,
   vcs,
   registries,
   tests,
   unitTestFrameworks,
+  integrationTestFrameworks,
   decisions,
   pathWithinParent
 }) {
   const [testingResults, lintingResults, huskyResults] = await Promise.all([
-    scaffoldTesting({
-      projectRoot,
-      tests,
-      visibility,
-      vcs,
-      unitTestFrameworks,
-      decisions,
-      dialect,
-      pathWithinParent
-    }),
+    scaffoldTesting({projectRoot, tests, unitTestFrameworks, integrationTestFrameworks, decisions, dialect}),
     scaffoldLinting({projectRoot, packageManager, registries, vcs, pathWithinParent}),
     scaffoldHusky({projectRoot, packageManager, pathWithinParent})
   ]);

package/src/verification/scaffolder.test.js

@@ -17,12 +17,12 @@ vi.mock('../linting/index.js');
 describe('verification scaffolder', () => {
   it('should scaffold linting and testing', async () => {
     const projectRoot = any.string();
-    const visibility = any.string();
     const packageManager = any.string();
     const dialect = any.word();
     const vcs = any.simpleObject();
     const tests = any.simpleObject();
     const unitTestFrameworks = any.simpleObject();
+    const integrationTestFrameworks = any.simpleObject();
     const decisions = any.simpleObject();
     const lintingResults = any.simpleObject();
     const huskyResults = any.simpleObject();
@@ -35,7 +35,7 @@ describe('verification scaffolder', () => {
       .calledWith({projectRoot, vcs, packageManager, registries, pathWithinParent})
       .thenResolve(lintingResults);
     when(scaffoldTesting)
-      .calledWith({projectRoot, tests, visibility, vcs, unitTestFrameworks, decisions, dialect, pathWithinParent})
+      .calledWith({projectRoot, tests, unitTestFrameworks, integrationTestFrameworks, decisions, dialect})
       .thenResolve(testingResults);
     when(scaffoldHusky).calledWith({projectRoot, packageManager, pathWithinParent}).thenResolve(huskyResults);
     when(deepmerge.all).calledWith([testingResults, lintingResults, huskyResults]).thenReturn(mergedResults);
@@ -45,9 +45,9 @@ describe('verification scaffolder', () => {
       vcs,
       dialect,
       tests,
-      visibility,
       decisions,
       unitTestFrameworks,
+      integrationTestFrameworks,
       packageManager,
       registries,
       pathWithinParent