Add note on interdependent values

w3c · Apr 8, 2024 · 5ca0350 · 5ca0350
1 parent 166e36b
commit 5ca0350
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/lib/install/macos.js b/lib/install/macos.js
@@ -11,6 +11,14 @@ const EXTENSION_IDENTIFIER = 'com.bocoup.ATDriverGenericMacOS.ATDriverGenericMac
 const VOICE_IDENTIFIER =
   'com.bocoup.ATDriverGenericMacOS.ATDriverGenericMacOSExtension.ATDriverGenericMacOSExtension';
 const SYSTEM_VOICE_IDENTIFIER = 'com.apple.Fred';
+/**
+ * This string comprises three tokens (the "type", "subtype", and
+ * "manufacturer" of the Audio Unit) which must be kept in-sync with other
+ * references in this project:
+ *
+ * - src/macos/ATDriverGenericMacOS/ATDriverGenericMacOS/Model/AudioUnitHostModel.swift
+ * - src/macos/ATDriverGenericMacOS/ATDriverGenericMacOSExtension/Info.plist
+ */
 const PLUGIN_TRIPLET_IDENTIFIER = 'ausp atdg BOCU';
 
 const exec = promisify(_exec);

diff --git a/src/macos/ATDriverGenericMacOS/ATDriverGenericMacOS/Model/AudioUnitHostModel.swift b/src/macos/ATDriverGenericMacOS/ATDriverGenericMacOS/Model/AudioUnitHostModel.swift
@@ -31,6 +31,11 @@ class AudioUnitHostModel: ObservableObject {
 
     let auValString: String
 
+    /// These values must be kept in-sync with other references in this
+    /// project:
+    ///
+    /// - lib/install/macos.js
+    /// - src/macos/ATDriverGenericMacOS/ATDriverGenericMacOSExtension/Info.plist
     init(type: String = "ausp", subType: String = "atdg", manufacturer: String = "BOCU") {
         self.type = type
         self.subType = subType

diff --git a/src/macos/ATDriverGenericMacOS/ATDriverGenericMacOSExtension/Info.plist b/src/macos/ATDriverGenericMacOS/ATDriverGenericMacOSExtension/Info.plist
@@ -11,18 +11,39 @@
 				<dict>
 					<key>description</key>
 					<string>ATDriverGenericMacOSExtension</string>
+					<!--
+						The "manufacturer" must be kept in-sync with other
+						references in this project:
+
+						- lib/install/macos.js
+						- src/macos/ATDriverGenericMacOS/ATDriverGenericMacOS/Model/AudioUnitHostModel.swift
+					-->
 					<key>manufacturer</key>
 					<string>BOCU</string>
 					<key>name</key>
 					<string>Bocoup LLC: ATDriverGenericMacOSExtension</string>
 					<key>sandboxSafe</key>
 					<true/>
+					<!--
+						The "subtype" must be kept in-sync with other
+						references in this project:
+
+						- lib/install/macos.js
+						- src/macos/ATDriverGenericMacOS/ATDriverGenericMacOS/Model/AudioUnitHostModel.swift
+					-->
 					<key>subtype</key>
 					<string>atdg</string>
 					<key>tags</key>
 					<array>
 						<string>Speech Synthesizer</string>
 					</array>
+					<!--
+						The "type" must be kept in-sync with other references
+						in this project:
+
+						- lib/install/macos.js
+						- src/macos/ATDriverGenericMacOS/ATDriverGenericMacOS/Model/AudioUnitHostModel.swift
+					-->
 					<key>type</key>
 					<string>ausp</string>
 					<key>version</key>