Integration scaffolder

.github/workflows/integration.yml

@@ -12,5 +12,9 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: '20.x'
+          cache: 'npm'
       - run: npm ci
-      - run: npm run test:integration
+      - run: npm run build
+      - run: ls -lart
+      - run: node dist/test/integration/scaffold.mjs
+      - run: ls -lart

src/api.mts

@@ -133,7 +133,15 @@ async function install(PACKAGE_WORKING_DIR: string) {
  *
  * @param {*} param0
  */
-export async function createPackage({ answers }: { answers: Answer }) {
+export async function createPackage({
+  answers,
+  isInstall = true,
+  isRun = true,
+}: {
+  answers: Answer;
+  isInstall?: boolean;
+  isRun?: boolean;
+}) {
   // First, determine if we're creating a namespaced directory for the
   // package. If not, scaffold out the package contents directly in the cwd
   const { namespacedDir = true, packageName, packageTemplate } = answers || {};
@@ -192,8 +200,12 @@ export async function createPackage({ answers }: { answers: Answer }) {
         camelComponentName,
       } as GenerateData,
     });
-    await install(PACKAGE_WORKING_DIR);
-    await runComponent(PACKAGE_WORKING_DIR);
+    if (isInstall) {
+      await install(PACKAGE_WORKING_DIR);
+    }
+    if (isRun) {
+      await runComponent(PACKAGE_WORKING_DIR);
+    }
   } else if (packageTemplate === TemplateTypes.VANILLA) {
     await generate({
       walkPath: TemplatePaths.VANILLA,
@@ -202,14 +214,18 @@ export async function createPackage({ answers }: { answers: Answer }) {
 
       data: { ...CONFIG, ...answers } as GenerateData,
     });
-    await install(PACKAGE_WORKING_DIR);
+    if (isInstall) {
+      await install(PACKAGE_WORKING_DIR);
+    }
   } else if (packageTemplate === TemplateTypes.MICROSITE) {
     await generate({
       walkPath: TemplatePaths.MICROSITE,
       packageTemplate,
       packageWorkingDir: PACKAGE_WORKING_DIR,
       data: { ...CONFIG, ...answers } as GenerateData,
     });
-    await install(PACKAGE_WORKING_DIR);
+    if (isInstall) {
+      await install(PACKAGE_WORKING_DIR);
+    }
   }
 }

src/test/integration/scaffold.mts

@@ -0,0 +1,39 @@
+import { access, rm } from 'node:fs/promises';
+import { resolve } from 'node:path';
+import LoggerFactory from '../../logger.mjs';
+import { Answer } from '../../types/index.mjs';
+import { TemplateTypes } from '../../util.mjs';
+import { createPackage } from '../../api.mjs';
+
+const logger = LoggerFactory({ label: '/test/integration.test.mts' });
+
+async function exists(filePath: string) {
+  try {
+    await access(filePath);
+    return true;
+  } catch (error) {
+    return false;
+  }
+}
+
+(async () => {
+  const packageName = 'integration-test-vue';
+  const scaffoldedPath = resolve(process.cwd(), packageName);
+  if (await exists(scaffoldedPath)) {
+    logger.info(`Removing ${scaffoldedPath}`);
+    await rm(scaffoldedPath, { recursive: true, force: true });
+  }
+
+  const answers: Answer = {
+    packageName,
+    packageDescription: 'This is a test vue component',
+    packageAuthor: 'rei',
+    packageOwnerTeamId: 'testTeamId',
+    packageTemplate: TemplateTypes.VUE,
+    packageUsesDataDog: false,
+    namespacedDir: true,
+  };
+
+  logger.info(`Executing createPackage from integration test`);
+  await createPackage({ answers, isInstall: false, isRun: false });
+})();

tsconfig.json

@@ -15,5 +15,5 @@
     "noFallthroughCasesInSwitch": true,
     "resolveJsonModule": true
   },
-  "include": ["src", "types", "vitest.config.mts"]
+  "include": ["src", "types"]
 }

vitest.config.mts

@@ -10,7 +10,14 @@ export default defineConfig({
       provider: 'v8',
       reporter: ['text', 'json-summary', 'html'],
       all: true,
-      exclude: ['test', 'dist', '**/*.d.mts', 'src/bin/*.mts', 'src/api.mts'],
+      exclude: [
+        'test',
+        'dist',
+        '**/*.d.mts',
+        'src/bin/*.mts',
+        'src/api.mts',
+        'src/test/integration/scaffold.mts',
+      ],
       include: ['src', 'test'],
       clean: true,
       thresholds: {