react-native-store-version 1.4.2 → 2.0.0

package/src/cli/output.ts

@@ -0,0 +1,122 @@
+// `check` の結果の出力: テキスト / `--json` / GitHub Actions の注釈と Job Summary
+import type { CheckEntry, Counts } from './result.ts';
+
+/** 出力に渡す結果 */
+export type Report = {
+  /** 確かめたディレクトリ（絶対パス） */
+  cwd: string;
+  entries: readonly CheckEntry[];
+  counts: Counts;
+  exitCode: number;
+};
+
+const COMMAND = 'react-native-store-version check';
+
+const plural = (n: number, word: string) => `${n} ${word}${n === 1 ? '' : 's'}`;
+
+const countsLine = ({ error, warning, info }: Counts) =>
+  `${plural(error, 'error')}, ${plural(warning, 'warning')}, ${info} info`;
+
+/**
+ * 1 行に出す値の `\r` / `\n` を空白にする。GitHub Actions 上では、値の中の改行の後ろが `::` で始まると
+ * ワークフローコマンドとして解釈されてしまうため（注釈にする行は escapeData で改行をエスケープする）
+ */
+export const oneLine = (value: string): string => value.replace(/[\r\n]/g, ' ');
+
+const headerLine = (cwd: string) => `${COMMAND}: ${oneLine(cwd)}`;
+
+const textLine = ({ id, level, message }: CheckEntry) =>
+  `  ${level.padEnd(8)} ${id}  ${oneLine(message)}`;
+
+/** テキストの出力（末尾の改行まで） */
+export const formatText = (report: Report): string =>
+  [
+    headerLine(report.cwd),
+    ...(report.entries.length === 0
+      ? ['  (no checks were run)']
+      : report.entries.map(textLine)),
+    countsLine(report.counts),
+    '',
+  ].join('\n');
+
+/** `--json` の出力（末尾の改行まで）。entries は `results` に、出したときと同じ順で入る */
+export const formatJson = (report: Report): string =>
+  `${JSON.stringify(
+    {
+      cwd: report.cwd,
+      results: report.entries,
+      counts: report.counts,
+      exitCode: report.exitCode,
+    },
+    null,
+    2
+  )}\n`;
+
+/** ワークフローコマンドの message のエスケープ（`%` を最初に置き換える。後の置き換えで入る `%` を二重にしないため） */
+export const escapeData = (value: string): string =>
+  value.replace(/%/g, '%25').replace(/\r/g, '%0D').replace(/\n/g, '%0A');
+
+/** ワークフローコマンドの property（`title` など）のエスケープ。message のエスケープに `:` と `,` を足す */
+export const escapeProperty = (value: string): string =>
+  escapeData(value).replace(/:/g, '%3A').replace(/,/g, '%2C');
+
+const ANNOTATION = {
+  error: 'error',
+  warning: 'warning',
+  info: 'notice',
+} as const;
+
+/**
+ * GitHub Actions 上の出力（末尾の改行まで）。error / warning / info は `::error::` / `::warning::` / `::notice::` の注釈にし
+ * （ログにも本文が出る）、ok / skipped はテキストと同じ行で出す
+ */
+export const formatGithub = (report: Report): string =>
+  [
+    headerLine(report.cwd),
+    ...report.entries.map((entry) =>
+      entry.level === 'ok' || entry.level === 'skipped'
+        ? textLine(entry)
+        : `::${ANNOTATION[entry.level]} title=${escapeProperty(`${COMMAND} ${entry.id}`)}::${escapeData(entry.message)}`
+    ),
+    countsLine(report.counts),
+    '',
+  ].join('\n');
+
+/**
+ * チェックの結果が出せなかったとき（引数の誤り・想定外の失敗）の GitHub Actions の注釈（末尾の改行まで）。
+ * ログの stderr だけでは失敗の理由が PR の画面に出ないため
+ */
+export const formatGithubFailure = (message: string): string =>
+  `::error title=${escapeProperty(COMMAND)}::${escapeData(message)}\n`;
+
+/** Markdown の表のセルに入れる文字列。HTML として読まれないようにし、`|` と改行で表が崩れないようにする */
+const escapeCell = (value: string): string =>
+  value
+    .replace(/&/g, '&')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;')
+    .replace(/\|/g, '\\|')
+    .replace(/\r?\n/g, '<br>');
+
+/** Job Summary（`GITHUB_STEP_SUMMARY` のファイル）に追記する Markdown（前後を空行で区切る） */
+export const formatSummary = (report: Report): string =>
+  [
+    '',
+    `### ${COMMAND}`,
+    '',
+    `Directory: <code>${escapeCell(report.cwd)}</code>`,
+    '',
+    ...(report.entries.length === 0
+      ? ['No checks were run.']
+      : [
+          '| Check | Result | Message |',
+          '| --- | --- | --- |',
+          ...report.entries.map(
+            ({ id, level, message }) =>
+              `| ${id} | ${level} | ${escapeCell(message)} |`
+          ),
+        ]),
+    '',
+    countsLine(report.counts),
+    '',
+  ].join('\n');

package/src/cli/packages.ts

@@ -0,0 +1,43 @@
+// `<cwd>` から見たパッケージの探し方。アプリ（Metro）と同じく、`<cwd>` から親へ辿った各ディレクトリの node_modules/<name> を見る
+// （monorepo の巻き上げも拾う）。
+//
+// createRequire の require.resolve は使わない。Node の解決は node_modules の連鎖のほかに NODE_PATH と
+// グローバルのフォルダ（~/.node_modules など）も見るが、pnpm の bin の shim は NODE_PATH に node_modules/.pnpm/node_modules
+// （巻き上げた推移的な依存）や、この CLI 自身のパッケージがある node_modules/.pnpm/react-native-store-version@x/node_modules を
+// 入れて起動する。そのため `pnpm exec` / `pnpm dlx` から動かすと、アプリに入っていないパッケージ（この CLI 自身を含む）も
+// 見つかってしまう。Metro は NODE_PATH を見ないので、ここも見ない
+import { statSync } from 'node:fs';
+import { basename, dirname, join, resolve } from 'node:path';
+
+const isFile = (path: string): boolean => {
+  try {
+    return statSync(path).isFile();
+  } catch {
+    return false;
+  }
+};
+
+/**
+ * `<cwd>` から親へ辿り、最初に見つかった `node_modules/<name>/package.json` のパス（symlink は辿らないままのパス）。
+ * 無ければ null。Node と同じく、`node_modules` という名前のディレクトリの下に node_modules は探さない
+ */
+export const findPackageJson = (cwd: string, name: string): string | null => {
+  let dir = resolve(cwd);
+  for (;;) {
+    if (basename(dir) !== 'node_modules') {
+      const candidate = join(dir, 'node_modules', name, 'package.json');
+      if (isFile(candidate)) {
+        return candidate;
+      }
+    }
+    const parent = dirname(dir);
+    if (parent === dir) {
+      return null;
+    }
+    dir = parent;
+  }
+};
+
+/** `<cwd>` から `name` のパッケージが見つかるか（{@link findPackageJson}） */
+export const isInstalled = (cwd: string, name: string): boolean =>
+  findPackageJson(cwd, name) !== null;

package/src/cli/project/android.ts

@@ -0,0 +1,96 @@
+// Android のネイティブのプロジェクト（`android/`）から package（C2）と版（C4）を読む。
+// `android/app/build.gradle`（無ければ `build.gradle.kts`）の最初の `defaultConfig { … }` と `android { namespace … }` を見る
+import { join } from 'node:path';
+
+import {
+  displayPath,
+  isDirectory,
+  isFile,
+  type Lookup,
+  readText,
+} from './files.ts';
+import {
+  findBlock,
+  findStatement,
+  hasWord,
+  maskGradle,
+  type Range,
+} from './gradle.ts';
+
+/** `android/` から読んだ値。`notes` は C2 が info で出す注意（productFlavors / applicationIdSuffix を無視したこと） */
+export type AndroidProject = {
+  packageName: Lookup;
+  version: Lookup;
+  notes: string[];
+};
+
+const GRADLE_FILES = ['build.gradle', 'build.gradle.kts'];
+
+/** `android/` が無ければ null（CNG）。読めない・特定できないものは {@link Lookup} の reason にする */
+export const readAndroidProject = (cwd: string): AndroidProject | null => {
+  const androidDir = join(cwd, 'android');
+  if (!isDirectory(androidDir)) {
+    return null;
+  }
+  const notes: string[] = [];
+  const unknown = (reason: string): AndroidProject => ({
+    packageName: { value: null, reason },
+    version: { value: null, reason },
+    notes,
+  });
+
+  const path = GRADLE_FILES.map((name) => join(androidDir, 'app', name)).find(
+    isFile
+  );
+  if (path === undefined) {
+    return unknown(
+      'there is no android/app/build.gradle or android/app/build.gradle.kts'
+    );
+  }
+  const file = displayPath(cwd, path);
+  const source = readText(path);
+  if (source === null) {
+    return unknown(`could not read ${file}`);
+  }
+  const masked = maskGradle(source);
+  const defaultConfig = findBlock(masked, 'defaultConfig');
+
+  /** `range` の直下の `key` を読む。無ければ null */
+  const statement = (key: string, range: Range | null): Lookup | null => {
+    const found = range && findStatement(source, masked, key, range);
+    if (!found) {
+      return null;
+    }
+    if (found.literal === undefined) {
+      return {
+        value: null,
+        reason: `${key} in ${file} is not a string literal (${found.expression})`,
+      };
+    }
+    return { value: found.literal, label: key, file };
+  };
+
+  // applicationId が無ければ namespace（AGP は applicationId の既定に namespace を使う）。applicationId が変数なら
+  // namespace と同じとは限らないので、namespace には戻らず「特定できない」にする
+  const packageName = statement('applicationId', defaultConfig) ??
+    statement('namespace', findBlock(masked, 'android')) ?? {
+      value: null,
+      reason: `there is no applicationId in defaultConfig or namespace in android { } of ${file}`,
+    };
+
+  const flavors = ['productFlavors', 'applicationIdSuffix'].filter((word) =>
+    hasWord(masked, word)
+  );
+  if (flavors.length > 0) {
+    notes.push(
+      `${file} has ${flavors.join(' and ')}; ${flavors.length > 1 ? 'they are' : 'it is'} ignored, and the package without a flavor or suffix is used`
+    );
+  }
+
+  const version = statement('versionName', defaultConfig) ?? {
+    value: null,
+    reason: `there is no versionName in defaultConfig of ${file}`,
+  };
+
+  return { packageName, version, notes };
+};

package/src/cli/project/expo.ts

@@ -0,0 +1,232 @@
+// Expo の設定（app.json / app.config.ts / app.config.js）から bundleIdentifier / package / version を読む（C2 / C4）。
+// アプリに入っている `expo` の `expo/config`（@expo/config の再 export）の getConfig で評価する。pnpm の isolated では
+// アプリから @expo/config を直接は解決できないので、expo のディレクトリを起点に読む。CLI のための依存は足さないので、
+// 型は import せず、返ってきた値（unknown）から必要な形を確かめる
+import { realpathSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { dirname, join, relative, sep } from 'node:path';
+import { format } from 'node:util';
+
+import { findPackageJson } from '../packages.ts';
+import { displayPath, isFile, readText } from './files.ts';
+
+/** Expo の設定から読んだ値。無い・文字列でないものは null */
+export type ExpoConfig = {
+  /** 値を読んだ設定ファイル（{@link displayPath}） */
+  file: string;
+  bundleIdentifier: string | null;
+  package: string | null;
+  version: string | null;
+};
+
+/**
+ * `expo` が入っているアプリの設定。`config` は読めなかったら null。`notes` は C2 が info で出す注意
+ * （getConfig が失敗して app.json の素読みに戻ったことなど）
+ */
+export type ExpoProject = {
+  config: ExpoConfig | null;
+  notes: string[];
+};
+
+type Obj = Record<string, unknown>;
+
+const isObject = (value: unknown): value is Obj =>
+  typeof value === 'object' && value !== null && !Array.isArray(value);
+
+const text = (value: unknown): string | null =>
+  typeof value === 'string' && value !== '' ? value : null;
+
+/** 失敗の理由を 1 行に詰めたときの長さの上限 */
+const MAX_REASON = 300;
+
+/**
+ * 失敗の理由を 1 行にする。getConfig の失敗は `Error reading Expo config at <path>:` の次の行以降に理由があり、
+ * 構文エラーではその後にコードの抜粋（`> 2 |   name: ,`）が続く。抜粋の手前までの空でない行をつなぎ、
+ * `<cwd>/` を落として（パスは cwd からの相対で出す）、長すぎれば切る
+ */
+/**
+ * Error の message。`instanceof Error` では見ない: アプリの設定の評価や、Jest のモジュールの解決が投げるものは
+ * 別の realm の Error のことがあり、`String(error)` だと先頭に `Error: ` が付く
+ */
+const messageOf = (error: unknown): string =>
+  typeof error === 'object' &&
+  error !== null &&
+  typeof (error as { message?: unknown }).message === 'string'
+    ? (error as { message: string }).message
+    : String(error);
+
+const errorMessage = (error: unknown, cwd?: string) => {
+  const lines: string[] = [];
+  for (const line of messageOf(error).split(/\r?\n/)) {
+    if (/^\s*>?\s*\d+\s*\|/.test(line)) {
+      break;
+    }
+    if (line.trim() !== '') {
+      lines.push(line.trim());
+    }
+  }
+  let reason = lines.join(' ');
+  if (cwd !== undefined) {
+    reason = reason.split(`${cwd}${sep}`).join('');
+  }
+  return reason.length > MAX_REASON
+    ? `${reason.slice(0, MAX_REASON)}…`
+    : reason;
+};
+
+/** 設定の `expo` の中身（app.json の `expo` キーの下、または app.config の戻り値）から値を取る */
+const valuesOf = (exp: Obj, file: string): ExpoConfig => {
+  const ios = isObject(exp.ios) ? exp.ios : {};
+  const android = isObject(exp.android) ? exp.android : {};
+  return {
+    file,
+    bundleIdentifier: text(ios.bundleIdentifier),
+    package: text(android.package),
+    version: text(exp.version),
+  };
+};
+
+/**
+ * `fn` の間、stdout への出力を stderr に回す。getConfig はアプリの app.config.ts / .js を評価するので、そこの
+ * `console.log` などが stdout に出ると `--json` の stdout が JSON でなくなる。
+ * Node の console は書くたびに `process.stdout.write` を引くので、それを差し替えれば `console.log` も回る。
+ * console 自体を差し替えたもの（Jest など）のために `console.log` / `info` / `debug` も回す。
+ * getConfig は同期なので、戻ってから後に（タイマーなどで）出るものは回らない
+ */
+export const withStdoutToStderr = <T>(fn: () => T): T => {
+  const { stdout, stderr } = process;
+  const write = stdout.write;
+  const { log, info, debug } = console;
+  const toStderr = (...args: unknown[]) => {
+    stderr.write(`${format(...args)}\n`);
+  };
+  stdout.write = stderr.write.bind(stderr) as typeof stdout.write;
+  console.log = toStderr;
+  console.info = toStderr;
+  console.debug = toStderr;
+  try {
+    return fn();
+  } finally {
+    stdout.write = write;
+    console.log = log;
+    console.info = info;
+    console.debug = debug;
+  }
+};
+
+/** 動的な設定（app.config.*）があればそれ、無ければ app.json のパス（getConfig の戻り値の名前） */
+const configFileOf = (cwd: string, result: Obj): string => {
+  const path = text(result.dynamicConfigPath) ?? text(result.staticConfigPath);
+  return path === null ? 'the Expo config' : displayPath(cwd, path);
+};
+
+/**
+ * getConfig の `exp.version` のうち、設定に書かれた値だけを返す（書かれていなければ null）。
+ * getConfig（@expo/config の ensureConfigHasDefaultValues）は version が無いと `<cwd>/package.json` の version
+ * （それも無ければ `1.0.0`）で埋めるので、bare RN に expo を入れただけのアプリ（app.json に version が無く、
+ * package.json が `0.0.1`）でネイティブの版とのずれを誤って出してしまう。
+ *
+ * - 静的な設定の生の中身（`rootConfig`。`expo` キーの下か直下）に version があれば、書かれた値
+ * - 動的な設定（app.config.*。`dynamicConfigPath`）があれば、`exp.version` が Expo の補う値（戻り値の `pkg.version`。
+ *   getConfig は `pkg` にも同じ既定値を入れて返す）と違うときだけ書かれた値。app.config に渡す `config` も既定値を
+ *   埋めた後のものなので、`({ config }) => ({ ...config, … })` は補った値をそのまま返すため
+ *   限界: app.config に package.json と同じ値を明示したときは「書かれていない」と見なす（比べないだけで、誤った warning は出ない）
+ * - どちらでもなければ書かれていない
+ */
+const writtenVersion = (result: Obj, version: string | null): string | null => {
+  const root = isObject(result.rootConfig) ? result.rootConfig : {};
+  const raw = isObject(root.expo) ? root.expo : root;
+  if (text(raw.version) !== null) {
+    return version;
+  }
+  if (text(result.dynamicConfigPath) === null) {
+    return null;
+  }
+  const pkg = isObject(result.pkg) ? result.pkg : {};
+  const filled = typeof pkg.version === 'string' ? pkg.version : '1.0.0';
+  return version === filled ? null : version;
+};
+
+/**
+ * 見つけた `expo` の `expo/config` を読み込む。createRequire の解決は NODE_PATH も見る（pnpm の bin の shim は
+ * `.pnpm/node_modules` を入れる）ので、見つけた expo に `expo/config` が無いと別の expo のものを読みうる。
+ * 解決した先が見つけた expo の中かを確かめる
+ */
+const loadExpoConfig = (cwd: string, expoPackageJson: string): unknown => {
+  const require = createRequire(expoPackageJson);
+  const resolved = require.resolve('expo/config');
+  const expoDir = dirname(expoPackageJson);
+  // expo の下の node_modules（入れ子の別の expo）も、見つけた expo のものではない
+  const inside = relative(realpathSync(expoDir), realpathSync(resolved));
+  if (inside.startsWith('..') || inside.split(sep).includes('node_modules')) {
+    throw new Error(
+      `${displayPath(cwd, expoDir)} does not provide expo/config`
+    );
+  }
+  return require(resolved);
+};
+
+/** `expo/config` の getConfig で評価する。失敗は Error を投げる */
+const evaluate = (cwd: string, expoPackageJson: string): ExpoConfig => {
+  const result = withStdoutToStderr(() => {
+    const mod = loadExpoConfig(cwd, expoPackageJson);
+    const getConfig = isObject(mod) ? mod.getConfig : undefined;
+    if (typeof getConfig !== 'function') {
+      throw new Error('expo/config does not export getConfig');
+    }
+    return getConfig(cwd, { skipSDKVersionRequirement: true }) as unknown;
+  });
+  if (!isObject(result) || !isObject(result.exp)) {
+    throw new Error('getConfig did not return { exp }');
+  }
+  const values = valuesOf(result.exp, configFileOf(cwd, result));
+  return { ...values, version: writtenVersion(result, values.version) };
+};
+
+/** app.json を JSON として読む（`expo` キーがあればその下、無ければ直下）。無い・壊れていれば null と注意 */
+const readAppJson = (
+  cwd: string
+): { config: ExpoConfig | null; note?: string } => {
+  const path = join(cwd, 'app.json');
+  if (!isFile(path)) {
+    return { config: null, note: 'there is no app.json' };
+  }
+  let json: unknown;
+  try {
+    json = JSON.parse(readText(path) ?? '');
+  } catch (error) {
+    return {
+      config: null,
+      note: `could not parse app.json: ${errorMessage(error)}`,
+    };
+  }
+  if (!isObject(json)) {
+    return { config: null, note: 'app.json is not a JSON object' };
+  }
+  return {
+    config: valuesOf(isObject(json.expo) ? json.expo : json, 'app.json'),
+  };
+};
+
+/**
+ * `<cwd>` から `expo` が見つからなければ null（Expo のアプリでない）。見つかれば getConfig で設定を評価し、
+ * 失敗したら理由を notes に入れて app.json の素読みに戻る
+ */
+export const readExpoProject = (cwd: string): ExpoProject | null => {
+  const expoPackageJson = findPackageJson(cwd, 'expo');
+  if (expoPackageJson === null) {
+    return null;
+  }
+  try {
+    return { config: evaluate(cwd, expoPackageJson), notes: [] };
+  } catch (error) {
+    const fallback = readAppJson(cwd);
+    return {
+      config: fallback.config,
+      notes: [
+        `could not evaluate the Expo config with expo/config (${errorMessage(error, cwd)}); read app.json directly instead`,
+        ...(fallback.note === undefined ? [] : [fallback.note]),
+      ],
+    };
+  }
+};

package/src/cli/project/files.ts

@@ -0,0 +1,56 @@
+// アプリのファイルを読むときの共通部分。読めないファイル・ディレクトリは例外にせず「無い」として扱う
+// （チェックの材料が無いだけで、CLI 全体は落とさない）
+import { readFileSync, statSync } from 'node:fs';
+import { relative, sep } from 'node:path';
+
+export const isFile = (path: string): boolean => {
+  try {
+    return statSync(path).isFile();
+  } catch {
+    return false;
+  }
+};
+
+export const isDirectory = (path: string): boolean => {
+  try {
+    return statSync(path).isDirectory();
+  } catch {
+    return false;
+  }
+};
+
+/** UTF-8 のテキストとして読む。無い・読めなければ null */
+export const readText = (path: string): string | null => {
+  try {
+    return readFileSync(path, 'utf8');
+  } catch {
+    return null;
+  }
+};
+
+/**
+ * メッセージに出すパス（`<cwd>` からの相対。区切りは `/`）。`<cwd>` の外なら絶対パスのまま。
+ * どのファイルの値かを、CI のログでもリポジトリの中の場所として読めるようにする
+ */
+export const displayPath = (cwd: string, path: string): string => {
+  const rel = relative(cwd, path);
+  if (rel === '' || rel.startsWith('..')) {
+    return path;
+  }
+  return rel.split(sep).join('/');
+};
+
+/** 値が `$(…)` / `${…}` のようにほかの設定を参照しているか（ビルド時にしか決まらないので「特定できない」にする） */
+export const hasVariable = (value: string): boolean => /\$[({]/.test(value);
+
+/** 1 つのファイルから読んだ値（{@link Lookup} の見つかった側） */
+export type Found = {
+  value: string;
+  /** 値の名前（`PRODUCT_BUNDLE_IDENTIFIER` / `versionName` など） */
+  label: string;
+  /** 値を読んだファイル（{@link displayPath}） */
+  file: string;
+};
+
+/** ネイティブのファイルから値を探した結果。見つからなければ、その理由（メッセージにそのまま入る英文） */
+export type Lookup = Found | { value: null; reason: string };