rename FingerprintSources to FingerprintOptions and run prettier

thymikee · thymikee · commit 071af896a9e2 · 2026-01-11T10:24:21.000+01:00
diff --git a/.github/pr-labeler.yml b/.github/pr-labeler.yml
@@ -3,4 +3,4 @@
 'release: bug fix':
   - '/^fix/'
 'release: breaking change':
-  - '/^breaking/'
+  - '/^breaking/'
diff --git a/packages/cli/README.md b/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:
diff --git a/packages/cli/src/lib/plugins/fingerprint.ts b/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);
diff --git a/packages/cli/src/lib/plugins/remoteCache.ts b/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) {
diff --git a/packages/config/src/lib/config.ts b/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 }) => {
diff --git a/packages/create-app/src/lib/utils/__tests__/initInExistingProject.test.ts b/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'),
+    );
   });
 });
diff --git a/packages/platform-android/src/lib/commands/buildAndroid/buildAndroid.ts b/packages/platform-android/src/lib/commands/buildAndroid/buildAndroid.ts
@@ -2,7 +2,7 @@ import type { AndroidProjectConfig } from '@react-native-community/cli-types';
 import type { RemoteBuildCache, RockCLIOptions } from '@rock-js/tools';
 import {
   colorLink,
-  type FingerprintSources,
+  type FingerprintOptions,
   formatArtifactName,
   getBinaryPath,
   logger,
@@ -28,7 +28,7 @@ export async function buildAndroid(
   args: BuildFlags,
   projectRoot: string,
   remoteCacheProvider: null | (() => RemoteBuildCache) | undefined,
-  fingerprintOptions: FingerprintSources,
+  fingerprintOptions: FingerprintOptions,
 ) {
   normalizeArgs(args);
   // Use assemble task by default, but bundle if the flag is set
diff --git a/packages/platform-android/src/lib/commands/runAndroid/runAndroid.ts b/packages/platform-android/src/lib/commands/runAndroid/runAndroid.ts
@@ -5,7 +5,7 @@ import type {
   Config,
 } from '@react-native-community/cli-types';
 import type { StartDevServerArgs } from '@rock-js/config';
-import type { FingerprintSources, RemoteBuildCache } from '@rock-js/tools';
+import type { FingerprintOptions, RemoteBuildCache } from '@rock-js/tools';
 import {
   color,
   formatArtifactName,
@@ -50,7 +50,7 @@ export async function runAndroid(
   args: Flags,
   projectRoot: string,
   remoteCacheProvider: null | (() => RemoteBuildCache) | undefined,
-  fingerprintOptions: FingerprintSources,
+  fingerprintOptions: FingerprintOptions,
   startDevServer: (options: StartDevServerArgs) => void,
   reactNativeVersion: string,
   reactNativePath: string,
diff --git a/packages/platform-android/src/lib/commands/runAndroid/tryInstallAppOnDevice.ts b/packages/platform-android/src/lib/commands/runAndroid/tryInstallAppOnDevice.ts
@@ -20,9 +20,7 @@ export async function tryInstallAppOnDevice(
 ) {
   let deviceId: string;
   if (!device.deviceId) {
-    logger.debug(
-      `No "deviceId" for ${device}, skipping launching the app`,
-    );
+    logger.debug(`No "deviceId" for ${device}, skipping launching the app`);
     return;
   } else {
     deviceId = device.deviceId;
diff --git a/packages/platform-android/src/lib/commands/runAndroid/tryLaunchAppOnDevice.ts b/packages/platform-android/src/lib/commands/runAndroid/tryLaunchAppOnDevice.ts
@@ -11,9 +11,7 @@ export async function tryLaunchAppOnDevice(
 ) {
   let deviceId;
   if (!device.deviceId) {
-    logger.debug(
-      `No "deviceId" for ${device}, skipping launching the app`,
-    );
+    logger.debug(`No "deviceId" for ${device}, skipping launching the app`);
     return {};
   } else {
     deviceId = device.deviceId;
diff --git a/packages/platform-apple-helpers/src/lib/commands/build/createBuild.ts b/packages/platform-apple-helpers/src/lib/commands/build/createBuild.ts
@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import type { FingerprintSources, RemoteBuildCache } from '@rock-js/tools';
+import type { FingerprintOptions, RemoteBuildCache } from '@rock-js/tools';
 import {
   colorLink,
   formatArtifactName,
@@ -37,7 +37,7 @@ export const createBuild = async ({
   args: BuildFlags;
   projectRoot: string;
   reactNativePath: string;
-  fingerprintOptions: FingerprintSources;
+  fingerprintOptions: FingerprintOptions;
   remoteCacheProvider: null | (() => RemoteBuildCache) | undefined;
   usePrebuiltRNCore?: number;
 }) => {
diff --git a/packages/platform-apple-helpers/src/lib/commands/run/createRun.ts b/packages/platform-apple-helpers/src/lib/commands/run/createRun.ts
@@ -1,7 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import type { StartDevServerArgs } from '@rock-js/config';
-import type { FingerprintSources, RemoteBuildCache } from '@rock-js/tools';
+import type { FingerprintOptions, RemoteBuildCache } from '@rock-js/tools';
 import {
   color,
   formatArtifactName,
@@ -45,7 +45,7 @@ export const createRun = async ({
   args: RunFlags;
   projectRoot: string;
   remoteCacheProvider: null | (() => RemoteBuildCache) | undefined;
-  fingerprintOptions: FingerprintSources;
+  fingerprintOptions: FingerprintOptions;
   reactNativePath: string;
   reactNativeVersion: string;
   platforms: { [platform: string]: object };
diff --git a/packages/platform-apple-helpers/src/lib/commands/run/runOptions.ts b/packages/platform-apple-helpers/src/lib/commands/run/runOptions.ts
@@ -38,7 +38,8 @@ export const getRunOptions = ({ platformName }: BuilderCommand) => {
     },
     {
       name: '--dev-server',
-      description: 'Automatically start a dev server (bundler) after building the app.',
+      description:
+        'Automatically start a dev server (bundler) after building the app.',
     },
     ...getBuildOptions({ platformName }),
   ];
diff --git a/packages/platform-apple-helpers/src/lib/utils/buildApp.ts b/packages/platform-apple-helpers/src/lib/utils/buildApp.ts
@@ -1,7 +1,7 @@
 import path from 'node:path';
 import type { IOSProjectConfig } from '@react-native-community/cli-types';
 import {
-  type FingerprintSources,
+  type FingerprintOptions,
   formatArtifactName,
   getInfoPlist,
   RockError,
@@ -52,14 +52,14 @@ export async function buildApp({
       brownfield?: false;
       artifactName: string;
       deviceOrSimulator: string;
-      fingerprintOptions: FingerprintSources;
+      fingerprintOptions: FingerprintOptions;
     } & SharedBuildAppOptions)
   | ({
       brownfield: true;
       // artifactName, deviceOrSimulator and fingerprintOptions are not used for brownfield builds
       artifactName?: string;
       deviceOrSimulator?: string;
-      fingerprintOptions?: FingerprintSources;
+      fingerprintOptions?: FingerprintOptions;
     } & SharedBuildAppOptions)) {
   if (binaryPath) {
     // @todo Info.plist is hardcoded when reading from binaryPath
diff --git a/packages/platform-harmony/src/lib/commands/build/buildHarmony.ts b/packages/platform-harmony/src/lib/commands/build/buildHarmony.ts
@@ -1,7 +1,7 @@
 import type { RemoteBuildCache, RockCLIOptions } from '@rock-js/tools';
 import {
   colorLink,
-  type FingerprintSources,
+  type FingerprintOptions,
   formatArtifactName,
   getBinaryPath,
   logger,
@@ -26,7 +26,7 @@ export async function buildHarmony(
   args: BuildFlags,
   projectRoot: string,
   remoteCacheProvider: null | (() => RemoteBuildCache) | undefined,
-  fingerprintOptions: FingerprintSources,
+  fingerprintOptions: FingerprintOptions,
 ) {
   const { sourceDir, bundleName } = harmonyConfig;
   const artifactName = await formatArtifactName({
diff --git a/packages/platform-harmony/src/lib/commands/run/runHarmony.ts b/packages/platform-harmony/src/lib/commands/run/runHarmony.ts
@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import type { FingerprintSources, RemoteBuildCache } from '@rock-js/tools';
+import type { FingerprintOptions, RemoteBuildCache } from '@rock-js/tools';
 import {
   color,
   formatArtifactName,
@@ -40,7 +40,7 @@ export async function runHarmony(
   args: Flags,
   projectRoot: string,
   remoteCacheProvider: null | (() => RemoteBuildCache) | undefined,
-  fingerprintOptions: FingerprintSources,
+  fingerprintOptions: FingerprintOptions,
 ) {
   intro('Running HarmonyOS Next app');
 
diff --git a/packages/tools/src/lib/build-cache/common.ts b/packages/tools/src/lib/build-cache/common.ts
@@ -1,7 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { color } from '../color.js';
-import type { FingerprintSources } from '../fingerprint/index.js';
+import type { FingerprintOptions } from '../fingerprint/index.js';
 import { nativeFingerprint } from '../fingerprint/index.js';
 import { isInteractive } from '../isInteractive.js';
 import { getCacheRootPath } from '../project.js';
@@ -10,8 +10,8 @@ import { spinner } from '../prompts.js';
 export const BUILD_CACHE_DIR = 'remote-build';
 
 export const supportedRemoteCacheProviders = ['github-actions', 's3'] as const;
-export type SupportedRemoteCacheProviders = typeof supportedRemoteCacheProviders[number];
-
+export type SupportedRemoteCacheProviders =
+  (typeof supportedRemoteCacheProviders)[number];
 
 export type RemoteArtifact = {
   name: string;
@@ -111,7 +111,7 @@ export async function formatArtifactName({
   platform?: 'ios' | 'android' | 'harmony';
   traits?: string[];
   root: string;
-  fingerprintOptions: FingerprintSources;
+  fingerprintOptions: FingerprintOptions;
   raw?: boolean;
   type?: 'create' | 'update';
 }): Promise<string> {
diff --git a/packages/tools/src/lib/build-cache/getBinaryPath.ts b/packages/tools/src/lib/build-cache/getBinaryPath.ts
@@ -2,7 +2,7 @@ import path from 'node:path';
 import { color, colorLink } from '../color.js';
 import type { RockError } from '../error.js';
 import { getAllIgnorePaths } from '../fingerprint/ignorePaths.js';
-import { type FingerprintSources } from '../fingerprint/index.js';
+import { type FingerprintOptions } from '../fingerprint/index.js';
 import logger from '../logger.js';
 import { getProjectRoot } from '../project.js';
 import { spawn } from '../spawn.js';
@@ -23,7 +23,7 @@ export async function getBinaryPath({
   binaryPathFlag?: string;
   localFlag?: boolean;
   remoteCacheProvider: null | (() => RemoteBuildCache) | undefined;
-  fingerprintOptions: FingerprintSources;
+  fingerprintOptions: FingerprintOptions;
   sourceDir: string;
   platformName: string;
 }) {
@@ -67,7 +67,7 @@ Read more: ${colorLink(
 }
 
 async function warnIgnoredFiles(
-  fingerprintOptions: FingerprintSources,
+  fingerprintOptions: FingerprintOptions,
   platformName: string,
   sourceDir: string,
 ) {
diff --git a/packages/tools/src/lib/fingerprint/index.ts b/packages/tools/src/lib/fingerprint/index.ts
diff --git a/packages/tools/src/lib/hermes.ts b/packages/tools/src/lib/hermes.ts
diff --git a/templates/rock-template-default/tsconfig.json b/templates/rock-template-default/tsconfig.json
diff --git a/website/src/docs/remote-cache/introduction.md b/website/src/docs/remote-cache/introduction.md
