Merge pull request #16 from snipsnipsnip/l10n-toml

Prepare for l10n

Author: snipsnipsnip

README.md

@@ -39,6 +39,8 @@ This add-on is not yet available on [addons.thunderbird.net](https://addons.thun
 3. Select `Install Add-on From File...` from the menu.
 4. Select downloaded `.xpi` file.
 
+See [the help page in the Mozilla Support Center](https://support.mozilla.org/kb/installing-addon-thunderbird) for details.
+
 ### Build from source
 
 Basically `yarn && yarn build`. See [CONTRIBUTING.md](./CONTRIBUTING.md) to get started.
@@ -99,7 +101,7 @@ gtClient -->|Updates| mailCompose
 * :nest_with_eggs: Start button on the toolbar
 * :nest_with_eggs: Edit plain text emails
 * :nest_with_eggs: Keyboard shortcuts
-* :construction: Roadmap and [Project board][proj]
+* :nest_with_eggs: Roadmap and [Project board][proj]
 * :no_entry: Non-bidirectional: Thunderbird becomes read-only while Ghostbird is active
 * :no_entry: No i18n: the UI is only in English*
 * :no_entry: Quirky when editing HTML emails
@@ -108,22 +110,22 @@ gtClient -->|Updates| mailCompose
 
 ### v0.1.0 (Alpha) - 2025 Q3
 
-* :construction: Debug
+* :nest_with_eggs: [Debug](https://github.com/exteditor/ghostbird/issues/2)
 
 ### v0.x.x (Beta) - 2025 Q4
 
-* :white_large_square: Website with some screenshot
-* :white_large_square: Basic option (at minimum, the port of the GhostText server)
-* :white_large_square: Prepare for i18n (Make texts translatable)
-* :white_large_square: Smoother editing of HTML emails
+* :white_large_square: [Website with some screenshot](https://github.com/exteditor/ghostbird/issues/5)
+* :construction: [Basic option (at minimum, the port of the GhostText server)](https://github.com/exteditor/ghostbird/issues/3)
+* :construction: [Prepare for i18n (Make texts translatable)](https://github.com/exteditor/ghostbird/issues/4)
+* :white_large_square: [Smoother editing of HTML emails](https://github.com/exteditor/ghostbird/issues/6)
 
 ### v1.0.0 (Stable) - 2026 Q2
 
-* :white_large_square: Publish on AMO (functionally identical to the last beta)
+* :white_large_square: [Publish on AMO (functionally identical to the last beta)](https://github.com/exteditor/ghostbird/issues/9)
 
 ### v1.x.x (Stable) - 2026 Q4
 
-* :white_large_square: Edit Address and Subject fields
+* :white_large_square: [Edit Address and Subject fields](https://github.com/exteditor/ghostbird/issues/8)
 * :white_large_square: Continue i18n (Add more languages)
 * :white_large_square: Support text editors that lack a GhostText add-on (e.g., Notepad)*
 * :white_large_square: Automate AMO release on GitHub
@@ -132,7 +134,7 @@ gtClient -->|Updates| mailCompose
 
 ### v2.x.x (Future)
 
-* Proper implementation as a GhostText client
+* [Proper implementation as a GhostText client](https://github.com/exteditor/ghostbird/issues/10)
   * :white_large_square: Cursor and selection synchronization
   * :white_large_square: Bidirectional editing; changes in Thunderbird are reflected in the text editor
 

doc/design.md

@@ -223,9 +223,9 @@ thunderbird --> background & compose & options
 ```
 
 * All `src/*/index.ts` export everything in the same folder, so practically these folders are equivalent to modules.
-* `root/` contains entry points and depends on all other modules.
+* `root/` contains entry points and depends on all other modules except `test/`.
 * `ghosttext-session/` doesn't depend on other modules.
-* `ghosttext-*/` depends on `ghosttext`.
+* `ghosttext-adaptor/` depends on `ghosttext-runner/`, which depends on `ghosttext-session/`.
 * `root/` and `thunderbird/` can use Thunderbird API directly.
   * Other modules define subsets of the Thunderbird API they use as interfaces in `api.ts` files in their directories, which are implemented by `thunderbird/` modules.
 
@@ -284,6 +284,29 @@ TL;DR: `root` module contains entry point and the [Composition Root][ploeh].
 * `test/startup.test.ts` contains tests to verify that all classes registered can be instantiated successfully.
 * See [FAQ](./faq-architectural.md) for some design decisions and justification.
 
+```mermaid
+flowchart LR
+
+need_instance["Need an<br>instance"]
+is_singleton{" "}
+is_singleton -->|isSingleton = true| singleton["Cache the<br>instance"]
+is_singleton -->|isSingleton = false| factory["Instantiate on<br>each request"]
+
+prepare_argument{" "}
+prepare_argument -->|Need arguments| want_array{" "}
+prepare_argument -->|No argument<br>needed| Done@{shape: dbl-circ}
+want_array -->|wantArray = false| unique_instance["Resolve the<br>unique name"]
+want_array -->|wantArray = true| array_instances["Resolve all instances<br>having the same name"]
+is_alias{" "}
+is_alias <-->|Alias| resolve_alias["Resolve<br>the alias"] --> instantiate_class
+is_alias -->|Actual class| instantiate_class["Prepare<br>the instance"]
+
+need_instance --> is_singleton
+singleton & factory --> prepare_argument
+unique_instance & array_instances --> is_alias
+instantiate_class --> need_instance
+```
+
 ## Links
 
 * [GhostText protocol][protocol]

doc/faq-architectural.md

@@ -20,7 +20,7 @@
 
 ### How does automatic instantiation help with maintainability?
 
-* It makes coding less boring by automating a necessary coding task that occurs often: passing objects around to call their methods. This task gets harder as the software grows (which correlates to the number of hops required). I like to think of it as being similar to generating a Makefile.
+* It makes coding less boring by automating a necessary coding task that occurs often: passing objects around to call their methods. I like to think of it as being similar to generating a Makefile. It's not a panacea, but I think it has some effect to extend lifespan of the code until it becomes unmaintainable due to the scale.
 * It nudges us to adhere to the [Dependency Inversion Principle][dip].
 
 ### How does DIP help with maintainability?
@@ -33,7 +33,6 @@
 
 * Maybe, but I intend to maintain this project for a while, and this was the best solution I could devise to adapt to breaking Thunderbird API changes, which seem to [happen every few versions][tbchanges].
 * Also, adding DI after the fact tends to be very hard.
-* I think DI may be over-engineered, but [the DIP][dip] is still valuable.
 * We might drop the autowiring thing and instantiate manually with `new` if the project ends up being stable enough. The practice of initializing everything in `startup.ts` would [still be useful][ploeh], though. It's possible to drop autowiring without [giving up DIP][ploeh2].
 
 ### It looks like not using a dependency injection library. Why are you reinventing the wheel?

ext/_locales/en/messages.json

@@ -0,0 +1,32 @@
+# This file contains translations for various messages Ghostbird shows.
+# The format is as follows:
+#
+# [<message_id>]
+# <language> = "<translated message>"
+#
+# See https://pontoon.mozilla.org/projects/thunderbirdnet/ for canonical terms like "email".
+
+[manifest_name]
+# Full name of the extension.
+en = "Ghostbird - GhostText for Thunderbird"
+ja = "Ghostbird - Thunderbird用GhostText"
+
+[manifest_description]
+# Description of the extension.
+en = "Use your favorite text editor to compose emails"
+ja = "好きなテキストエディタでメールを編集"
+
+[manifest_commands_start_ghostbird_description]
+# Description of the shortcut key to start Ghostbird.
+en = "Connect to the text editor"
+ja = "テキストエディタに接続"
+
+[manifest_commands_stop_ghostbird_description]
+# Description of the shortcut key to stop Ghostbird.
+en = "Disconnect from the text editor"
+ja = "テキストエディタから切断"
+
+[manifest_commants_toggle_ghostbird_description]
+# Description of the shortcut key to toggle Ghostbird.
+en = "Toggle connection with the text editor"
+ja = "テキストエディタとの接続を切り替え"

locales.toml

@@ -1,12 +1,19 @@
 {
   "manifest_version": 3,
-  "name": "Ghostbird - GhostText for Thunderbird",
+  "name": "__MSG_manifest_name__",
   "short_name": "Ghostbird",
-  "description": "Use your favorite text editor to compose emails in Thunderbird",
+  "description": "__MSG_manifest_description__",
   "version": "$version$",
   "homepage_url": "$homepage_url$",
+  "version_name": "$version_name$",
   "default_locale": "en",
   "author": "snipsnipsnip",
+  "browser_specific_settings": {
+    "gecko": {
+      "id": "@ghostbird.exteditor.github.io",
+      "strict_min_version": "128.0"
+    }
+  },
   "permissions": [
     "alarms",
     "storage",
@@ -23,24 +30,18 @@
   "icons": {
     "96": "blue.svg"
   },
-  "browser_specific_settings": {
-    "gecko": {
-      "id": "@ghostbird.exteditor.github.io",
-      "strict_min_version": "128.0"
-    }
-  },
   "commands": {
-    "start-ghostbird": {
-      "description": "Start Ghostbird and connect to the GhostText server",
+    "start_ghostbird": {
+      "description": "__MSG_manifest_commands_start_ghostbird_description__",
       "suggested_key": {
-        "default": "Ctrl+E"
+        "default": "Ctrl+Shift+H"
       }
     },
-    "stop-ghostbird": {
-      "description": "Disconnect from the GhostText server and Stop Ghostbird. (Set the same shortcut as 'Start Ghostbird' to toggle)",
-      "suggested_key": {
-        "default": "Ctrl+E"
-      }
+    "stop_ghostbird": {
+      "description": "__MSG_manifest_commands_stop_ghostbird_description__"
+    },
+    "toggle_ghostbird": {
+      "description": "__MSG_manifest_commands_toggle_ghostbird_description__"
     }
   },
   "background": {

manifest_template.json

@@ -58,6 +58,7 @@
   "devDependencies": {
     "@biomejs/biome": "2.2.0",
     "@std/text": "jsr:^1.0.16",
+    "@std/toml": "jsr:^1.0.10",
     "@types/node": "^24.3.0",
     "@types/thunderbird-webext-browser": "^127.0.0",
     "barrelsby": "^2.8.1",

package.json

@@ -3,7 +3,7 @@ import type { IComposeWindow } from "src/ghosttext-adaptor/api"
 export type { IGhostServerPort } from "src/ghosttext-adaptor/api"
 
 /** IDs of shortcut keys. Must be in sync with ones in manifest.json */
-export type CommandId = "start-ghostbird" | "stop-ghostbird"
+export type CommandId = "start_ghostbird" | "stop_ghostbird" | "toggle_ghostbird"
 
 /** Queries current shortcut key config */
 export interface ICommandConfig {

src/app-background/api.ts

@@ -1,3 +1,4 @@
+import type { IComposeWindow } from "src/ghosttext-adaptor/api"
 import type { CommandId, ICommandConfig, IComposeWindowDetector, ITab } from "./api"
 import type { ComposeActionNotifier } from "./compose_action_notifier"
 
@@ -24,11 +25,17 @@ export class BackgroundEventRouter {
       return this.composeActionNotifier.toggle(composeTab)
     }
 
+    return this.runCommand(command, composeTab)
+  }
+
+  private runCommand(command: string, composeTab: IComposeWindow): Promise<void> {
     switch (command as CommandId) {
-      case "start-ghostbird":
+      case "start_ghostbird":
         return this.composeActionNotifier.start(composeTab)
-      case "stop-ghostbird":
+      case "stop_ghostbird":
         return this.composeActionNotifier.stop(composeTab)
+      case "toggle_ghostbird":
+        return this.composeActionNotifier.toggle(composeTab)
     }
     // We don't handle default here so that tsc checks for exhaustiveness
   }

src/app-background/background_event_router.ts

@@ -28,7 +28,7 @@ export class ComposeActionNotifier {
     }
   }
 
-  stop(tab: IComposeWindow): void {
+  async stop(tab: IComposeWindow): Promise<void> {
     this.close(tab, this.runners.get(tab.tabId))
   }