feat: expose brownfield plugin actions & types (#666)

* feat: expose RockCLIOptions type

* feat: expose brownfield plugin actions

* refactor: use RockCLIOptions type in platform-ios

* chore: add changeset

* refactor fn signatures to be more explicit instead of using api

* fix(types): add PublishLocalAarFlags

* feat: expose types from @rock-js/platform-apple-helpers

* feat: Rock escape hatch in plugin-brownfield-ios

* fix: debug logs in mergeFrameworks not showing path to removed framework before writing merge output

* rename FingerprintSources to FingerprintOptions and run prettier

* fixup test types

* cleanup; iosConfig is from autolinking; derivedDataDir can be overriden by --build-folder arg

* cleanup unused type

* feat: add skipCache parameter to buildApp, packageIosAction and installPodsIfNeeded

* feat: make args.buildFolder override getBuildPaths in iOS brownfield plugin to work with non-Rock projects

* feat: add packageDir to override artifact outputs path in non-Rock projects

---------

Co-authored-by: Michał Pierzchała <thymikee@gmail.com>

Author: artus9033

.changeset/itchy-nails-visit.md

@@ -0,0 +1,5 @@
+---
+'@rock-js/platform-apple-helpers': patch
+---
+
+fix: debug logs in mergeFrameworks not showing path to removed framework before writing merge output

.changeset/itchy-spoons-trade.md

@@ -0,0 +1,6 @@
+---
+'@rock-js/plugin-brownfield-android': patch
+'@rock-js/plugin-brownfield-ios': patch
+---
+
+feat: expose logic of brownfield plugin actions

.github/pr-labeler.yml

@@ -3,4 +3,4 @@
 'release: bug fix':
   - '/^fix/'
 'release: breaking change':
-  - '/^breaking/'
+  - '/^breaking/'

packages/cli/README.md

@@ -32,7 +32,7 @@ Choose your path based on your current situation:
 
 ### Creating a new project
 
-> [!TIP] 
+> [!TIP]
 > For **new projects**, we recommend starting with [Expo](https://expo.dev) for the best developer experience and similar remote caching capabilities. Rock is designed for teams who have outgrown the Community CLI.
 
 To create a fresh React Native app with Rock, open a terminal and run:

packages/cli/src/lib/plugins/fingerprint.ts

@@ -1,7 +1,7 @@
 import { createHash } from 'node:crypto';
 import { performance } from 'node:perf_hooks';
 import type { PluginApi } from '@rock-js/config';
-import type { FingerprintInputHash, FingerprintSources } from '@rock-js/tools';
+import type { FingerprintInputHash, FingerprintOptions } from '@rock-js/tools';
 import {
   color,
   intro,
@@ -39,7 +39,7 @@ type NativeFingerprintCommandOptions = {
 
 export async function nativeFingerprintCommand(
   path: string,
-  { extraSources, ignorePaths, env }: FingerprintSources,
+  { extraSources, ignorePaths, env }: FingerprintOptions,
   options: NativeFingerprintCommandOptions,
 ) {
   validateOptions(options);

packages/cli/src/lib/plugins/remoteCache.ts

@@ -2,7 +2,7 @@ import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
 import type { PluginApi, PluginOutput } from '@rock-js/config';
-import type { FingerprintSources, RemoteBuildCache } from '@rock-js/tools';
+import type { FingerprintOptions, RemoteBuildCache } from '@rock-js/tools';
 import {
   color,
   colorLink,
@@ -48,7 +48,7 @@ async function remoteCache({
   args: Flags;
   remoteCacheProvider: null | (() => RemoteBuildCache);
   projectRoot: string;
-  fingerprintOptions: FingerprintSources;
+  fingerprintOptions: FingerprintOptions;
 }) {
   const isJsonOutput = args.json;
   if (!remoteCacheProvider) {

packages/config/src/lib/config.ts

@@ -2,7 +2,7 @@ import * as fs from 'node:fs';
 import { createRequire } from 'node:module';
 import * as path from 'node:path';
 import { pathToFileURL } from 'node:url';
-import type { FingerprintSources, RemoteBuildCache } from '@rock-js/tools';
+import type { FingerprintOptions, RemoteBuildCache } from '@rock-js/tools';
 import { colorLink, getReactNativeVersion, logger } from '@rock-js/tools';
 import type { ValidationError } from 'joi';
 import { ConfigTypeSchema } from './schema.js';
@@ -54,7 +54,7 @@ export type PluginApi = {
   getRemoteCacheProvider: () => Promise<
     null | undefined | (() => RemoteBuildCache)
   >;
-  getFingerprintOptions: () => FingerprintSources;
+  getFingerprintOptions: () => FingerprintOptions;
   getBundlerStart: () => ({ args }: { args: DevServerArgs }) => void;
   getUsePrebuiltRNCore: () => number | undefined;
 };
@@ -103,7 +103,7 @@ export type ConfigType = {
     ignorePaths?: string[];
     env?: string[];
   };
-  usePrebuiltRNCore?: number,
+  usePrebuiltRNCore?: number;
 };
 
 export type ConfigOutput = {
@@ -219,7 +219,7 @@ Read more: ${colorLink('https://rockjs.dev/docs/configuration#github-actions-pro
       return validatedConfig.remoteCacheProvider;
     },
     getFingerprintOptions: () =>
-      validatedConfig.fingerprint as FingerprintSources,
+      validatedConfig.fingerprint as FingerprintOptions,
     getBundlerStart:
       () =>
       ({ args }: { args: DevServerArgs }) => {

packages/create-app/src/lib/utils/__tests__/initInExistingProject.test.ts

@@ -2,7 +2,7 @@ import * as fs from 'node:fs';
 import * as path from 'node:path';
 import { cleanup, getTempDirectory, writeFiles } from '@rock-js/test-helpers';
 import * as tools from '@rock-js/tools';
-import { updateAndroidBuildGradle } from "../initInExistingProject.js";
+import { updateAndroidBuildGradle } from '../initInExistingProject.js';
 
 const directory = getTempDirectory('test_updateAndroidBuildGradle');
 
@@ -61,15 +61,23 @@ describe('updateAndroidBuildGradle', () => {
     },
   ];
 
-  it.each(workingCases)('should update the Android build.gradle file when $name', ({ content, expected }) => {
-    const files = {
-      'android/app/build.gradle': content,
-    };
-    writeFiles(directory, files);
-    updateAndroidBuildGradle(directory, 'android');
-
-    expect(fs.readFileSync(path.join(directory, 'android/app/build.gradle'), 'utf8')).toStrictEqual(expected)
-  });
+  it.each(workingCases)(
+    'should update the Android build.gradle file when $name',
+    ({ content, expected }) => {
+      const files = {
+        'android/app/build.gradle': content,
+      };
+      writeFiles(directory, files);
+      updateAndroidBuildGradle(directory, 'android');
+
+      expect(
+        fs.readFileSync(
+          path.join(directory, 'android/app/build.gradle'),
+          'utf8',
+        ),
+      ).toStrictEqual(expected);
+    },
+  );
 
   it('should not update the Android build.gradle file when cliFile is already set', () => {
     const content = `
@@ -84,7 +92,9 @@ describe('updateAndroidBuildGradle', () => {
     writeFiles(directory, files);
     updateAndroidBuildGradle(directory, 'android');
 
-    expect(fs.readFileSync(path.join(directory, 'android/app/build.gradle'), 'utf8')).toStrictEqual(content)
+    expect(
+      fs.readFileSync(path.join(directory, 'android/app/build.gradle'), 'utf8'),
+    ).toStrictEqual(content);
   });
 
   it('should display a warning when unable to update the Android build.gradle file', () => {
@@ -101,10 +111,12 @@ describe('updateAndroidBuildGradle', () => {
     writeFiles(directory, files);
     updateAndroidBuildGradle(directory, 'android');
 
-    expect(fs.readFileSync(path.join(directory, 'android/app/build.gradle'), 'utf8')).toStrictEqual(content)
+    expect(
+      fs.readFileSync(path.join(directory, 'android/app/build.gradle'), 'utf8'),
+    ).toStrictEqual(content);
 
     expect(warn).toHaveBeenCalledWith(
-      expect.stringContaining('Unable to update')
-    )
+      expect.stringContaining('Unable to update'),
+    );
   });
 });

packages/platform-android/src/index.ts

@@ -5,6 +5,7 @@ export {
   options as packageAarOptions,
 } from './lib/commands/aar/packageAar.js';
 export {
+  type PublishLocalAarFlags,
   publishLocalAar,
   options as publishLocalAarOptions,
 } from './lib/commands/aar/publishLocalAar.js';

packages/platform-android/src/lib/commands/aar/packageAar.ts

@@ -1,3 +1,4 @@
+import type { RockCLIOptions } from '@rock-js/tools';
 import { outro } from '@rock-js/tools';
 import { runGradleAar } from '../runGradle.js';
 import { toPascalCase } from '../toPascalCase.js';
@@ -12,35 +13,24 @@ export type PackageAarFlags = {
   moduleName?: string;
 };
 
-export async function packageAar(
-  aarProject: AarProject,
-  args: PackageAarFlags,
-) {
-  normalizeArgs(args);
+export async function packageAar(aarProject: AarProject, variant: string) {
+  normalizeVariant(variant);
+  const tasks = [`assemble${toPascalCase(variant)}`];
 
-  const tasks = [`assemble${toPascalCase(args.variant)}`];
-
-  await runGradleAar({ tasks, aarProject, variant: args.variant });
+  await runGradleAar({ tasks, aarProject, variant });
   outro('Success 🎉.');
 }
 
-export async function localPublishAar(
-  aarProject: AarProject,
-  args: PackageAarFlags,
-) {
+export async function localPublishAar(aarProject: AarProject, variant: string) {
   const tasks = ['publishToMavenLocal'];
 
-  await runGradleAar({
-    tasks,
-    aarProject,
-    variant: args.variant,
-  });
+  await runGradleAar({ tasks, aarProject, variant });
   outro('Success 🎉.');
 }
 
-function normalizeArgs(args: PackageAarFlags) {
-  if (!args.variant) {
-    args.variant = 'debug';
+function normalizeVariant(variant: string) {
+  if (!variant) {
+    variant = 'debug';
   }
 }
 
@@ -54,4 +44,4 @@ export const options = [
     name: '--module-name <string>',
     description: 'AAR module name',
   },
-];
+] satisfies RockCLIOptions;