Address further review feedback

- Rename hasYarnPlugin -> hasBackstageYarnPlugin for clarity
- Change SuccessCache.create to accept an options object

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

.changeset/move-utils-to-cli-node.md

@@ -2,4 +2,4 @@
 '@backstage/cli-node': patch
 ---
 
-Added `hasYarnPlugin` and `SuccessCache` exports, moved from `@backstage/cli`.
+Added `hasBackstageYarnPlugin` and `SuccessCache` exports, moved from `@backstage/cli`.

packages/cli-node/report.api.md

@@ -100,7 +100,7 @@ export class GitUtils {
 }
 
 // @public
-export function hasYarnPlugin(workspaceDir?: string): Promise<boolean>;
+export function hasBackstageYarnPlugin(workspaceDir?: string): Promise<boolean>;
 
 // @public
 export function isMonoRepo(): Promise<boolean>;
@@ -227,7 +227,7 @@ export function runWorkerQueueThreads<TItem, TResult, TContext>(
 // @public
 export class SuccessCache {
   // (undocumented)
-  static create(name: string, basePath?: string): SuccessCache;
+  static create(options: { name: string; basePath?: string }): SuccessCache;
   // (undocumented)
   read(): Promise<Set<string>>;
   static trimPaths(input: string): string;

packages/cli-node/src/cache/SuccessCache.ts

@@ -40,12 +40,15 @@ export class SuccessCache {
     return input.replaceAll(targetPaths.rootDir, '');
   }
 
-  static create(name: string, basePath?: string): SuccessCache {
-    return new SuccessCache(name, basePath);
+  static create(options: { name: string; basePath?: string }): SuccessCache {
+    return new SuccessCache(options);
   }
 
-  private constructor(name: string, basePath?: string) {
-    this.#path = resolvePath(basePath ?? DEFAULT_CACHE_BASE_PATH, name);
+  private constructor(options: { name: string; basePath?: string }) {
+    this.#path = resolvePath(
+      options.basePath ?? DEFAULT_CACHE_BASE_PATH,
+      options.name,
+    );
   }
 
   async read(): Promise<Set<string>> {

packages/cli-node/src/yarn/index.ts

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export { hasYarnPlugin } from './yarnPlugin';
+export { hasBackstageYarnPlugin } from './yarnPlugin';

packages/cli-node/src/yarn/yarnPlugin.test.ts

@@ -16,12 +16,12 @@
 
 import { createMockDirectory } from '@backstage/backend-test-utils';
 import { overrideTargetPaths } from '@backstage/cli-common/testUtils';
-import { hasYarnPlugin } from './yarnPlugin';
+import { hasBackstageYarnPlugin } from './yarnPlugin';
 
 const mockDir = createMockDirectory();
 overrideTargetPaths(mockDir.path);
 
-describe('hasYarnPlugin', () => {
+describe('hasBackstageYarnPlugin', () => {
   beforeEach(() => {
     mockDir.clear();
   });
@@ -29,7 +29,7 @@ describe('hasYarnPlugin', () => {
   it('should return false when .yarnrc.yml does not exist', async () => {
     mockDir.setContent({});
 
-    const result = await hasYarnPlugin();
+    const result = await hasBackstageYarnPlugin();
     expect(result).toBe(false);
   });
 
@@ -38,7 +38,7 @@ describe('hasYarnPlugin', () => {
       '.yarnrc.yml': '',
     });
 
-    const result = await hasYarnPlugin();
+    const result = await hasBackstageYarnPlugin();
     expect(result).toBe(false);
   });
 
@@ -47,7 +47,7 @@ describe('hasYarnPlugin', () => {
       '.yarnrc.yml': 'plugins: []',
     });
 
-    const result = await hasYarnPlugin();
+    const result = await hasBackstageYarnPlugin();
     expect(result).toBe(false);
   });
 
@@ -60,7 +60,7 @@ plugins:
 `,
     });
 
-    const result = await hasYarnPlugin();
+    const result = await hasBackstageYarnPlugin();
     expect(result).toBe(false);
   });
 
@@ -74,7 +74,7 @@ plugins:
 `,
     });
 
-    const result = await hasYarnPlugin();
+    const result = await hasBackstageYarnPlugin();
     expect(result).toBe(true);
   });
 
@@ -86,7 +86,7 @@ plugins:
 `,
     });
 
-    const result = await hasYarnPlugin();
+    const result = await hasBackstageYarnPlugin();
     expect(result).toBe(true);
   });
 
@@ -95,7 +95,7 @@ plugins:
       '.yarnrc.yml': 'invalid: yaml: content: [',
     });
 
-    await expect(hasYarnPlugin()).rejects.toThrow();
+    await expect(hasBackstageYarnPlugin()).rejects.toThrow();
   });
 
   it('should throw error when .yarnrc.yml has unexpected structure', async () => {
@@ -105,7 +105,7 @@ plugins: "not an array"
 `,
     });
 
-    await expect(hasYarnPlugin()).rejects.toThrow(
+    await expect(hasBackstageYarnPlugin()).rejects.toThrow(
       'Unexpected content in .yarnrc.yml',
     );
   });
@@ -120,7 +120,7 @@ plugins:
       },
     });
 
-    const result = await hasYarnPlugin(mockDir.resolve('custom-dir'));
+    const result = await hasBackstageYarnPlugin(mockDir.resolve('custom-dir'));
     expect(result).toBe(true);
   });
 });

packages/cli-node/src/yarn/yarnPlugin.ts

@@ -37,7 +37,9 @@ const yarnRcSchema = z.object({
  * @returns Promise resolving to true if the plugin is installed, false otherwise
  * @public
  */
-export async function hasYarnPlugin(workspaceDir?: string): Promise<boolean> {
+export async function hasBackstageYarnPlugin(
+  workspaceDir?: string,
+): Promise<boolean> {
   const yarnRcPath = resolvePath(
     workspaceDir ?? targetPaths.rootDir,
     '.yarnrc.yml',

packages/cli/src/modules/lint/commands/repo/lint.ts

@@ -41,7 +41,10 @@ function depCount(pkg: BackstagePackageJson) {
 export async function command(opts: OptionValues, cmd: Command): Promise<void> {
   let packages = await PackageGraph.listTargetPackages();
 
-  const cache = SuccessCache.create('lint', opts.successCacheDir);
+  const cache = SuccessCache.create({
+    name: 'lint',
+    basePath: opts.successCacheDir,
+  });
   const cacheContext = opts.successCache
     ? {
         entries: await cache.read(),

packages/cli/src/modules/migrate/commands/versions/bump.ts

@@ -31,7 +31,7 @@ import { isError, NotFoundError } from '@backstage/errors';
 import { resolve as resolvePath } from 'node:path';
 
 import {
-  hasYarnPlugin,
+  hasBackstageYarnPlugin,
   Lockfile,
   runConcurrentTasks,
 } from '@backstage/cli-node';
@@ -76,7 +76,7 @@ function extendsDefaultPattern(pattern: string): boolean {
 export default async (opts: OptionValues) => {
   const lockfilePath = targetPaths.resolveRoot('yarn.lock');
   const lockfile = await Lockfile.load(lockfilePath);
-  const yarnPluginEnabled = await hasYarnPlugin();
+  const yarnPluginEnabled = await hasBackstageYarnPlugin();
 
   let pattern = opts.pattern;
 

packages/cli/src/modules/new/lib/execution/PortableTemplater.ts

@@ -28,7 +28,7 @@ import { Lockfile } from '@backstage/cli-node';
 import { targetPaths } from '@backstage/cli-common';
 
 import { createPackageVersionProvider } from '../../../../lib/version';
-import { hasYarnPlugin } from '@backstage/cli-node';
+import { hasBackstageYarnPlugin } from '@backstage/cli-node';
 
 const builtInHelpers = {
   camelCase,
@@ -55,7 +55,7 @@ export class PortableTemplater {
       /* ignored */
     }
 
-    const yarnPluginEnabled = await hasYarnPlugin();
+    const yarnPluginEnabled = await hasBackstageYarnPlugin();
     const versionProvider = createPackageVersionProvider(lockfile, {
       preferBackstageProtocol: yarnPluginEnabled,
     });

packages/cli/src/modules/test/commands/repo/test.ts

@@ -332,7 +332,10 @@ export async function command(opts: OptionValues, cmd: Command): Promise<void> {
       );
     }
 
-    const cache = SuccessCache.create('test', opts.successCacheDir);
+    const cache = SuccessCache.create({
+      name: 'test',
+      basePath: opts.successCacheDir,
+    });
     const graph = await getPackageGraph();
 
     // Shared state for the bridge