add new init command (#28)

.changeset/nasty-experts-search.md

@@ -0,0 +1,5 @@
+---
+'@codeowners-flow/cli': minor
+---
+
+add new "init" command

packages/cli/README.md

@@ -28,30 +28,18 @@ The first step is to install `codeowners-flow` in your project:
 pnpm add codeowners-flow
 ```
 
-Next, create a file named `codeowners.config.mjs`:
+Next, run the init command:
 
-```js
-/** @type {import('@codeowners-flow/cli/config').UserConfig} */
-export default {
-  outDir: '.github',
-  rules: [
-    {
-      patterns: ['*'],
-      owners: [
-        {
-          name: '@company/team',
-        },
-      ],
-    },
-  ],
-};
+```bash
+pnpm codeowners-flow init # or npx codeowners-flow init
 ```
 
+This command will create a file in the folder you're named `codeowners.config.mjs`. This config file is where you're gonna define your code owners shape.
+
 After that, you can run the CLI:
 
 ```bash
-pnpm codeowners-flow generate
-# or npx codeowners-flow generate
+pnpm codeowners-flow generate # or npx codeowners-flow generate
 ```
 
 The CLI will read your configuration and generate a `CODEOWNERS` file in the specified `outDir`:

packages/cli/src/index.ts

@@ -1,11 +1,13 @@
 import meow from 'meow';
 
 import { generateCodeOwners } from './generate-codeowners.js';
+import { initProject } from './init.js';
 
 const cli = meow(
   `
   Usage
-    $ codeowners-flow generate
+  $ codeowners-flow generate
+  $ codeowners-flow init
 
   Example
     $ codeowners-flow generate
@@ -33,6 +35,17 @@ switch (command) {
       });
     break;
   }
+  case 'init': {
+    initProject()
+      .then(() => {
+        console.log('Configuration file created! 🎉');
+      })
+      .catch((error) => {
+        console.error('Error initializing project:', error);
+        process.exit(1);
+      });
+    break;
+  }
   default: {
     cli.showHelp();
   }

packages/cli/src/init.test.ts

@@ -0,0 +1,48 @@
+import { initProject } from './init.js';
+
+const mockExistsSync = vi.fn();
+const mockWriteFileSync = vi.fn();
+vi.mock('node:fs', () => ({
+  default: {
+    existsSync: (...args: any) => mockExistsSync(...args),
+    writeFileSync: (...args: any) => mockWriteFileSync(...args),
+  },
+}));
+
+describe('fn: initProject', () => {
+  it('throws an error if config file already exists', async () => {
+    mockExistsSync.mockReturnValue(true);
+    await expect(initProject()).rejects.toThrowError(
+      'Configuration file already exists.',
+    );
+  });
+
+  it('writes the config file correctly', async () => {
+    const spyCwd = vi.spyOn(process, 'cwd');
+
+    spyCwd.mockReturnValue('/path/to');
+
+    mockExistsSync.mockReturnValue(false);
+    await initProject();
+
+    const [path, content] = mockWriteFileSync.mock.calls[0];
+
+    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',
+              },
+            ],
+          },
+        ],
+      };"
+    `);
+  });
+});

packages/cli/src/init.ts

@@ -0,0 +1,32 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+export async function initProject() {
+  const content = getConfigTemplate();
+
+  const configPath = path.resolve(process.cwd(), 'codeowners.config.mjs');
+  const exists = fs.existsSync(configPath);
+
+  if (exists) {
+    throw new Error('Configuration file already exists.');
+  }
+
+  fs.writeFileSync(configPath, content);
+}
+
+function getConfigTemplate() {
+  return `/** @type {import('@codeowners-flow/cli/config').UserConfig} */
+export default {
+  outDir: '.github',
+  rules: [
+    {
+      patterns: ['*'],
+      owners: [
+        {
+          name: '@company-team',
+        },
+      ],
+    },
+  ],
+};`;
+}