Skip to content

refactor: rename title -> name, author -> developer #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 11 additions & 21 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ the Coco AI app.

## Extension Files Hierarchy

The structure is straightforward. The top-level directory represents the extension author,
described by the `author.json` file. Authors can customize their profile picture, which
The structure is straightforward. The top-level directory represents the extension developer,
described by the `developer.json` file. Developers can customize their profile picture, which
should be placed in the `assets` directory.

Extensions created by the author are also placed there. Each extension resides in its own
sub-directory, with a structure similar to the author directory: an `assets` folder for
Extensions created by the developer are also placed there. Each extension resides in its own
sub-directory, with a structure similar to the developer directory: an `assets` folder for
extension-specific resources and a `plugin.json` file that describes the extension.

```sh
extensions/
└── AUTHOR_ID/
└── DEVELOPER_ID/
├── assets/
├── author.json
├── developer.json
├── EXTENSION_1/
│ ├── assets/
│ └── plugin.json
Expand All @@ -29,13 +29,12 @@ extensions/
└── ...
```

## Author Configuration (`author.json`)
## developer Configuration (`developer.json`)

Every author has a metadata file that describes their information:
Every developer has a metadata file that describes their information:

```json
{
"id": "infinilabs",
"name": "INFINI Labs",
"avatar": "avatar.png",
"twitter_handle": "infinilabs",
Expand All @@ -49,13 +48,12 @@ Every author has a metadata file that describes their information:

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `id` | string | **Yes** | Unique identifier for the author |
| `name` | string | **Yes** | Display name of the author |
| `name` | string | **Yes** | Display name of the developer |
| `avatar` | string | **Yes** | **Relative** path to the profile picture under the `assets` directory |
| `twitter_handle` | string | No | Twitter/X username |
| `github_handle` | string | No | GitHub username |
| `location` | string | No | Author's location |
| `website` | string | No | Author's website URL |
| `location` | string | No | developer's location |
| `website` | string | No | developer's website URL |
| `bio` | string | No | Short biography or description |

## Extension Configuration (`plugin.json`)
Expand All @@ -65,14 +63,6 @@ and configuration needed to run the extension.

### Extension JSON specification


* `id`: Extension ID. This ID doesn't uniquely identify an extension; its bundle
ID (ID & author) does.

type: string

required: **Yes**

* `title`: Extension display name

type: string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"id": "infinilabs",
"name": "INFINI Labs",
"avatar": "avatar.png",
"twitter_handle": "infinilabs",
Expand Down
6 changes: 1 addition & 5 deletions extensions/infinilabs/empty_trash/plugin.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"id": "empty_trash",
"title": "Empty Trash",
"name": "Empty Trash",
"description": "...",
"icon": "icon.png",
"type": "command",
Expand All @@ -12,9 +11,6 @@
"osascript -e 'try' -e 'tell application \"Finder\" to empty' -e 'end try'"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
}
13 changes: 6 additions & 7 deletions extensions/infinilabs/screenshot/plugin.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
{
"id": "screenshot",
"title": "Screenshot",
"name": "Screenshot",
"description": "...",
"icon": "icon.png",
"type": "extension",
"platforms": ["macos"],
"commands": [
{
"id": "capture_screen",
"title": "Capture Screen",
"name": "Capture Screen",
"description": "...",
"icon": "icon.png",
"type": "command",
Expand All @@ -23,7 +22,7 @@
},
{
"id": "capture_area",
"title": "Capture Area",
"name": "Capture Area",
"description": "...",
"icon": "icon.png",
"type": "command",
Expand All @@ -38,7 +37,7 @@
},
{
"id": "capture_window",
"title": "Capture Window",
"name": "Capture Window",
"description": "...",
"icon": "icon.png",
"type": "command",
Expand All @@ -53,7 +52,7 @@
},
{
"id": "capture_to_clipboard",
"title": "Capture to Clipboard",
"name": "Capture to Clipboard",
"description": "...",
"icon": "icon.png",
"type": "command",
Expand All @@ -68,7 +67,7 @@
},
{
"id": "capture_windows_to_clipboard",
"title": "Capture Window to Clipboard",
"name": "Capture Window to Clipboard",
"description": "...",
"icon": "icon.png",
"type": "command",
Expand Down
55 changes: 11 additions & 44 deletions extensions/infinilabs/system_settings/plugin.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"id": "system_settings",
"title": "System Settings",
"name": "System Settings",
"platforms": [
"macos"
],
Expand All @@ -10,7 +9,7 @@
"commands": [
{
"id": "general",
"title": "General",
"name": "General",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -20,15 +19,12 @@
"x-apple.systempreferences:com.apple.preferences.general"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
},
{
"id": "wifi",
"title": "Wi-Fi",
"name": "Wi-Fi",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -38,15 +34,12 @@
"x-apple.systempreferences:com.apple.wifi-settings-extension"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
},
{
"id": "storage",
"title": "Storage",
"name": "Storage",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -56,15 +49,12 @@
"x-apple.systempreferences:com.apple.settings.Storage"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
},
{
"id": "wallpaper",
"title": "Wallpaper",
"name": "Wallpaper",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -74,15 +64,12 @@
"x-apple.systempreferences:com.apple.Wallpaper-Settings.extension"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
},
{
"id": "trackpad",
"title": "Trackpad",
"name": "Trackpad",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -92,15 +79,12 @@
"x-apple.systempreferences:com.apple.preference.trackpad"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
},
{
"id": "keyboard",
"title": "Keyboard",
"name": "Keyboard",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -110,15 +94,12 @@
"x-apple.systempreferences:com.apple.preference.keyboard"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
},
{
"id": "bluetooth",
"title": "Bluetooth",
"name": "Bluetooth",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -128,15 +109,12 @@
"x-apple.systempreferences:com.apple.BluetoothSettings"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
},
{
"id": "displays",
"title": "Displays",
"name": "Displays",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -146,15 +124,12 @@
"x-apple.systempreferences:com.apple.preference.displays"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
},
{
"id": "dock",
"title": "Dock",
"name": "Dock",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -164,15 +139,12 @@
"x-apple.systempreferences:com.apple.preference.dock"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
},
{
"id": "sound",
"title": "Sound",
"name": "Sound",
"description": "...",
"icon": "icon_settings.png",
"type": "command",
Expand All @@ -182,14 +154,9 @@
"x-apple.systempreferences:com.apple.preference.sound"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
}
],
"scripts": null,
"quicklinks": null,
"enabled": true
}
6 changes: 1 addition & 5 deletions extensions/infinilabs/uuid_generator/plugin.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"id": "uuid_generator",
"title": "UUID Generator",
"name": "UUID Generator",
"platforms": [
"macos"
],
Expand All @@ -14,9 +13,6 @@
"uuidgen | pbcopy"
]
},
"commands": null,
"scripts": null,
"quicklinks": null,
"alias": "",
"enabled": true
}
Loading