feat: add remote cache provider setup to the create-app command

.changeset/sixty-cases-fry.md

@@ -0,0 +1,5 @@
+---
+'create-rock': patch
+---
+
+feat: add remote cache provider setup

packages/config/src/lib/config.ts

@@ -172,6 +172,13 @@ export async function getConfig(
     getRemoteCacheProvider: async () => {
       // special case for github-actions
       if (validatedConfig.remoteCacheProvider === 'github-actions') {
+        logger.warnOnce('github-actions')(
+          `Using shorthand "github-actions" as "remoteCacheProvider" value in ${colorLink(
+            'rock.config.mjs',
+          )} is deprecated. It will be removed in future releases. 
+Please use "@rock-js/provider-github" plugin explicitly instead.
+Read more: ${colorLink('https://rockjs.dev/docs/configuration#github-actions-provider')}`,
+        );
         const { providerGitHub } = await import('@rock-js/provider-github');
         return providerGitHub();
       }

packages/create-app/src/lib/__tests__/bin.test.ts

@@ -15,7 +15,6 @@ test('should format config without plugins', () => {
           ios: platformIOS(),
           android: platformAndroid(),
         },
-        remoteCacheProvider: null,
       };
       "
     `);
@@ -33,7 +32,7 @@ test('should format config with plugins', () => {
     },
   ];
 
-  expect(formatConfig([PLATFORMS[0]], plugins, BUNDLERS[1], 'github-actions'))
+  expect(formatConfig([PLATFORMS[0]], plugins, BUNDLERS[1], null))
     .toMatchInlineSnapshot(`
       "import { platformIOS } from '@rock-js/platform-ios';
       import { pluginTest } from '@rock-js/plugin-test';
@@ -47,7 +46,86 @@ test('should format config with plugins', () => {
         platforms: {
           ios: platformIOS(),
         },
-        remoteCacheProvider: 'github-actions',
+      };
+      "
+    `);
+});
+
+test(`should format config with the 'github-actions' provider`, () => {
+  expect(
+    formatConfig([PLATFORMS[0]], null, BUNDLERS[1], {
+      name: 'github-actions',
+      args: { owner: 'custom-owner', repository: 'repository-name' },
+    }),
+  ).toMatchInlineSnapshot(`
+      "import { platformIOS } from '@rock-js/platform-ios';
+      import { pluginRepack } from '@rock-js/plugin-repack';
+      import { providerGitHub } from '@rock-js/provider-github';
+
+      export default {
+        bundler: pluginRepack(),
+        platforms: {
+          ios: platformIOS(),
+        },
+        remoteCacheProvider: providerGitHub({
+          owner: 'custom-owner',
+          repository: 'repository-name',
+        }),
+      };
+      "
+    `);
+});
+
+test(`should format config with the 's3' provider`, () => {
+  expect(
+    formatConfig([PLATFORMS[0]], null, BUNDLERS[1], {
+      name: 's3',
+      args: { bucket: 'custom-bucket', region: 'us-east-1' },
+    }),
+  ).toMatchInlineSnapshot(`
+      "import { platformIOS } from '@rock-js/platform-ios';
+      import { pluginRepack } from '@rock-js/plugin-repack';
+      import { providerS3 } from '@rock-js/provider-s3';
+
+      export default {
+        bundler: pluginRepack(),
+        platforms: {
+          ios: platformIOS(),
+        },
+        remoteCacheProvider: providerS3({
+          bucket: 'custom-bucket',
+          region: 'us-east-1',
+        }),
+      };
+      "
+    `);
+});
+
+test(`should format config with the 's3' provider using a custom endpoint`, () => {
+  expect(
+    formatConfig([PLATFORMS[0]], null, BUNDLERS[1], {
+      name: 's3',
+      args: {
+        bucket: 'custom-bucket',
+        region: 'us-east-1',
+        endpoint: 'https://custom-endpoint.com',
+      },
+    }),
+  ).toMatchInlineSnapshot(`
+      "import { platformIOS } from '@rock-js/platform-ios';
+      import { pluginRepack } from '@rock-js/plugin-repack';
+      import { providerS3 } from '@rock-js/provider-s3';
+
+      export default {
+        bundler: pluginRepack(),
+        platforms: {
+          ios: platformIOS(),
+        },
+        remoteCacheProvider: providerS3({
+          bucket: 'custom-bucket',
+          region: 'us-east-1',
+          endpoint: 'https://custom-endpoint.com',
+        }),
       };
       "
     `);

packages/create-app/src/lib/bin.ts

@@ -16,6 +16,8 @@ import {
   BUNDLERS,
   PLATFORMS,
   PLUGINS,
+  remoteCacheProviderToConfigTemplate,
+  remoteCacheProviderToImportTemplate,
   resolveTemplate,
   TEMPLATES,
 } from './templates.js';
@@ -46,6 +48,7 @@ import {
   promptPlugins,
   promptProjectName,
   promptRemoteCacheProvider,
+  promptRemoteCacheProviderArgs,
   promptTemplate,
 } from './utils/prompts.js';
 import {
@@ -146,6 +149,10 @@ export async function run() {
       ? null
       : await promptRemoteCacheProvider();
 
+  const remoteCacheProviderArgs = remoteCacheProvider
+    ? await promptRemoteCacheProviderArgs(remoteCacheProvider)
+    : null;
+
   const shouldInstallDependencies =
     options.install || isInteractive()
       ? await promptInstallDependencies()
@@ -172,7 +179,12 @@ export async function run() {
     platforms,
     plugins,
     bundler,
-    remoteCacheProvider,
+    remoteCacheProvider && remoteCacheProviderArgs
+      ? {
+          name: remoteCacheProvider,
+          args: remoteCacheProviderArgs,
+        }
+      : null,
   );
   loader.stop('Applied template, platforms and plugins.');
 
@@ -296,7 +308,10 @@ function createConfig(
   platforms: TemplateInfo[],
   plugins: TemplateInfo[] | null,
   bundler: TemplateInfo,
-  remoteCacheProvider: SupportedRemoteCacheProviders | null,
+  remoteCacheProvider: {
+    name: SupportedRemoteCacheProviders;
+    args: Record<string, string>;
+  } | null,
 ) {
   const rockConfig = path.join(absoluteTargetDir, 'rock.config.mjs');
   fs.writeFileSync(
@@ -309,40 +324,54 @@ export function formatConfig(
   platforms: TemplateInfo[],
   plugins: TemplateInfo[] | null,
   bundler: TemplateInfo,
-  remoteCacheProvider: SupportedRemoteCacheProviders | null,
+  remoteCacheProvider: {
+    name: SupportedRemoteCacheProviders;
+    args: Record<string, string>;
+  } | null,
 ) {
   const platformsWithImports = platforms.filter(
     (template) => template.importName,
   );
   const pluginsWithImports = plugins
     ? plugins.filter((template) => template.importName)
     : null;
-  return `${[...platformsWithImports, ...(pluginsWithImports ?? []), bundler]
-    .map(
+
+  return `${[
+    ...[...platformsWithImports, ...(pluginsWithImports ?? []), bundler].map(
       (template) =>
         `import { ${template.importName} } from '${template.packageName}';`,
-    )
+    ),
+    remoteCacheProvider?.name
+      ? remoteCacheProviderToImportTemplate(remoteCacheProvider.name)
+      : '',
+  ]
+    .filter(Boolean)
     .join('\n')}
 
-export default {${
+export default {
+  ${[
     pluginsWithImports && pluginsWithImports.length > 0
-      ? `
-  plugins: [
+      ? `plugins: [
     ${pluginsWithImports
       .map((template) => `${template.importName}(),`)
       .join('\n    ')}
   ],`
-      : ''
-  }
-  bundler: ${bundler.importName}(),
-  platforms: {
+      : '',
+    `bundler: ${bundler.importName}(),`,
+    `platforms: {
     ${platformsWithImports
       .map((template) => `${template.name}: ${template.importName}(),`)
       .join('\n    ')}
-  },
-  remoteCacheProvider: ${
-    remoteCacheProvider === null ? null : `'${remoteCacheProvider}'`
-  },
+  },`,
+    remoteCacheProvider?.name
+      ? remoteCacheProviderToConfigTemplate(
+          remoteCacheProvider.name,
+          remoteCacheProvider.args,
+        )
+      : '',
+  ]
+    .filter(Boolean)
+    .join('\n  ')}
 };
 `;
 }

packages/create-app/src/lib/templates.ts

@@ -1,5 +1,8 @@
 import * as path from 'node:path';
-import { resolveAbsolutePath } from '@rock-js/tools';
+import {
+  resolveAbsolutePath,
+  type SupportedRemoteCacheProviders,
+} from '@rock-js/tools';
 
 export type TemplateInfo = NpmTemplateInfo | LocalTemplateInfo;
 
@@ -93,6 +96,58 @@ export const PLATFORMS: TemplateInfo[] = [
   },
 ];
 
+export function remoteCacheProviderToImportTemplate(
+  provider: SupportedRemoteCacheProviders,
+) {
+  switch (provider) {
+    case 'github-actions':
+      return `import { providerGitHub } from '@rock-js/provider-github';`;
+    case 's3':
+      return `import { providerS3 } from '@rock-js/provider-s3';`;
+  }
+}
+
+export function remoteCacheProviderToConfigTemplate(
+  provider: SupportedRemoteCacheProviders,
+  args: Record<string, string>,
+) {
+  switch (provider) {
+    case 'github-actions':
+      return template([
+        'remoteCacheProvider: providerGitHub({',
+        `  owner: '${args['owner']}',`,
+        `  repository: '${args['repository']}',`,
+        '}),',
+      ]);
+    case 's3':
+      return template([
+        'remoteCacheProvider: providerS3({',
+        `  bucket: '${args['bucket']}',`,
+        `  region: '${args['region']}',`,
+        [`  endpoint: '${args['endpoint']}',`, Boolean(args['endpoint'])],
+        '}),',
+      ]);
+  }
+}
+
+export function template(lines: Array<string | [string, boolean]>) {
+  return lines
+    .filter((line) => {
+      // If it's a [content, condition] pair, check the condition
+      if (Array.isArray(line)) {
+        return Boolean(line[1]);
+      }
+      // If it's just a string, always include it
+      return true;
+    })
+    .map((line) => {
+      // Extract content from [content, condition] pair or use string directly
+      const content = Array.isArray(line) ? line[0] : line;
+      return content;
+    })
+    .join('\n  ');
+}
+
 export function resolveTemplate(
   templates: TemplateInfo[],
   name: string,