refactor(web): migrate npm workflow to bun and modernize tooling

Author: brndnmtthws

.github/workflows/web.yml

@@ -25,13 +25,15 @@ jobs:
         uses: actions/setup-node@v5
         with:
           node-version: 18
-          cache: npm
-          cache-dependency-path: '**/package-lock.json'
-      - run: npm ci
+      - name: Use Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: 1.3.10
+      - run: bun install --frozen-lockfile
         working-directory: web
-      - run: npm run lint
+      - run: bun run lint
         working-directory: web
-      - run: npm run build --if-present
+      - run: bun run build
         working-directory: web
-      - run: npm run e2e:headless
+      - run: bun run e2e:headless
         working-directory: web

doc/README.md

@@ -1,27 +1,27 @@
 # Conky docs
 
-There are 3 YAML files which contain the documentation:
+There are three YAML files that contain the documentation:
 
-* [`variables.yaml`](variables.yaml): Documents each object/variable
-* [`config_settings.yaml`](config_settings.yaml): Documents global configuration settings
-* [`lua.yaml`](lua.yaml): Documents Conky's Lua API
+- [`variables.yaml`](variables.yaml): Documents each object or variable
+- [`config_settings.yaml`](config_settings.yaml): Documents global configuration settings
+- [`lua.yaml`](lua.yaml): Documents Conky's Lua API
 
-The `desc` field within the docs can be formatted with markdown, however _do
-not_ include headings within the `desc` fields, as it will mess up the man page
-output. In markdown, headings begin with `#`.
+The `desc` field within the docs can be formatted with Markdown; however, _do
+not_ include headings within `desc` fields, as that will break the man page
+output. In Markdown, headings begin with `#`.
 
 The supported documentation fields are:
 
-* `name`: the name of the thing
-* `desc`: a markdown-formatted description of the thing
-* `args`: optional list of arguments
-* `default`: an optional default value, if applicable
+- `name`: the name of the thing
+- `desc`: a markdown-formatted description of the thing
+- `args`: optional list of arguments
+- `default`: an optional default value, if applicable
 
 ## Updating docs
 
-The man page is based on [`man.md.j2`](man.md.j2) which is a Jinja2 template.
+The man page is based on [`man.md.j2`](man.md.j2), which is a Jinja2 template.
 The generated markdown is used to generate a final man page using
-[`pandoc`](https://pandoc.org/). Generating the final man page is a 2 step
+[`pandoc`](https://pandoc.org/). Generating the final man page is a two-step
 process:
 
 1. Run `render.py` to process `man.md.j2`:

doc/config_settings.yaml

@@ -11,32 +11,33 @@
 #  * `default`: an optional default value, if applicable
 ---
 desc: |-
-  This is a listing of global configuration options for Conky. These are placed
-  in the `conky.config` section of your configuration file, before `conky.text`.
+  This is a list of Conky's global configuration options. These belong in the
+  `conky.config` section of your configuration file, before `conky.text`.
 
   The default configuration file location is `~/.config/conky/conky.conf` or
   `${sysconfdir}/conky/conky.conf`. On most systems, `$sysconfdir` is `/etc`,
   and you can find the sample config file there in
   `/etc/conky/conky.conf`.
 
-  You might want to copy the default config to `~/.config/conky/conky.conf` and
-  then start modifying it. User configs can be found at
+  You may want to copy the default config to `~/.config/conky/conky.conf` and
+  modify it there. User configs can be found at
   https://github.com/brndnmtthws/conky/wiki/Configs.
 
-  Optional arguments are generally denoted with paretheses (i.e., `(optional)`).
+  Optional arguments are generally denoted with parentheses, for example
+  `(optional)`.
 values:
   - name: alignment
     desc: |-
-      Aligned position on screen, may be `none` or one of:
+      Screen alignment. May be `none` or one of:
 
       |                       |                         |                        |
       |:----------------------|:-----------------------:|-----------------------:|
       |`top_left` (or `tl`)   | `top_middle` (or `tm`)  |   `top_right` (or `tr`)|
       |`middle_left` (or `ml`)|`middle_middle` (or `mm`)|`middle_right` (or `mr`)|
       |`bottom_left` (or `bl`)|`bottom_middle` (or `bm`)|`bottom_right` (or `br`)|
 
-      In case of `panel` and `dock` [windows](#own_window_type), it might make more sense to use one
-      of the following aliases:
+      For `panel` and `dock` [windows](#own_window_type), it may be more useful
+      to use one of the following aliases:
 
       | Alias  |     Value     |
       |:------:|:-------------:|
@@ -48,10 +49,10 @@ values:
 
       See also [`gap_x`](#gap_x) and [`gap_y`](#gap_y) settings.
   - name: append_file
-    desc: Append the file given as argument.
+    desc: Append the file given as an argument.
   - name: background
     desc: |-
-      Boolean value, if true, Conky will be forked to background
+      Boolean value. If true, Conky will fork into the background
       when started.
   - name: border_inner_margin
     desc: |-
@@ -65,9 +66,9 @@ values:
     desc: Border width in pixels.
   - name: colorN
     desc: |-
-      Predefine a color for use inside conky.text segments.
-      Substitute N by a digit between 0 and 9, inclusively. When specifying
-      the color value in hex, omit the leading hash (#).
+      Predefine a color for use inside `conky.text` segments.
+      Replace `N` with a digit between 0 and 9, inclusive. When specifying
+      the color value in hex, omit the leading `#`.
   - name: console_bar_fill
     desc: 'A character to fill the console bars.'
     default: '#'
@@ -76,10 +77,10 @@ values:
     default: '.'
   - name: console_graph_ticks
     desc: |-
-      A comma-separated list of strings to use as the bars of a
-      graph output to console/shell. The first list item is used for the
-      minimum bar height and the last item is used for the maximum, e.g. \"
-      ,_,=,#\".
+      A comma-separated list of strings to use as the bars in a graph rendered
+      to the console or shell. The first list item is used for the minimum bar
+      height and the last item is used for the maximum, for example
+      `",_,=,#"`.
   - name: cpu_avg_samples
     desc: The number of samples to average for CPU monitoring.
   - name: default_bar_height
@@ -94,7 +95,7 @@ values:
       will be 10 for the text version of the bar.
     default: 0
   - name: default_color
-    desc: Default color and border color.
+    desc: Default text color and border color.
   - name: default_gauge_height
     desc: |-
       Specify a default height for gauges.

doc/lua.yaml

@@ -11,21 +11,21 @@
 #  * `default`: an optional default value, if applicable
 ---
 desc: |-
-  Conky features a Lua Programming API, and also ships with Lua bindings
+  Conky features a Lua programming API and also ships with Lua bindings
   for some useful libraries. Note that the bindings require tolua++.
 
-  To use Lua Conky, you first need to make sure you have a version of
+  To use Lua with Conky, first make sure you have a version of
   Conky with Lua support enabled (`conky -v` will report this).
-  Conky defines certain global functions and variables which can be
-  accessed from Lua code running in Conky. Scripts must first be loaded
-  using the lua_load configuration option. You then call functions in Lua
-  via Conky's $lua, $lua_read, and Lua hooks.
+  Conky defines certain global functions and variables that can be
+  accessed from Lua code running inside Conky. Scripts must first be loaded
+  using the `lua_load` configuration option. You can then call Lua functions
+  through Conky's `$lua`, `$lua_read`, and Lua hooks.
 
-  Be careful when creating threaded objects through the Lua API. You could
-  wind up with a whole bunch of threads running if a thread is created
+  Be careful when creating threaded objects through the Lua API. You could end
+  up with a large number of threads running if a thread is created
   with each iteration.
 
-  NOTE: In order to accommodate certain features in the cairo library's
+  Note: to accommodate certain features in the Cairo library's
   API, Conky will export a few additional functions for the creation of
   certain structures. These are documented below.
 values:
@@ -140,12 +140,11 @@ values:
       `tolua.takeownership(cte)`
   - name: conky_build_arch
     desc: |-
-      A string containing the build architecture for this
-      particular instance of Conky.
+      A string containing the build architecture for this Conky instance.
   - name: conky_build_info
     desc: |-
-      A string containing the build info for this particular
-      instance of Conky, including the version, build date, and
+      A string containing build information for this Conky instance, including
+      the version, build date, and
       architecture.
   - name: conky_config
     desc: |-
@@ -170,8 +169,7 @@ values:
       'number'.
   - name: conky_version
     desc: |-
-      A string containing the version of the current instance of
-      Conky.
+      A string containing the version of the current Conky instance.
   - name: conky_window
     desc: |-
       This table contains some information about Conky's window.
@@ -210,8 +208,8 @@ values:
 
   - name: cairo_text_hp_show(cr, x, y, text, font, font_size, alignment, language, script, direction)
     desc: |-
-      Renders text to a cairo_t using harfbuzz and freetype, this provides significantly
-      better text rendering then using cairo's inbuilt functions.
+      Renders text to a `cairo_t` using HarfBuzz and FreeType. This provides
+      significantly better text rendering than Cairo's built-in functions.
 
       | Argument            | Description                                                                          |
       |---------------------|--------------------------------------------------------------------------------------|

doc/variables.yaml

@@ -12,28 +12,30 @@
 ---
 desc: |-
   To configure what Conky displays, you must supply some variables in the
-  `conky.text` section of your configuration. In this secton you'll find a
+  `conky.text` section of your configuration. In this section you will find a
   listing of the available variables. Some of them may require build options to
   be enabled at compile time for them to work.
 
-  Colours are parsed using `XParseColor()`, there might be a list of them:
-  `/usr/share/X11/rgb.txt`. Colour can be also in `#rrggbb` format (hex).
+  Colors are parsed using `XParseColor()`. A list of named colors may be
+  available in `/usr/share/X11/rgb.txt`. Colors may also be specified in
+  `#rrggbb` hexadecimal format.
 
   Some objects may create threads, and sometimes these threads will not be
   destroyed until Conky terminates. There is no way to destroy or clean up
   threads while Conky is running. For example, if you use an MPD variable,
-  the MPD thread will keep running until Conky dies. Some threaded objects
-  will use one of the parameters as a `key`, so that you only have 1
+  the MPD thread will keep running until Conky exits. Some threaded objects
+  will use one of the parameters as a `key`, so that you only have one
   relevant thread running (for example, the $curl, and $rss
   objects launch one thread per URI).
 
-  Optional arguments are generally denoted with paretheses (i.e., `(optional)`).
+  Optional arguments are generally denoted with parentheses, for example
+  `(optional)`.
 values:
   - name: acpiacadapter
     desc: |-
-      ACPI AC adapter state. On linux, the adapter option
+      ACPI AC adapter state. On Linux, the adapter option
       specifies the subfolder of `/sys/class/power_supply` containing the state
-      information (tries `AC` and `ADP1` if there is no argument given).
+      information. Tries `AC` and `ADP1` if no argument is given.
       Non-linux systems ignore it.
     args:
       - (adapter)
@@ -58,7 +60,7 @@ values:
   - name: adt746xfan
     desc: Fan speed from therm_adt746x.
   - name: alignc
-    desc: Align text to centre.
+    desc: Align text to the center.
     args:
       - (num)
   - name: alignr
@@ -119,7 +121,7 @@ values:
   - name: apm_battery_time
     desc: |-
       Display remaining APM battery life in hh:mm:ss or "unknown"
-      if AC adapterstatus is on-line or charging. FreeBSD, OpenBSD only.
+      if AC adapter status is online or charging. FreeBSD and OpenBSD only.
   - name: audacious_bar
     desc: Progress bar.
     args:
@@ -137,7 +139,7 @@ values:
   - name: audacious_length_seconds
     desc: Total length of current tune in seconds.
   - name: audacious_main_volume
-    desc: The current volume fetched from Audacious.
+    desc: The current volume reported by Audacious.
   - name: audacious_playlist_length
     desc: Number of tunes in playlist.
   - name: audacious_playlist_position
@@ -157,7 +159,7 @@ values:
   - name: battery
     desc: |-
       Battery status and remaining percentage capacity of ACPI or
-      APM battery. ACPI battery number can be given as argument.
+      APM battery. An ACPI battery number may be given as an argument.
     default: BAT0
     args:
       - (num)
@@ -187,23 +189,23 @@ values:
   - name: battery_short
     desc: |-
       Battery status and remaining percentage capacity of ACPI or APM battery.
-      ACPI battery number can be given as argument. This mode display a short
-      status, which means that C is displayed instead of charging, D for
-      discharging, F for full, N for not present, E for empty and U for unknown.
+      An ACPI battery number may be given as an argument. This mode displays a
+      short status: `C` for charging, `D` for discharging, `F` for full, `N`
+      for not present, `E` for empty, and `U` for unknown.
     default: BAT0
     args:
       - (num)
   - name: battery_status
     desc: |-
-      Battery status for ACPI battery. ACPI battery number can be
-      given as arguments.
+      Battery status for an ACPI battery. An ACPI battery number may be given
+      as an argument.
     default: BAT0
     args:
       - (num)
   - name: battery_time
     desc: |-
       Battery charge/discharge time remaining of ACPI battery.
-      ACPI battery number can be given as argument.
+      An ACPI battery number may be given as an argument.
     default: BAT0
     args:
       - (num)
@@ -217,23 +219,23 @@ values:
     desc: Amount of memory cached.
   - name: cat
     desc: |-
-      Reads a file and displays the contents in conky. This is
+      Reads a file and displays its contents in Conky. This is
       useful if you have an independent process generating output that you
-      want to include in conky.
+      want to include in Conky.
     args:
       - file
   - name: catp
     desc: |-
-      Reads a file and displays the contents in conky. This is
+      Reads a file and displays its contents in Conky. This is
       useful if you have an independent process generating output that you
-      want to include in conky. This differs from $cat in that it parses the
+      want to include in Conky. This differs from `$cat` in that it parses the
       contents of the file, so you can insert things like
       `${color red}hi!${color}` in your file and have it correctly parsed by
       Conky.
     args:
       - file
   - name: cmdline_to_pid
-    desc: PID of the first process that has string in its commandline.
+    desc: PID of the first process whose command line contains the given string.
     args:
       - string
   - name: cmus_aaa