cli: refactor to simplify codeowners logic

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

packages/cli/src/commands/create-plugin/createPlugin.ts

@@ -263,7 +263,6 @@ export default async (cmd: Command) => {
   const pluginDir = isMonoRepo
     ? paths.resolveTargetRoot('plugins', pluginId)
     : paths.resolveTargetRoot(pluginId);
-  const ownerIds = parseOwnerIds(answers.owner);
   const { version: pluginVersion } = isMonoRepo
     ? await fs.readJson(paths.resolveTargetRoot('lerna.json'))
     : { version: '0.1.0' };
@@ -318,12 +317,8 @@ export default async (cmd: Command) => {
       await addPluginExtensionToApp(pluginId, extensionName, name);
     }
 
-    if (ownerIds && ownerIds.length) {
-      await addCodeownersEntry(
-        codeownersPath!,
-        `/plugins/${pluginId}`,
-        ownerIds,
-      );
+    if (answers.owner) {
+      await addCodeownersEntry(`/plugins/${pluginId}`, answers.owner);
     }
 
     Task.log();

packages/cli/src/commands/remove-plugin/removePlugin.test.ts

@@ -177,9 +177,9 @@ describe('removePlugin', () => {
         fse.readFileSync(mockedCodeownersPath, 'utf8'),
       );
       await addCodeownersEntry(
-        testFilePath!,
         path.join('plugins', testPluginName),
-        ['@thisIsAtestTeam', 'test@gmail.com'],
+        '@thisIsAtestTeam test@gmail.com',
+        testFilePath,
       );
       await removePluginFromCodeOwners(testFilePath, testPluginName);
       expect(testFileContent).toBe(codeOwnersFileContent);

packages/cli/src/lib/codeowners/codeowners.ts

@@ -16,6 +16,7 @@
 
 import fs from 'fs-extra';
 import path from 'path';
+import { paths } from '../paths';
 
 const TEAM_ID_RE = /^@[-\w]+\/[-\w]+$/;
 const USER_ID_RE = /^@[-\w]+$/;
@@ -30,14 +31,14 @@ type CodeownersEntry = {
 export async function getCodeownersFilePath(
   rootDir: string,
 ): Promise<string | undefined> {
-  const paths = [
+  const possiblePaths = [
     path.join(rootDir, '.github', 'CODEOWNERS'),
     path.join(rootDir, '.gitlab', 'CODEOWNERS'),
     path.join(rootDir, 'docs', 'CODEOWNERS'),
     path.join(rootDir, 'CODEOWNERS'),
   ];
 
-  for (const p of paths) {
+  for (const p of possiblePaths) {
     if (await fs.pathExists(p)) {
       return p;
     }
@@ -70,11 +71,24 @@ export function parseOwnerIds(
 }
 
 export async function addCodeownersEntry(
-  codeownersFilePath: string,
   ownedPath: string,
-  ownerIds: string[],
-): Promise<void> {
-  const allLines = (await fs.readFile(codeownersFilePath, 'utf8')).split('\n');
+  ownerStr: string,
+  codeownersFilePath?: string,
+): Promise<boolean> {
+  const ownerIds = parseOwnerIds(ownerStr);
+  if (!ownerIds || ownerIds.length === 0) {
+    return false;
+  }
+
+  let filePath = codeownersFilePath;
+  if (!filePath) {
+    filePath = await getCodeownersFilePath(paths.targetRoot);
+    if (!filePath) {
+      return false;
+    }
+  }
+
+  const allLines = (await fs.readFile(filePath, 'utf8')).split('\n');
 
   // Only keep comments from the top of the file
   const commentLines = [];
@@ -117,5 +131,7 @@ export async function addCodeownersEntry(
 
   const newLines = [...commentLines, '', ...newDeclarationLines, ''];
 
-  await fs.writeFile(codeownersFilePath, newLines.join('\n'), 'utf8');
+  await fs.writeFile(filePath, newLines.join('\n'), 'utf8');
+
+  return true;
 }

packages/cli/src/lib/create/factories/backendPlugin.ts

@@ -17,11 +17,7 @@
 import fs from 'fs-extra';
 import camelCase from 'lodash/camelCase';
 import { paths } from '../../paths';
-import {
-  addCodeownersEntry,
-  getCodeownersFilePath,
-  parseOwnerIds,
-} from '../../codeowners';
+import { addCodeownersEntry, getCodeownersFilePath } from '../../codeowners';
 import { createFactory, CreateContext } from '../types';
 import { addPackageDependency, Task } from '../../tasks';
 import { ownerPrompt, pluginIdPrompt } from './common/prompts';
@@ -74,15 +70,8 @@ export const backendPlugin = createFactory<Options>({
       });
     }
 
-    if (options.codeOwnersPath && options.owner) {
-      const ownerIds = parseOwnerIds(options.owner);
-      if (ownerIds && ownerIds.length > 0) {
-        await addCodeownersEntry(
-          options.codeOwnersPath,
-          `/plugins/${id}`,
-          ownerIds,
-        );
-      }
+    if (options.owner) {
+      await addCodeownersEntry(`/plugins/${id}`, options.owner);
     }
 
     await Task.forCommand('yarn install', { cwd: targetDir, optional: true });

packages/cli/src/lib/create/factories/frontendPlugin.ts

@@ -18,11 +18,7 @@ import fs from 'fs-extra';
 import camelCase from 'lodash/camelCase';
 import upperFirst from 'lodash/upperFirst';
 import { paths } from '../../paths';
-import {
-  addCodeownersEntry,
-  getCodeownersFilePath,
-  parseOwnerIds,
-} from '../../codeowners';
+import { addCodeownersEntry, getCodeownersFilePath } from '../../codeowners';
 import { createFactory, CreateContext } from '../types';
 import { addPackageDependency, Task } from '../../tasks';
 import { ownerPrompt, pluginIdPrompt } from './common/prompts';
@@ -114,15 +110,8 @@ export const frontendPlugin = createFactory<Options>({
       });
     }
 
-    if (options.codeOwnersPath && options.owner) {
-      const ownerIds = parseOwnerIds(options.owner);
-      if (ownerIds && ownerIds.length > 0) {
-        await addCodeownersEntry(
-          options.codeOwnersPath,
-          `/plugins/${id}`,
-          ownerIds,
-        );
-      }
+    if (options.owner) {
+      await addCodeownersEntry(`/plugins/${id}`, options.owner);
     }
 
     await Task.forCommand('yarn install', { cwd: targetDir, optional: true });