feat: extract @rnef/provider-github package (#343)

* feat: extract @rnef/provider-github package

* changeset

* cleanup package.json

* move resolving github-actions provider to config

* remove unnecessary abstraction

Author: thymikee

.changeset/curly-deers-try.md

@@ -0,0 +1,6 @@
+---
+'@rnef/provider-github': patch
+'@rnef/tools': patch
+---
+
+feat: extract @rnef/provider-github package

packages/cli/src/lib/plugins/remoteCache.ts

@@ -1,10 +1,6 @@
 import type { PluginApi, PluginOutput } from '@rnef/config';
-import type {
-  RemoteBuildCache,
-  SupportedRemoteCacheProviders,
-} from '@rnef/tools';
+import type { RemoteBuildCache } from '@rnef/tools';
 import {
-  createRemoteBuildCache,
   formatArtifactName,
   getLocalArtifactPath,
   getLocalBinaryPath,
@@ -31,18 +27,15 @@ async function remoteCache({
 }: {
   action: string;
   args: Flags;
-  remoteCacheProvider:
-    | SupportedRemoteCacheProviders
-    | null
-    | { (): RemoteBuildCache };
+  remoteCacheProvider: null | (() => RemoteBuildCache);
   projectRoot: string;
   fingerprintOptions: { extraSources: string[]; ignorePaths: string[] };
 }) {
   const isJsonOutput = args.json;
-  const remoteBuildCache = await createRemoteBuildCache(remoteCacheProvider);
-  if (!remoteBuildCache) {
+  if (!remoteCacheProvider) {
     return null;
   }
+  const remoteBuildCache = remoteCacheProvider();
 
   validateArgs(args, action);
 
@@ -195,7 +188,7 @@ export const remoteCachePlugin =
         await remoteCache({
           action,
           args,
-          remoteCacheProvider: api.getRemoteCacheProvider() || null,
+          remoteCacheProvider: (await api.getRemoteCacheProvider()) || null,
           projectRoot: api.getProjectRoot(),
           fingerprintOptions: api.getFingerprintOptions(),
         });

packages/config/src/lib/config.ts

@@ -1,6 +1,7 @@
 import * as fs from 'node:fs';
 import { createRequire } from 'node:module';
 import * as path from 'node:path';
+import type { RemoteBuildCache } from '@rnef/tools';
 import { color, logger } from '@rnef/tools';
 import type { ValidationError } from 'joi';
 import { ConfigTypeSchema } from './schema.js';
@@ -21,15 +22,15 @@ export type PluginApi = {
   getReactNativeVersion: () => string;
   getReactNativePath: () => string;
   getPlatforms: () => { [platform: string]: object };
-  getRemoteCacheProvider: () => SupportedRemoteCacheProviders | undefined;
+  getRemoteCacheProvider: () => Promise<
+    null | undefined | (() => RemoteBuildCache)
+  >;
   getFingerprintOptions: () => {
     extraSources: string[];
     ignorePaths: string[];
   };
 };
 
-type SupportedRemoteCacheProviders = 'github-actions';
-
 type PluginType = (args: PluginApi) => PluginOutput;
 
 type PlatformType = (args: PluginApi) => PlatformOutput;
@@ -68,7 +69,7 @@ export type ConfigType = {
   plugins?: PluginType[];
   platforms?: Record<string, PlatformType>;
   commands?: Array<CommandType>;
-  remoteCacheProvider?: SupportedRemoteCacheProviders;
+  remoteCacheProvider?: null | 'github-actions' |(() => RemoteBuildCache);
   fingerprint?: {
     extraSources?: string[];
     ignorePaths?: string[];
@@ -167,7 +168,15 @@ export async function getConfig(
     getReactNativePath: () => resolveReactNativePath(projectRoot),
     getPlatforms: () =>
       validatedConfig.platforms as { [platform: string]: object },
-    getRemoteCacheProvider: () => validatedConfig.remoteCacheProvider,
+    getRemoteCacheProvider: async () => {
+      // special case for github-actions
+      if (validatedConfig.remoteCacheProvider === 'github-actions') {
+        // @ts-expect-error @rnef/provider-github may not be installed
+        const { providerGitHub } = await import('@rnef/provider-github');
+        return providerGitHub();
+      }
+      return validatedConfig.remoteCacheProvider;
+    },
     getFingerprintOptions: () =>
       validatedConfig.fingerprint as {
         extraSources: string[];

packages/create-app/src/lib/utils/parse-cli-options.ts

@@ -1,4 +1,3 @@
-import type { SupportedRemoteCacheProviders } from '@rnef/tools';
 import minimist from 'minimist';
 
 export type CliOptions = {
@@ -11,7 +10,7 @@ export type CliOptions = {
   version: boolean;
   dir?: string;
   override: boolean;
-  remoteCacheProvider?: SupportedRemoteCacheProviders | undefined | false;
+  remoteCacheProvider?: string | undefined | false;
   install: boolean;
 };
 
@@ -45,10 +44,7 @@ export function parseCliOptions(argv: string[]): CliOptions {
     version: options.version,
     dir: ensureOptionalString(options.dir),
     override: options.override,
-    remoteCacheProvider: options['remote-cache-provider'] as
-      | SupportedRemoteCacheProviders
-      | undefined
-      | false,
+    remoteCacheProvider: options['remote-cache-provider'] as undefined | false,
     install: options.install,
   };
 }

packages/platform-android/src/lib/commands/runAndroid/command.ts

@@ -19,7 +19,7 @@ export function registerRunCommand(
         androidConfig,
         args as Flags,
         projectRoot,
-        api.getRemoteCacheProvider(),
+        await api.getRemoteCacheProvider(),
         api.getFingerprintOptions()
       );
     },

packages/platform-android/src/lib/commands/runAndroid/runAndroid.ts

@@ -4,7 +4,7 @@ import type {
   AndroidProjectConfig,
   Config,
 } from '@react-native-community/cli-types';
-import type { SupportedRemoteCacheProviders } from '@rnef/tools';
+import type { RemoteBuildCache } from '@rnef/tools';
 import {
   fetchCachedBuild,
   formatArtifactName,
@@ -46,7 +46,7 @@ export async function runAndroid(
   androidProject: AndroidProjectConfig,
   args: Flags,
   projectRoot: string,
-  remoteCacheProvider: SupportedRemoteCacheProviders | undefined,
+  remoteCacheProvider: null | (() => RemoteBuildCache) | undefined,
   fingerprintOptions: { extraSources: string[]; ignorePaths: string[] }
 ) {
   intro('Running Android app');

packages/platform-apple-helpers/src/lib/commands/run/createRun.ts

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import type { SupportedRemoteCacheProviders } from '@rnef/tools';
+import type { RemoteBuildCache } from '@rnef/tools';
 import {
   color,
   fetchCachedBuild,
@@ -44,7 +44,7 @@ export const createRun = async ({
   projectConfig: ProjectConfig;
   args: RunFlags;
   projectRoot: string;
-  remoteCacheProvider: SupportedRemoteCacheProviders | undefined;
+  remoteCacheProvider: null | (() => RemoteBuildCache) | undefined;
   fingerprintOptions: { extraSources: string[]; ignorePaths: string[] };
   reactNativePath: string;
 }) => {

packages/platform-ios/src/lib/platformIOS.ts

@@ -56,7 +56,7 @@ export const platformIOS =
           projectConfig: iosConfig,
           args: args as RunFlags,
           projectRoot,
-          remoteCacheProvider: api.getRemoteCacheProvider(),
+          remoteCacheProvider: await api.getRemoteCacheProvider(),
           fingerprintOptions: api.getFingerprintOptions(),
           reactNativePath: api.getReactNativePath(),
         });

packages/provider-github/README.md

@@ -0,0 +1,7 @@
+# @rnef/provider-github
+
+GitHub Actions artifact storage provider for React Native Enterprise Framework (RNEF). This package is part of the RNEF ecosystem.
+
+## Documentation
+
+For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.dev)

packages/provider-github/eslint.config.js

@@ -0,0 +1,3 @@
+import baseConfig from '../../eslint.config.js';
+
+export default baseConfig;