test(e2e): ensure valid config output format and commitlint success

Author: kguzek

tests/integration.test.ts

@@ -3,6 +3,43 @@ import { afterEach, beforeEach, describe, expect, test } from "vitest";
 import { getCurrentPackageManager } from "./utils/package-manager";
 import { TestEnvironment } from "./utils/test-environment";
 
+const expectGeneratedConfigToBeFormatted = async ({
+  env,
+  appPath,
+  expectedGeneratedFiles,
+}: {
+  env: TestEnvironment;
+  appPath: string;
+  expectedGeneratedFiles: string[];
+}) => {
+  const generatedFilesThatExist = expectedGeneratedFiles.filter((filePath) =>
+    env.fileExists(appPath, filePath),
+  );
+  const prettierCheckResult = await env.runPrettierCheckIfInstalled(
+    appPath,
+    generatedFilesThatExist,
+  );
+  expect(prettierCheckResult.success, prettierCheckResult.output).toBe(true);
+};
+
+const expectCommitlintHookToAllowMessage = async ({
+  env,
+  appPath,
+  message,
+}: {
+  env: TestEnvironment;
+  appPath: string;
+  message: string;
+}) => {
+  env.writeFile(
+    appPath,
+    "commitlint-hook-test.txt",
+    `commitlint hook test ${Date.now()}\n`,
+  );
+  const commitResult = await env.commitWithMessage(appPath, message);
+  expect(commitResult.success, commitResult.output).toBe(true);
+};
+
 describe("Next.js Integration Tests", () => {
   let testEnv: TestEnvironment;
   const packageManager = getCurrentPackageManager();
@@ -27,6 +64,18 @@ describe("Next.js Integration Tests", () => {
     const output = await env.runSolvroConfig(appPath, ["--all", "--force"]);
     expect(output).toContain("Konfiguracja zakończona pomyślnie");
 
+    await expectGeneratedConfigToBeFormatted({
+      env,
+      appPath,
+      expectedGeneratedFiles: [
+        "eslint.config.js",
+        "package.json",
+        ".github/workflows/ci.yml",
+        ".github/dependabot.yml",
+        ".commitlintrc.js",
+      ],
+    });
+
     const prettierResult = await env.runPrettier(appPath, true);
     expect(prettierResult.success).toBe(true);
 
@@ -77,6 +126,18 @@ describe("NestJS Integration Tests", () => {
     const output = await env.runSolvroConfig(appPath, ["--all", "--force"]);
     expect(output).toContain("Konfiguracja zakończona pomyślnie");
 
+    await expectGeneratedConfigToBeFormatted({
+      env,
+      appPath,
+      expectedGeneratedFiles: [
+        "eslint.config.mjs",
+        "package.json",
+        ".github/workflows/ci.yml",
+        ".github/dependabot.yml",
+        ".commitlintrc.js",
+      ],
+    });
+
     const prettierResult = await env.runPrettier(appPath, true);
     expect(prettierResult.success).toBe(true);
 
@@ -127,6 +188,18 @@ describe("Vite Integration Tests", () => {
     const output = await env.runSolvroConfig(appPath, ["--all", "--force"]);
     expect(output).toContain("Konfiguracja zakończona pomyślnie");
 
+    await expectGeneratedConfigToBeFormatted({
+      env,
+      appPath,
+      expectedGeneratedFiles: [
+        "eslint.config.js",
+        "package.json",
+        ".github/workflows/ci.yml",
+        ".github/dependabot.yml",
+        ".commitlintrc.js",
+      ],
+    });
+
     const prettierResult = await env.runPrettier(appPath, true);
     expect(prettierResult.success).toBe(true);
 
@@ -154,3 +227,55 @@ describe("Vite Integration Tests", () => {
     expect(packageJson).toContain('"prettier": "@solvro/config/prettier"');
   });
 });
+
+describe("Commitlint Integration Tests", () => {
+  let testEnv: TestEnvironment;
+  const packageManager = getCurrentPackageManager();
+
+  beforeEach(async () => {
+    testEnv = new TestEnvironment("commitlint-integration", packageManager);
+  });
+
+  afterEach(() => {
+    testEnv?.cleanup();
+  });
+
+  test(`should allow valid commit message through husky commit-msg hook with ${packageManager.name}`, async () => {
+    const env = testEnv;
+    await env.setup();
+
+    const appPath = await env.createNextjsApp("commitlint-test-app");
+    await env.installSolvroConfig(appPath);
+    await env.initGitRepo(appPath);
+
+    const output = await env.runSolvroConfig(appPath, [
+      "--commitlint",
+      "--force",
+    ]);
+    expect(output).toContain("Konfiguracja zakończona pomyślnie");
+
+    await expectGeneratedConfigToBeFormatted({
+      env,
+      appPath,
+      expectedGeneratedFiles: ["package.json", ".commitlintrc.js"],
+    });
+
+    const packageJson = JSON.parse(env.readFile(appPath, "package.json")) as {
+      scripts?: Record<string, string>;
+    };
+    packageJson.scripts = packageJson.scripts ?? {};
+    packageJson.scripts.test = packageJson.scripts.test ?? "true";
+    (packageJson as { type?: string }).type = "module";
+    env.writeFile(
+      appPath,
+      "package.json",
+      JSON.stringify(packageJson, null, 2),
+    );
+
+    await expectCommitlintHookToAllowMessage({
+      env,
+      appPath,
+      message: "chore: test commit",
+    });
+  });
+});

tests/utils/test-environment.ts

@@ -404,6 +404,81 @@ export class TestEnvironment {
     }
   }
 
+  async runPrettierCheckIfInstalled(
+    appPath: string,
+    paths: string[] = ["."],
+  ): Promise<{ success: boolean; output: string; skipped: boolean }> {
+    const packageJson = JSON.parse(this.readFile(appPath, "package.json")) as {
+      dependencies?: Record<string, string>;
+      devDependencies?: Record<string, string>;
+    };
+    const hasPrettier =
+      packageJson.dependencies?.prettier != null ||
+      packageJson.devDependencies?.prettier != null;
+
+    if (!hasPrettier) {
+      return {
+        success: true,
+        output: "Skipped prettier check: prettier is not installed.",
+        skipped: true,
+      };
+    }
+
+    if (paths.length === 0) {
+      return {
+        success: true,
+        output: "Skipped prettier check: no files selected.",
+        skipped: true,
+      };
+    }
+
+    try {
+      const { stdout, stderr } = await this.execute({
+        command: "localExecute",
+        args: ["prettier", "--check", ...paths],
+        cwd: appPath,
+        label: "prettier-check",
+      });
+      return { success: true, output: stdout + stderr, skipped: false };
+    } catch (error: any) {
+      return {
+        success: false,
+        output: (error.stdout || "") + (error.stderr || ""),
+        skipped: false,
+      };
+    }
+  }
+
+  async commitWithMessage(
+    appPath: string,
+    message: string,
+  ): Promise<{ success: boolean; output: string }> {
+    try {
+      const { stdout: addStdout, stderr: addStderr } = await execWithLogging(
+        "git",
+        ["add", "."],
+        { cwd: appPath },
+        "git-add-for-commit",
+      );
+      const { stdout: commitStdout, stderr: commitStderr } =
+        await execWithLogging(
+          "git",
+          ["commit", "-m", message],
+          { cwd: appPath },
+          "git-commit-with-message",
+        );
+      return {
+        success: true,
+        output: addStdout + addStderr + commitStdout + commitStderr,
+      };
+    } catch (error: any) {
+      return {
+        success: false,
+        output: (error.stdout || "") + (error.stderr || ""),
+      };
+    }
+  }
+
   async buildNextjsApp(
     appPath: string,
   ): Promise<{ success: boolean; output: string }> {