Merge pull request #1089 from kiwix/safe-translations-applied

Safe translations applied

Author: kelson42

.github/workflows/ci.yml

@@ -33,6 +33,9 @@ jobs:
           # /!\ important: this checks out code from the HEAD of the PR instead of the main branch (for pull_request_target)
           ref: ${{ github.event.pull_request.head.sha || github.ref }}
 
+      - name: Validate localizations
+        run: python localizations.py validate
+
       - name: Add Apple Store Key
         run: echo "${{ secrets.APPLE_STORE_AUTH_KEY }}" | base64 --decode -o ${{ env.APPLE_STORE_AUTH_KEY_PATH}}
 

.gitignore

@@ -81,4 +81,7 @@ Brewfile.lock.json
 
 # this is CI specific
 Brewfile_CI
-Brewfile_CI.lock.json
+Brewfile_CI.lock.json
+
+# Generated localization swift file:
+Support/LocalString.swift

.pre-commit-config.yaml

@@ -3,6 +3,12 @@ default_install_hook_types: [post-merge, post-checkout, post-rewrite]
 repos:
   - repo: local
     hooks:
+      - id: generate_localizations
+        name: "Generate localization swift file"
+        entry: python localizations.py generate
+        language: python
+        always_run: true
+        stages: [post-checkout, post-merge, post-rewrite]
       - id: xcodegen
         name: Generate project files for Xcode
         description: "Generate project file for Xcode"

.swiftlint.yml

@@ -1,4 +1,6 @@
 disabled_rules:
   - trailing_whitespace
 included:
-  - Views/Settings/
+  - Views/Settings/
+excluded:
+  - Support/LocalString.swift

App/App_macOS.swift

@@ -52,10 +52,10 @@ struct Kiwix: App {
         }.commands {
             SidebarCommands()
             CommandGroup(replacing: .importExport) {
-                OpenFileButton(context: .command) { Text("app_macos_commands.open_file".localized) }
+                OpenFileButton(context: .command) { Text(LocalString.app_macos_commands_open_file) }
             }
             CommandGroup(replacing: .newItem) {
-                Button("app_macos_commands.new".localized) {
+                Button(LocalString.app_macos_commands_new) {
                     guard let currentWindow = NSApp.keyWindow,
                           let controller = currentWindow.windowController else { return }
                     controller.newWindowForTab(nil)
@@ -85,7 +85,7 @@ struct Kiwix: App {
             }
             .frame(width: 550, height: 400)
         }
-        Window("payment.donate.title".localized, id: "donation") {
+        Window(LocalString.payment_donate_title, id: "donation") {
             Group {
                 if let selectedAmount {
                     PaymentSummary(selectedAmount: selectedAmount, onComplete: {
@@ -187,7 +187,7 @@ struct RootView: View {
                     Label(navigationItem.name, systemImage: navigationItem.icon)
                 }
                 if FeatureFlags.hasLibrary {
-                    Section("app_macos_navigation.button.library".localized) {
+                    Section(LocalString.app_macos_navigation_button_library) {
                         ForEach(libraryItems, id: \.self) { navigationItem in
                             Label(navigationItem.name, systemImage: navigationItem.icon)
                         }

App/CompactViewController.swift

@@ -84,7 +84,7 @@ final class CompactViewController: UIHostingController<AnyView>, UISearchControl
         searchController.delegate = self
         searchController.hidesNavigationBarDuringPresentation = false
         searchController.showsSearchResultsController = true
-        searchController.searchBar.searchTextField.placeholder = "common.search".localized
+        searchController.searchBar.searchTextField.placeholder = LocalString.common_search
 
         searchTextObserver = searchViewModel.$searchText.sink { [weak self] searchText in
             guard self?.searchController.searchBar.text != searchText else { return }
@@ -107,7 +107,7 @@ final class CompactViewController: UIHostingController<AnyView>, UISearchControl
         trailingNavItemGroups = navigationItem.trailingItemGroups
         navigationItem.setRightBarButton(
             UIBarButtonItem(
-                title: "common.button.cancel".localized,
+                title: LocalString.common_button_cancel,
                 style: .done,
                 target: self,
                 action: #selector(onSearchCancelled)
@@ -185,14 +185,14 @@ private struct CompactView: View {
                             Button {
                                 presentedSheet = .library
                             } label: {
-                                Label("common.tab.menu.library".localized, systemImage: "folder")
+                                Label(LocalString.common_tab_menu_library, systemImage: "folder")
                             }
                             Spacer()
                         }
                         Button {
                             presentedSheet = .settings
                         } label: {
-                            Label("common.tab.menu.settings".localized, systemImage: "gear")
+                            Label(LocalString.common_tab_menu_settings, systemImage: "gear")
                         }
                         Spacer()
                     }
@@ -209,7 +209,7 @@ private struct CompactView: View {
                                     Button {
                                         self.presentedSheet = nil
                                     } label: {
-                                        Text("common.button.done".localized).fontWeight(.semibold)
+                                        Text(LocalString.common_button_done).fontWeight(.semibold)
                                     }
                                 }
                             }
@@ -285,7 +285,7 @@ private struct Content<LaunchModel>: View where LaunchModel: LaunchProtocol {
         }
         .toolbar {
             ToolbarItemGroup(placement: .primaryAction) {
-                Button("article_shortcut.random.button.title.ios".localized,
+                Button(LocalString.article_shortcut_random_button_title_ios,
                        systemImage: "die.face.5",
                        action: { browser.loadRandomArticle() })
                 .disabled(zimFiles.isEmpty)

App/SidebarViewController.swift

@@ -105,7 +105,7 @@ class SidebarViewController: UICollectionViewController, NSFetchedResultsControl
             },
             menu: UIMenu(children: [
                 UIAction(
-                    title: "sidebar_view.navigation.button.close".localized,
+                    title: LocalString.sidebar_view_navigation_button_close,
                     image: UIImage(systemName: "xmark.square"),
                     attributes: .destructive
                 ) { [unowned self] _ in
@@ -114,7 +114,7 @@ class SidebarViewController: UICollectionViewController, NSFetchedResultsControl
                     navigationViewModel.deleteTab(tabID: tabID)
                 },
                 UIAction(
-                    title: "sidebar_view.navigation.button.close_all".localized,
+                    title: LocalString.sidebar_view_navigation_button_close_all,
                     image: UIImage(systemName: "xmark.square.fill"),
                     attributes: .destructive
                 ) { [unowned self] _ in
@@ -196,7 +196,7 @@ class SidebarViewController: UICollectionViewController, NSFetchedResultsControl
         if case let .tab(objectID) = item,
             let tab = try? Database.shared.viewContext.existingObject(with: objectID) as? Tab {
             var config = cell.defaultContentConfiguration()
-            config.text = tab.title ?? "common.tab.menu.new_tab".localized
+            config.text = tab.title ?? LocalString.common_tab_menu_new_tab
             if let zimFile = tab.zimFile, let category = Category(rawValue: zimFile.category) {
                 config.textProperties.numberOfLines = 1
                 if let imgData = zimFile.faviconData {
@@ -224,11 +224,11 @@ class SidebarViewController: UICollectionViewController, NSFetchedResultsControl
         switch section {
         case .tabs:
             var config = UIListContentConfiguration.sidebarHeader()
-            config.text = "common.tab.navigation.title".localized
+            config.text = LocalString.common_tab_navigation_title
             headerView.contentConfiguration = config
         case .library:
             var config = UIListContentConfiguration.sidebarHeader()
-            config.text = "common.tab.menu.library".localized
+            config.text = LocalString.common_tab_menu_library
             headerView.contentConfiguration = config
         default:
             headerView.contentConfiguration = nil
@@ -239,7 +239,7 @@ class SidebarViewController: UICollectionViewController, NSFetchedResultsControl
         guard let navigationViewModel,
               let item = dataSource.itemIdentifier(for: indexPath),
               case let .tab(tabID) = item else { return nil }
-        let title = "sidebar_view.navigation.button.close".localized
+        let title = LocalString.sidebar_view_navigation_button_close
         let action = UIContextualAction(style: .destructive,
                                         title: title) { [weak navigationViewModel] _, _, _ in
             navigationViewModel?.deleteTab(tabID: tabID)

Brewfile

@@ -9,5 +9,6 @@ at_exit do
     system "cp Support/CoreKiwix.modulemap CoreKiwix.xcframework/ios-arm64/Headers/module.modulemap"
     system "cp Support/CoreKiwix.modulemap CoreKiwix.xcframework/ios-arm64_x86_64-simulator/Headers/module.modulemap"
     system "cp Support/CoreKiwix.modulemap CoreKiwix.xcframework/macos-arm64_x86_64/Headers/module.modulemap"
+    system "python localizations.py generate"
     system "xcodegen"
 end

Model/Brand.swift

@@ -49,7 +49,7 @@ enum Brand {
     static let loadingLogoImage: String = "welcomeLogo"
     static var loadingLogoSize: CGSize = ImageInfo.sizeOf(imageName: loadingLogoImage)!
 
-    static let aboutText: String = Config.value(for: .aboutText) ?? "settings.about.description".localized
+    static let aboutText: String = Config.value(for: .aboutText) ?? LocalString.settings_about_description
     static let aboutWebsite: String = Config.value(for: .aboutWebsite) ?? "https://www.kiwix.org"
     // currently only used under the Kiwix brand
     // if this is set to true in Support/Info.plist the support/donation button is hidden (for macOS FTP)

Model/DownloadService.swift

@@ -254,10 +254,10 @@ final class DownloadService: NSObject, URLSessionDelegate, URLSessionTaskDelegat
             Database.shared.performBackgroundTask { context in
                 // configure notification content
                 let content = UNMutableNotificationContent()
-                content.title = "download_service.complete.title".localized
+                content.title = LocalString.download_service_complete_title
                 content.sound = .default
                 if let zimFile = try? context.fetch(ZimFile.fetchRequest(fileID: zimFileID)).first {
-                    content.body = "download_service.complete.description".localizedWithFormat(withArgs: zimFile.name)
+                    content.body = LocalString.download_service_complete_description(withArgs: zimFile.name)
                 }
 
                 // schedule notification