feat(android): brownfield plugin (#160)

* feat: add brownfield-android plugin to templates

* feat: scaffold plugin-brownfield-android

* fix: use name without dash

* feat: add brownfield android template files

* feat: add and update template files

* feat: register task for aar generation

* feat: expose separate functions for AAR generation

* refactor: default to helloworld

* feat: add and update files for template

* feat: register task for aar local maven publishing

* refactor: avoid duplicate consts

* chore: bump to latest version

* refactor: extract re-used code

* chore: generate changeset

* test: add test for plugin-brownfield-android

* feat: update versions after sync with main

* feat: use variant

* docs: add brownfield docs for android

* chore: add changeset

* chore: remove previous changeset

* Update packages/platform-android/src/lib/commands/buildAndroid/buildAndroid.ts

Co-authored-by: Michał Pierzchała <[email protected]>

* Update packages/plugin-brownfield-android/package.json

Co-authored-by: Michał Pierzchała <[email protected]>

* Apply suggestions from code review

Co-authored-by: Michał Pierzchała <[email protected]>

* Update BROWNFIELD.md

Co-authored-by: Michał Pierzchała <[email protected]>

* refactor: remove package-name

* refactor: separate Aar options and use function for config

* refactor: rename to ReactNativeHostManager

* Update packages/platform-android/src/lib/commands/runGradle.ts

Co-authored-by: Michał Pierzchała <[email protected]>

* refactor: add error cause

* update version

* move to docs

* update titles

* remove plugin from defaults

* bring back local publish

* refactor

* feat: use brownfield-gradle-plugin

---------

Co-authored-by: Michał Pierzchała <[email protected]>

Author: hurali97

.changeset/quick-lamps-hear.md

@@ -0,0 +1,7 @@
+---
+'@rnef/plugin-brownfield-android': patch
+'@rnef/platform-android': patch
+'@rnef/create-app': patch
+---
+
+add android brownfield plugin

docs/assets/android-brownfield/create_module.png

@@ -1 +1,11 @@
 export * from './lib/platformAndroid.js';
+export {
+  type PackageAarFlags,
+  packageAar,
+  options as packageAarOptions,
+} from './lib/commands/aar/packageAar.js';
+export {
+  type PublishLocalAarFlags,
+  publishLocalAar,
+  options as publishLocalAarOptions,
+} from './lib/commands/aar/publishLocalAar.js';

docs/assets/android-brownfield/verify_aar_plugin_setup.png

@@ -0,0 +1,53 @@
+import { outro } from '@rnef/tools';
+import { runGradleAar } from '../runGradle.js';
+import { toPascalCase } from '../toPascalCase.js';
+
+export interface AarProject {
+  sourceDir: string;
+  moduleName: string;
+}
+
+export type PackageAarFlags = {
+  variant: string;
+  moduleName?: string;
+};
+
+export async function packageAar(
+  aarProject: AarProject,
+  args: PackageAarFlags
+) {
+  normalizeArgs(args);
+
+  const tasks = [`assemble${toPascalCase(args.variant)}`];
+
+  await runGradleAar({ tasks, aarProject, args });
+  outro('Success 🎉.');
+}
+
+export async function localPublishAar(
+  aarProject: AarProject,
+  args: PackageAarFlags
+) {
+  const tasks = ['publishToMavenLocal'];
+
+  await runGradleAar({ tasks, aarProject, args, isPublishTask: true });
+  outro('Success 🎉.');
+}
+
+function normalizeArgs(args: PackageAarFlags) {
+  if (!args.variant) {
+    args.variant = 'debug';
+  }
+}
+
+export const options = [
+  {
+    name: '--variant <string>',
+    description:
+      "Specify your app's build variant, which is constructed from build type and product flavor, e.g. 'debug' or 'freeRelease'.",
+  },
+  {
+    name: '--module-name <string>',
+    description: 'AAR module name',
+  },
+];

packages/platform-android/src/index.ts

@@ -0,0 +1,24 @@
+import { outro } from '@rnef/tools';
+import { runGradleAar } from '../runGradle.js';
+import type { AarProject } from './packageAar.js';
+
+export type PublishLocalAarFlags = {
+  moduleName: string;
+};
+
+export async function publishLocalAar(
+  aarProject: AarProject,
+  args: PublishLocalAarFlags
+) {
+  const tasks = ['publishToMavenLocal'];
+
+  await runGradleAar({ tasks, aarProject, args, isPublishTask: true });
+  outro('Success 🎉.');
+}
+
+export const options = [
+  {
+    name: '--module-name <string>',
+    description: 'AAR module name',
+  },
+];

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

@@ -6,16 +6,33 @@ import {
   spinner,
   type SubprocessError,
 } from '@rnef/tools';
+import type { AarProject, PackageAarFlags } from './aar/packageAar.js';
+import type { PublishLocalAarFlags } from './aar/publishLocalAar.js';
 import type { BuildFlags } from './buildAndroid/buildAndroid.js';
 import { getAdbPath, getDevices } from './runAndroid/adb.js';
 import type { AndroidProject, Flags } from './runAndroid/runAndroid.js';
 
+type RunGradleAarArgs = {
+  tasks: string[];
+  aarProject: AarProject;
+  args: PackageAarFlags | PublishLocalAarFlags;
+  isPublishTask?: boolean;
+};
+
 export type RunGradleArgs = {
   tasks: string[];
   androidProject: AndroidProject;
   args: BuildFlags | Flags;
 };
 
+const getCleanedErrorMessage = (error: SubprocessError) => {
+  return error.stderr
+    .split('\n')
+    .filter((line) => !gradleLinesToRemove.some((l) => line.includes(l)))
+    .join('\n')
+    .trim();
+};
+
 export async function runGradle({
   tasks,
   androidProject,
@@ -69,11 +86,9 @@ export async function runGradle({
     );
   } catch (error) {
     loader.stop('Failed to build the app');
-    const cleanedErrorMessage = (error as SubprocessError).stderr
-      .split('\n')
-      .filter((line) => !gradleLinesToRemove.some((l) => line.includes(l)))
-      .join('\n')
-      .trim();
+    const cleanedErrorMessage = getCleanedErrorMessage(
+      error as SubprocessError
+    );
 
     if (cleanedErrorMessage) {
       logger.error(cleanedErrorMessage);
@@ -87,6 +102,61 @@ export async function runGradle({
   }
 }
 
+export async function runGradleAar({
+  tasks,
+  aarProject,
+  args,
+  isPublishTask = false,
+}: RunGradleAarArgs) {
+  if ('binaryPath' in args) {
+    return;
+  }
+  const loader = spinner({ indicator: 'timer' });
+  const message = isPublishTask
+    ? 'Publishing the AAR'
+    : // @ts-expect-error args.variant is not set for publish task
+      `Building the AAR with Gradle in ${args.variant} build variant`;
+
+  loader.start(message);
+  const gradleArgs = getTaskNames(aarProject.moduleName, tasks);
+
+  gradleArgs.push('-x', 'lint');
+
+  const gradleWrapper = getGradleWrapper();
+
+  try {
+    logger.debug(`Running ${gradleWrapper} ${gradleArgs.join(' ')}.`);
+    await spawn(gradleWrapper, gradleArgs, {
+      cwd: aarProject.sourceDir,
+      stdio: logger.isVerbose() ? 'inherit' : 'pipe',
+    });
+    loader.stop(
+      isPublishTask
+        ? 'Published the AAR to local maven (~/.m2/repository)'
+        : // @ts-expect-error args.variant is not set for publish task
+          `Built the AAR in ${args.variant} build variant.`
+    );
+  } catch (error) {
+    loader.stop(`Failed to ${isPublishTask ? 'publish' : 'build'} the AAR`);
+    const cleanedErrorMessage = getCleanedErrorMessage(
+      error as SubprocessError
+    );
+
+    if (cleanedErrorMessage) {
+      logger.error(cleanedErrorMessage);
+    }
+
+    const hints = getErrorHints((error as SubprocessError).stdout ?? '');
+    throw new RnefError(
+      hints ||
+        `Failed to ${
+          isPublishTask ? 'publish' : 'build'
+        } the AAR. See the error above for details from Gradle.`,
+      { cause: (error as SubprocessError).stderr }
+    );
+  }
+}
+
 function getErrorHints(output: string) {
   const signingMessage = output.includes('validateSigningRelease FAILED')
     ? `Hint: You can run "${color.bold(

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

@@ -0,0 +1,11 @@
+# plugin-brownfield-android
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build plugin-brownfield-android` to build the library.
+
+## Running unit tests
+
+Run `nx test plugin-brownfield-ios` to execute the unit tests via [Vitest](https://vitest.dev/).

packages/platform-android/src/lib/commands/runGradle.ts

@@ -0,0 +1,3 @@
+import baseConfig from '../../eslint.config.js';
+
+export default baseConfig;

packages/plugin-brownfield-android/README.md

@@ -0,0 +1,31 @@
+{
+  "name": "@rnef/plugin-brownfield-android",
+  "version": "0.4.1",
+  "type": "module",
+  "exports": {
+    "types": "./dist/src/index.d.ts",
+    "import": "./dist/src/index.js"
+  },
+  "files": [
+    "dist",
+    "src",
+    "template"
+  ],
+  "scripts": {
+    "publish:npm": "npm publish --access restricted",
+    "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc"
+  },
+  "dependencies": {
+    "@rnef/tools": "^0.4.1",
+    "@rnef/platform-android": "^0.4.1",
+    "@react-native-community/cli-config-android": "^16.0.2",
+    "tslib": "^2.3.0"
+  },
+  "devDependencies": {
+    "@rnef/config": "^0.4.1",
+    "@react-native-community/cli-types": "^16.0.2"
+  },
+  "publishConfig": {
+    "access": "restricted"
+  }
+}