@bacons/apple-targets 3.0.4 → 3.0.5

package/README.md

@@ -56,7 +56,10 @@ module.exports = {
   type: "widget",
 
   // Name of the target/product. Defaults to the directory name.
-  name: "My Widget",
+  name: "my_widget",
+
+  // Optional override for CFBundleDisplayName. Defaults to `name` if not provided.
+  displayName: "My Widget",
 
   // Generates colorset files for the target.
   colors: {
@@ -230,7 +233,7 @@ These show up in the share sheet. The icon should be transparent as it will be m
 /** @type {import('@bacons/apple-targets/app.plugin').Config} */
 module.exports = {
   type: "action",
-  name: "Inspect Element",
+  displayName: "Inspect Element",
   icon: "./assets/icon.png",
   colors: {
     TouchBarBezel: "#DB739C",

package/build/config.d.ts

@@ -69,6 +69,8 @@ export type Config = {
     type: ExtensionType;
     /** Name of the target. Will default to a sanitized version of the directory name. */
     name?: string;
+    /** Optional custom name for `CFBundleDisplayName`. */
+    displayName?: string;
     /**
      * Bundle identifier for the target. Will default to a sanitized version of the root project + name.
      * If the specified bundle identifier is prefixed with a dot (.), the bundle identifier will be appended to the main app's bundle identifier.

package/build/withWidget.js

@@ -247,6 +247,7 @@ const withWidget = (config, props) => {
         productName,
         configPath: props.configPath,
         name: targetDisplayName,
+        displayName: props.displayName,
         cwd: "../" +
             path_1.default.relative(config._internal.projectRoot, path_1.default.resolve(props.directory)),
         deploymentTarget: (_f = props.deploymentTarget) !== null && _f !== void 0 ? _f : DEFAULT_DEPLOYMENT_TARGET,

package/build/withXcodeChanges.d.ts

@@ -2,6 +2,8 @@ import { ConfigPlugin } from "@expo/config-plugins";
 import { ExtensionType } from "./target";
 export type XcodeSettings = {
     name: string;
+    /** Optional custom value for CFBundleDisplayName */
+    displayName?: string;
     /** Name used for internal purposes. This has more strict rules and should be generated. */
     productName: string;
     /** Directory relative to the project root, (i.e. outside of the `ios` directory) where the widget code should live. */

package/build/withXcodeChanges.js

@@ -20,7 +20,7 @@ const withXcodeChanges = (config, props) => {
     });
 };
 exports.withXcodeChanges = withXcodeChanges;
-function createNotificationContentConfigurationList(project, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
+function createNotificationContentConfigurationList(project, { name, displayName, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
     const common = {
         CLANG_ANALYZER_NONNULL: "YES",
         CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION: "YES_AGGRESSIVE",
@@ -36,7 +36,7 @@ function createNotificationContentConfigurationList(project, { name, cwd, bundle
         GENERATE_INFOPLIST_FILE: "YES",
         CURRENT_PROJECT_VERSION: currentProjectVersion,
         INFOPLIST_FILE: cwd + "/Info.plist",
-        INFOPLIST_KEY_CFBundleDisplayName: name,
+        INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
         INFOPLIST_KEY_NSHumanReadableCopyright: "",
         IPHONEOS_DEPLOYMENT_TARGET: deploymentTarget,
         LD_RUNPATH_SEARCH_PATHS: [
@@ -82,7 +82,7 @@ function createNotificationContentConfigurationList(project, { name, cwd, bundle
 }
 function createExtensionConfigurationListFromTemplate(project, 
 // NSExtensionPointIdentifier
-extensionType, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, icon, }) {
+extensionType, { name, displayName, cwd, bundleId, deploymentTarget, currentProjectVersion, icon, }) {
     if (!TemplateBuildSettings[extensionType]) {
         throw new Error(`No template for extension type ${extensionType}. Add it to the xcode project and re-run the generation script.`);
     }
@@ -90,7 +90,7 @@ extensionType, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, i
     const dynamic = {
         CURRENT_PROJECT_VERSION: currentProjectVersion,
         INFOPLIST_FILE: cwd + "/Info.plist",
-        INFOPLIST_KEY_CFBundleDisplayName: name,
+        INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
         IPHONEOS_DEPLOYMENT_TARGET: deploymentTarget,
         PRODUCT_BUNDLE_IDENTIFIER: bundleId,
     };
@@ -121,7 +121,7 @@ extensionType, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, i
     });
     return configurationList;
 }
-function createAppIntentConfigurationList(project, { name, cwd, bundleId }) {
+function createAppIntentConfigurationList(project, { name, displayName, cwd, bundleId }) {
     const commonBuildSettings = {
         // @ts-expect-error
         ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS: "YES",
@@ -139,7 +139,7 @@ function createAppIntentConfigurationList(project, { name, cwd, bundleId }) {
         GCC_C_LANGUAGE_STANDARD: "gnu17",
         GENERATE_INFOPLIST_FILE: "YES",
         INFOPLIST_FILE: cwd + "/Info.plist",
-        INFOPLIST_KEY_CFBundleDisplayName: name,
+        INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
         INFOPLIST_KEY_NSHumanReadableCopyright: "",
         IPHONEOS_DEPLOYMENT_TARGET: "17.0",
         LD_RUNPATH_SEARCH_PATHS: [
@@ -183,7 +183,7 @@ function createAppIntentConfigurationList(project, { name, cwd, bundleId }) {
     });
     return configurationList;
 }
-function createShareConfigurationList(project, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
+function createShareConfigurationList(project, { name, displayName, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
     const common = {
         CLANG_ANALYZER_NONNULL: "YES",
         CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION: "YES_AGGRESSIVE",
@@ -198,7 +198,7 @@ function createShareConfigurationList(project, { name, cwd, bundleId, deployment
         GENERATE_INFOPLIST_FILE: "YES",
         CURRENT_PROJECT_VERSION: currentProjectVersion,
         INFOPLIST_FILE: cwd + "/Info.plist",
-        INFOPLIST_KEY_CFBundleDisplayName: name,
+        INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
         INFOPLIST_KEY_NSHumanReadableCopyright: "",
         IPHONEOS_DEPLOYMENT_TARGET: deploymentTarget,
         LD_RUNPATH_SEARCH_PATHS: [
@@ -253,7 +253,7 @@ function getMainMarketingVersion(project) {
     }
     return version;
 }
-function createIMessageConfigurationList(project, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
+function createIMessageConfigurationList(project, { name, displayName, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
     const common = {
         ASSETCATALOG_COMPILER_APPICON_NAME: "iMessage App Icon",
         CLANG_ANALYZER_NONNULL: "YES",
@@ -269,7 +269,7 @@ function createIMessageConfigurationList(project, { name, cwd, bundleId, deploym
         GENERATE_INFOPLIST_FILE: "YES",
         CURRENT_PROJECT_VERSION: currentProjectVersion,
         INFOPLIST_FILE: cwd + "/Info.plist",
-        INFOPLIST_KEY_CFBundleDisplayName: name,
+        INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
         INFOPLIST_KEY_NSHumanReadableCopyright: "",
         IPHONEOS_DEPLOYMENT_TARGET: deploymentTarget,
         LD_RUNPATH_SEARCH_PATHS: [
@@ -311,7 +311,7 @@ function createIMessageConfigurationList(project, { name, cwd, bundleId, deploym
     });
     return configurationList;
 }
-function createWatchAppConfigurationList(project, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, hasAccentColor, }) {
+function createWatchAppConfigurationList(project, { name, displayName, cwd, bundleId, deploymentTarget, currentProjectVersion, hasAccentColor, }) {
     const mainAppTarget = (0, target_1.getMainAppTarget)(project).getDefaultConfiguration();
     // NOTE: No base Info.plist needed.
     const common = {
@@ -329,7 +329,7 @@ function createWatchAppConfigurationList(project, { name, cwd, bundleId, deploym
         GCC_C_LANGUAGE_STANDARD: "gnu11",
         INFOPLIST_FILE: cwd + "/Info.plist",
         GENERATE_INFOPLIST_FILE: "YES",
-        INFOPLIST_KEY_CFBundleDisplayName: name,
+        INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
         INFOPLIST_KEY_UISupportedInterfaceOrientations: "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown",
         INFOPLIST_KEY_WKCompanionAppBundleIdentifier: mainAppTarget.props.buildSettings.PRODUCT_BUNDLE_IDENTIFIER,
         // INFOPLIST_KEY_WKCompanionAppBundleIdentifier: "$(BUNDLE_IDENTIFIER)",
@@ -379,7 +379,7 @@ function createWatchAppConfigurationList(project, { name, cwd, bundleId, deploym
     });
     return configurationList;
 }
-function createSafariConfigurationList(project, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
+function createSafariConfigurationList(project, { name, displayName, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
     const common = {
         CLANG_ANALYZER_NONNULL: "YES",
         CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION: "YES_AGGRESSIVE",
@@ -393,7 +393,7 @@ function createSafariConfigurationList(project, { name, cwd, bundleId, deploymen
         GENERATE_INFOPLIST_FILE: "YES",
         CURRENT_PROJECT_VERSION: currentProjectVersion,
         INFOPLIST_FILE: cwd + "/Info.plist",
-        INFOPLIST_KEY_CFBundleDisplayName: name,
+        INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
         INFOPLIST_KEY_NSHumanReadableCopyright: "",
         IPHONEOS_DEPLOYMENT_TARGET: deploymentTarget,
         LD_RUNPATH_SEARCH_PATHS: [
@@ -440,12 +440,12 @@ function createSafariConfigurationList(project, { name, cwd, bundleId, deploymen
     });
     return configurationList;
 }
-function createAppClipConfigurationList(project, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, hasAccentColor, orientation, deviceFamilies, }) {
+function createAppClipConfigurationList(project, { name, displayName, cwd, bundleId, deploymentTarget, currentProjectVersion, hasAccentColor, orientation, deviceFamilies, }) {
     // TODO: Unify AppIcon and AccentColor logic
     const dynamic = {
         CURRENT_PROJECT_VERSION: currentProjectVersion,
         INFOPLIST_FILE: cwd + "/Info.plist",
-        INFOPLIST_KEY_CFBundleDisplayName: name,
+        INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
         IPHONEOS_DEPLOYMENT_TARGET: deploymentTarget,
         MARKETING_VERSION: "1.0",
         PRODUCT_BUNDLE_IDENTIFIER: bundleId,
@@ -478,7 +478,7 @@ function createAppClipConfigurationList(project, { name, cwd, bundleId, deployme
         INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad: "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight",
         ...getOrientationBuildSettings(orientation),
     };
-    // Attempt to automatically set the build number to match the main app. 
+    // Attempt to automatically set the build number to match the main app.
     // This only works with EAS Build, other processes can simply set the number manually.
     if (process.env.EAS_BUILD_IOS_BUILD_NUMBER) {
         // NOTE: INFOPLIST_KEY_CFBundleVersion doesn't work here.
@@ -558,7 +558,7 @@ function getDeviceFamilyBuildSettings(deviceFamilies) {
         TARGETED_DEVICE_FAMILY: families.join(","),
     };
 }
-function createWidgetConfigurationList(project, { name, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
+function createWidgetConfigurationList(project, { name, displayName, cwd, bundleId, deploymentTarget, currentProjectVersion, }) {
     const debugBuildConfig = xcode_1.XCBuildConfiguration.create(project, {
         name: "Debug",
         buildSettings: {
@@ -577,7 +577,7 @@ function createWidgetConfigurationList(project, { name, cwd, bundleId, deploymen
             GCC_C_LANGUAGE_STANDARD: "gnu11",
             GENERATE_INFOPLIST_FILE: "YES",
             INFOPLIST_FILE: cwd + "/Info.plist",
-            INFOPLIST_KEY_CFBundleDisplayName: name,
+            INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
             INFOPLIST_KEY_NSHumanReadableCopyright: "",
             IPHONEOS_DEPLOYMENT_TARGET: deploymentTarget,
             LD_RUNPATH_SEARCH_PATHS: [
@@ -617,7 +617,7 @@ function createWidgetConfigurationList(project, { name, cwd, bundleId, deploymen
             GCC_C_LANGUAGE_STANDARD: "gnu11",
             GENERATE_INFOPLIST_FILE: "YES",
             INFOPLIST_FILE: cwd + "/Info.plist",
-            INFOPLIST_KEY_CFBundleDisplayName: name,
+            INFOPLIST_KEY_CFBundleDisplayName: displayName !== null && displayName !== void 0 ? displayName : name,
             INFOPLIST_KEY_NSHumanReadableCopyright: "",
             IPHONEOS_DEPLOYMENT_TARGET: deploymentTarget,
             LD_RUNPATH_SEARCH_PATHS: [
@@ -941,7 +941,8 @@ async function applyXcodeChanges(config, project, props) {
         if (!globalSharedAssets.length)
             return;
         // Create or find the global shared synchronized root group
-        let globalSharedSyncGroup = protectedGroup.props.children.find((child) => child.props.path === "_shared" && child instanceof xcode_1.PBXFileSystemSynchronizedRootGroup);
+        let globalSharedSyncGroup = protectedGroup.props.children.find((child) => child.props.path === "_shared" &&
+            child instanceof xcode_1.PBXFileSystemSynchronizedRootGroup);
         if (!globalSharedSyncGroup) {
             globalSharedSyncGroup = xcode_1.PBXFileSystemSynchronizedRootGroup.create(project, {
                 path: "_shared",
@@ -979,27 +980,31 @@ async function applyXcodeChanges(config, project, props) {
             let mainAppExceptionSet = globalSharedSyncGroup.props.exceptions.find((exception) => exception instanceof xcode_1.PBXFileSystemSynchronizedBuildFileExceptionSet &&
                 exception.props.target === mainAppTarget);
             if (!mainAppExceptionSet) {
-                mainAppExceptionSet = xcode_1.PBXFileSystemSynchronizedBuildFileExceptionSet.create(project, {
-                    target: mainAppTarget,
-                    membershipExceptions: globalSharedAssets.sort(),
-                });
+                mainAppExceptionSet =
+                    xcode_1.PBXFileSystemSynchronizedBuildFileExceptionSet.create(project, {
+                        target: mainAppTarget,
+                        membershipExceptions: globalSharedAssets.sort(),
+                    });
                 globalSharedSyncGroup.props.exceptions.push(mainAppExceptionSet);
             }
             else {
-                mainAppExceptionSet.props.membershipExceptions = globalSharedAssets.sort();
+                mainAppExceptionSet.props.membershipExceptions =
+                    globalSharedAssets.sort();
             }
             // Update or create exception set for extension target
             let extensionExceptionSet = globalSharedSyncGroup.props.exceptions.find((exception) => exception instanceof xcode_1.PBXFileSystemSynchronizedBuildFileExceptionSet &&
                 exception.props.target === target);
             if (!extensionExceptionSet) {
-                extensionExceptionSet = xcode_1.PBXFileSystemSynchronizedBuildFileExceptionSet.create(project, {
-                    target: target,
-                    membershipExceptions: globalSharedAssets.sort(),
-                });
+                extensionExceptionSet =
+                    xcode_1.PBXFileSystemSynchronizedBuildFileExceptionSet.create(project, {
+                        target: target,
+                        membershipExceptions: globalSharedAssets.sort(),
+                    });
                 globalSharedSyncGroup.props.exceptions.push(extensionExceptionSet);
             }
             else {
-                extensionExceptionSet.props.membershipExceptions = globalSharedAssets.sort();
+                extensionExceptionSet.props.membershipExceptions =
+                    globalSharedAssets.sort();
             }
             // Ensure the current target has the synchronized group in its fileSystemSynchronizedGroups
             if (!target.props.fileSystemSynchronizedGroups) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bacons/apple-targets",
-  "version": "3.0.4",
+  "version": "3.0.5",
   "description": "Generate Apple Targets with Expo Prebuild",
   "main": "build/ExtensionStorage.js",
   "types": "build/ExtensionStorage.d.ts",