Add validate command (#45)

Raul Melo · web-flow · commit 819e1aacae9a · 2025-04-07T07:07:29.000+02:00
diff --git a/.changeset/chilly-clowns-start.md b/.changeset/chilly-clowns-start.md
@@ -0,0 +1,5 @@
+---
+'@codeowners-flow/cli': minor
+---
+
+Enhance string formatting while generating CODEOWNERS
diff --git a/.changeset/light-keys-crash.md b/.changeset/light-keys-crash.md
@@ -0,0 +1,7 @@
+---
+'@codeowners-flow/cli': minor
+---
+
+Add new "validate" command.
+
+With `codeowners-flow validate`, you can validate your CODEOWNERS file against a set of rules and ensure that it meets the required format and structure.
diff --git a/.changeset/purple-candies-matter.md b/.changeset/purple-candies-matter.md
@@ -0,0 +1,5 @@
+---
+'@codeowners-flow/cli': minor
+---
+
+Fix init boilerplate to import "defineConfig" from CLI
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -2,14 +2,6 @@
 # Instead, modify the `codeowners.config.mjs` file located at the root of your project.
 
 # -------------------- START -------------------- #
-# Everything else will be fallback to @company/core-team to approve
 ## Matching patterns...
-* @company/core-team @company/infra-team
-# -------------------- END -------------------- #
-
-# -------------------- START -------------------- #
-## Matching patterns...
-apps/website-frontend @company/website-team @company/core-team @company/infra-team
-## Except...
-apps/website-frontend/github
+* @company-team
 # -------------------- END -------------------- #
diff --git a/bun.lock b/bun.lock
diff --git a/packages/cli/eslint.config.js b/packages/cli/eslint.config.js
@@ -1,3 +1,8 @@
 import config from '@codeowners-flow/eslint';
 
-export default config;
+export default [
+  ...config,
+  {
+    ignores: ['src/__fixtures__/codeowners.config.mjs'],
+  },
+];
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -51,6 +51,7 @@
   "dependencies": {
     "@manypkg/find-root": "2.2.3",
     "cosmiconfig": "9.0.0",
+    "dedent": "1.5.3",
     "meow": "13.2.0",
     "zod": "3.24.2",
     "zod-validation-error": "3.4.0"
diff --git a/packages/cli/src/__fixtures__/codeowners.config.mjs b/packages/cli/src/__fixtures__/codeowners.config.mjs
@@ -0,0 +1,13 @@
+export default {
+  outDir: '.github',
+  rules: [
+    {
+      patterns: ['*'],
+      owners: [
+        {
+          name: '@company-team',
+        },
+      ],
+    },
+  ],
+};
diff --git a/packages/cli/src/config/index.ts b/packages/cli/src/config/index.ts
@@ -18,6 +18,7 @@ export async function loadUserConfig(
   rootDir: string,
   configRelativePath?: string,
 ) {
+  console.log('configRelativePath', configRelativePath);
   try {
     const result = configRelativePath
       ? await explorer.load(path.resolve(rootDir, configRelativePath))
diff --git a/packages/cli/src/generate-codeowners.test.ts b/packages/cli/src/generate-codeowners.test.ts
@@ -7,9 +7,9 @@ vi.mock('./config/index.js', () => ({
 }));
 
 const mockWriteFileSync = vi.fn();
-vi.mock('node:fs', () => ({
+vi.mock('node:fs/promises', () => ({
   default: {
-    writeFileSync: (...args: any) => mockWriteFileSync(...args),
+    writeFile: (...args: any) => mockWriteFileSync(...args),
   },
 }));
 
@@ -57,8 +57,7 @@ describe('fn: generateCodeOwners', () => {
       # -------------------- START -------------------- #
       ## Matching patterns...
       packages/core/**/* @team/core
-      # -------------------- END -------------------- #
-      "
+      # -------------------- END -------------------- #"
     `);
   });
 
@@ -73,8 +72,7 @@ describe('fn: generateCodeOwners', () => {
       # -------------------- START -------------------- #
       ## Matching patterns...
       packages/core/**/* @team/core
-      # -------------------- END -------------------- #
-      ",
+      # -------------------- END -------------------- #",
         "ownersPath": "/root/test/CODEOWNERS",
       }
     `);
diff --git a/packages/cli/src/generate-codeowners.ts b/packages/cli/src/generate-codeowners.ts
@@ -1,4 +1,4 @@
-import fs from 'node:fs';
+import fs from 'node:fs/promises';
 import path from 'node:path';
 
 import { findRoot } from '@manypkg/find-root';
@@ -16,23 +16,28 @@ export async function generateCodeOwners({
   ownersContent: string;
   ownersPath: string;
 }> {
-  const { rootDir } = await findRoot(process.cwd());
+  const codeOwners = await getCodeOwners(config);
+  await writeCodeOwnersFile(codeOwners.ownersPath, codeOwners.ownersContent);
+
+  return codeOwners;
+}
 
-  const loadedConfig = await loadUserConfig(rootDir, config);
+export async function getCodeOwners(config?: string) {
+  const { rootDir } = await findRoot(process.cwd());
 
-  const ownersContent = getCodeOwnersContent(loadedConfig);
-  const ownersPath = await getCodeOwnersPath(loadedConfig, rootDir);
+  const userConfig = await loadUserConfig(rootDir, config);
 
-  writeCodeOwnersFile(ownersPath, ownersContent);
+  const ownersContent = getCodeOwnersContent(userConfig);
+  const ownersPath = await getCodeOwnersPath(userConfig, rootDir);
 
   return {
     ownersContent,
     ownersPath,
   };
 }
 
-function writeCodeOwnersFile(path: string, content: string): void {
-  fs.writeFileSync(path, content, 'utf-8');
+function writeCodeOwnersFile(path: string, content: string): Promise<void> {
+  return fs.writeFile(path, content, 'utf-8');
 }
 
 function getCodeOwnersPath(
diff --git a/packages/cli/src/get-codeowners-content.test.ts b/packages/cli/src/get-codeowners-content.test.ts
@@ -24,8 +24,7 @@ describe('getCodeOwnersContent', () => {
       # -------------------- START -------------------- #
       ## Matching patterns...
       packages/core/**/* @team/core
-      # -------------------- END -------------------- #
-      "
+      # -------------------- END -------------------- #"
     `);
   });
 
@@ -57,8 +56,7 @@ describe('getCodeOwnersContent', () => {
       packages/core @team/core
       pnpm-workspace.yaml @team/core
       .github/workflows @team/core
-      # -------------------- END -------------------- #
-      "
+      # -------------------- END -------------------- #"
     `);
   });
 
@@ -87,8 +85,7 @@ describe('getCodeOwnersContent', () => {
       # This is another comment
       ## Matching patterns...
       packages/core/**/* @team/core
-      # -------------------- END -------------------- #
-      "
+      # -------------------- END -------------------- #"
     `);
   });
 
@@ -117,8 +114,7 @@ describe('getCodeOwnersContent', () => {
       packages/core/**/* @team/core
       ## Except...
       packages/core/**/test
-      # -------------------- END -------------------- #
-      "
+      # -------------------- END -------------------- #"
     `);
   });
 
@@ -148,8 +144,7 @@ describe('getCodeOwnersContent', () => {
       ## Except...
       packages/core/**/test
       packages/core/**/mock
-      # -------------------- END -------------------- #
-      "
+      # -------------------- END -------------------- #"
     `);
   });
 });
diff --git a/packages/cli/src/get-codeowners-content.ts b/packages/cli/src/get-codeowners-content.ts
@@ -1,3 +1,5 @@
+import dedent from 'dedent';
+
 import type { UserConfig } from './config/index.js';
 
 export function getCodeOwnersContent(userConfig: UserConfig) {
@@ -34,7 +36,7 @@ export function getCodeOwnersContent(userConfig: UserConfig) {
     content.push(...partialConfig);
   }
 
-  return content.join('\n');
+  return dedent(content.join('\n'));
 }
 
 function getSectionDivider(heading: string): string {
diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -2,12 +2,14 @@ import meow from 'meow';
 
 import { generateCodeOwners } from './generate-codeowners.js';
 import { initProject } from './init.js';
+import { validateCodeowners } from './validate-codeowners.ts';
 
 const cli = meow(
   `
   Usage
   $ codeowners-flow generate
   $ codeowners-flow generate --config /path/to/config.mjs
+  $ codeowners-flow validate
   $ codeowners-flow init
 
   Example
@@ -30,6 +32,10 @@ const cli = meow(
 const [command] = cli.input;
 
 switch (command) {
+  case 'validate': {
+    validateCodeowners(cli.flags).then(console.log).catch(console.error);
+    break;
+  }
   case 'generate': {
     generateCodeOwners(cli.flags)
       .then(({ ownersPath }) => {
diff --git a/packages/cli/src/init.test.ts b/packages/cli/src/init.test.ts
@@ -29,20 +29,21 @@ describe('fn: initProject', () => {
 
     expect(path).toMatchInlineSnapshot('"/path/to/codeowners.config.mjs"');
     expect(content).toMatchInlineSnapshot(`
-      "/** @type {import('@codeowners-flow/cli/config').UserConfig} */
-      export default {
-        outDir: '.github',
-        rules: [
-          {
-            patterns: ['*'],
-            owners: [
-              {
-                name: '@company-team',
-              },
-            ],
-          },
-        ],
-      };"
+      "import { defineConfig } from '@codeowners-flow/cli/config';
+
+        export default defineConfig({
+          outDir: '.github',
+          rules: [
+            {
+              patterns: ['*'],
+              owners: [
+                {
+                  name: '@company-team',
+                },
+              ],
+            },
+          ],
+        });"
     `);
   });
 });
diff --git a/packages/cli/src/init.ts b/packages/cli/src/init.ts
@@ -16,18 +16,19 @@ export async function initProject() {
 }
 
 function getConfigTemplate() {
-  return `/** @type {import('@codeowners-flow/cli/config').UserConfig} */
-export default {
-  outDir: '.github',
-  rules: [
-    {
-      patterns: ['*'],
-      owners: [
-        {
-          name: '@company-team',
-        },
-      ],
-    },
-  ],
-};`;
+  return `import { defineConfig } from '@codeowners-flow/cli/config';
+
+  export default defineConfig({
+    outDir: '.github',
+    rules: [
+      {
+        patterns: ['*'],
+        owners: [
+          {
+            name: '@company-team',
+          },
+        ],
+      },
+    ],
+  });`;
 }
diff --git a/packages/cli/src/validate-codeowners.test.ts b/packages/cli/src/validate-codeowners.test.ts
@@ -0,0 +1,66 @@
+import { describe, expect, it, vi } from 'vitest';
+
+import { validateCodeowners } from './validate-codeowners.ts';
+
+const mockReadFile = vi.fn();
+vi.mock('node:fs/promises', async () => {
+  const actualModule = await vi.importActual('node:fs/promises');
+
+  return {
+    default: {
+      // @ts-expect-error - default is there
+      ...actualModule.default,
+      readFile: (...args: any[]) => mockReadFile(...args),
+    },
+  };
+});
+
+describe('fn: validateCodeowners', () => {
+  it('should exit process with status code 1', async () => {
+    const mockFile = `# This file was generated automatically by codeowners-flow. Do not edit it manually.
+    # Instead, modify the \`codeowners.config.mjs\` file located at the root of your project.
+
+    # -------------------- START -------------------- #
+    ## Matching patterns...
+    app/package.json @company-team
+    # -------------------- END -------------------- #
+    `;
+    mockReadFile.mockResolvedValue(mockFile);
+    const exitSpy = vi.spyOn(process, 'exit');
+    const consoleSpy = vi.spyOn(console, 'error');
+
+    await validateCodeowners({
+      config: 'packages/cli/src/__fixtures__/codeowners.config.mjs',
+    });
+
+    expect(exitSpy).toHaveBeenCalledWith(1);
+    expect(consoleSpy).toHaveBeenCalledWith(
+      'CODEOWNERS file is not up to date or it was modified manually. Run `codeowners-flow generate` to update it.',
+    );
+    exitSpy.mockRestore();
+    consoleSpy.mockRestore();
+  });
+
+  it('should exit process with status code 0 if CODEOWNERS file is up to date', async () => {
+    const mockFile = `# This file was generated automatically by codeowners-flow. Do not edit it manually.
+    # Instead, modify the \`codeowners.config.mjs\` file located at the root of your project.
+
+    # -------------------- START -------------------- #
+    ## Matching patterns...
+    * @company-team
+    # -------------------- END -------------------- #`;
+
+    mockReadFile.mockResolvedValue(mockFile);
+    const exitSpy = vi.spyOn(process, 'exit');
+    const consoleSpy = vi.spyOn(console, 'log');
+
+    await validateCodeowners({
+      config: 'packages/cli/src/__fixtures__/codeowners.config.mjs',
+    });
+
+    expect(exitSpy).toHaveBeenCalledWith(0);
+    expect(consoleSpy).toHaveBeenCalledWith('CODEOWNERS file is up to date.');
+    exitSpy.mockRestore();
+    consoleSpy.mockRestore();
+  });
+});
diff --git a/packages/cli/src/validate-codeowners.ts b/packages/cli/src/validate-codeowners.ts
diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@codeowners-flow/cli': minor
 +---
++
 +Enhance string formatting while generating CODEOWNERS