Add --config flag (#30)

.changeset/strong-windows-sleep.md

@@ -0,0 +1,11 @@
+---
+'@codeowners-flow/cli': minor
+---
+
+Accept configuration path to generate CODEOWNERS
+
+Now, users can point where the config file is located:
+
+```bash
+npx codeowners-flow generate -c ./path/to/config
+```

.gitignore

@@ -2,4 +2,5 @@ node_modules/
 dist/
 .turbo
 tsconfig.tsbuildinfo
-.history
+.history
+coverage/

examples/common-js/codeowners.config.cjs

@@ -0,0 +1,10 @@
+/** @type {import('@codeowners-flow/cli/config').UserConfig} */
+module.exports = {
+  outDir: '.github',
+  rules: [
+    {
+      patterns: ['*'],
+      owners: [{ name: '@company/core-team' }],
+    },
+  ],
+};

codeowners.config.mjs → examples/composing/codeowners.config.mjs

@@ -1,7 +1,7 @@
 import {
   defineConfig,
-  defineRule,
   defineOwner,
+  defineRule,
 } from '@codeowners-flow/cli/config';
 
 const mainTeams = [

examples/different-file-name/codeowners.mjs

@@ -0,0 +1,10 @@
+/** @type {import('@codeowners-flow/cli/config').UserConfig} */
+export default {
+  outDir: '.github',
+  rules: [
+    {
+      patterns: ['*'],
+      owners: [{ name: '@company/core-team' }],
+    },
+  ],
+};

examples/simple/codeowners.config.mjs

@@ -0,0 +1,10 @@
+/** @type {import('@codeowners-flow/cli/config').UserConfig} */
+export default {
+  outDir: '.github',
+  rules: [
+    {
+      patterns: ['*'],
+      owners: [{ name: '@company/core-team' }],
+    },
+  ],
+};

examples/using-define-fn/codeowners.config.mjs

@@ -0,0 +1,15 @@
+import {
+  defineConfig,
+  defineOwner,
+  defineRule,
+} from '@codeowners-flow/cli/config';
+
+export default defineConfig({
+  outDir: '.github',
+  rules: [
+    defineRule({
+      patterns: ['*'],
+      owners: [defineOwner({ name: '@company/core-team' })],
+    }),
+  ],
+});

examples/yaml/codeowners.config.yaml

@@ -0,0 +1,8 @@
+outDir: .github
+rules:
+  - patterns:
+      - '*'
+      - 'docs/**'
+    owners:
+      - name: '@company/core-team'
+      - name: '@company/infra-team'

packages/cli/README.md

@@ -16,6 +16,21 @@ To understand the motivations behind this project, refer to the [root repository
 - Node 16 or later
 - pnpm, yarn, or npm
 
+## Usage
+
+```
+Usage
+$ codeowners-flow generate
+$ codeowners-flow generate --config /path/to/config.mjs
+$ codeowners-flow init
+
+Example
+  $ codeowners-flow generate
+
+    CODEOWNERS file generated! 🎉
+    You can find it at: "/path/to/CODEOWNERS".
+```
+
 ## Getting started
 
 The first step is to install `codeowners-flow` in your project:

packages/cli/package.json

@@ -57,6 +57,7 @@
     "@codeowners-flow/eslint": "workspace:*",
     "@codeowners-flow/tsconfig": "workspace:*",
     "@types/node": "16",
+    "@vitest/coverage-v8": "0.34.1",
     "eslint": "8.47.0",
     "meow": "12.0.1",
     "tsx": "3.12.7",

packages/cli/src/config/index.test.ts

@@ -0,0 +1,79 @@
+import { loadUserConfig, type UserConfig } from './index.js';
+
+const mockConfig: UserConfig = {
+  outDir: 'outDir',
+  rules: [
+    {
+      owners: [
+        {
+          name: 'ownerName',
+        },
+      ],
+      patterns: ['*'],
+      comments: ['comment'],
+      excludePatterns: ['excludePatterns'],
+    },
+  ],
+};
+
+const mockExploderLoad = vi.fn().mockResolvedValue({ config: mockConfig });
+const mockExplorerSearch = vi.fn().mockResolvedValue({ config: mockConfig });
+vi.mock('cosmiconfig', () => ({
+  cosmiconfig: () => {
+    return {
+      load: (...args: any) => mockExploderLoad(...args),
+      search: (...args: any) => mockExplorerSearch(...args),
+    };
+  },
+}));
+
+describe('fn: loadUserConfig', () => {
+  it('searches for config if no configRelativePath is sent', async () => {
+    await loadUserConfig('rootDir');
+    expect(mockExplorerSearch).toHaveBeenCalled();
+  });
+
+  it('loads the config sent', () => {
+    loadUserConfig('rootDir', 'configRelativePath');
+    expect(mockExploderLoad).toHaveBeenCalledWith(
+      expect.stringContaining('configRelativePath'),
+    );
+  });
+
+  it('returns the parsed configuration', async () => {
+    const config = await loadUserConfig('rootDir', 'configRelativePath');
+    expect(config).toEqual(mockConfig);
+  });
+
+  describe('error handling', () => {
+    it('throws an user-friendly error message about the schema', async () => {
+      const customConfig: Partial<UserConfig> = {
+        rules: [],
+      };
+
+      mockExplorerSearch.mockResolvedValue({ config: customConfig });
+
+      try {
+        await loadUserConfig('rootDir');
+      } catch (error) {
+        expect((error as Error).message).toMatchInlineSnapshot(
+          '"Validation error: Required at \\"outDir\\""',
+        );
+      }
+    });
+
+    it('throws an user-friendly error message if config file is not found', async () => {
+      mockExploderLoad.mockRejectedValue(
+        new Error('no such file or directory'),
+      );
+
+      try {
+        await loadUserConfig('rootDir', 'configRelativePath');
+      } catch (error) {
+        expect((error as Error).message).toMatchInlineSnapshot(
+          '"Config file not found. Please ensure to point a valid config file path or create a new one with the init command."',
+        );
+      }
+    });
+  });
+});

packages/cli/src/config/index.ts

@@ -1,5 +1,7 @@
+import path from 'node:path';
+
 import { cosmiconfig } from 'cosmiconfig';
-import type { ZodError } from 'zod';
+import { ZodError } from 'zod';
 import { fromZodError } from 'zod-validation-error';
 
 import {
@@ -12,21 +14,35 @@ import {
 
 const explorer = cosmiconfig('codeowners');
 
-export async function loadConfig() {
-  const config = await explorer.search();
-
+export async function loadUserConfig(
+  rootDir: string,
+  configRelativePath?: string,
+) {
   try {
-    return UserConfigSchema.parse(config?.config ?? {});
+    const result = configRelativePath
+      ? await explorer.load(path.resolve(rootDir, configRelativePath))
+      : await explorer.search();
+
+    return UserConfigSchema.parse(result?.config ?? {});
   } catch (error: unknown) {
-    const validationError = fromZodError(error as ZodError);
-    // the error now is readable by the user
-    // you may print it to console
-    // or return it via an API
-    console.error(validationError.message);
-    console.log('\n');
-    process.exit(1);
+    let message = 'An unexpected error occurred.';
+
+    if (error instanceof ZodError) {
+      const validationError = fromZodError(error as ZodError);
+      message = validationError.message;
+    } else if (error instanceof Error) {
+      if (error.message.includes('no such file or directory')) {
+        message =
+          'Config file not found. Please ensure to point a valid config file path or create a new one with the init command.';
+      } else {
+        message = error.message;
+      }
+    }
+
+    throw new Error(message);
   }
 }
 
 export type { UserConfig };
+
 export { defineConfig, defineOwner, defineRule };

packages/cli/src/generate-codeowners.test.ts

@@ -1,9 +1,9 @@
 import type { UserConfig } from './config/index.js';
 import { generateCodeOwners } from './generate-codeowners.js';
 
-const mockLoadConfig = vi.fn();
+const mockLoadUserConfig = vi.fn();
 vi.mock('./config/index.js', () => ({
-  loadConfig: (...args: any) => mockLoadConfig(...args),
+  loadUserConfig: (...args: any) => mockLoadUserConfig(...args),
 }));
 
 const mockWriteFileSync = vi.fn();
@@ -20,7 +20,7 @@ vi.mock('@manypkg/find-root', () => ({
 
 describe('fn: generateCodeOwners', () => {
   beforeEach(() => {
-    mockLoadConfig.mockResolvedValue({
+    mockLoadUserConfig.mockResolvedValue({
       outDir: './test',
       rules: [
         {
@@ -46,7 +46,7 @@ describe('fn: generateCodeOwners', () => {
     expect(location).toBe('/root/test/CODEOWNERS');
   });
 
-  it.concurrent('writes CODEOWNERS content', async () => {
+  it('writes CODEOWNERS content', async () => {
     await generateCodeOwners();
 
     const [, content] = mockWriteFileSync.mock.calls[0];
@@ -79,4 +79,9 @@ describe('fn: generateCodeOwners', () => {
       }
     `);
   });
+
+  it('calls load config with custom config path', async () => {
+    await generateCodeOwners({ config: 'custom/path' });
+    expect(mockLoadUserConfig).toHaveBeenCalledWith('/root', 'custom/path');
+  });
 });

packages/cli/src/generate-codeowners.ts

@@ -3,17 +3,25 @@ import path from 'node:path';
 
 import { findRoot } from '@manypkg/find-root';
 
-import { loadConfig, type UserConfig } from './config/index.js';
+import { loadUserConfig, type UserConfig } from './config/index.js';
 import { getCodeOwnersContent } from './get-codeowners-content.js';
 
-export async function generateCodeOwners(): Promise<{
+type GenerateCodeOwnersOptions = {
+  config?: string;
+};
+
+export async function generateCodeOwners({
+  config,
+}: GenerateCodeOwnersOptions = {}): Promise<{
   ownersContent: string;
   ownersPath: string;
 }> {
-  const config = await loadConfig();
+  const { rootDir } = await findRoot(process.cwd());
+
+  const loadedConfig = await loadUserConfig(rootDir, config);
 
-  const ownersContent = getCodeOwnersContent(config);
-  const ownersPath = await getCodeOwnersPath(config);
+  const ownersContent = getCodeOwnersContent(loadedConfig);
+  const ownersPath = await getCodeOwnersPath(loadedConfig, rootDir);
 
   writeCodeOwnersFile(ownersPath, ownersContent);
 
@@ -27,7 +35,9 @@ function writeCodeOwnersFile(path: string, content: string): void {
   fs.writeFileSync(path, content, 'utf-8');
 }
 
-async function getCodeOwnersPath(userConfig: UserConfig): Promise<string> {
-  const root = await findRoot(process.cwd());
-  return path.join(root.rootDir, userConfig.outDir, 'CODEOWNERS');
+async function getCodeOwnersPath(
+  userConfig: UserConfig,
+  rootPath: string,
+): Promise<string> {
+  return path.join(rootPath, userConfig.outDir, 'CODEOWNERS');
 }

packages/cli/src/index.ts

@@ -7,6 +7,7 @@ const cli = meow(
   `
   Usage
   $ codeowners-flow generate
+  $ codeowners-flow generate --config /path/to/config.mjs
   $ codeowners-flow init
 
   Example
@@ -17,14 +18,20 @@ const cli = meow(
 `,
   {
     importMeta: import.meta,
+    flags: {
+      config: {
+        type: 'string',
+        shortFlag: 'c',
+      },
+    },
   },
 );
 
 const [command] = cli.input;
 
 switch (command) {
   case 'generate': {
-    generateCodeOwners()
+    generateCodeOwners(cli.flags)
       .then(({ ownersPath }) => {
         console.log('Codeowners file generated! 🎉');
         console.log(`You can find it at: "${ownersPath}".\n`);