expo-modules-autolinking
Version:
Scripts that autolink Expo modules.
263 lines (240 loc) • 8.61 kB
text/typescript
import glob from 'fast-glob';
import fs from 'fs/promises';
import path from 'path';
import type {
RNConfigDependencyAndroid,
RNConfigReactNativePlatformsConfigAndroid,
} from './reactNativeConfig.types';
import {
fileExistsAsync,
globMatchFunctorAllAsync,
globMatchFunctorFirstAsync,
} from '../fileUtils';
export async function resolveDependencyConfigImplAndroidAsync(
packageRoot: string,
reactNativeConfig: RNConfigReactNativePlatformsConfigAndroid | null | undefined
): Promise<RNConfigDependencyAndroid | null> {
if (reactNativeConfig === null) {
// Skip autolinking for this package.
return null;
}
const sourceDir = reactNativeConfig?.sourceDir || 'android';
const androidDir = path.join(packageRoot, sourceDir);
const { gradle, manifest } = await findGradleAndManifestAsync({ androidDir, isLibrary: true });
if (!manifest && !gradle) {
return null;
}
const packageName =
reactNativeConfig?.packageName || (await parsePackageNameAsync(androidDir, manifest, gradle));
if (!packageName) {
return null;
}
const nativePackageClassName = await parseNativePackageClassNameAsync(packageRoot, androidDir);
if (!nativePackageClassName) {
return null;
}
const packageJson = JSON.parse(await fs.readFile(path.join(packageRoot, 'package.json'), 'utf8'));
const packageImportPath =
reactNativeConfig?.packageImportPath || `import ${packageName}.${nativePackageClassName};`;
const packageInstance = reactNativeConfig?.packageInstance || `new ${nativePackageClassName}()`;
const buildTypes = reactNativeConfig?.buildTypes || [];
const dependencyConfiguration = reactNativeConfig?.dependencyConfiguration;
const libraryName =
reactNativeConfig?.libraryName || (await parseLibraryNameAsync(androidDir, packageJson));
const componentDescriptors =
reactNativeConfig?.componentDescriptors ||
(await parseComponentDescriptorsAsync(packageRoot, packageJson));
let cmakeListsPath = reactNativeConfig?.cmakeListsPath
? path.join(androidDir, reactNativeConfig?.cmakeListsPath)
: path.join(androidDir, 'build/generated/source/codegen/jni/CMakeLists.txt');
const cxxModuleCMakeListsModuleName = reactNativeConfig?.cxxModuleCMakeListsModuleName || null;
const cxxModuleHeaderName = reactNativeConfig?.cxxModuleHeaderName || null;
let cxxModuleCMakeListsPath = reactNativeConfig?.cxxModuleCMakeListsPath
? path.join(androidDir, reactNativeConfig?.cxxModuleCMakeListsPath)
: null;
if (process.platform === 'win32') {
cmakeListsPath = cmakeListsPath.replace(/\\/g, '/');
if (cxxModuleCMakeListsPath) {
cxxModuleCMakeListsPath = cxxModuleCMakeListsPath.replace(/\\/g, '/');
}
}
const result: RNConfigDependencyAndroid = {
sourceDir: androidDir,
packageImportPath,
packageInstance,
dependencyConfiguration,
buildTypes,
libraryName,
componentDescriptors,
cmakeListsPath,
cxxModuleCMakeListsModuleName,
cxxModuleCMakeListsPath,
cxxModuleHeaderName,
};
if (!result.libraryName) {
delete result.libraryName;
}
if (!result.dependencyConfiguration) {
delete result.dependencyConfiguration;
}
return result;
}
/**
* Parse the `RNConfigDependencyAndroid.packageName`
*/
export async function parsePackageNameAsync(
androidDir: string,
manifestPath: string | null,
gradlePath: string | null
): Promise<string | null> {
if (gradlePath) {
const gradleContents = await fs.readFile(path.join(androidDir, gradlePath), 'utf8');
const match = gradleContents.match(/namespace\s*[=]*\s*["'](.+?)["']/);
if (match) {
return match[1];
}
}
if (manifestPath) {
const manifestContents = await fs.readFile(path.join(androidDir, manifestPath), 'utf8');
const match = manifestContents.match(/package="(.+?)"/);
if (match) {
return match[1];
}
}
return null;
}
/**
* Parse the Java or Kotlin class name to for `ReactPackage` or `(Base|Turbo)ReactPackage`.
*/
export async function parseNativePackageClassNameAsync(
packageRoot: string,
androidDir: string
): Promise<string | null> {
const matched = await globMatchFunctorFirstAsync(
'**/*Package.{java,kt}',
matchNativePackageClassName,
{ cwd: androidDir }
);
if (matched) {
return matched;
}
// Early return if the module is an Expo module
if (await fileExistsAsync(path.join(packageRoot, 'expo-module.config.json'))) {
return null;
}
return await globMatchFunctorFirstAsync('**/*.{java,kt}', matchNativePackageClassName, {
cwd: androidDir,
});
}
let lazyReactPackageRegex: RegExp | null = null;
let lazyTurboReactPackageRegex: RegExp | null = null;
export function matchNativePackageClassName(filePath: string, contents: Buffer): string | null {
const fileContents = contents.toString();
// [0] Match ReactPackage
if (!lazyReactPackageRegex) {
lazyReactPackageRegex =
/class\s+(\w+[^(\s]*)[\s\w():]*(\s+implements\s+|:)[\s\w():,]*[^{]*ReactPackage/;
}
const matchReactPackage = fileContents.match(lazyReactPackageRegex);
if (matchReactPackage) {
return matchReactPackage[1];
}
// [1] Match (Base|Turbo)ReactPackage
if (!lazyTurboReactPackageRegex) {
lazyTurboReactPackageRegex =
/class\s+(\w+[^(\s]*)[\s\w():]*(\s+extends\s+|:)[\s\w():,]*[^{]*(Base|Turbo)ReactPackage/;
}
const matchTurboReactPackage = fileContents.match(lazyTurboReactPackageRegex);
if (matchTurboReactPackage) {
return matchTurboReactPackage[1];
}
return null;
}
export async function parseLibraryNameAsync(
androidDir: string,
packageJson: any
): Promise<string | null> {
// [0] `codegenConfig.name` from package.json
if (packageJson.codegenConfig?.name) {
return packageJson.codegenConfig.name;
}
const libraryNameRegExp = /libraryName = ["'](.+)["']/;
const gradlePath = path.join(androidDir, 'build.gradle');
// [1] `libraryName` from build.gradle
if (await fileExistsAsync(gradlePath)) {
const buildGradleContents = await fs.readFile(gradlePath, 'utf8');
const match = buildGradleContents.match(libraryNameRegExp);
if (match) {
return match[1];
}
}
// [2] `libraryName` from build.gradle.kts
const gradleKtsPath = path.join(androidDir, 'build.gradle.kts');
if (await fileExistsAsync(gradleKtsPath)) {
const buildGradleContents = await fs.readFile(gradleKtsPath, 'utf8');
const match = buildGradleContents.match(libraryNameRegExp);
if (match) {
return match[1];
}
}
return null;
}
export async function parseComponentDescriptorsAsync(
packageRoot: string,
packageJson: any
): Promise<string[]> {
const jsRoot = packageJson?.codegenConfig?.jsSrcsDir
? path.join(packageRoot, packageJson.codegenConfig.jsSrcsDir)
: packageRoot;
const results = await globMatchFunctorAllAsync(
'**/*.{js,jsx,ts,tsx}',
matchComponentDescriptors,
{
cwd: jsRoot,
ignore: ['**/node_modules/**'],
}
);
// Filter out duplicates as it happens that libraries contain multiple outputs due to package publishing.
// TODO: consider using "codegenConfig" to avoid this.
return Array.from(new Set(results));
}
let lazyCodegenComponentRegex: RegExp | null = null;
function matchComponentDescriptors(filePath: string, contents: Buffer): string | null {
const fileContents = contents.toString();
if (!lazyCodegenComponentRegex) {
lazyCodegenComponentRegex =
/codegenNativeComponent(<.*>)?\s*\(\s*["'`](\w+)["'`](,?[\s\S]+interfaceOnly:\s*(\w+))?/m;
}
const match = fileContents.match(lazyCodegenComponentRegex);
if (!(match?.[4] === 'true') && match?.[2]) {
return `${match[2]}ComponentDescriptor`;
}
return null;
}
export async function findGradleAndManifestAsync({
androidDir,
isLibrary,
}: {
androidDir: string;
isLibrary: boolean;
}): Promise<{ gradle: string | null; manifest: string | null }> {
const globExcludes = [
'node_modules/**',
'**/build/**',
'**/debug/**',
'Examples/**',
'examples/**',
'**/Pods/**',
'**/sdks/hermes/android/**',
'**/src/androidTest/**',
'**/src/test/**',
];
const gradlePattern = isLibrary ? 'build.gradle{,.kts}' : 'app/build.gradle{,.kts}';
const [manifests, gradles] = await Promise.all([
glob('**/AndroidManifest.xml', { cwd: androidDir, ignore: globExcludes }),
glob(gradlePattern, { cwd: androidDir, ignore: globExcludes }),
]);
const manifest = manifests.find((manifest) => manifest.includes('src/main/')) ?? manifests[0];
const gradle = gradles[0];
return { gradle: gradle || null, manifest: manifest || null };
}