feat(fsapp): add fsapp plugin #2784

crherman7 · 2024-12-23T16:16:43Z

Describe your changes

Created a new @brandingbrand/code-plugin-fsapp package that handles FSApp environment configuration and native module setup. This plugin extracts FSApp-specific functionality from the core CLI into a dedicated plugin, improving modularity and maintainability.

Key changes:

Created new plugin package with iOS/Android native module setup
Moved FSApp-related transformers and assets to new package
Added documentation for plugin usage and configuration
Updated environment handling and validation logic
Removed FSApp-specific code from core CLI package

Issue ticket number and link

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Test Plan

Run comprehensive unit tests for:
- Environment file validation
- Package name validation
- Path resolution
- iOS/Android platform-specific transformations
Test package installation and configuration:

yarn add --dev @brandingbrand/code-plugin-fsapp

Verify plugin functionality:

yarn flagship-code prebuild --build internal --env development

Ensure environment switching and native modules are properly configured for both iOS and Android platforms.

Checklist before requesting a review

A self-review of my code has been completed
Tests have been added / updated if required
Documentation has been updated to reflect these changes

crherman7 · 2024-12-30T18:31:29Z

requires .flagshipcoderc.json
no longer needs envPath in flagship-code.config.ts

We should utilize glob to find all files that match env.<env_name>.ts and then use babel to traverse and verify single default export with the correct import of defineEnv.

glob(<root_dir>/**/env.*.ts) -> babel.traverse -> verify exports/imports -> bundleRequire -> write envs

crherman7

One thing to notice is that dynamic args is reading from anywhere in node_modules which fails us in a monorepo. We actually should only look at the dependencies and devDependencies installed

crherman7 · 2025-01-02T18:51:06Z

One thing to notice is that dynamic args is reading from anywhere in node_modules which fails us in a monorepo. We actually should only look at the dependencies and devDependencies installed

fixed in latest

crherman7 · 2025-01-02T19:24:48Z

packages/cli-kit/src/lib/FlagshipCodeLogger.ts

-      if ((message as any) instanceof Error) {
-        const errorStackArr = (message as any).stack.split(
-          '\n',
-        ) as unknown as Array<string>;
-
-        errorStackArr.shift();
-
-        FlagshipCodeManager.shared.emit(
-          'onLog',
-          chalk.dim('\n' + errorStackArr.join('\n')),
-        );
-      }


this needs to be looked into further

there is no great way to split the stack from the error message, so we may just want to display the stack instead since it includes both - the stack can be useful.

packages/cli-kit/src/lib/FlagshipCodeManager.ts

apps/docs/src/content/docs/packages/plugin-fsapp.mdx

crherman7 · 2025-01-02T21:31:45Z

packages/plugin-fsapp/src/index.ts

+
+async function validateEnvFiles(baseDir: string): Promise<string[]> {
+  const pattern = path.join(baseDir, '**', 'env.*.ts');
+  const files = glob.sync(pattern, {ignore: '**/node_modules/**'});


We can collect files here but how can we guarantee that these are intended to be env files...we shouldn't just throw an error due to it being named in a particular way but not conforming to a format. this could be a different file used for something else. something to think about

crherman7 · 2025-01-02T21:48:56Z

packages/plugin-fsapp/src/index.ts

+          },
+        });
+
+        if (!hasDefaultExport) {


we should likely only throw an error here if the import does not exist that way we know it's supposed to be a runtime env

NickBurkhartBB

looks good to me, just some minor nitpicks or questions

apps/docs/src/content/docs/packages/plugin-fsapp.mdx

packages/cli-kit/src/lib/FlagshipCodeManager.ts

packages/cli/src/actions/dependencies.ts

packages/cli/src/transformers/transformers-0.72/ios/project-pbxproj.ts

packages/cli/src/transformers/transformers-0.73/ios/project-pbxproj.ts

NickBurkhartBB · 2025-01-03T17:07:42Z

packages/plugin-fsapp/src/index.ts

@@ -0,0 +1,464 @@
+/// <reference types="@brandingbrand/code-cli-kit/types" />


this file is fairly large, wonder if we should break up

this is probably another thing we can do as well, it will minimally help with readability and testing without exporting those functions through the main plugin.

NickBurkhartBB · 2025-01-03T17:08:45Z

packages/plugin-fsapp/src/index.ts

+        }
+
+        if (!hasDefineEnvImport) {
+          throw new Error(


I feel like this one might be more of a warning, I believe it will still work if they don't use defineEnv

yeah I was thinking we need to not necessarily throw an error for certain things but we need a way to know it's an env file

NickBurkhartBB · 2025-01-03T17:14:24Z

packages/plugin-fsapp/src/index.ts

+    options: PrebuildOptions,
+  ): Promise<void> {
+    logger.log('Processing environment files for Android...');
+    await processAndLinkEnvs(options as any);


seems like we need to repeat this step in both android and iOS cause we don't know if one or both are running. I wonder if we need to build in another way to run these type of things, though this may be a unique case.

yeah we will add a "universal" or something like that that will run once that has no relation to a particular platform when we move to presets and plugins

NickBurkhartBB · 2025-01-03T17:29:01Z

packages/plugin-fsapp/src/index.ts

+ * @returns {Promise<void>} A promise that resolves when environment processing is complete.
+ */
+async function processAndLinkEnvs(
+  options: PrebuildOptions & Record<string, string>,


should this be PrebuildOptions & {env?: string}? so we don't have to cast the call sites to any?

So for now the call sites will still need to be casted because of the explicit nature of the definePlugin where the options are defined as explicitly the prebuild options....going to update the type to be non-breaking.

updated to allow this.

packages/plugin-fsapp/__tests__/platform.ts

crherman7 marked this pull request as draft December 23, 2024 16:16

crherman7 force-pushed the feat/fsapp_plugin branch from 5f917dd to 7011217 Compare December 23, 2024 16:52

crherman7 force-pushed the feat/fsapp_plugin branch 2 times, most recently from 9ae11dd to b93a263 Compare January 2, 2025 17:23

crherman7 commented Jan 2, 2025

View reviewed changes

packages/cli-kit/src/lib/FlagshipCodeManager.ts Outdated Show resolved Hide resolved

crherman7 commented Jan 2, 2025

View reviewed changes

apps/docs/src/content/docs/packages/plugin-fsapp.mdx Outdated Show resolved Hide resolved

crherman7 commented Jan 2, 2025

View reviewed changes

feat(fsapp): add fsapp plugin

aaadc71

crherman7 force-pushed the feat/fsapp_plugin branch from 6286a8b to aaadc71 Compare January 2, 2025 22:14

NickBurkhartBB reviewed Jan 3, 2025

View reviewed changes

feat(plugin): add unit tests

05888c3

crherman7 force-pushed the feat/fsapp_plugin branch from 3f63f1f to 05888c3 Compare January 8, 2025 09:09

crherman7 added 2 commits January 13, 2025 11:38

fix(plugin): prebuild typings

9ce4a12

feat(plugin): allow extended options type

c7c3ed3

crherman7 marked this pull request as ready for review January 13, 2025 16:55

crherman7 requested a review from NickBurkhartBB January 13, 2025 17:01

crherman7 commented Jan 13, 2025

View reviewed changes

feat(path): remove envSwitcher nativeConstants path

6d77450

crherman7 force-pushed the feat/fsapp_plugin branch from ba8706a to 6d77450 Compare January 13, 2025 17:43

fix(plugin): nativeconstants + envswitcher java only

f20d7bc

NickBurkhartBB approved these changes Jan 15, 2025

View reviewed changes

NickBurkhartBB merged commit 632e384 into brandingbrand:feature/app-router Jan 15, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(fsapp): add fsapp plugin #2784

feat(fsapp): add fsapp plugin #2784

crherman7 commented Dec 23, 2024 •

edited

Loading

crherman7 commented Dec 30, 2024 •

edited

Loading

crherman7 left a comment

crherman7 commented Jan 2, 2025

crherman7 Jan 2, 2025

crherman7 Jan 3, 2025

crherman7 Jan 2, 2025

crherman7 Jan 2, 2025

NickBurkhartBB left a comment

NickBurkhartBB Jan 3, 2025

crherman7 Jan 13, 2025

NickBurkhartBB Jan 3, 2025

crherman7 Jan 3, 2025

NickBurkhartBB Jan 3, 2025

crherman7 Jan 3, 2025

NickBurkhartBB Jan 3, 2025

crherman7 Jan 13, 2025

crherman7 Jan 13, 2025

		@@ -0,0 +1,464 @@
		/// <reference types="@brandingbrand/code-cli-kit/types" />

feat(fsapp): add fsapp plugin #2784

feat(fsapp): add fsapp plugin #2784

Conversation

crherman7 commented Dec 23, 2024 • edited Loading

Describe your changes

Issue ticket number and link

Type of change

Test Plan

Checklist before requesting a review

crherman7 commented Dec 30, 2024 • edited Loading

crherman7 left a comment

Choose a reason for hiding this comment

crherman7 commented Jan 2, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NickBurkhartBB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crherman7 commented Dec 23, 2024 •

edited

Loading

crherman7 commented Dec 30, 2024 •

edited

Loading