react-native-coverage 0.1.0

package/lib/typescript/src/pull-native-coverage.d.ts

@@ -0,0 +1,38 @@
+import type { CoverageConfig } from './config.js';
+export type PullOptions = {
+    softFail?: boolean;
+    outputDir?: string;
+    config?: CoverageConfig;
+};
+export declare function getAdbBinary(): string;
+export declare function resolveAndroidDeviceId(preferredDeviceId?: string): string;
+export declare function androidCoverageFileExists(deviceId: string, config?: CoverageConfig): boolean;
+/**
+ * Pull Android Emma/Jacoco `.ec` from the device into `outputDir`.
+ * Ported from RNFB tests/scripts/pull-native-coverage.js with config injection.
+ */
+export declare function pullAndroidCoverage(deviceId: string, options?: PullOptions): string | null;
+export declare function pullAndroidCoverageWithRetry(deviceId: string, options?: PullOptions & {
+    retries?: number;
+    intervalMs?: number;
+}): Promise<string | null>;
+/**
+ * Pull iOS LLVM `.profraw` files from a simulator app container.
+ * Ported from RNFB with config-driven bundle id / output paths.
+ */
+export declare function pullIosCoverage(deviceId: string, options?: PullOptions): string[];
+export type AndroidReportOptions = {
+    androidDir?: string;
+    jacocoXml?: string;
+    config?: CoverageConfig;
+    /** When true (default), assert Jacoco XML after a successful Gradle report. */
+    assertAfterReport?: boolean;
+};
+/**
+ * Run a consumer Jacoco report Gradle task, then optionally assert LINE hits.
+ */
+export declare function runJacocoTestReport(options?: AndroidReportOptions | string): {
+    ok: boolean;
+    exitCode: number;
+};
+//# sourceMappingURL=pull-native-coverage.d.ts.map

package/lib/typescript/src/pull-native-coverage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pull-native-coverage.d.ts","sourceRoot":"","sources":["../../../src/pull-native-coverage.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAU,CAAC;AAI/C,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF,wBAAgB,YAAY,IAAI,MAAM,CAIrC;AAED,wBAAgB,sBAAsB,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,CAsBzE;AAED,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAwC,GAC/C,OAAO,CAcT;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,WAAgB,GACxB,MAAM,GAAG,IAAI,CAqCf;AAED,wBAAsB,4BAA4B,CAChD,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,WAAW,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAO,GACpE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAoCxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,WAAgB,GACxB,MAAM,EAAE,CAwDV;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,+EAA+E;IAC/E,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,oBAAoB,GAAG,MAAW,GAC1C;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAuCnC"}

package/package.json

@@ -0,0 +1,184 @@
+{
+  "name": "react-native-coverage",
+  "version": "0.1.0",
+  "description": "Native code coverage tooling for React Native (TurboModule + CLI + Expo config plugin)",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "react-native": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./node": {
+      "types": "./lib/typescript/src/node.d.ts",
+      "default": "./lib/module/node.js"
+    },
+    "./app.plugin.js": "./app.plugin.js",
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "rn-coverage": "./bin/rn-coverage.js"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "bin",
+    "plugin/build",
+    "app.plugin.js",
+    "cocoapods",
+    "docs",
+    "docs.json",
+    "react-native-coverage.config.js.example",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-coverage-example",
+    "example:dynamic": "yarn workspace react-native-coverage-example-dynamic",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build example-dynamic/ios/build lib plugin/build",
+    "prepare": "bob build && yarn build:plugin",
+    "build:plugin": "tsc --project plugin/tsconfig.json",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "e2e:ios:dynamic": "CELL=dynamic bash scripts/ci/run-ios-e2e-cell.sh",
+    "e2e:ios:static": "CELL=static bash scripts/ci/run-ios-e2e-cell.sh",
+    "e2e:android": "bash scripts/ci/run-android-e2e.sh",
+    "commitlint": "commitlint",
+    "release": "semantic-release",
+    "release:dry-run": "semantic-release --dry-run"
+  },
+  "keywords": [
+    "react-native",
+    "coverage",
+    "jacoco",
+    "llvm",
+    "istanbul",
+    "nyc",
+    "ios",
+    "android",
+    "turbo-module"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/invertase/react-native-coverage.git"
+  },
+  "author": "Invertase <oss@invertase.io> (https://invertase.io)",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/invertase/react-native-coverage/issues"
+  },
+  "homepage": "https://github.com/invertase/react-native-coverage#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "commander": "^13.1.0",
+    "nyc": "^17.1.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/compat": "^2.1.0",
+    "@eslint/eslintrc": "^3.3.5",
+    "@eslint/js": "^9.39.4",
+    "@react-native/babel-preset": "0.86.3",
+    "@react-native/eslint-config": "0.86.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/github": "^12.0.0",
+    "@semantic-release/npm": "^13.1.1",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.2.0",
+    "babel-plugin-istanbul": "^7.0.1",
+    "conventional-changelog-conventionalcommits": "^9.1.0",
+    "del-cli": "^7.0.0",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-ft-flow": "^3.0.11",
+    "eslint-plugin-prettier": "^5.5.6",
+    "expo": "~57.0.18",
+    "jest": "^29.7.0",
+    "prettier": "^3.8.3",
+    "react": "19.2.3",
+    "react-native": "0.86.3",
+    "react-native-builder-bob": "^0.43.0",
+    "semantic-release": "^25.0.1",
+    "ts-jest": "^29.4.0",
+    "turbo": "^2.9.16",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "expo": ">=52.0.0",
+    "react": "*",
+    "react-native": "*"
+  },
+  "peerDependenciesMeta": {
+    "expo": {
+      "optional": true
+    }
+  },
+  "workspaces": [
+    "example",
+    "example/fixture-lib",
+    "example-dynamic",
+    "e2e"
+  ],
+  "packageManager": "yarn@4.11.0",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "CoverageSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.coverage"
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "create-react-native-library": {
+    "type": "turbo-module",
+    "languages": "kotlin-objc",
+    "tools": [
+      "eslint",
+      "jest"
+    ],
+    "version": "0.63.0"
+  }
+}

package/plugin/build/index.d.ts

@@ -0,0 +1,21 @@
+import type { ConfigPlugin } from 'expo/config-plugins';
+export type ReactNativeCoveragePluginProps = {
+    /** iOS Mach-O / framework basename prefixes for multi-image LINKEDIT flush. */
+    frameworkNamePrefixes?: string[];
+    /** Android Gradle project-name substrings to instrument + report. */
+    libraryProjectMatchers?: string[];
+    /**
+     * Restore Coverage / fixture pods as dynamic frameworks after Expo's
+     * React-Core staticlib downgrade.
+     *
+     * Default **false** for Expo: Expo forces React-Core (and many RN pods) to
+     * static libraries, so dynamic Coverage* pods fail CocoaPods' transitive
+     * static→dynamic check. Set true on bare RN / RNFB hosts that build React
+     * as dynamic frameworks (primary multi-image LINKEDIT cell).
+     */
+    forceDynamicFrameworks?: boolean;
+    /** Wire Gradle helpers + testCoverageEnabled. Default true. */
+    enableAndroidCoverage?: boolean;
+};
+declare const _default: ConfigPlugin<void | ReactNativeCoveragePluginProps>;
+export default _default;

package/plugin/build/index.js

@@ -0,0 +1,153 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("expo/config-plugins");
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const PACKAGE_NAME = 'react-native-coverage';
+/** Bump when Podfile injection shape changes so re-prebuild rewrites. */
+const PODFILE_MARKER = '# react-native-coverage: post_install coverage flags';
+const ROOT_GRADLE_MARKER = '// react-native-coverage: root instrumentation';
+const APP_GRADLE_MARKER = '// react-native-coverage: app jacoco report';
+const APP_DEBUG_MARKER = '// react-native-coverage: enable testCoverageEnabled in debug builds';
+const DEFAULT_PREFIXES = ['CoverageFixture'];
+const DEFAULT_MATCHERS = ['coverage-fixture', 'react-native-coverage'];
+function resolvePackageRootGroovy() {
+    return ('new File(["node", "--print", ' +
+        `"require.resolve('${PACKAGE_NAME}/package.json')"` +
+        '].execute(null, rootDir).text.trim()).getParentFile()');
+}
+/**
+ * Expo config plugin — safe split:
+ * - Android: root instrumentation helper + app Jacoco report + testCoverageEnabled
+ * - iOS: dynamic frameworks (Podfile.properties) + Ruby helper require/call
+ * - Pod LLVM flags + dynamic-framework restore: shipped Ruby helper (not regex)
+ */
+const withReactNativeCoverage = (config, props) => {
+    const frameworkNamePrefixes = props?.frameworkNamePrefixes?.length
+        ? props.frameworkNamePrefixes
+        : DEFAULT_PREFIXES;
+    const libraryProjectMatchers = props?.libraryProjectMatchers?.length
+        ? props.libraryProjectMatchers
+        : DEFAULT_MATCHERS;
+    const forceDynamicFrameworks = props?.forceDynamicFrameworks === true;
+    const enableAndroidCoverage = props?.enableAndroidCoverage !== false;
+    // Primary proof cell is iOS dynamic frameworks (mode-c LINKEDIT).
+    config = (0, config_plugins_1.withPodfileProperties)(config, (cfg) => {
+        cfg.modResults['ios.useFrameworks'] = 'dynamic';
+        return cfg;
+    });
+    if (enableAndroidCoverage) {
+        config = (0, config_plugins_1.withProjectBuildGradle)(config, (cfg) => {
+            if (cfg.modResults.language !== 'groovy') {
+                return cfg;
+            }
+            if (cfg.modResults.contents.includes(ROOT_GRADLE_MARKER)) {
+                return cfg;
+            }
+            const matchersLiteral = libraryProjectMatchers
+                .map((m) => `'${m.replace(/'/g, "\\'")}'`)
+                .join(', ');
+            const snippet = `
+${ROOT_GRADLE_MARKER}
+ext.coverageLibraryProjectMatchers = [${matchersLiteral}]
+def rnCoverageRoot = ${resolvePackageRootGroovy()}
+apply from: new File(rnCoverageRoot, "android/rn-coverage.gradle")
+`;
+            cfg.modResults.contents = `${cfg.modResults.contents.trimEnd()}\n${snippet}\n`;
+            return cfg;
+        });
+        config = (0, config_plugins_1.withAppBuildGradle)(config, (cfg) => {
+            if (cfg.modResults.language !== 'groovy') {
+                return cfg;
+            }
+            if (!cfg.modResults.contents.includes(APP_DEBUG_MARKER)) {
+                // Prefer buildTypes.debug — do NOT match signingConfigs.debug.
+                if (/buildTypes\s*\{[\s\S]*?\bdebug\s*\{/.test(cfg.modResults.contents)) {
+                    cfg.modResults.contents = cfg.modResults.contents.replace(/(buildTypes\s*\{[\s\S]*?\bdebug\s*\{)/, `$1\n            testCoverageEnabled true\n            ${APP_DEBUG_MARKER}`);
+                }
+                else {
+                    cfg.modResults.contents += `\n${APP_DEBUG_MARKER}\n`;
+                }
+            }
+            if (!cfg.modResults.contents.includes(APP_GRADLE_MARKER)) {
+                const snippet = `
+${APP_GRADLE_MARKER}
+def rnCoverageRoot = ${resolvePackageRootGroovy()}
+apply from: new File(rnCoverageRoot, "android/rn-coverage-jacoco.gradle")
+`;
+                cfg.modResults.contents = `${cfg.modResults.contents.trimEnd()}\n${snippet}\n`;
+            }
+            return cfg;
+        });
+    }
+    config = (0, config_plugins_1.withDangerousMod)(config, [
+        'ios',
+        async (cfg) => {
+            const podfilePath = node_path_1.default.join(cfg.modRequest.platformProjectRoot, 'Podfile');
+            if (!node_fs_1.default.existsSync(podfilePath)) {
+                return cfg;
+            }
+            let contents = node_fs_1.default.readFileSync(podfilePath, 'utf8');
+            // Skip only when the full helper shape is already present.
+            if (contents.includes(PODFILE_MARKER) &&
+                contents.includes('force_dynamic_frameworks:') &&
+                contents.includes('install_installer_hooks!')) {
+                return cfg;
+            }
+            const requireLine = "require_relative '../node_modules/react-native-coverage/cocoapods/coverage_post_install'\n";
+            if (!contents.includes('coverage_post_install')) {
+                contents = requireLine + contents;
+            }
+            // Strip older helper injection so we can rewrite cleanly.
+            contents = contents.replace(/\n?[ \t]*# react-native-coverage: post_install coverage flags(?: \(05C4\))?\n[ \t]*ReactNativeCoverage\.apply_post_install!\([\s\S]*?\)\n?/g, '\n');
+            contents = contents.replace(/\n?[ \t]*ReactNativeCoverage\.install_installer_hooks!\n?/g, '\n');
+            contents = contents.replace(/\n?[ \t]*ReactNativeCoverage\.install_installer_hooks!\([\s\S]*?\)\n?/g, '\n');
+            const prefixesRuby = frameworkNamePrefixes
+                .map((p) => `'${p.replace(/'/g, "\\'")}'`)
+                .join(', ');
+            const hooksLine = `
+# react-native-coverage: wrap Installer after Expo use_expo_modules! patch
+ReactNativeCoverage.install_installer_hooks!(
+  force_dynamic_frameworks: ${forceDynamicFrameworks}
+)
+`;
+            // Must run AFTER react_native_post_install so RN does not wipe OTHER_CFLAGS.
+            const helperCall = `
+  ${PODFILE_MARKER}
+  ReactNativeCoverage.apply_post_install!(
+    installer,
+    framework_name_prefixes: [${prefixesRuby}],
+    force_dynamic_frameworks: ${forceDynamicFrameworks}
+  )
+`;
+            if (!contents.includes('install_installer_hooks!')) {
+                if (contents.includes('post_install do |installer|')) {
+                    contents = contents.replace(/post_install do \|installer\|/, `${hooksLine}post_install do |installer|`);
+                }
+                else {
+                    contents += `\n${hooksLine}\n`;
+                }
+            }
+            if (contents.includes('react_native_post_install(')) {
+                contents = contents.replace(/(react_native_post_install\([\s\S]*?\))\n/, `$1\n${helperCall}`);
+            }
+            else if (contents.includes('post_install do |installer|')) {
+                contents = contents.replace(/post_install do \|installer\|/, `post_install do |installer|${helperCall}`);
+            }
+            else {
+                contents += `
+post_install do |installer|
+${helperCall}
+end
+`;
+            }
+            node_fs_1.default.writeFileSync(podfilePath, contents);
+            return cfg;
+        },
+    ]);
+    return config;
+};
+exports.default = (0, config_plugins_1.createRunOncePlugin)(withReactNativeCoverage, PACKAGE_NAME, '0.1.0');

package/react-native-coverage.config.js.example

@@ -0,0 +1,47 @@
+/**
+ * Example consumer config — copy to react-native-coverage.config.js
+ * and adjust for your dedicated test app (Pattern C).
+ *
+ * Defaults are intentionally product-neutral.
+ */
+module.exports = {
+  nativeModuleName: 'Coverage',
+  app: {
+    androidApplicationId: 'com.example.coverage',
+    iosBundleId: 'com.example.coverage',
+    iosProductName: 'CoverageExample',
+  },
+  ios: {
+    // e.g. ['MyLib'] to include MyLib*.framework as llvm-cov objects
+    frameworkNamePrefixes: [],
+  },
+  android: {
+    libraryProjectMatchers: [],
+    detoxStagingPath: '/data/local/tmp/coverage/coverage.ec',
+    coverageRelativePath: 'files/coverage.ec',
+    jacocoReportXml:
+      'android/app/build/reports/jacoco/jacocoTestReport/jacocoTestReport.xml',
+  },
+  sourcePathRewrite: [
+    { kind: 'after-marker', marker: '/packages/', includeMarker: true },
+    {
+      kind: 'regex',
+      pattern: '^.*/@example-scope/([^/]+)/(.+)$',
+      replacement: 'packages/$1/$2',
+    },
+  ],
+  /**
+   * Prefer true in CI: pull/export/report/assert exit 2 when expected
+   * hits or artifacts are empty.
+   */
+  strict: true,
+  assert: {
+    /** LCOV SF: paths must include at least one of these substrings. */
+    lcovPathIncludes: ['packages/'],
+    /** Jacoco <package name> substrings that must have LINE covered > 0. */
+    jacocoPackageIncludes: [],
+    defaultLcovPath: 'coverage/ios/lcov.info',
+    defaultJacocoXmlPath:
+      'android/app/build/reports/jacoco/jacocoTestReport/jacocoTestReport.xml',
+  },
+};

package/react-native.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  dependency: {
+    platforms: {
+      android: {
+        cmakeListsPath: null,
+      },
+    },
+  },
+};

package/src/NativeCoverage.ts

@@ -0,0 +1,16 @@
+import { TurboModuleRegistry, type TurboModule } from 'react-native';
+
+/**
+ * TurboModule surface for native coverage flush (New Architecture only).
+ */
+export interface Spec extends TurboModule {
+  flush(): void;
+  /**
+   * Persist Istanbul `global.__coverage__` JSON to the app sandbox
+   * (`files/coverage-final.json` on Android, `Documents/coverage-final.json` on iOS)
+   * for host-side `rn-coverage js pull` + NYC remap.
+   */
+  dumpJsCoverage(json: string): void;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('Coverage');