Expo 指纹

一个从 React Native 项目生成指纹的库。

@expo/fingerprint 提供了一个 API 来生成项目的指纹（哈希），用于确定应用的原生层和 JavaScript 层之间的兼容性。哈希计算是可配置的，但默认情况下源自哈希应用依赖、自定义原生代码、原生项目文件和配置。

¥@expo/fingerprint provides an API to generate a fingerprint (hash) of your project for use in determining compatibility between the native layer and JavaScript layer of your app. The hash calculation is configurable, but is by default derived from hashing app dependencies, custom native code, native project files, and configuration.

安装

¥Installation

@expo/fingerprint 默认包含在 expo 和 expo-updates 中。

¥@expo/fingerprint is included with expo and expo-updates by default.

如果你希望将 @expo/fingerprint 用作独立包，则可以通过运行以下命令进行安装：

¥If you wish to use @expo/fingerprint as a standalone package, you can install it by running the command:

API 使用

¥API Usage

import * as Fingerprint from '@expo/fingerprint';

CLI 使用

¥CLI Usage

配置

¥Configuration

@expo/fingerprint 提供的默认值应该适用于大多数项目，但也提供了几种配置指纹识别过程的方法，以更好地适应你的应用结构和工作流程。

¥@expo/fingerprint provides defaults that should work for most projects, but also provides a few ways to configure the fingerprinting process to better fit your app structure and workflow.

.fingerprintignore

.fingerprintignore 位于项目根目录中，是一种类似 .gitignore 的忽略机制，用于将文件排除在哈希计算之外。它的行为类似，但使用 minimatch 进行模式匹配，其中有一些 limitations（请参阅 选项 下 ignorePaths 的文档）。

¥Placed in your project root, .fingerprintignore is a .gitignore-like ignore mechanism used to exclude files from hash calculation. It behaves similarly but instead uses minimatch for pattern matching which has some limitations (see documentation for ignorePaths under Options).

例如，要跳过文件夹但保留一些文件：

¥For example, to skip a folder but keep some files:

# Ignore the entire /app/ios folder
/app/ios/**/*

# But still keep /app/ios/Podfile and /app/ios/Podfile.lock
!/app/ios/Podfile
!/app/ios/Podfile.lock

fingerprint.config.js

fingerprint.config.js 位于你的项目根目录中，允许你指定自定义哈希计算配置，超出 .fingerprintignore 中可配置的内容。

¥Placed in your project root, fingerprint.config.js allows you to specify custom hash calculation configuration beyond what is configurable in the .fingerprintignore.

有关支持的配置，请参阅 配置 和 SourceSkips。

¥For supported configurations, see Config and SourceSkips.

以下是示例 finger.config.js 配置，假设你已将 @expo/fingerprint 安装为直接依赖：

¥Below is an example fingerprint.config.js configuration, assuming you have @expo/fingerprint installed as a direct dependency:

/** @type {import('@expo/fingerprint').Config} */
const config = {
  sourceSkips: [
    'ExpoConfigRuntimeVersionIfString',
    'ExpoConfigVersions',
    'PackageJsonAndroidAndIosScriptsIfNotContainRun',
  ],
};
module.exports = config;

如果你正在使用 @expo/fingerprint 到 expo（其中 @expo/fingerprint 作为传递依赖安装），则可以从 expo/fingerprint 导入指纹：

¥If you are using @expo/fingerprint through expo (where @expo/fingerprint is installed as a transitive dependency), you can import fingerprint from expo/fingerprint:

/** @type {import('expo/fingerprint').Config} */

局限性

¥Limitations

const { withInfoPlist } = require('expo/config-plugins');

const withMyPlugin = (config) => {
  return withInfoPlist(config, (config) => {
    config.modResults.NSLocationWhenInUseUsageDescription = 'Allow $(PRODUCT_NAME) to use your location';
    return config;
  });
};

export default ({ config }) => {
  config.plugins ||= [];
  config.plugins.push(withMyPlugin);
  config.plugins.push((config) => config);
  return config;
};

const { withInfoPlist } = require('expo/config-plugins');

const withMyPlugin = config => {
  return withInfoPlist(config, config => {
    config.modResults.NSLocationWhenInUseUsageDescription =
      'Allow $(PRODUCT_NAME) to use your location';
    return config;
  });
};

module.exports = withMyPlugin;

{
  "expo": {
    %%placeholder-start%%... %%placeholder-end%%
    "plugins": "./plugins/withMyPlugin"
  }
}

Constants

Methods

const fingerprint = await createFingerprintAsync('/app');
console.log(fingerprint);

const hash = await createProjectHashAsync('/app');
console.log(hash);

// Create a fingerprint for the project
const fingerprint = await createFingerprintAsync('/app');

// Make some changes to the project

// Calculate the diff
const diff = await diffFingerprintChangesAsync(fingerprint, '/app');
console.log(diff);

// Create a fingerprint for the project
const fingerprint = await createFingerprintAsync('/app');

// Make some changes to the project

// Create a fingerprint again
const fingerprint2 = await createFingerprintAsync('/app');
const diff = await diffFingerprints(fingerprint, fingerprint2);
console.log(diff);

Interfaces

Types

Enums