Doc: update JSON schema; make it more IDE friendly

This commit is contained in:
李通洲 2023-10-09 20:27:40 +08:00
parent ccbb252466
commit 42f6d029b0
No known key found for this signature in database
GPG Key ID: 6E72B663408769DE
2 changed files with 175 additions and 45 deletions

View File

@ -108,7 +108,7 @@ All categories not listed here should work without needing a specific implementa
##### Available Modules
```
Battery, Bios, Bluetooth, Board, Break, Brightness, Colors, Command, CPU, CPUUsage, Cursor, Custom, Date, DateTime, DE, Disk, Display, Font, Gamepad, GPU, Host, Icons, Kernel, LM, Locale, LocalIP, Media, Memory, Monitor, NetIO, OpenCL, OpenGL, OS, Packages, Player, Power Adapter, Processes, PublicIP, Separator, Shell, Sound, Swap, Terminal, Terminal Font, Terminal Size, Theme, Time, Title, Uptime, Version, Vulkan, Wallpaper, Weather, Wifi, WM, WMTheme
Battery, Bios, Bluetooth, Board, Break, Brightness, Colors, Command, CPU, CPUUsage, Cursor, Custom, Date, DateTime, DE, Disk, DiskIO, Display, Font, Gamepad, GPU, Host, Icons, Kernel, LM, Locale, LocalIP, Media, Memory, Monitor, NetIO, OpenCL, OpenGL, OS, Packages, Player, Power Adapter, Processes, PublicIP, Separator, Shell, Sound, Swap, Terminal, Terminal Font, Terminal Size, Theme, Time, Title, Uptime, Version, Vulkan, Wallpaper, Weather, Wifi, WM, WMTheme
```
##### Builtin logos

View File

@ -596,7 +596,6 @@
],
"properties": {
"type": {
"title": "Module type",
"type": "string"
}
},
@ -615,45 +614,159 @@
"title": "No additional properties",
"properties": {
"type": {
"enum": [
"bios",
"board",
"brightness",
"chassis",
"cpuusage",
"cursor",
"datetime",
"de",
"font",
"gamepad",
"host",
"icons",
"kernel",
"lm",
"locale",
"media",
"memory",
"monitor",
"opencl",
"os",
"packages",
"player",
"poweradapter",
"processes",
"shell",
"swap",
"terminal",
"terminalfont",
"terminalsize",
"theme",
"uptime",
"users",
"version",
"vulkan",
"wallpaper",
"wm",
"wifi",
"wmtheme"
"anyOf": [
{
"const": "bios",
"description": "Print BIOS name, version, release date, etc"
},
{
"const": "board",
"description": "Print mather board name and other info"
},
{
"const": "brightness",
"description": "Print brightness of your monitors"
},
{
"const": "chassis",
"description": "Print chassis type (desktop, laptop, etc)"
},
{
"const": "cpuusage",
"description": "Print CPU usage. Costs some time to collect data"
},
{
"const": "cursor",
"description": "Print cursor style name"
},
{
"const": "datetime",
"description": "Print current date and time"
},
{
"const": "de",
"description": "Print desktop environment name"
},
{
"const": "font",
"description": "Print system font name"
},
{
"const": "gamepad",
"description": "List connected gamepads"
},
{
"const": "host",
"description": "Print product name of your computer"
},
{
"const": "icons",
"description": "Print icon style name"
},
{
"const": "kernel",
"description": "Print system kernel version"
},
{
"const": "lm",
"description": "Print login manager (desktop manager) name and version"
},
{
"const": "locale",
"description": "Print system locale name"
},
{
"const": "media",
"description": "Print playing song name"
},
{
"const": "memory",
"description": "Print system memory usage info"
},
{
"const": "monitor",
"description": "Print connected physical monitor information"
},
{
"const": "opencl",
"description": "Print highest OpenCL version supported by the GPU"
},
{
"const": "os",
"description": "Print operating system name and version"
},
{
"const": "packages",
"description": "List installed package managers and count of installed packages"
},
{
"const": "player",
"description": "Print music player name"
},
{
"const": "poweradapter",
"description": "Print power adapter name and charging watts"
},
{
"const": "processes",
"description": "Count running processes"
},
{
"const": "shell",
"description": "Print current shell name and version"
},
{
"const": "swap",
"description": "Print swap (paging file) space usage"
},
{
"const": "terminal",
"description": "Print current terminal name and version"
},
{
"const": "terminalfont",
"description": "Print font name and size used by current terminal"
},
{
"const": "terminalsize",
"description": "Print current terminal size"
},
{
"const": "theme",
"description": "Print current theme information"
},
{
"const": "uptime",
"description": "Print system uptime"
},
{
"const": "users",
"description": "List users currently logged in"
},
{
"const": "version",
"description": "Print Fastfetch version"
},
{
"const": "vulkan",
"description": "Print highest Vulkan version supported by the GPU"
},
{
"const": "wallpaper",
"description": "Print image file path of current wallpaper"
},
{
"const": "wm",
"description": "Print window manager name and version"
},
{
"const": "wifi",
"description": "Print connected Wi-Fi info (SSID, connection and security protocol)"
},
{
"const": "wmtheme",
"description": "Print current theme of window manager"
}
]
},
"key": {
@ -675,7 +788,8 @@
"title": "Battery",
"properties": {
"type": {
"const": "battery"
"const": "battery",
"description": "Print battery capacity, status, etc"
},
"dir": {
"title": "The directory where the battery folders are. Standard: `/sys/class/power_supply/`. Linux only",
@ -705,6 +819,7 @@
"title": "Bluetooth",
"properties": {
"type": {
"description": "List bluetooth devices",
"const": "bluetooth"
},
"showDisconnected": {
@ -731,6 +846,7 @@
"title": "CPU",
"properties": {
"type": {
"description": "Print CPU name, frequency, etc",
"const": "cpu"
},
"temp": {
@ -764,6 +880,7 @@
"title": "Colors",
"properties": {
"type": {
"description": "Print some colored blocks",
"const": "colors"
},
"symbol": {
@ -791,6 +908,7 @@
"title": "Command",
"properties": {
"type": {
"description": "Running custom shell scripts",
"const": "command"
},
"shell": {
@ -818,9 +936,9 @@
},
{
"title": "Custom",
"description": "Print a custom string, with or without key",
"properties": {
"type": {
"description": "Print a custom string, with or without key",
"const": "custom"
},
"key": {
@ -847,6 +965,7 @@
"title": "Display",
"properties": {
"type": {
"description": "Print resolutions, refresh rates, etc",
"const": "display"
},
"compactType": {
@ -882,6 +1001,7 @@
"title": "Disk",
"properties": {
"type": {
"description": "Print partitions, space usage, disk type, etc",
"const": "disk"
},
"folders": {
@ -934,9 +1054,10 @@
"additionalProperties": false
},
{
"title": "Physical disk throughput (usage)",
"title": "DiskIO",
"properties": {
"type": {
"description": "Print physical disk I/O throughput",
"const": "diskio"
},
"namePrefix": {
@ -962,6 +1083,7 @@
"title": "GPU",
"properties": {
"type": {
"description": "Print GPU names, graphic memory size, type, etc",
"const": "gpu"
},
"temp": {
@ -1002,6 +1124,7 @@
"title": "Local IP",
"properties": {
"type": {
"description": "List local IP addresses (v4 or v6), MAC addresses, etc",
"const": "localip"
},
"showIpv4": {
@ -1054,9 +1177,10 @@
"additionalProperties": false
},
{
"title": "Network throughput (usage)",
"title": "NetIO",
"properties": {
"type": {
"description": "Print network I/O throughput",
"const": "netio"
},
"namePrefix": {
@ -1087,6 +1211,7 @@
"title": "OpenGL",
"properties": {
"type": {
"description": "Print highest OpenGL version supported by the GPU",
"const": "opengl"
},
"library": {
@ -1118,6 +1243,7 @@
"title": "Public IP",
"properties": {
"type": {
"description": "Print your public IP address, etc",
"const": "publicip"
},
"url": {
@ -1151,6 +1277,7 @@
"title": "Separator",
"properties": {
"type": {
"description": "Print a separator line",
"const": "separator"
},
"string": {
@ -1165,6 +1292,7 @@
"title": "Sound",
"properties": {
"type": {
"description": "Print sound devices, volume, etc",
"const": "sound"
},
"soundType": {
@ -1196,6 +1324,7 @@
"title": "Title",
"properties": {
"type": {
"description": "Print title, which contains your user name, hostname",
"const": "title"
},
"fqdn": {
@ -1240,6 +1369,7 @@
"title": "Weather",
"properties": {
"type": {
"description": "Print weather information",
"const": "weather"
},
"location": {