diff --git a/.changeset/aar-extra-params.md b/.changeset/aar-extra-params.md new file mode 100644 index 000000000..7c4f704b4 --- /dev/null +++ b/.changeset/aar-extra-params.md @@ -0,0 +1,6 @@ +--- +'@rock-js/platform-android': patch +'@rock-js/plugin-brownfield-android': patch +--- + +Add `--extra-params` to `package:aar` and `publish-local:aar` to pass extra parameters to Gradle, as `build:android` already does. diff --git a/packages/platform-android/src/lib/commands/aar/__tests__/aar.test.ts b/packages/platform-android/src/lib/commands/aar/__tests__/aar.test.ts new file mode 100644 index 000000000..fa6521c1d --- /dev/null +++ b/packages/platform-android/src/lib/commands/aar/__tests__/aar.test.ts @@ -0,0 +1,72 @@ +import * as tools from '@rock-js/tools'; +import { spawn } from '@rock-js/tools'; +import { test, vi } from 'vitest'; +import { options as packageAarOptions,packageAar } from '../packageAar.js'; +import { + options as publishLocalAarOptions, + publishLocalAar, +} from '../publishLocalAar.js'; + +const aarProject = { sourceDir: '/android', moduleName: 'reactnativeapp' }; + +const spinnerMock = vi.hoisted(() => ({ + start: vi.fn(), + stop: vi.fn(), + message: vi.fn(), +})); + +vi.spyOn(tools, 'spinner').mockImplementation(() => spinnerMock); + +beforeEach(() => { + vi.clearAllMocks(); +}); + +test('packageAar runs the assemble task for the module', async () => { + await packageAar(aarProject, 'Release'); + + expect(spawn).toBeCalledWith( + './gradlew', + ['reactnativeapp:assembleRelease', '-x', 'lint'], + { cwd: '/android' }, + ); +}); + +test('packageAar passes extra params to Gradle', async () => { + await packageAar(aarProject, 'Release', ['-PmyProperty=value', '--offline']); + + expect(spawn).toBeCalledWith( + './gradlew', + [ + 'reactnativeapp:assembleRelease', + '-x', + 'lint', + '-PmyProperty=value', + '--offline', + ], + { cwd: '/android' }, + ); +}); + +test('publishLocalAar passes extra params to Gradle', async () => { + await publishLocalAar(aarProject, ['-PmyProperty=value']); + + expect(spawn).toBeCalledWith( + './gradlew', + ['reactnativeapp:publishToMavenLocal', '-x', 'lint', '-PmyProperty=value'], + { cwd: '/android' }, + ); +}); + +test.each([ + ['package:aar', packageAarOptions], + ['publish-local:aar', publishLocalAarOptions], +])('%s parses --extra-params into Gradle arguments', (_, options) => { + const extraParams = options.find( + (option) => option.name === '--extra-params ', + ); + + expect(extraParams?.parse?.('-PmyProperty=value --offline')).toEqual([ + '-PmyProperty=value', + '--offline', + ]); +}); diff --git a/packages/platform-android/src/lib/commands/aar/packageAar.ts b/packages/platform-android/src/lib/commands/aar/packageAar.ts index 7e751d182..ac881880c 100644 --- a/packages/platform-android/src/lib/commands/aar/packageAar.ts +++ b/packages/platform-android/src/lib/commands/aar/packageAar.ts @@ -1,5 +1,5 @@ import type { RockCLIOptions } from '@rock-js/tools'; -import { outro } from '@rock-js/tools'; +import { outro, parseArgs } from '@rock-js/tools'; import { runGradleAar } from '../runGradle.js'; import { toPascalCase } from '../toPascalCase.js'; @@ -25,13 +25,22 @@ export type PackageAarFlags = { * AAR module name. */ moduleName?: string; + + /** + * Extra parameters passed to Gradle, e.g. `-PmyProperty=value`. + */ + extraParams?: string[]; }; -export async function packageAar(aarProject: AarProject, variant: string) { +export async function packageAar( + aarProject: AarProject, + variant: string, + extraParams?: string[], +) { normalizeVariant(variant); const tasks = [`assemble${toPascalCase(variant)}`]; - await runGradleAar({ tasks, aarProject, variant }); + await runGradleAar({ tasks, aarProject, variant, extraParams }); outro('Success 🎉.'); } @@ -58,4 +67,9 @@ export const options = [ name: '--module-name ', description: 'AAR module name', }, + { + name: '--extra-params ', + description: 'Custom params passed to gradle build command', + parse: parseArgs, + }, ] satisfies RockCLIOptions; diff --git a/packages/platform-android/src/lib/commands/aar/publishLocalAar.ts b/packages/platform-android/src/lib/commands/aar/publishLocalAar.ts index f4edf12bd..2b599b9ef 100644 --- a/packages/platform-android/src/lib/commands/aar/publishLocalAar.ts +++ b/packages/platform-android/src/lib/commands/aar/publishLocalAar.ts @@ -1,5 +1,5 @@ import type { RockCLIOptions } from '@rock-js/tools'; -import { outro } from '@rock-js/tools'; +import { outro, parseArgs } from '@rock-js/tools'; import { runGradleAar } from '../runGradle.js'; import type { AarProject } from './packageAar.js'; @@ -8,14 +8,23 @@ export type PublishLocalAarFlags = { * AAR module name. */ moduleName?: string; + + /** + * Extra parameters passed to Gradle, e.g. `-PmyProperty=value`. + */ + extraParams?: string[]; }; -export async function publishLocalAar(aarProject: AarProject) { +export async function publishLocalAar( + aarProject: AarProject, + extraParams?: string[], +) { const tasks = ['publishToMavenLocal']; await runGradleAar({ tasks, aarProject, + extraParams, }); outro('Success 🎉.'); } @@ -25,4 +34,9 @@ export const options = [ name: '--module-name ', description: 'AAR module name', }, + { + name: '--extra-params ', + description: 'Custom params passed to gradle publish command', + parse: parseArgs, + }, ] satisfies RockCLIOptions; diff --git a/packages/platform-android/src/lib/commands/runGradle.ts b/packages/platform-android/src/lib/commands/runGradle.ts index 7d9ae7ea2..748957043 100644 --- a/packages/platform-android/src/lib/commands/runGradle.ts +++ b/packages/platform-android/src/lib/commands/runGradle.ts @@ -18,6 +18,7 @@ type RunGradleAarArgs = { aarProject: AarProject; // if variant is not provided, it means we are publishing the AAR variant?: string; + extraParams?: string[]; }; export type RunGradleArgs = { @@ -113,6 +114,7 @@ export async function runGradleAar({ tasks, aarProject, variant, + extraParams, }: RunGradleAarArgs) { const loader = spinner({ indicator: 'timer' }); const message = variant @@ -124,6 +126,10 @@ export async function runGradleAar({ gradleArgs.push('-x', 'lint'); + if (extraParams) { + gradleArgs.push(...extraParams); + } + const gradleWrapper = getGradleWrapper(); try { diff --git a/packages/plugin-brownfield-android/src/__tests__/pluginBrownfieldAndroid.test.ts b/packages/plugin-brownfield-android/src/__tests__/pluginBrownfieldAndroid.test.ts index 23bdd44f8..88296ff6f 100644 --- a/packages/plugin-brownfield-android/src/__tests__/pluginBrownfieldAndroid.test.ts +++ b/packages/plugin-brownfield-android/src/__tests__/pluginBrownfieldAndroid.test.ts @@ -1,6 +1,18 @@ +import type * as PlatformAndroid from '@rock-js/platform-android'; +import { packageAar, publishLocalAar } from '@rock-js/platform-android'; import { expect, test } from 'vitest'; import { pluginBrownfieldAndroid } from '../lib/pluginBrownfieldAndroid.js'; +vi.mock('@react-native-community/cli-config-android', () => ({ + projectConfig: vi.fn(() => ({ sourceDir: '/android' })), +})); + +vi.mock('@rock-js/platform-android', async (importOriginal) => ({ + ...(await importOriginal()), + packageAar: vi.fn(), + publishLocalAar: vi.fn(), +})); + const pluginApi = { registerCommand: vi.fn(), getProjectRoot: vi.fn(), @@ -9,6 +21,13 @@ const pluginApi = { getPlatforms: vi.fn(), }; +function registeredAction(name: string) { + const command = pluginApi.registerCommand.mock.calls.find( + ([options]) => options.name === name, + ); + return command?.[0].action; +} + test('plugin is called with correct arguments and returns its name and description', () => { const plugin = pluginBrownfieldAndroid()(pluginApi); @@ -17,3 +36,23 @@ test('plugin is called with correct arguments and returns its name and descripti description: 'Rock plugin for brownfield Android.', }); }); + +test('package:aar and publish-local:aar pass extra params to Gradle', async () => { + pluginBrownfieldAndroid()(pluginApi); + const aarProject = { sourceDir: '/android', moduleName: 'reactnativeapp' }; + + await registeredAction('package:aar')({ + variant: 'Release', + moduleName: 'reactnativeapp', + extraParams: ['-PmyProperty=value'], + }); + await registeredAction('publish-local:aar')({ + moduleName: 'reactnativeapp', + extraParams: ['-PmyProperty=value'], + }); + + expect(packageAar).toBeCalledWith(aarProject, 'Release', [ + '-PmyProperty=value', + ]); + expect(publishLocalAar).toBeCalledWith(aarProject, ['-PmyProperty=value']); +}); diff --git a/packages/plugin-brownfield-android/src/lib/pluginBrownfieldAndroid.ts b/packages/plugin-brownfield-android/src/lib/pluginBrownfieldAndroid.ts index 17194f3df..4448680d5 100644 --- a/packages/plugin-brownfield-android/src/lib/pluginBrownfieldAndroid.ts +++ b/packages/plugin-brownfield-android/src/lib/pluginBrownfieldAndroid.ts @@ -25,11 +25,13 @@ const getAarConfig = ( export const packageAarAction = async ({ variant, moduleName, + extraParams, projectRoot, pluginConfig, }: { variant: string; moduleName: string | undefined; + extraParams?: string[]; projectRoot: string; pluginConfig?: AndroidProjectConfig; }) => { @@ -39,7 +41,7 @@ export const packageAarAction = async ({ if (androidConfig) { const config = getAarConfig(moduleName, androidConfig); - await packageAar(config, variant); + await packageAar(config, variant, extraParams); } else { throw new RockError('Android project not found.'); } @@ -47,10 +49,12 @@ export const packageAarAction = async ({ export const publishLocalAarAction = async ({ moduleName, + extraParams, projectRoot, pluginConfig, }: { moduleName: string | undefined; + extraParams?: string[]; projectRoot: string; pluginConfig?: AndroidProjectConfig; }) => { @@ -60,7 +64,7 @@ export const publishLocalAarAction = async ({ if (androidConfig) { const config = getAarConfig(moduleName, androidConfig); - await publishLocalAar(config); + await publishLocalAar(config, extraParams); } else { throw new RockError('Android project not found.'); } @@ -77,6 +81,7 @@ export const pluginBrownfieldAndroid = return packageAarAction({ variant: args.variant, moduleName: args.moduleName, + extraParams: args.extraParams, projectRoot: api.getProjectRoot(), pluginConfig, }); @@ -90,6 +95,7 @@ export const pluginBrownfieldAndroid = action: async (args: PublishLocalAarFlags) => { return publishLocalAarAction({ moduleName: args.moduleName, + extraParams: args.extraParams, projectRoot: api.getProjectRoot(), pluginConfig, }); diff --git a/website/src/docs/brownfield/android.mdx b/website/src/docs/brownfield/android.mdx index d7cf255f7..331eedcc5 100644 --- a/website/src/docs/brownfield/android.mdx +++ b/website/src/docs/brownfield/android.mdx @@ -277,6 +277,15 @@ If you're integrating an Expo app with Expo CLI instead of Rock, skip this step. rock publish-local:aar --module-name reactnativeapp ``` +:::tip +Both commands accept `--extra-params` to pass extra parameters to Gradle, for example a project property your module's build script reads: + +```sh title="Terminal" +rock package:aar --variant Release --module-name reactnativeapp --extra-params "-PmyProperty=value" +``` + +::: + ### 10. Extra steps for Expo CLI and Expo Modules 1. Make `ReactNativeHostManager` aware with expo modules: