improving the looks and docs of network-vpn #346
Conversation
📝 WalkthroughWalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant network_vpn.sh
participant System (tun0 interface)
User->>network_vpn.sh: Run script with (or without) verbose flag
network_vpn.sh->>System (tun0 interface): Check for VPN IP
alt VPN IP detected
alt Verbose mode enabled
network_vpn.sh->>User: Output label + VPN IP address
else Verbose mode disabled
network_vpn.sh->>User: Output label only
end
else No VPN IP detected
network_vpn.sh->>User: (No VPN output)
end
✨ Finishing Touches
🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/CONFIG.md (1)
518-529: Tighten wording and fix macOS casing/apostrophe issuesMinor copy-editing will make this paragraph read more professionally:
-This widget tries to display whether a vpn is connected. -Tailscale exit nodes are fully supported for Linux and MacOS. - -Set verbose to true in order to see the VPNs IP or name of Tailscale exit node. +This widget tries to display whether a VPN is connected. +Tailscale exit nodes are fully supported on Linux and macOS. + +Set `@dracula-network-vpn-verbose` to `true` to see the VPN’s IP address or the +name of the Tailscale exit node.Besides the grammar tweaks (
VPN’s,macOS, avoid “in order to”), this keeps terminology and option names consistent with the neighbouring examples.scripts/network_vpn.sh (1)
23-29: Remove duplication by fetching the label once
get_tmux_optionis executed twice even though the option value never changes inside the branch. A tiny refactor improves readability and avoids an extra tmux call:- if $verbose; then - vpn_label=$(get_tmux_option "@dracula-network-vpn-label" " ") - echo "$vpn_label$vpn" - else - vpn_label=$(get_tmux_option "@dracula-network-vpn-label" "VPN-ON") - echo "$vpn_label" - fi + vpn_label=$(get_tmux_option "@dracula-network-vpn-label" " ") + if $verbose; then + echo "${vpn_label}${vpn}" + else + echo "${vpn_label}" + fi(The default icon is preserved; users can still override it via the option.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/CONFIG.md(1 hunks)scripts/network_vpn.sh(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/CONFIG.md
[grammar] ~519-~519: The operating system from Apple is written “macOS”.
Context: ...nodes are fully supported for Linux and MacOS. Set verbose to true in order to see t...
(MAC_OS)
[style] ~521-~521: Consider a more concise word here.
Context: ...r Linux and MacOS. Set verbose to true in order to see the VPNs IP or name of Tailscale ex...
(IN_ORDER_TO_PREMIUM)
No description provided.