feat(v13): Flagship Code v13 #138

crherman7 · 2024-03-15T19:11:14Z

Describe your changes

Issue ticket number and link

Type of change

Please delete options that are not relevant.

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

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

…lugin-fastlane chore: add README for code-plugin-fastlane package

…lugin-fbsdk-next chore: add README for code-plugin-fbsdk-next package

…-firebase-analytics chore: add README for code-plugin-firebase-analytics package

…-firebase-app chore: add README for code-plugin-firebase-app package

…d#2613) minimal README with link to documentation site update package json fields Co-authored-by: Jason Mosley <[email protected]>

minimal README with link to documentation site update package json fields Co-authored-by: Jason Mosley <[email protected]>

…brand#2615) minimal README with link to documentation site update package json fields

…d#2616) minimal README with link to documentation site update package json fields

…gbrand#2617) minimal README with link to documentation site update package json fields

…rand#2618) minimal README with link to documentation site update package json fields

…2619) minimal README with link to documentation site update package json fields

…e_0.71.11 feat(code): react-native v0.71.11

feat(code-core): ENG-3750 - Android API 33, Gradle plugin version ENV var

…up-docs chore: bump all package versions and setup docs to release

…egate fix(leanplum): unnotification delegate + launchOptions

…s-deploy chore: move doc deploy to target main branch

…ase_dir fix(core): android template release directory

…-leanplum/1_0_1 docs(leanplum): 1.0.1 version changelog and docs

NickBurkhartBB · 2024-03-19T13:04:22Z

apps/docs/src/content/docs/guides/migration.mdx

+
+In this update, all Flagship Code dependencies have undergone a major version upgrade, accompanied by notable deprecations. Particularly, the package `@brandingbrand/code-core` has been deprecated in favor of `@brandingbrand/code-cli-kit`. This change stems from the recognition that the former package name lacked clarity regarding its intended use-case. We believe that `code-cli-kit` better communicates that this package serves as a developer toolkit to support the CLI package.
+
+Furthermore, several plugins have been deprecated due to their inability to undergo open-source testing. Some of these plugins necessitated third-party accounts, posing a risk of exposing Branding Brand's accounts to public developers. These deprecated plugins, including `@brandingbrand/code-plugin-fbsdk-next`, `@brandingbrand/code-plugin-firebase-analytics`, `@brandingbrand/code-plugin-firebase-app`, `@brandingbrand/code-plugin-google-signin`, and `@brandingbrand/code-plugin-leanplum`, will need to be re-implemented in the new plugin format, following the guidelines outlined in the [plugin guide](/guides/plugins). While we understand that this may be frustrating for developers, we firmly believe that this approach is necessary to ensure the quality and supportability of our plugins.


@crherman7 @jasonmosley I think we may need discuss these removal of plugins and current usage. My personal thought is we may need to keep them for this version and then build out a true deprecation path rather then just removing from this version.

@NickBurkhartBB @crherman7 I agree. We should mark them as deprecated but recreate them for this version. We could even have part of the migration plan move these into the projects as local plugins. Since the old plugins are not compatible with this version, we can't leave existing clients hanging.

NickBurkhartBB · 2024-03-19T13:05:15Z

.github/workflows/deploy-docs.yml

@@ -1,62 +0,0 @@
-# Workflow for building and deploying Flagship Code™ Docs to GitHub Pages


@crherman7 I think we need to keep our workflows for deploy docs and running test for PRs

NickBurkhartBB

running yarn prebuild -b internal.blah -e prod in example app doesn't stop at config due to missing build config, but continues to run and you end up seeing undefined error in template instead of invalid build config error.

NickBurkhartBB · 2024-03-19T20:40:22Z

packages/cli/src/index.ts

+ * @type {Object}
+ */
+program
+  .name("@brandingbrand/code-cli")


flagship-code instead of package name

NickBurkhartBB · 2024-03-19T20:47:51Z

packages/cli/src/lib/guards.ts

+  action: () => Promise<void | string>,
+  name: string
+) {
+  return withAction(action, name);


this function doesn't seem to add anything above withAction, can we remove?

yeah probably can remove it

NickBurkhartBB · 2024-03-19T20:48:43Z

packages/cli/src/lib/guards.ts

+ * console.log(transformedContent);
+ * ```
+ */
+export function defineTransformer<T>(transformer: Transformer<T>) {


this function just returns the transformer without any additional logic, is it even needed?

yes it type guards entry point

NickBurkhartBB · 2024-03-19T20:59:01Z

packages/cli/src/lib/errors.ts

+ * console.log(result); // Output: true
+ * ```
+ */
+export function isWarning(error: Error | unknown | any): boolean {


the union type is unnecessary as once any is involved the type is just any, so you can just remove Error | unknown as it seems it wants to work with any.

NickBurkhartBB · 2024-03-19T21:12:19Z

packages/cli/src/transformers/android/android-manifest-xml.ts

+  /**
+   * Specifies the file to be transformed, which is AndroidManifest.xml in this case.
+   */
+  file: "AndroidManifest.xml",


this value doesn't seem to matter, it doesn't actually affect what file is transformed cause that is handled in the transform function, it feels like a name instead of file, but I couldn't find the usage to determine if we need it

we can remove it, but it's for future usage potentially

NickBurkhartBB · 2024-03-21T14:08:46Z

packages/plugin-splash-screen/src/legacy.ts

+export async function ios(config: BuildConfig & CodePluginSplashScreen) {
+  // Extract xcassetsDir and xcassetsFile from the iOS legacy splash screen configuration
+  const { xcassetsDir, xcassetsFile, storyboardFile } =
+    // @ts-ignore


remove ts-ignore and handle typescript error

NickBurkhartBB · 2024-03-21T14:09:18Z

packages/plugin-splash-screen/src/legacy.ts

+ */
+export async function android(config: BuildConfig & CodePluginSplashScreen) {
+  // Extract assetsDir from the Android legacy splash screen configuration
+  // @ts-ignore


remove ts-ignore and handle typescript error

NickBurkhartBB · 2024-03-22T13:19:09Z

packages/cli/src/lib/config.ts

+    if (!/^[a-z0-9-~][a-z0-9-._~]*$/gm.test(data.name)) {
+      // Throw an error if the name does not match the specified format
+      throw Error(
+        "[GenerateCliCommandError]: name must follow non-scoped package names format"


why can't we use scoped package name? I can modify the package after generation to scope and it seems to work

it uses the package name as the name of the directory - this will be a problem. they shouldn't be scoped anyway because they aren't being published anywhere. imo it's much easier to block this at the top level then sanitizing the name for dual purposes of linking vs naming.

NickBurkhartBB · 2024-03-22T13:23:27Z

apps/example/flagship-code.config.ts

+    '@brandingbrand/code-plugin-asset',
+    '@brandingbrand/code-plugin-app-icon',
+    '@brandingbrand/code-plugin-permissions',
+    '@brandingbrand/code-plugin-splash-screen',


missing example local plugin

NickBurkhartBB · 2024-03-22T13:25:11Z

packages/cli/template/plugin/__tests__/index.ts

+
+import plugin from "../src";
+
+describe("plugin", () => {


using generated plugin in example gives prettier rule warning Strings must use single quote, we should probably switch to single quotes here to match rule

we will have to revisit prettier rules to sync them as they likely clash then

after looking into it - we will need to add the prettier config at the root of the repo so vs code can sync those settings appropriately with format command. we may want to do this is subsequent commit after merge since it affects most files.

crherman7 · 2024-03-27T19:39:31Z

running yarn prebuild -b internal.blah -e prod in example app doesn't stop at config due to missing build config, but continues to run and you end up seeing undefined error in template instead of invalid build config error.

updated.

NickBurkhartBB · 2024-03-28T14:54:46Z

looks good, let's rebase this to only have history of the rewrite and get it up on the brandingbrand repo

jasonmosley and others added 30 commits June 15, 2023 14:53

Merge pull request brandingbrand#2608 from NickBurkhartBB/docs/code-p…

2a86b3c

…lugin-fastlane chore: add README for code-plugin-fastlane package

Merge branch 'develop' into docs/code-plugin-fbsdk-next

715174b

Merge pull request brandingbrand#2609 from NickBurkhartBB/docs/code-p…

fe4efc7

…lugin-fbsdk-next chore: add README for code-plugin-fbsdk-next package

Merge branch 'develop' into docs/plugin-firebase-analytics

f841d63

Merge pull request brandingbrand#2611 from NickBurkhartBB/docs/plugin…

37dfbfd

…-firebase-analytics chore: add README for code-plugin-firebase-analytics package

Merge branch 'develop' into docs/plugin-firebase-app

4e41535

Merge pull request brandingbrand#2612 from NickBurkhartBB/docs/plugin…

7aaaee1

…-firebase-app chore: add README for code-plugin-firebase-app package

feat(code): react-native v0.71.11

87daf3b

feat(code): format + android allprojects obj

92cc4f0

chore: add README for code-plugin-google-signin package (brandingbran…

5f20515

…d#2613) minimal README with link to documentation site update package json fields Co-authored-by: Jason Mosley <[email protected]>

chore: add README for code-plugin-leanplum package (brandingbrand#2614)

07be004

minimal README with link to documentation site update package json fields Co-authored-by: Jason Mosley <[email protected]>

chore: add README for code-plugin-native-navigation package (branding…

5b612ad

…brand#2615) minimal README with link to documentation site update package json fields

chore: add README for code-plugin-splash-screen package (brandingbran…

be91b6d

…d#2616) minimal README with link to documentation site update package json fields

chore: add README for code-plugin-target-application package (brandin…

124c0a4

…gbrand#2617) minimal README with link to documentation site update package json fields

chore: add README for code-plugin-target-extension package (brandingb…

19dc978

…rand#2618) minimal README with link to documentation site update package json fields

chore: add README for code-plugin-permissions package (brandingbrand#…

1cc2af8

…2619) minimal README with link to documentation site update package json fields

Merge pull request brandingbrand#2620 from crherman7/feat/react-nativ…

25e2a9d

…e_0.71.11 feat(code): react-native v0.71.11

Merge branch 'develop' into feat/ENG-3750

b0b7feb

Merge pull request brandingbrand#2610 from UncleClapton/feat/ENG-3750

c874a4d

feat(code-core): ENG-3750 - Android API 33, Gradle plugin version ENV var

chore: bump all package versions and setup docs to release

cfa08d9

Merge pull request brandingbrand#2621 from NickBurkhartBB/release/set…

1db0599

…up-docs chore: bump all package versions and setup docs to release

fix(leanplum): unnotification delegate + launchOptions

a569bc4

feat(leanplum): unit test template

e7ee512

Merge pull request brandingbrand#2627 from crherman7/fix/leanplum_del…

998377b

…egate fix(leanplum): unnotification delegate + launchOptions

docs(leanplum): 1.0.1 version changelog and docs

cbdeade

chore: move doc deploy to target main branch

4af9880

feat(core): android template release directory

9424fea

Merge pull request brandingbrand#2628 from NickBurkhartBB/actions/doc…

d856a83

…s-deploy chore: move doc deploy to target main branch

Merge pull request brandingbrand#2630 from crherman7/fix/android_rele…

857928e

…ase_dir fix(core): android template release directory

Merge pull request brandingbrand#2629 from NickBurkhartBB/docs/plugin…

61fa18b

…-leanplum/1_0_1 docs(leanplum): 1.0.1 version changelog and docs

crherman7 added 9 commits March 4, 2024 14:34

feat(code): add migration guide

b65ba39

feat(code): add plugin package.json mig changes

79aa8e1

feat(code): add ts parser

3d1c509

feat(code): add ts traversal

3063d0f

feat(code): add interface descriptions

e38cd7a

feat(code): update fastlane lanes

e1a5e78

feat(code): fastlane gradle app module

933466a

feat(fastlane): compile gym settings

363c207

feat(code): versioning and README.md

0471fda

NickBurkhartBB reviewed Mar 19, 2024

View reviewed changes

NickBurkhartBB reviewed Mar 22, 2024

View reviewed changes

crherman7 added 14 commits March 25, 2024 14:21

feat(code): add changesets

0103e12

feat(code): add github actions

3be706c

feat(code): add example plugin to flagship code config

9196fac

feat(code): remove warning unused types

9557b42

feat(code): update cli name

d2d47c4

fix(code): cli-kit platform unit tests

e218a07

fix(code): add missing throw

be4d473

fix(code): add ruby setup to pr-test

91eb476

fix(code): system.exit(1) on errors

6839828

fix(code): type assertions in favor of ts-ignore

92de8f4

fix(code): add object in favor of ts-ignore

ddcf261

feat(code): filter out permission objects and empty strings

1cb8744

feat(code): add better comment for permission push

87a85c8

feat(code): add build config defaults

0e72b84

crherman7 closed this Apr 1, 2024

crherman7 force-pushed the v13 branch from 4db3499 to 4b1f60c Compare April 1, 2024 19:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(v13): Flagship Code v13 #138

feat(v13): Flagship Code v13 #138

crherman7 commented Mar 15, 2024

NickBurkhartBB Mar 19, 2024

jasonmosley Mar 20, 2024

NickBurkhartBB Mar 19, 2024

crherman7 Mar 25, 2024

crherman7 Mar 25, 2024

NickBurkhartBB left a comment

NickBurkhartBB Mar 19, 2024

crherman7 Mar 25, 2024

NickBurkhartBB Mar 19, 2024

crherman7 Mar 25, 2024

NickBurkhartBB Mar 19, 2024

crherman7 Mar 25, 2024

NickBurkhartBB Mar 19, 2024

crherman7 Mar 25, 2024

NickBurkhartBB Mar 19, 2024

crherman7 Mar 25, 2024

NickBurkhartBB Mar 21, 2024

crherman7 Mar 25, 2024

NickBurkhartBB Mar 21, 2024

crherman7 Mar 25, 2024

NickBurkhartBB Mar 22, 2024

crherman7 Mar 25, 2024

NickBurkhartBB Mar 22, 2024

crherman7 Mar 25, 2024

crherman7 Mar 25, 2024

NickBurkhartBB Mar 22, 2024

crherman7 Mar 25, 2024

crherman7 Mar 25, 2024

crherman7 commented Mar 27, 2024

NickBurkhartBB commented Mar 28, 2024


		In this update, all Flagship Code dependencies have undergone a major version upgrade, accompanied by notable deprecations. Particularly, the package `@brandingbrand/code-core` has been deprecated in favor of `@brandingbrand/code-cli-kit`. This change stems from the recognition that the former package name lacked clarity regarding its intended use-case. We believe that `code-cli-kit` better communicates that this package serves as a developer toolkit to support the CLI package.

		Furthermore, several plugins have been deprecated due to their inability to undergo open-source testing. Some of these plugins necessitated third-party accounts, posing a risk of exposing Branding Brand's accounts to public developers. These deprecated plugins, including `@brandingbrand/code-plugin-fbsdk-next`, `@brandingbrand/code-plugin-firebase-analytics`, `@brandingbrand/code-plugin-firebase-app`, `@brandingbrand/code-plugin-google-signin`, and `@brandingbrand/code-plugin-leanplum`, will need to be re-implemented in the new plugin format, following the guidelines outlined in the [plugin guide](/guides/plugins). While we understand that this may be frustrating for developers, we firmly believe that this approach is necessary to ensure the quality and supportability of our plugins.

		@@ -1,62 +0,0 @@
		# Workflow for building and deploying Flagship Code™ Docs to GitHub Pages

feat(v13): Flagship Code v13 #138

feat(v13): Flagship Code v13 #138

Conversation

crherman7 commented Mar 15, 2024

Describe your changes

Issue ticket number and link

Type of change

Test Plan

Checklist before requesting a review

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crherman7 commented Mar 27, 2024

NickBurkhartBB commented Mar 28, 2024