zedfrigg/ironbar
1
0
Fork 0
mirror of https://github.com/Zedfrigg/ironbar.git synced 2025-07-01 18:51:04 +02:00
Code Activity

refactor(sys_info): use snake_case for module tokens for consistency

Browse source 
BREAKING CHANGE: This renames the module from `sys-info` to `sys_info`, and almost every formatting token from `kebab-case` to `snake_case`. Any use of this module will need to be updated.
This commit is contained in:
Jake Stanger 2022-11-28 22:23:33 +00:00
parent 0fb5fa8c2a
commit df77020c52
No known key found for this signature in database
GPG key ID: C51FC8F9CB0BEA61
3 changed files with 71 additions and 71 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/_Sidebar.md
View file

@ -17,6 +17,6 @@
- [Launcher](launcher) - [Launcher](launcher)
- [MPD](mpd) - [MPD](mpd)
- [Script](script) - [Script](script)
- [Sys-info](sys-info) - [Sys_Info](sys-info)
- [Tray](tray) - [Tray](tray)
- [Workspaces](workspaces) - [Workspaces](workspaces)

100
docs/Sys-Info.md → docs/modules/Sys-Info.md
View file

@ -8,7 +8,7 @@ Pango markup is supported.
## Configuration ## Configuration
> Type: `sys-info` > Type: `sys_info`
| Name | Type | Default | Description | | Name | Type | Default | Description |
|--------------------|--------------------|---------|--------------------------------------------------------------------------------------------------------------------------------| |--------------------|--------------------|---------|--------------------------------------------------------------------------------------------------------------------------------|
@ -28,12 +28,12 @@ Pango markup is supported.
"end": [ "end": [
{ {
"format": [ "format": [
" {cpu-percent}% | {temp-c:k10temp-Tccd1}°C", " {cpu_percent}% | {temp_c:k10temp_Tccd1}°C",
" {memory-used} / {memory-total} GB ({memory-percent}%)", " {memory_used} / {memory_total} GB ({memory_percent}%)",
"| {swap-used} / {swap-total} GB ({swap-percent}%)", "| {swap_used} / {swap_total} GB ({swap_percent}%)",
" {disk-used:/} / {disk-total:/} GB ({disk-percent:/}%)", " {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)",
"李 {net-down:enp39s0} / {net-up:enp39s0} Mbps", "李 {net_down:enp39s0} / {net_up:enp39s0} Mbps",
"猪 {load-average:1} | {load-average:5} | {load-average:15}", "猪 {load_average:1} | {load_average:5} | {load_average:15}",
" {uptime}" " {uptime}"
], ],
"interval": { "interval": {
@ -43,7 +43,7 @@ Pango markup is supported.
"networks": 3, "networks": 3,
"temps": 5 "temps": 5
}, },
"type": "sys-info" "type": "sys_info"
} }
] ]
} }
@ -56,14 +56,14 @@ Pango markup is supported.
```toml ```toml
[[end]] [[end]]
type = 'sys-info' type = 'sys_info'
format = [ format = [
' {cpu-percent}% | {temp-c:k10temp-Tccd1}°C', ' {cpu_percent}% | {temp_c:k10temp_Tccd1}°C',
' {memory-used} / {memory-total} GB ({memory-percent}%)', ' {memory_used} / {memory_total} GB ({memory_percent}%)',
'| {swap-used} / {swap-total} GB ({swap-percent}%)', '| {swap_used} / {swap_total} GB ({swap_percent}%)',
' {disk-used:/} / {disk-total:/} GB ({disk-percent:/}%)', ' {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)',
'李 {net-down:enp39s0} / {net-up:enp39s0} Mbps', '李 {net_down:enp39s0} / {net_up:enp39s0} Mbps',
'猪 {load-average:1} | {load-average:5} | {load-average:15}', '猪 {load_average:1} | {load_average:5} | {load_average:15}',
' {uptime}', ' {uptime}',
] ]
@ -85,20 +85,20 @@ temps = 5
```yaml ```yaml
end: end:
- format: - format:
-  {cpu-percent}% | {temp-c:k10temp-Tccd1}°C - ' {cpu_percent}% | {temp_c:k10temp_Tccd1}°C'
-  {memory-used} / {memory-total} GB ({memory-percent}%) - ' {memory_used} / {memory_total} GB ({memory_percent}%)'
- '| {swap-used} / {swap-total} GB ({swap-percent}%)' - '| {swap_used} / {swap_total} GB ({swap_percent}%)'
-  {disk-used:/} / {disk-total:/} GB ({disk-percent:/}%) - ' {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)'
- 李 {net-down:enp39s0} / {net-up:enp39s0} Mbps - '李 {net_down:enp39s0} / {net_up:enp39s0} Mbps'
- 猪 {load-average:1} | {load-average:5} | {load-average:15} - '猪 {load_average:1} | {load_average:5} | {load_average:15}'
-  {uptime} - ' {uptime}'
interval: interval:
cpu: 1 cpu: 1
disks: 300 disks: 300
memory: 30 memory: 30
networks: 3 networks: 3
temps: 5 temps: 5
type: sys-info type: sys_info
``` ```
</details> </details>
@ -110,7 +110,7 @@ end:
{ {
end = [ end = [
{ {
type = "sys-info" type = "sys_info"
interval.memory = 30 interval.memory = 30
interval.cpu = 1 interval.cpu = 1
@ -119,12 +119,12 @@ end:
interval.networks = 3 interval.networks = 3
format = [ format = [
" {cpu-percent}% | {temp-c:k10temp-Tccd1}°C" " {cpu_percent}% | {temp_c:k10temp_Tccd1}°C"
" {memory-used} / {memory-total} GB ({memory-percent}%)" " {memory_used} / {memory_total} GB ({memory_percent}%)"
"| {swap-used} / {swap-total} GB ({swap-percent}%)" "| {swap_used} / {swap_total} GB ({swap_percent}%)"
" {disk-used:/} / {disk-total:/} GB ({disk-percent:/}%)" " {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)"
"李 {net-down:enp39s0} / {net-up:enp39s0} Mbps" "李 {net_down:enp39s0} / {net_up:enp39s0} Mbps"
"猪 {load-average:1} | {load-average:5} | {load-average:15}" "猪 {load_average:1} | {load_average:5} | {load_average:15}"
" {uptime}" " {uptime}"
] ]
} }
@ -141,31 +141,31 @@ The following tokens can be used in the `format` configuration option:
| Token | Description | | Token | Description |
|--------------------------|------------------------------------------------------------------------------------| |--------------------------|------------------------------------------------------------------------------------|
| **CPU** | | | **CPU** | |
| `{cpu-percent}` | Total CPU utilisation percentage | | `{cpu_percent}` | Total CPU utilisation percentage |
| **Memory** | | | **Memory** | |
| `{memory-free}` | Memory free in GB. | | `{memory_free}` | Memory free in GB. |
| `{memory-used}` | Memory used in GB. | | `{memory_used}` | Memory used in GB. |
| `{memory-total}` | Memory total in GB. | | `{memory_total}` | Memory total in GB. |
| `{memory-percent}` | Memory utilisation percentage. | | `{memory_percent}` | Memory utilisation percentage. |
| `{swap-free}` | Swap free in GB. | | `{swap_free}` | Swap free in GB. |
| `{swap-used}` | Swap used in GB. | | `{swap_used}` | Swap used in GB. |
| `{swap-total}` | Swap total in GB. | | `{swap_total}` | Swap total in GB. |
| `{swap-percent}` | Swap utilisation percentage. | | `{swap_percent}` | Swap utilisation percentage. |
| **Temperature** | | | **Temperature** | |
| `{temp-c:[sensor]}` | Temperature in degrees C. Replace `[sensor]` with the sensor label. | | `{temp_c:[sensor]}` | Temperature in degrees C. Replace `[sensor]` with the sensor label. |
| `{temp-f:[sensor]}` | Temperature in degrees F. Replace `[sensor]` with the sensor label. | | `{temp_f:[sensor]}` | Temperature in degrees F. Replace `[sensor]` with the sensor label. |
| **Disk** | | | **Disk** | |
| `{disk-free:[mount]}` | Disk free space in GB. Replace `[mount]` with the disk mountpoint. | | `{disk_free:[mount]}` | Disk free space in GB. Replace `[mount]` with the disk mountpoint. |
| `{disk-used:[mount]}` | Disk used space in GB. Replace `[mount]` with the disk mountpoint. | | `{disk_used:[mount]}` | Disk used space in GB. Replace `[mount]` with the disk mountpoint. |
| `{disk-total:[mount]}` | Disk total space in GB. Replace `[mount]` with the disk mountpoint. | | `{disk_total:[mount]}` | Disk total space in GB. Replace `[mount]` with the disk mountpoint. |
| `{disk-percent:[mount]}` | Disk utilisation percentage. Replace `[mount]` with the disk mountpoint. | | `{disk_percent:[mount]}` | Disk utilisation percentage. Replace `[mount]` with the disk mountpoint. |
| **Network** | | | **Network** | |
| `{net-down:[adapter]}` | Average network download speed in Mbps. Replace `[adapter]` with the adapter name. | | `{net_down:[adapter]}` | Average network download speed in Mbps. Replace `[adapter]` with the adapter name. |
| `{net-up:[adapter]}` | Average network upload speed in Mbps. Replace `[adapter]` with the adapter name. | | `{net_up:[adapter]}` | Average network upload speed in Mbps. Replace `[adapter]` with the adapter name. |
| **System** | | | **System** | |
| `{load-average:1}` | 1-minute load average. | | `{load_average:1}` | 1-minute load average. |
| `{load-average:5}` | 5-minute load average. | | `{load_average:5}` | 5-minute load average. |
| `{load-average:15}` | 15-minute load average. | | `{load_average:15}` | 15-minute load average. |
| `{uptime}` | System uptime formatted as `HH:mm`. | | `{uptime}` | System uptime formatted as `HH:mm`. |
## Styling ## Styling

40
src/modules/sysinfo.rs
View file

@ -293,19 +293,19 @@ fn refresh_memory_tokens(format_info: &mut HashMap<String, String>, sys: &mut Sy
let memory_percent = actual_used_memory as f64 / total_memory as f64 * 100.0; let memory_percent = actual_used_memory as f64 / total_memory as f64 * 100.0;
format_info.insert( format_info.insert(
String::from("memory-free"), String::from("memory_free"),
(bytes_to_gigabytes(available_memory)).to_string(), (bytes_to_gigabytes(available_memory)).to_string(),
); );
format_info.insert( format_info.insert(
String::from("memory-used"), String::from("memory_used"),
(bytes_to_gigabytes(actual_used_memory)).to_string(), (bytes_to_gigabytes(actual_used_memory)).to_string(),
); );
format_info.insert( format_info.insert(
String::from("memory-total"), String::from("memory_total"),
(bytes_to_gigabytes(total_memory)).to_string(), (bytes_to_gigabytes(total_memory)).to_string(),
); );
format_info.insert( format_info.insert(
String::from("memory-percent"), String::from("memory_percent"),
format!("{:0>2.0}", memory_percent), format!("{:0>2.0}", memory_percent),
); );
@ -313,19 +313,19 @@ fn refresh_memory_tokens(format_info: &mut HashMap<String, String>, sys: &mut Sy
let total_swap = sys.total_swap(); let total_swap = sys.total_swap();
format_info.insert( format_info.insert(
String::from("swap-free"), String::from("swap_free"),
(bytes_to_gigabytes(sys.free_swap())).to_string(), (bytes_to_gigabytes(sys.free_swap())).to_string(),
); );
format_info.insert( format_info.insert(
String::from("swap-used"), String::from("swap_used"),
(bytes_to_gigabytes(used_swap)).to_string(), (bytes_to_gigabytes(used_swap)).to_string(),
); );
format_info.insert( format_info.insert(
String::from("swap-total"), String::from("swap_total"),
(bytes_to_gigabytes(total_swap)).to_string(), (bytes_to_gigabytes(total_swap)).to_string(),
); );
format_info.insert( format_info.insert(
String::from("swap-percent"), String::from("swap_percent"),
format!("{:0>2.0}", used_swap as f64 / total_swap as f64 * 100.0), format!("{:0>2.0}", used_swap as f64 / total_swap as f64 * 100.0),
); );
} }
@ -337,7 +337,7 @@ fn refresh_cpu_tokens(format_info: &mut HashMap<String, String>, sys: &mut Syste
let cpu_percent = cpu_info.cpu_usage(); let cpu_percent = cpu_info.cpu_usage();
format_info.insert( format_info.insert(
String::from("cpu-percent"), String::from("cpu_percent"),
format!("{:0>2.0}", cpu_percent), format!("{:0>2.0}", cpu_percent),
); );
} }
@ -350,8 +350,8 @@ fn refresh_temp_tokens(format_info: &mut HashMap<String, String>, sys: &mut Syst
let key = component.label().replace(' ', "-"); let key = component.label().replace(' ', "-");
let temp = component.temperature(); let temp = component.temperature();
format_info.insert(format!("temp-c:{key}"), format!("{temp:.0}")); format_info.insert(format!("temp_c:{key}"), format!("{temp:.0}"));
format_info.insert(format!("temp-f:{key}"), format!("{:.0}", c_to_f(temp))); format_info.insert(format!("temp_f:{key}"), format!("{:.0}", c_to_f(temp)));
} }
} }
@ -371,22 +371,22 @@ fn refresh_disk_tokens(format_info: &mut HashMap<String, String>, sys: &mut Syst
let used = total - available; let used = total - available;
format_info.insert( format_info.insert(
format!("disk-free:{key}"), format!("disk_free:{key}"),
bytes_to_gigabytes(available).to_string(), bytes_to_gigabytes(available).to_string(),
); );
format_info.insert( format_info.insert(
format!("disk-used:{key}"), format!("disk_used:{key}"),
bytes_to_gigabytes(used).to_string(), bytes_to_gigabytes(used).to_string(),
); );
format_info.insert( format_info.insert(
format!("disk-total:{key}"), format!("disk_total:{key}"),
bytes_to_gigabytes(total).to_string(), bytes_to_gigabytes(total).to_string(),
); );
format_info.insert( format_info.insert(
format!("disk-percent:{key}"), format!("disk_percent:{key}"),
format!("{:0>2.0}", used as f64 / total as f64 * 100.0), format!("{:0>2.0}", used as f64 / total as f64 * 100.0),
); );
} }
@ -402,12 +402,12 @@ fn refresh_network_tokens(
for (iface, network) in sys.networks() { for (iface, network) in sys.networks() {
format_info.insert( format_info.insert(
format!("net-down:{iface}"), format!("net_down:{iface}"),
format!("{:0>2.0}", bytes_to_megabits(network.received()) / interval), format!("{:0>2.0}", bytes_to_megabits(network.received()) / interval),
); );
format_info.insert( format_info.insert(
format!("net-up:{iface}"), format!("net_up:{iface}"),
format!( format!(
"{:0>2.0}", "{:0>2.0}",
bytes_to_megabits(network.transmitted()) / interval bytes_to_megabits(network.transmitted()) / interval
@ -420,15 +420,15 @@ fn refresh_system_tokens(format_info: &mut HashMap<String, String>, sys: &System
// no refresh required for these tokens // no refresh required for these tokens
let load_average = sys.load_average(); let load_average = sys.load_average();
format_info.insert(String::from("load-average:1"), load_average.one.to_string()); format_info.insert(String::from("load_average:1"), load_average.one.to_string());
format_info.insert( format_info.insert(
String::from("load-average:5"), String::from("load_average:5"),
load_average.five.to_string(), load_average.five.to_string(),
); );
format_info.insert( format_info.insert(
String::from("load-average:15"), String::from("load_average:15"),
load_average.fifteen.to_string(), load_average.fifteen.to_string(),
); );