wxt-module-safari-xcode 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 rxliuli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# Safari Xcode Module
+
+A WXT module that automatically converts Safari extensions to Xcode projects and configures related settings after the build is complete.
+
+## Features
+
+- Automatically runs `xcrun safari-web-extension-converter` to convert the extension to an Xcode project
+- Updates Xcode project configuration (version number, app category, development team, etc.)
+- Updates all Info.plist files
+
+## Usage
+
+### 1. Enable the module in wxt.config.ts
+
+```typescript
+import { defineConfig } from 'wxt'
+
+export default defineConfig({
+  modules: ['wxt-module-safari-xcode'],
+  safariXcode: {
+    projectName: 'Your Project Name',
+    appCategory: 'public.app-category.productivity',
+    bundleIdentifier: 'com.example.your-extension',
+    developmentTeam: 'ABC1234567', // 可选，Apple Developer Team ID
+  },
+  // ... other configurations
+})
+```
+
+### 2. Build Safari Extension
+
+```bash
+pnpm wxt build -b safari
+```
+
+The module will automatically convert the extension to an Xcode project after the build completes.
+
+## Configuration Options
+
+| Option             | Type     | Required | Description                                                                                   |
+| ------------------ | -------- | -------- | --------------------------------------------------------------------------------------------- |
+| `projectName`      | `string` | ❌       | Safari project name. Defaults to `manifest.name` if not provided                              |
+| `appCategory`      | `string` | ✅       | App category, e.g., `'public.app-category.productivity'`                                      |
+| `bundleIdentifier` | `string` | ✅       | Bundle identifier, e.g., `'com.example.app'`                                                  |
+| `developmentTeam`  | `string` | ❌       | Apple Developer Team ID, e.g., `'ABC1234567'`. If not provided, must be set manually in Xcode |
+
+## How It Works
+
+This module uses WXT's `build:done` hook to perform the following steps after the build completes:
+
+1. Run `xcrun safari-web-extension-converter` to convert the extension to a Safari Xcode project
+2. Read the version number from `package.json`
+3. Update the Xcode project configuration file (`.xcodeproj/project.pbxproj`)
+   - Set `MARKETING_VERSION` to the version from package.json
+   - Set `CURRENT_PROJECT_VERSION` to numeric version (major _ 10000 + minor _ 100 + patch)
+   - Configure app category
+   - Configure development team (if provided)
+4. Update all Info.plist files and add `CFBundleVersion`
+
+## Notes
+
+- This module only executes when building for Safari browser (`wxt build -b safari`)
+- Requires macOS and Xcode Command Line Tools
+- If you want to read configuration from environment variables, ensure `.env.local` is added to `.gitignore`
+
+## Examples
+
+### Complete Configuration Example
+
+```typescript
+import { defineConfig } from 'wxt'
+
+export default defineConfig({
+  modules: ['@wxt-dev/module-react', 'wxt-module-safari-xcode'],
+  safariXcode: {
+    projectName: 'My Awesome Extension',
+    appCategory: 'public.app-category.productivity',
+    bundleIdentifier: 'com.mycompany.awesome-extension',
+    developmentTeam: 'ABC1234567',
+  },
+  manifest: {
+    name: 'My Awesome Extension',
+    version: '0.1.0',
+  },
+})
+```
+
+生成的 Xcode 项目将位于：`.output/My Awesome Extension/My Awesome Extension.xcodeproj`

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import * as wxt from 'wxt';
+
+interface SafariXcodeOptions {
+    /**
+     * Safari project name
+     * Defaults to manifest.name if not provided
+     */
+    projectName?: string;
+    /**
+     * App category, e.g., 'public.app-category.productivity'
+     */
+    appCategory: string;
+    /**
+     * Bundle identifier
+     */
+    bundleIdentifier: string;
+    /**
+     * Apple Developer Team ID (optional)
+     * Example: 'ABC1234567'
+     * If not provided, the generated Xcode project will need to have the development team set manually
+     */
+    developmentTeam?: string;
+}
+declare const _default: wxt.WxtModule<SafariXcodeOptions>;
+
+declare module 'wxt' {
+    interface InlineConfig {
+        safariXcode?: SafariXcodeOptions;
+    }
+}
+
+export { type SafariXcodeOptions, _default as default };

package/dist/index.js

@@ -0,0 +1,117 @@
+// src/index.ts
+import "wxt";
+import { defineWxtModule } from "wxt/modules";
+import { $ } from "zx";
+
+// src/safari-utils.ts
+import { globby } from "zx";
+import path from "path";
+import fs from "fs/promises";
+async function updateProjectConfig(options) {
+  const projectConfigPath = path.resolve(
+    options.rootPath,
+    `.output/${options.projectName}/${options.projectName}.xcodeproj/project.pbxproj`
+  );
+  const packageJsonModule = await import(path.resolve(options.rootPath, "package.json"), {
+    with: { type: "json" }
+  });
+  const packageJson = packageJsonModule.default;
+  const content = await fs.readFile(projectConfigPath, "utf-8");
+  const newContent = content.replaceAll(
+    "MARKETING_VERSION = 1.0;",
+    `MARKETING_VERSION = ${packageJson.version};`
+  ).replace(
+    new RegExp(
+      `INFOPLIST_KEY_CFBundleDisplayName = ("?${options.projectName}"?);`,
+      "g"
+    ),
+    `INFOPLIST_KEY_CFBundleDisplayName = $1;
+				INFOPLIST_KEY_LSApplicationCategoryType = "${options.appCategory}";`
+  ).replace(
+    new RegExp(`GCC_WARN_UNUSED_VARIABLE = YES;`, "g"),
+    `GCC_WARN_UNUSED_VARIABLE = YES;
+				INFOPLIST_KEY_LSApplicationCategoryType = "${options.appCategory}";`
+  ).replace(
+    new RegExp(
+      `INFOPLIST_KEY_CFBundleDisplayName = ("?${options.projectName}"?);`,
+      "g"
+    ),
+    `INFOPLIST_KEY_CFBundleDisplayName = $1;
+				INFOPLIST_KEY_ITSAppUsesNonExemptEncryption = NO;`
+  ).replaceAll(
+    `COPY_PHASE_STRIP = NO;`,
+    options.developmentTeam ? `COPY_PHASE_STRIP = NO;
+				DEVELOPMENT_TEAM = ${options.developmentTeam};` : "COPY_PHASE_STRIP = NO;"
+  ).replace(
+    /CURRENT_PROJECT_VERSION = \d+;/g,
+    `CURRENT_PROJECT_VERSION = ${parseProjectVersion(packageJson.version)};`
+  );
+  await fs.writeFile(projectConfigPath, newContent);
+}
+async function updateInfoPlist(options) {
+  const projectPath = path.resolve(options.rootPath, ".output", options.projectName);
+  const files = await globby("**/*.plist", {
+    cwd: projectPath
+  });
+  for (const file of files) {
+    const content = await fs.readFile(path.resolve(projectPath, file), "utf-8");
+    await fs.writeFile(
+      path.resolve(projectPath, file),
+      content.replaceAll(
+        "</dict>\n</plist>",
+        "	<key>CFBundleVersion</key>\n	<string>$(CURRENT_PROJECT_VERSION)</string>\n</dict>\n</plist>"
+      )
+    );
+  }
+}
+function parseProjectVersion(version) {
+  const [major, minor, patch] = version.split(".").map(Number);
+  return major * 1e4 + minor * 100 + patch;
+}
+
+// src/index.ts
+var index_default = defineWxtModule({
+  name: "safari-xcode",
+  configKey: "safariXcode",
+  async setup(wxt, options) {
+    if (wxt.config.browser !== "safari") {
+      return;
+    }
+    const { appCategory, bundleIdentifier, developmentTeam } = options ?? {};
+    const projectName = options?.projectName ?? wxt.config.manifest.name;
+    if (!projectName || !appCategory || !bundleIdentifier) {
+      wxt.logger.warn(
+        "Safari Xcode module is not configured properly. Please provide projectName, appCategory and bundleIdentifier."
+      );
+      return;
+    }
+    wxt.hook("build:done", async (wxt2) => {
+      wxt2.logger.info("Converting Safari extension to Xcode project...");
+      try {
+        wxt2.logger.info("Running safari-web-extension-converter...");
+        await $`xcrun safari-web-extension-converter --bundle-identifier ${bundleIdentifier} --force --project-location .output .output/safari-mv3`;
+        wxt2.logger.info("Updating Xcode project config...");
+        await updateProjectConfig({
+          projectName,
+          appCategory,
+          developmentTeam,
+          rootPath: wxt2.config.root
+        });
+        wxt2.logger.info("Updating Info.plist files...");
+        await updateInfoPlist({
+          projectName,
+          appCategory,
+          developmentTeam,
+          rootPath: wxt2.config.root
+        });
+        wxt2.logger.success("Safari Xcode project created successfully!");
+      } catch (error) {
+        wxt2.logger.error("Safari Xcode conversion failed:", error);
+        throw error;
+      }
+    });
+  }
+});
+export {
+  index_default as default
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "wxt-module-safari-xcode",
+  "version": "0.0.1",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "wxt": "^0.20.13"
+  },
+  "optionalDependencies": {
+    "wxt": "^0.20.13"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "zx": "^8.8.5"
+  },
+  "scripts": {
+    "setup": "pnpm build",
+    "build": "tsup src/index.ts --format esm --dts --out-dir dist --clean --external wxt",
+    "dev": "pnpm build --watch"
+  }
+}