https://github.com/gary-ash/xcodegeedbla
My Xcode utility extension
https://github.com/gary-ash/xcodegeedbla
xcode xcode-source-editor-extension
Last synced: about 1 month ago
JSON representation
My Xcode utility extension
- Host: GitHub
- URL: https://github.com/gary-ash/xcodegeedbla
- Owner: Gary-Ash
- License: mit
- Created: 2024-04-28T19:05:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-07T00:21:16.000Z (over 1 year ago)
- Last Synced: 2025-01-20T08:31:44.889Z (over 1 year ago)
- Topics: xcode, xcode-source-editor-extension
- Language: Swift
- Homepage:
- Size: 1.66 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
- Contributing: .github/CONTRIBUTING.markdown
- Funding: .github/FUNDING.yml
- License: LICENSE.markdown
- Code of conduct: .github/CODE_OF_CONDUCT.markdown
Awesome Lists containing this project
README
# XcodeGeeDblA
An Xcode Source Editor Extension for macOS that provides convenient source code formatting and file header management tools for Swift, C, C++, and Objective-C files.
## Features
### Header Management
- **Update File Header** — Automatically updates the "Modified" date in file headers while preserving the "Created" date and intelligently handling copyright year ranges (e.g., 2024–2026)
### Comment Formatting
- **Insert Separator Comment** — Inserts a horizontal line comment (`/*----...----*/`)
- **Insert Asterisk Box Comment** — Creates a decorative comment box with asterisks
- **Insert Dash Box Comment** — Creates a decorative comment box with dashes
- **Insert Equals Sign Box Comment** — Creates a decorative comment box with equals signs
### Debugging Utilities
- **Insert Function Trace Comment** — Automatically adds `print("# Gee Dbl A: Entering functionName()")` statements to all functions in the file
- **Remove Function Trace Comment** — Removes previously added function trace comments
### Configuration App
The companion macOS application allows you to maintain a list of copyright holders that the extension recognizes when updating file headers.
## Supported File Types
- Swift source files (`.swift`)
- Swift Playgrounds
- C/C++ source and header files (`.c`, `.cpp`, `.h`, `.hpp`)
- Objective-C source files (`.m`, `.mm`)
- Xcode strings files
## Requirements
- macOS (recent versions)
- Xcode
## Installation
1. Download the latest release or build from source
2. Move `XcodeGeeDblA.app` to your Applications folder
3. Launch the app once to register the extension
4. Enable the extension in **System Settings → Privacy & Security → Extensions → Xcode Source Editor**
5. Restart Xcode
## Usage
1. Open any supported source file in Xcode
2. Select **Editor → XcodeGeeDblA** from the menu bar
3. Choose the desired command
You can also assign keyboard shortcuts to these commands via **Xcode → Settings → Key Bindings**.
## Building from Source
### Xcode
```bash
git clone https://github.com/YourUsername/XcodeGeeDblA.git
cd XcodeGeeDblA
open XcodeGeeDblA.xcodeproj
```
Select your development team in **Signing & Capabilities** for both the app and extension targets, then build and run. The extension will be automatically built and registered.
### Distribution Build
The `build.sh` script automates a full release build including code signing and notarization. It extracts your team ID from the Developer ID Application certificate in your keychain, so no team ID needs to be stored in the project file.
**Prerequisites:**
- A **Developer ID Application** certificate installed in your keychain
- A notarization keychain profile named `notary-profile` (created via `xcrun notarytool store-credentials`)
```bash
./build.sh
```
The script performs the following steps:
1. Locates your Developer ID Application signing certificate
2. Extracts the team ID and injects it into the Xcode project file
3. Builds a Release configuration with `xcodebuild`
4. Code signs the resulting `XcodeGeeDblA.app`
5. Submits the app for Apple notarization and waits for approval
6. Staples the notarization ticket to the app
7. Cleans up by removing the team ID from the project file and any generated build artifacts
On completion, a signed and notarized `XcodeGeeDblA.app` is ready for distribution in the project root.
### Debugging the Extension
For extension debugging, use the `pluginkit` command-line tool:
```bash
# List registered extensions
pluginkit -m -v -i com.gee-dbl-a.XcodeGeeDblA.Extension
# Reset extension registration
pluginkit -e use -i com.gee-dbl-a.XcodeGeeDblA.Extension
```
## Project Structure
```
XcodeGeeDblA/
├── XcodeGeeDblA/ # Main macOS app (SwiftUI)
│ ├── XcodeGeeDblAApp.swift
│ ├── ContentView.swift # Copyright holders management UI
│ └── Assets.xcassets/
├── Extension/ # Xcode Source Editor Extension
│ ├── SourceEditorCommand.swift # Core extension logic
│ ├── SourceEditorExtension.swift
│ ├── Constants.swift # Supported UTI definitions
│ └── Info.plist # Command registrations
└── BuildEnv/ # CI/CD and build scripts
```
## Contributing
Contributions are welcome. Please read the [Contributing Guidelines](.github/CONTRIBUTING.markdown) and [Code of Conduct](.github/CODE_OF_CONDUCT.markdown) before submitting a pull request.
## License
This project is licensed under the MIT License — see [LICENSE.markdown](LICENSE.markdown) for details.
Copyright 2024 Gary Ash