refactor(cli): better gitignore management to make it easier when r…

…unning the CLI on upstream backstage environments. (#2325)

refactor(cli): better gitignore management...

... to make it easier when running the CLI on upstream backstage environments.

Signed-off-by: David Festal <dfestal@redhat.com>

packages/cli/src/commands/export-dynamic-plugin/backend-embed-as-dependencies.ts

@@ -109,9 +109,14 @@ export async function backend(opts: OptionValues): Promise<string> {
     path.join(target, '.gitignore'),
     `
 *
+${
+  opts.trackDynamicManifestAndLockFile
+    ? `
 !package.json
 !yarn.lock
-`,
+`
+    : ''
+}`,
   );
 
   const embeddedPeerDependencies: {

packages/cli/src/commands/export-dynamic-plugin/dev.ts

@@ -91,6 +91,14 @@ export async function applyDevOptions(
           path.dirname(destFolderPath),
         )}`,
       );
+
+      if (!fs.existsSync(dynamicPluginsRootPath)) {
+        await fs.mkdirs(dynamicPluginsRootPath);
+        await fs.writeFile(
+          path.resolve(dynamicPluginsRootPath, '.gitignore'),
+          '*',
+        );
+      }
       fs.rmSync(destFolderPath, { force: true, recursive: true });
       fs.cpSync(target, destFolderPath, { recursive: true });
     }

packages/cli/src/commands/index.ts

@@ -137,6 +137,11 @@ export function registerScriptCommand(program: Command) {
       '--scalprum-config <file>',
       'Allows retrieving scalprum configuration from an external JSON file, instead of using a `scalprum` field of the `package.json`. Frontend plugins only.',
     )
+    .option(
+      '--track-dynamic-manifest-and-lock-file',
+      'Adds the `package.json` and `yarn.lock` files, generated in the `dist-dynamic` folder of backend plugins, to source control. By default the whole `dist-dynamic` folder id git-ignored.',
+      false,
+    )
     .action(lazy(() => import('./export-dynamic-plugin').then(m => m.command)));
 
   command