feat: add ports.yml schema & add info to conform to the schema (#1814)

pull/1/head
winston 2 years ago committed by GitHub
parent 1554c9f4c3
commit 8527ff6288
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,116 @@
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/catppuccin/catppuccin/main/resources/ports.schema.json",
"type": "object",
"additionalProperties": false,
"patternProperties": {
"[A-Za-z0-9_\\-]": {
"$id": "#ports/port",
"title": "Port",
"type": "object",
"description": "The GitHub repository name of the port.",
"examples": ["nvim"],
"required": ["category", "name", "platform"],
"properties": {
"name": {
"$id": "#ports/port/name",
"title": "Name",
"description": "The Name of the software the port is for",
"type": "string",
"examples": ["Neovim"]
},
"category": {
"$id": "#ports/port/category",
"title": "Category",
"type": "string",
"enum": [
"browser",
"browser_extension",
"cli",
"code_editor",
"development",
"leisure",
"library",
"messaging",
"note_taking",
"productivity",
"search_engine",
"social",
"system",
"terminal"
],
"examples": ["editor"]
},
"platform": {
"$id": "#ports/port/platform",
"title": "Platform",
"description": "The platforms the port supports. Either an array of supported operating systems, \"agnostic\" (indicating support for all platforms), or \"userstyle\".",
"oneOf": [
{
"type": "array",
"items": {
"$id": "#ports/port/platform/os",
"title": "Operating Systems",
"type": "string",
"enum": [
"android",
"ios",
"linux",
"macos",
"windows"
],
"examples": [
["linux", "macos", "windows"],
["android", "ios"]
]
}
},
{
"type": "string",
"enum": ["agnostic", "userstyle"]
}
]
},
"color": {
"$id": "#ports/port/color",
"title": "Color",
"description": "The fill color for the icon on the website",
"type": "string",
"enum": [
"rosewater",
"flamingo",
"pink",
"mauve",
"red",
"maroon",
"peach",
"yellow",
"green",
"teal",
"sky",
"sapphire",
"blue",
"lavender",
"text"
],
"examples": ["pink"]
},
"icon": {
"$id": "#ports/port/icon",
"title": "Icon",
"description": "The icon to use on the website. This should be the same name as the SVG file on https://simpleicons.org/. If a `.svg` suffix is present, it's taken from the local website repository resources.",
"type": "string",
"examples": ["neovim", "neovim.svg"]
},
"userstyle": {
"$id": "#ports/port/userstyle",
"title": "Userstyle",
"description": "Whether the port is a userstyle",
"type": "boolean",
"examples": [true]
}
}
}
}
}

@ -1,412 +1,820 @@
alacritty: alacritty:
name: Alacritty
category: terminal
color: peach color: peach
os: [linux, macos, windows] platform: [linux, macos, windows]
alfred: alfred:
name: Alfred
category: productivity
color: mauve color: mauve
os: [macos] platform: [macos]
aliucord: aliucord:
os: [android] name: Aliucord
category: messaging
platform: [android]
amfora: amfora:
os: [linux, macos, windows] name: Amfora
category: leisure
platform: [linux, macos, windows]
anilist: anilist:
name: AniList
category: leisure
platform: userstyle
color: blue color: blue
anki: anki:
name: Anki
category: productivity
platform: agnostic
icon: anki.svg icon: anki.svg
color: blue color: blue
base16: base16:
name: Base16
category: system
platform: agnostic
bat: bat:
name: bat
category: cli
platform: [linux, macos, windows]
icon: bat.svg icon: bat.svg
os: [linux, macos, windows]
bento: bento:
name: Bento
category: productivity
platform: agnostic
binary-ninja: binary-ninja:
os: [linux, macos, windows] name: Binary Ninja
category: code_editor
platform: [linux, macos, windows]
bitburner: bitburner:
os: [linux, macos, windows] name: BitBurner
category: leisure
platform: [linux, macos, windows]
blackbox: blackbox:
os: [linux] name: Black Box
category: terminal
platform: [linux]
blink: blink:
os: [ios] name: Blink
category: terminal
platform: [ios]
blockbench: blockbench:
os: [linux, macos, windows] name: Blockbench
category: leisure
platform: [linux, macos, windows]
bottom: bottom:
os: [linux, macos, windows] name: bottom
category: cli
platform: [linux, macos, windows]
brave-search: brave-search:
name: Brave Search
category: productivity
platform: userstyle
icon: brave icon: brave
color: peach color: peach
btop: btop:
os: [linux, macos] name: Btop++
category: cli
platform: [linux, macos]
cava: cava:
os: [linux, macos] name: C.A.V.A.
category: cli
platform: [linux, macos]
chrome: chrome:
name: Google Chrome
category: browser
platform: [linux, macos, windows]
icon: googlechrome icon: googlechrome
color: yellow color: yellow
os: [linux, macos, windows]
cinny: cinny:
os: [linux] name: Cinny
category: messaging
platform: [linux]
codeberg: codeberg:
name: Codeberg
category: productivity
platform: userstyle
codemirror: codemirror:
name: CodeMirror
category: development
platform: agnostic
conky: conky:
os: [linux] name: Conky
category: system
platform: [linux]
contour: contour:
os: [linux, macos, windows] name: Contour
category: terminal
platform: [linux, macos, windows]
crt: crt:
os: [linux, macos] name: 'CRT: cool-retro-term'
category: terminal
platform: [linux, macos]
cursors: cursors:
name: Cursors
category: system
platform: [linux]
icon: cursors.svg icon: cursors.svg
os: [linux]
cutter: cutter:
os: [linux, macos, windows] name: Cutter
category: code_editor
platform: [linux, macos, windows]
dark-reader: dark-reader:
name: Dark Reader
category: browser_extension
platform: agnostic
icon: darkreader icon: darkreader
color: red color: red
deepl: deepl:
name: DeepL
category: productivity
platform: userstyle
discord: discord:
name: Discord
category: messaging
platform: [linux, macos, windows]
color: blue color: blue
os: [linux, macos, windows]
dmenu: dmenu:
os: [linux] name: dmenu
category: system
platform: [linux]
duckduckgo: duckduckgo:
name: DuckDuckGo
category: productivity
platform: userstyle
color: peach color: peach
dunst: dunst:
os: [linux] name: Dunst
category: system
platform: [linux]
dwarf-fortress: dwarf-fortress:
os: [linux, macos, windows] name: Dwarf Fortress
category: leisure
platform: [linux, macos, windows]
element: element:
os: [linux, macos, windows] name: Element
category: leisure
platform: [linux, macos, windows]
elk: elk:
name: Elk
category: social
platform: agnostic
emacs: emacs:
name: Emacs
category: code_editor
platform: [linux, macos, windows]
icon: gnuemacs icon: gnuemacs
color: mauve color: mauve
os: [linux, macos, windows]
enmity: enmity:
os: [ios] name: Enmity
category: messaging
platform: [ios]
fcitx5: fcitx5:
os: [linux] name: fcitx5
category: system
platform: [linux]
firefox: firefox:
name: Firefox
category: browser
platform: [linux, macos, windows]
color: red color: red
os: [linux, macos, windows]
fish: fish:
name: Fish
category: cli
platform: [linux, macos]
icon: fish.svg icon: fish.svg
color: green color: green
os: [linux, macos]
floris-board: floris-board:
os: [android] name: FlorisBoard
category: system
platform: [android]
foliate: foliate:
os: [linux] name: Foliate
category: productivity
platform: [linux]
foot: foot:
os: [linux] name: foot
category: terminal
platform: [linux]
fzf: fzf:
os: [linux, macos] name: fzf
category: cli
platform: [linux, macos]
geany: geany:
os: [linux] name: Geany
category: code_editor
platform: [linux]
gedit: gedit:
os: [linux] name: Gedit
category: code_editor
platform: [linux]
github: github:
name: GitHub
category: productivity
platform: userstyle
color: text color: text
github-readme-stats: github-readme-stats:
name: GitHub Readme Stats
category: social
platform: agnostic
color: text color: text
github-readme-tech-stack: github-readme-tech-stack:
name: GitHub Readme Tech Stack
category: social
platform: agnostic
color: text color: text
gitui: gitui:
name: GitUI
category: cli
platform: [linux, macos]
icon: gitui.svg icon: gitui.svg
os: [linux, macos]
glamour: glamour:
os: [linux, macos] name: Glamour
category: cli
platform: [linux, macos]
gnome-terminal: gnome-terminal:
name: GNOME Terminal
category: terminal
platform: [linux]
color: text color: text
icon: gnometerminal icon: gnometerminal
go: go:
name: Go
category: library
platform: agnostic
grub: grub:
name: GRUB
category: system
platform: [linux]
icon: gnu icon: gnu
color: text color: text
os: [linux]
gtk: gtk:
name: GTK
category: system
platform: [linux]
color: green color: green
os: [linux]
hacker-news: hacker-news:
name: Hacker News
category: social
platform: userstyle
icon: ycombinator icon: ycombinator
helix: helix:
os: [linux, macos, windows] name: Helix
category: code_editor
platform: [linux, macos, windows]
hexchat: hexchat:
name: HexChat
category: messaging
platform: [linux, windows]
icon: hexchat.svg icon: hexchat.svg
color: peach color: peach
os: [linux, windows]
highlightjs: highlightjs:
name: Highlight.js
category: development
platform: agnostic
home-assistant: home-assistant:
name: Home Assistant
category: leisure
platform: agnostic
icon: homeassistant icon: homeassistant
hyper: hyper:
name: Hyper
category: terminal
platform: [linux, macos, windows]
color: text color: text
os: [linux, macos, windows]
hyprland: hyprland:
os: [linux] name: Hyprland
category: system
platform: [linux]
i3: i3:
name: i3/sway
category: system
platform: [linux]
color: text color: text
icon: i3wm.svg icon: i3wm.svg
os: [linux]
ichi.moe: ichi.moe:
name: ichi.moe
category: productivity
platform: userstyle
infinity: infinity:
name: Infinity for Reddit
category: social
platform: [android]
icon: reddit icon: reddit
color: peach color: peach
insomnia: insomnia:
name: Insomnia
category: development
platform: [android]
color: blue color: blue
os: [android]
invidious: invidious:
name: Invidious
category: social
platform: userstyle
icon: youtube icon: youtube
color: red color: red
iterm: iterm:
name: iTerm2
category: terminal
platform: [macos]
icon: iterm2 icon: iterm2
color: green color: green
os: [macos]
jetbrains: jetbrains:
name: JetBrains
category: code_editor
platform: [linux, macos, windows]
color: text color: text
os: [linux, macos, windows]
joplin: joplin:
name: joplin
category: note_taking
platform: [linux, macos, windows]
color: blue color: blue
os: [linux, macos, windows]
k9s: k9s:
name: k9s
category: cli
platform: [linux, macos]
icon: kubernetes icon: kubernetes
color: blue color: blue
os: [linux, macos]
Kvantum: Kvantum:
os: [linux] name: Kvantum
category: system
platform: [linux]
kakoune: kakoune:
os: [linux, macos] name: Kakoune
category: code_editor
platform: [linux, macos]
kde: kde:
name: KDE
category: system
platform: [linux]
color: blue color: blue
os: [linux]
kitty: kitty:
name: Kitty
category: terminal
platform: [linux, macos]
icon: kitty.svg icon: kitty.svg
color: green color: green
os: [linux, macos]
konsole: konsole:
name: Konsole
category: terminal
platform: [linux]
icon: kde icon: kde
color: blue color: blue
os: [linux]
lapce: lapce:
os: [linux, macos, windows] name: Lapce
category: code_editor
platform: [linux, macos, windows]
lastfm: lastfm:
name: Last.fm
category: leisure
platform: userstyle
icon: lastdotfm icon: lastdotfm
color: red color: red
lazygit: lazygit:
name: Lazygit
category: cli
platform: [linux, macos]
color: green color: green
libreddit: libreddit:
name: Libreddit
category: social
platform: userstyle
icon: reddit icon: reddit
color: peach color: peach
lxqt: lxqt:
name: LxQT
category: system
platform: [linux]
icon: lxqt.svg icon: lxqt.svg
color: sky color: sky
os: [linux]
mailspring: mailspring:
os: [linux, macos, windows] name: Mailspring
category: productivity
platform: [linux, macos, windows]
mako: mako:
os: [linux] name: Mako
category: system
platform: [linux]
mastodon: mastodon:
name: Mastodon
category: social
platform: userstyle
mattermost: mattermost:
name: Mattermost
category: messaging
platform: agnostic
mc: mc:
os: [linux, macos] name: Midning Commander
category: cli
platform: [linux, macos]
mdBook: mdBook:
name: mdBook
category: development
platform: agnostic
icon: mdbook icon: mdbook
micro: micro:
name: Micro
category: code_editor
platform: [linux, macos, windows]
icon: micro.svg icon: micro.svg
os: [linux, macos, windows]
minecraft: minecraft:
os: [linux, macos, windows] name: Minecraft
category: leisure
platform: [linux, macos, windows]
modrinth: modrinth:
name: Modrinth
category: leisure
platform: userstyle
color: green color: green
monkeytype: monkeytype:
name: monkeytype
category: leisure
platform: userstyle
icon: monkeytype.svg icon: monkeytype.svg
color: text color: text
neomutt: neomutt:
os: [linux, macos] name: NeoMutt
category: cli
platform: [linux, macos]
newsboat: newsboat:
os: [linux, macos] name: Newsboat
category: cli
platform: [linux, macos]
nighttab: nighttab:
name: Nighttab
category: browser_extension
platform: agnostic
nitter: nitter:
name: Nitter
category: social
platform: userstyle
icon: twitter icon: twitter
color: blue color: blue
noir: noir:
os: [ios] name: Noir
category: browser_extension
platform: [ios]
notepad-plus-plus: notepad-plus-plus:
name: Notepad++
category: code_editor
platform: [windows]
icon: notepadplusplus icon: notepadplusplus
color: green color: green
os: [windows]
nova: nova:
os: [macos] name: Nova
category: code_editor
platform: [macos]
nvim: nvim:
name: Neovim
category: code_editor
platform: [linux, macos, windows]
icon: neovim icon: neovim
color: green color: green
os: [linux, macos, windows]
obs: obs:
name: OBS Studio
category: productivity
platform: [linux, macos, windows]
icon: obsstudio icon: obsstudio
os: [linux, macos, windows]
obsidian: obsidian:
name: Obsidian
category: note_taking
platform: [linux, macos, windows]
color: mauve color: mauve
os: [linux, macos, windows]
pantone: pantone:
name: Pantone
category: library
platform: agnostic
papirus-folders: papirus-folders:
name: Papirus Folders
category: system
platform: [linux]
icon: folders.svg icon: folders.svg
os: [linux]
plank: plank:
os: [linux] name: Plank
category: system
platform: [linux]
plymouth: plymouth:
os: [linux] name: Plymouth
category: system
platform: [linux]
polybar: polybar:
os: [linux] name: Polybar
category: system
platform: [linux]
prismlauncher: prismlauncher:
os: [linux, macos, windows] name: Prism Launcher
category: leisure
platform: [linux, macos, windows]
proton: proton:
name: Proton
category: productivity
platform: userstyle
icon: protonmail icon: protonmail
color: lavender color: lavender
pyradio: pyradio:
os: [linux, macos, windows] name: PyRadio
category: leisure
platform: [linux, macos, windows]
python: python:
name: Python
category: library
platform: agnostic
qt5ct: qt5ct:
os: [linux] name: qt5ct
category: system
platform: [linux]
qutebrowser: qutebrowser:
name: qutebrowser
category: browser
platform: [linux, macos, windows]
icon: qutebrowser.svg icon: qutebrowser.svg
os: [linux, macos, windows]
qterminal: qterminal:
name: QTerminal
category: terminal
platform: [linux]
icon: lxqt.svg icon: lxqt.svg
color: sky color: sky
os: [linux]
rboard: rboard:
name: Rboard
category: system
platform: [android]
color: blue color: blue
icon: gboard.svg icon: gboard.svg
regolith: regolith:
os: [linux] name: Regolith Desktop
category: system
platform: [linux]
remnote: remnote:
name: Remnote
category: note_taking
platform: agnostic
revolt: revolt:
name: Revolt
category: messaging
platform: [linux, macos, windows]
icon: revoltdotchat icon: revoltdotchat
os: [linux, macos, windows]
rofi: rofi:
os: [linux] name: Rofi
category: system
platform: [linux]
rust: rust:
name: Rust
category: library
platform: agnostic
sc-im: sc-im:
name: sc-im
category: cli
platform: [linux, macos]
sddm: sddm:
os: [linux] name: SDDM
category: system
platform: [linux]
SearXNG: SearXNG:
name: SearXNG
category: search_engine
platform: userstyle
sharex: sharex:
os: [windows] name: ShareX
category: productivity
platform: [windows]
sideberry: sideberry:
name: Sideberry
category: browser_extension
platform: agnostic
slack: slack:
name: Slack
category: messaging
platform: agnostic
spicetify: spicetify:
name: Spicetify
category: leisure
platform: [linux, macos, windows]
color: green color: green
icon: spotify icon: spotify
os: [linux, macos, windows]
spotify-player: spotify-player:
name: spotify-player
category: leisure
platform: [linux, macos, windows]
color: green color: green
icon: spotify icon: spotify
os: [linux, macos, windows]
spotify-tui: spotify-tui:
name: spotify-tui
category: leisure
platform: [linux, macos, windows]
color: green color: green
icon: spotify icon: spotify
os: [linux, macos, windows]
spyder: spyder:
name: spyder
category: code_editor
platform: [linux, macos, windows]
icon: spyderide icon: spyderide
color: red color: red
os: [linux, macos, windows]
st: st:
os: [linux] name: st
category: terminal
platform: [linux]
stable-diffusion-web-ui: stable-diffusion-web-ui:
os: [linux, macos, windows] name: Stable Diffusion WebUI
category: leisure
platform: userstyle
startpage: startpage:
name: Startpage
category: search_engine
platform: agnostic
steam: steam:
name: Steam
category: leisure
platform: [linux, macos, windows]
color: blue color: blue
os: [linux, macos, windows]
sublime-text: sublime-text:
name: Sublime Text
category: code_editor
platform: [linux, macos, windows]
color: yellow color: yellow
icon: sublimetext icon: sublimetext
os: [linux, macos, windows]
sumatra-pdf: sumatra-pdf:
os: [windows] name: SumatraPDF
category: productivity
platform: [windows]
tabby: tabby:
os: [linux, macos, windows] name: Tabby
category: terminal
platform: [linux, macos, windows]
tailwindcss: tailwindcss:
name: Tailwind CSS
category: development
platform: agnostic
color: sky color: sky
telegram: telegram:
name: Telegram
category: messaging
platform: agnostic
color: blue color: blue
terminator: terminator:
os: [linux] name: Terminator
category: terminal
platform: [linux]
Terminal.app: Terminal.app:
os: [macos] name: Terminal.app
category: terminal
platform: [macos]
termux: termux:
os: [android] name: Termux
category: terminal
platform: [android]
thelounge: thelounge:
name: The Lounge
category: messaging
platform: agnostic
thunderbird: thunderbird:
name: Thunderbird
category: productivity
platform: [linux, macos, windows]
color: blue color: blue
os: [linux, macos, windows]
tilix: tilix:
os: [linux] name: Tilix
category: terminal
platform: [linux]
tmux: tmux:
name: tmux
category: cli
platform: [linux, macos]
color: green color: green
os: [linux, macos]
tty: tty:
os: [linux] name: tty
tym: category: system
platform: [linux]
tutanota: tutanota:
name: Tutanota
category: productivity
platform: userstyle
color: red color: red
tym:
name: tym
category: terminal
platform: [linux]
ui: ui:
name: UI
category: library
platform: agnostic
icon: react icon: react
color: sky color: sky
ulauncher: ulauncher:
os: [linux] name: Ulauncher
category: system
platform: [linux]
unreal-engine: unreal-engine:
name: Unreal Engine
category: development
platform: [linux, macos, windows]
icon: unrealengine icon: unrealengine
color: blue color: blue
os: [linux, macos, windows]
urxvt: urxvt:
os: [linux] name: Urxvt
category: terminal
platform: [linux]
vercel: vercel:
name: Vercel
category: development
platform: userstyle
vim: vim:
name: Vim
category: code_editor
platform: [linux, macos, windows]
color: green color: green
os: [linux, macos, windows]
vimium: vimium:
name: Vimium
category: browser_extension
platform: agnostic
visual-studio: visual-studio:
name: Visual Studio
category: code_editor
platform: [windows]
icon: visualstudio icon: visualstudio
os: [windows]
vivaldi: vivaldi:
name: Vivaldi
category: browser
platform: [linux, macos, windows]
color: peach color: peach
vscode: vscode:
name: Visual Studio Code
category: code_editor
platform: [linux, macos, windows]
color: blue color: blue
icon: visualstudiocode icon: visualstudiocode
os: [linux, macos, windows]
warp: warp:
os: [macos] name: Warp
category: terminal
platform: [macos]
waybar: waybar:
os: [linux] name: waybar
category: system
platform: [linux]
wezterm: wezterm:
name: WezTerm
category: terminal
platform: [linux, macos, windows]
icon: wezterm.svg icon: wezterm.svg
os: [linux, macos, windows]
whoogle: whoogle:
name: Whoogle
category: search_engine
platform: userstyle
wikiwand: wikiwand:
name: WikiWand
category: productivity
platform: userstyle
icon: wikipedia icon: wikipedia
windows-files: windows-files:
name: Windows Files
category: system
platform: [windows]
icon: windows-files.svg icon: windows-files.svg
color: yellow color: yellow
os: [windows]
windows-terminal: windows-terminal:
name: Windows Terminal
category: terminal
platform: [windows]
icon: windowsterminal icon: windowsterminal
color: text color: text
os: [windows]
xcode: xcode:
name: Xcode
category: code_editor
platform: [macos]
color: blue color: blue
os: [macos]
xfce4-terminal: xfce4-terminal:
name: Xfce4 Terminal
category: terminal
platform: [linux]
icon: xfce.svg icon: xfce.svg
os: [linux]
xresources: xresources:
name: Xresources
category: system
platform: [linux]
icon: xdotorg icon: xdotorg
os: [linux]
youtube: youtube:
name: YouTube
category: social
platform: userstyle
color: red color: red
youtubemusic: youtubemusic:
name: YouTube Musics
category: leisure
platform: userstyle
color: red
zathura: zathura:
name: Zathura
category: productivity
platform: [linux]
icon: zathura.svg icon: zathura.svg
os: [linux]
zellij: zellij:
name: Zellij
category: cli
platform: [linux, macos]
icon: zellij.svg icon: zellij.svg
os: [linux, macos]
zsh-syntax-highlighting: zsh-syntax-highlighting:
os: [linux, macos] name: zsh-syntax-highlighting
category: cli
platform: [linux, macos]
zutty: zutty:
os: [linux] name: Zutty
category: terminal
platform: [linux]
# yaml-language-server: $schema=https://raw.githubusercontent.com/catppuccin/catppuccin/main/resources/ports.schema.json

Loading…
Cancel
Save