refactor(cat-voices): self contained frontend dir (#1082)

* refactor: move uikit_example into utilities dir

* fix: exclude example packages from melos bootstrap

* refactor: move poc_local_storage into catalyst_voices/utilities

* refactor: move catalyst_voices_remote_widgets package to catalyst_voices/utilities dir

* refactor: move scripts into catalyst_voices dir

* refactor: move catalyst_voices/packages into catalyst_voices/packages/internal

* refactor: move catalyst_voices_packages into catalyst_voices/packages/external

* refactor: move melos.yaml into catalyst_voices

* refactor: move app into apps/voices dir

* refactor: rename packages/external to packages/libs

* docs: update README

* fix: builder target

* fix: update paths in Earthfile

* fix: uikit_example pubspec + libs examples deps override

* chore: test

* fix: update cspell and check markdown rules

* fix: README formatting

* fix: build-web target path

* fix: remove build-web target suffix separator

* fix: wallet-automation tests target path

* fix: wallet-automation builder target

* fix: voices automation tests target

* fix: code-generator target path

* fix: vscode launch.recommended paths

* feat: catalyst_voices justfile

* refactor: rename catalyst_voices_remote_widgets to remote_widgets

* fix: remote_widget spelling and licence checks

* fix: remote_widget analyzer

* refactor: move repo-catalyst-voices from root Earthfile to catalyst_voices/Earthfile

* fix: file drop

* fix: force downgraded version of flutter_dropzone

* chore: update repository links + codeowners paths

* fix: deploy uikit workflow

* fix: uikit_example earthly build target

* fix: uikit deploy workflow path

* chore: integration tests docs readme paths

* chore: remote widget readme path

* chore: markdown ignore macos pods path fix

* chore: integration test scripts

* chore: build_runner assets

* chore: document flutter_dropzone issue

---------

Co-authored-by: Dominik Toton <[email protected]>

.config/dictionaries/project.dic

@@ -2,6 +2,7 @@ aapt
 aarch
 abnf
 addr
+addrof
 addrr
 adminer
 afinet
@@ -10,6 +11,7 @@ anypolicy
 appbar
 appspot
 Arbritrary
+ARCHS
 ARGB
 Arissara
 asmjs
@@ -28,8 +30,10 @@ bluefireteam
 BROTLI
 canvaskit
 cardano
+cargokit
 carryforward
 Catalyst
+cbindgen
 CBOR
 cborg
 cborseq
@@ -78,6 +82,7 @@ earthfile
 Easterling
 eddsa
 Edgedriver
+Embedder
 emurgo
 encryptor
 endfunction
@@ -115,6 +120,7 @@ interps
 inversed
 iohk
 iphoneos
+iphonesimulator
 jdbc
 jetbrains
 Joaquín
@@ -140,12 +146,14 @@ libasound
 libatk
 libatspi
 libavcodec
+libcatalyst
 libdrm
 libflutter
 libgbm
 libnss
 libxkbcommon
 libxshmfence
+Lifetimeable
 lintfix
 localizable
 loguru
@@ -161,6 +169,7 @@ miniaturizable
 minicbor
 mithril
 mitigations
+mocktail
 moderations
 moka
 msedgedriver
@@ -191,6 +200,7 @@ pinenacl
 plpgsql
 podfile
 podhelper
+Podspec
 postcss
 Pozhylenkov
 Precache
@@ -239,8 +249,10 @@ servernum
 serviceworker
 slotno
 sqlfluff
+SRCROOT
 sslmode
 sstableinfo
+staticlib
 Stefano
 stevenj
 stringzilla
@@ -306,17 +318,3 @@ xctestrun
 xcworkspace
 xvfb
 yoroi
-Pbkdf2
-Embedder
-Podspec
-podspec
-ARCHS
-iphonesimulator
-cargokit
-SRCROOT
-libcatalyst
-staticlib
-addrof
-Lifetimeable
-cbindgen
-mocktail

.github/CODEOWNERS

@@ -2,7 +2,7 @@
 
 /catalyst_voices/ @minikin
 
-/catalyst_voices_packages/ @minikin @stevenj
+/catalyst_voices/packages/libs/ @minikin @stevenj
 
 /catalyst-gateway/ @stevenj @Mr-Leshiy @FelipeRosa @cong-or @saibatizoku @minikin
 

.github/dependabot.yml

@@ -21,7 +21,7 @@ updates:
       - "minikin"
 
   - package-ecosystem: "pub"
-    directory: "/catalyst_voices_packages"
+    directory: "/catalyst_voices/packages/libs"
     schedule:
       interval: "monthly"
     assignees:

.github/workflows/flutter-mobile-integration-test.yml

@@ -48,8 +48,8 @@ jobs:
         run: melos build:pub_get:all
 
       - name: 🤖 Run Android Integration Tests
-        run: ./scripts/flutter_android_integration_test.sh
+        run: ./catalyst_voices/scripts/flutter_android_integration_test.sh
 
       # TODO: https://github.com/input-output-hk/catalyst-voices/issues/135
       # - name: 📱 Run iOS Integration Tests
-      #   run: ./scripts/flutter_ios_integration_test.sh
+      #   run: ./catalyst_voices/scripts/flutter_ios_integration_test.sh

.github/workflows/flutter-uikit-example-firebase-deploy.yml

@@ -38,7 +38,7 @@ jobs:
         if: always()
         continue-on-error: true
         with:
-          earthfile: ./catalyst_voices/uikit_example
+          earthfile: ./catalyst_voices/utilities/uikit_example
           flags: --allow-privileged
           targets: local-build-web
           target_flags:
@@ -50,4 +50,4 @@ jobs:
           firebaseServiceAccount: "${{ secrets.UIKIT_FIREBASE_SERVICE_ACCOUNT }}"
           projectId: "${{ secrets.UIKIT_FIREBASE_PROJECT_ID }}"
           channelId: live
-          entryPoint: catalyst_voices/uikit_example
+          entryPoint: catalyst_voices/utilities/uikit_example

.github/workflows/nightly-ci.yml

@@ -67,7 +67,7 @@ jobs:
         if: always()
         continue-on-error: true
         with:
-            earthfile: ./catalyst_voices_packages/catalyst_cardano/catalyst_cardano/wallet-automation/
+            earthfile: ./catalyst_voices/packages/libs/catalyst_cardano/catalyst_cardano/wallet-automation/
             flags: --allow-privileged
             targets: nightly-test
             target_flags:

.markdownlint-cli2.jsonc

@@ -11,9 +11,9 @@
     ".config/dictionaries/**",
     "catalyst-gateway/target/**",
     "CHANGELOG.md",
-    "catalyst_voices_packages/**/CHANGELOG.md",
-    "catalyst_voices_packages/**/cargokit/**",
-    "catalyst_voices/macos/Pods/**",
+    "catalyst_voices/packages/libs/**/CHANGELOG.md",
+    "catalyst_voices/packages/libs/**/cargokit/**",
+    "catalyst_voices/apps/voices/macos/Pods/**",
     "**/node_modules/**",
     "**/.dart_tool/**"
   ],

.vscode/launch.recommended.json

@@ -7,124 +7,163 @@
   "configurations": [
     {
       "name": "Catalyst Voices [macOS]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "debug",
       "program": "lib/configs/main_web.dart"
     },
     {
       "name": "Catalyst Voices [Web]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "debug",
       "program": "lib/configs/main_web.dart",
-      "args": ["--dart-define", "SENTRY_DSN=REPLACE_WITH_SENTRY_DSN_URL"]
+      "args": [
+        "--dart-define",
+        "SENTRY_DSN=REPLACE_WITH_SENTRY_DSN_URL"
+      ]
     },
     {
       "name": "Catalyst Voices [DEV][Debug]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "program": "lib/configs/main_dev.dart",
-      "args": ["--flavor", "dev"]
+      "args": [
+        "--flavor",
+        "dev"
+      ]
     },
     {
       "name": "Catalyst Voices [DEV][Profile]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "profile",
       "program": "lib/configs/main_dev.dart",
-      "args": ["--flavor", "dev"]
+      "args": [
+        "--flavor",
+        "dev"
+      ]
     },
     {
       "name": "Catalyst Voices [DEV][Release]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "release",
       "program": "lib/configs/main_dev.dart",
-      "args": ["--flavor", "dev"]
+      "args": [
+        "--flavor",
+        "dev"
+      ]
     },
     {
       "name": "Catalyst Voices [QA][Debug]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "program": "lib/configs/main_qa.dart",
-      "args": ["--flavor", "qa"]
+      "args": [
+        "--flavor",
+        "qa"
+      ]
     },
     {
       "name": "Catalyst Voices [QA][Profile]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "profile",
       "program": "lib/configs/main_qa.dart",
-      "args": ["--flavor", "qa"]
+      "args": [
+        "--flavor",
+        "qa"
+      ]
     },
     {
       "name": "Catalyst Voices [QA][Release]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "release",
       "program": "lib/configs/main_qa.dart",
-      "args": ["--flavor", "qa"]
+      "args": [
+        "--flavor",
+        "qa"
+      ]
     },
     {
       "name": "Catalyst Voices [PROD][Debug]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "program": "lib/configs/main_prod.dart",
-      "args": ["--flavor", "prod"]
+      "args": [
+        "--flavor",
+        "prod"
+      ]
     },
     {
       "name": "Catalyst Voices [PROD][Profile]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "profile",
       "program": "lib/configs/main_prod.dart",
-      "args": ["--flavor", "prod"]
+      "args": [
+        "--flavor",
+        "prod"
+      ]
     },
     {
       "name": "Catalyst Voices [PROD][Release]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "release",
       "program": "lib/configs/main_prod.dart",
-      "args": ["--flavor", "prod"]
+      "args": [
+        "--flavor",
+        "prod"
+      ]
     },
     {
       "name": "Catalyst Voices [PRE:PROD][Debug]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "program": "lib/configs/main_preprod.dart",
-      "args": ["--flavor", "preprod"]
+      "args": [
+        "--flavor",
+        "preprod"
+      ]
     },
     {
       "name": "Catalyst Voices [PRE:PROD][Profile]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "profile",
       "program": "lib/configs/main_preprod.dart",
-      "args": ["--flavor", "preprod"]
+      "args": [
+        "--flavor",
+        "preprod"
+      ]
     },
     {
       "name": "Catalyst Voices [PRE:PROD][Release]",
-      "cwd": "catalyst_voices",
+      "cwd": "catalyst_voices/apps/voices",
       "request": "launch",
       "type": "dart",
       "flutterMode": "release",
       "program": "lib/configs/main_preprod.dart",
-      "args": ["--flavor", "preprod"]
+      "args": [
+        "--flavor",
+        "preprod"
+      ]
     }
   ]
-}
+}

Earthfile

@@ -41,24 +41,4 @@ repo-docs:
     WORKDIR /repo
     COPY --dir *.md LICENSE-APACHE LICENSE-MIT .
 
-    SAVE ARTIFACT /repo repo
-
-# repo-catalyst-voices-packages - Create artifacts of catalyst_voices_packages
-# we need to refer to in other earthly targets.
-repo-catalyst-voices-packages:
-    FROM scratch
-
-    WORKDIR /repo
-    COPY --dir catalyst_voices_packages .
-
-    SAVE ARTIFACT /repo repo
-
-# repo-catalyst-voices-all - Creates artifacts of all configuration files,
-# packages and folders related to catalyst_voices frontend.
-repo-catalyst-voices-all:
-    FROM scratch
-
-    WORKDIR /repo
-    COPY --dir catalyst_voices catalyst_voices_packages utilities melos.yaml pubspec.yaml  .
-
     SAVE ARTIFACT /repo repo