Skip to content

Commit

Permalink
Merge pull request #239 from CelticBoozer/development
Browse files Browse the repository at this point in the history
ci: add cspell workflow and configs
  • Loading branch information
CelticBoozer authored Oct 14, 2024
2 parents 14e615d + 4c99d8d commit 5d58220
Show file tree
Hide file tree
Showing 12 changed files with 155 additions and 42 deletions.
4 changes: 2 additions & 2 deletions .bin/.github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This directory contains scripts that allow me to automate some of my work.

- **backup-configs.sh** - copies the cofiguration files in .system-config-backup,
- **backup-configs.sh** - copies the configuration files in .system-config-backup,
which are not in $XDG_CONFIG but in other places like /etc. The script is
automatically started by the pacman hook 95-backup-configs.hook. This script
requires your customization: change **celtic** to **<your_user_name>**.
Expand All @@ -17,7 +17,7 @@ This directory contains scripts that allow me to automate some of my work.
configuration of the system. Before running it, you need to copy this repo to
the $HOME, install arch linux, git and have internet access. This script
requires your customization: change **celtic** to **<your_user_name>**.
- **maintenance.sh** - performs some frequent maintenence tasks on my system.
- **maintenance.sh** - performs some frequent maintenance tasks on my system.
zsh alias - maint.
- **power-menu.sh** - allows me to control system reboot, shutdown, hibernation,
etc with rofi.
Expand Down
2 changes: 1 addition & 1 deletion .config/easyeffects/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# EasyEfects
# EasyEffects

[EasyEffects](https://github.com/wwmm/easyeffects/) is a powerful audio processing
application, allows users to apply various effects.
Expand Down
2 changes: 1 addition & 1 deletion .config/kanshi/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# kanshi

I use [kanshi](https://sr.ht/~emersion/kanshi/) for convenient multiscreen
I use [kanshi](https://sr.ht/~emersion/kanshi/) for convenient multi-screen
operation and easy switching in case of configuration changes.

It currently works in two modes.
Expand Down
64 changes: 32 additions & 32 deletions .config/kitty/.github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,35 @@ You can execute kitty, using the Win+Return hotkey.
I tried to configure the hotkeys in the style of my sway configuration and
added some vim-like hotkeys.

| Function | Hotkey |
|--------------------------|---------------------|
| mod | ctrl+shift |
| Copy text to clipboab | mod+Shift+c |
| Paste text from clipboab | mod+Shift+v |
| Scroll line up | mod+up, mod+k |
| Scroll line down | mod+down, mod+j |
| Scroll page up | mod+page_up |
| Scroll page down | mod+page_down |
| Scroll home | mod+home |
| Scroll end | mod+end |
| Show last command output | mod+g |
| New window | mod+enter |
| Close window | mod+w |
| Next window | mod+] |
| Previous window | mod+[ |
| Resize window | mod+r |
| Go to window [0-9] | mod+[0-9] |
| New tab | mod+t |
| Next tab | ctrl+tab |
| Previous tab | mod+tab |
| Close tab | mod+q |
| Move tab forward | mod+. |
| Move tab backward | mod+, |
| Set tab title | mod+l |
| Go to tab [0-9] | ctrl+alt+[0-9] |
| Increase font size | mod+equal, mod+plus |
| Reduce font size | mod+minus |
| Reset font size | mod+backspace |
| Edit config file | mod+f2 |
| Reload config file | mod+f5 |
| Debug config | mod+f6 |
| Function | Hotkey |
|---------------------------|---------------------|
| mod | ctrl+shift |
| Copy text to clipboard | mod+Shift+c |
| Paste text from clipboard | mod+Shift+v |
| Scroll line up | mod+up, mod+k |
| Scroll line down | mod+down, mod+j |
| Scroll page up | mod+page_up |
| Scroll page down | mod+page_down |
| Scroll home | mod+home |
| Scroll end | mod+end |
| Show last command output | mod+g |
| New window | mod+enter |
| Close window | mod+w |
| Next window | mod+] |
| Previous window | mod+[ |
| Resize window | mod+r |
| Go to window [0-9] | mod+[0-9] |
| New tab | mod+t |
| Next tab | ctrl+tab |
| Previous tab | mod+tab |
| Close tab | mod+q |
| Move tab forward | mod+. |
| Move tab backward | mod+, |
| Set tab title | mod+l |
| Go to tab [0-9] | ctrl+alt+[0-9] |
| Increase font size | mod+equal, mod+plus |
| Reduce font size | mod+minus |
| Reset font size | mod+backspace |
| Edit config file | mod+f2 |
| Reload config file | mod+f5 |
| Debug config | mod+f6 |
4 changes: 2 additions & 2 deletions .config/sway/.github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[Sway](https://github.com/swaywm/sway/) Window Manager is a tiling window manager
and a drop-in replacement for i3, built specifically for the Wayland display
server. I chose it because of: lightweight, tiling, customization, minimalizm.
server. I chose it because of: lightweight, tiling, customization, minimalism.

![sway](sway-full.png "Sway")

Expand Down Expand Up @@ -45,7 +45,7 @@ Files list:
| Layout container stacking | mod+s |
| Layout container tabbed | mod+w |
| Layout container in current split mode | mod+e |
| Fullscreen container | mod+f |
| Full-screen container | mod+f |
| Make container floating | mod+Shift+space |
| Reload sway config | mod+Shift+c |
| Focus between floating and not | mod+space |
Expand Down
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ community looks forward to your contributions. 🎉
- [I Want To Contribute](#i-want-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Styleguides](#styleguides)
- [Style guides](#style-guides)
- [Commit Messages](#commit-messages)
- [Code style](#code-style)

Expand Down Expand Up @@ -150,7 +150,7 @@ and [Discussions](https://github.com/CelticBoozer/dotfiles/discussions/).
You may also want to point out the other projects that solved it better and
which could serve as inspiration.

## Styleguides
## Style guides

### Commit Messages

Expand Down
2 changes: 1 addition & 1 deletion .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ All the info about my setup.
| **File manager** | [yazi](https://github.com/sxyazi/yazi/) [:gear:](../.config/yazi/) |
| **Fuzzy file finder** | [fzf](https://github.com/junegunn/fzf/) |
| **Fuzzy word finder** | [ripgrep](https://github.com/BurntSushi/ripgrep/) |
| **Cheatsheet tool** | [navi](https://github.com/denisidoro/navi) |
| **Cheat sheet tool** | [navi](https://github.com/denisidoro/navi) |
| **Git TUI** | [lazygit](https://github.com/jesseduffield/lazygit/) |
| **Docker TUI** | [lazydocker](https://github.com/jesseduffield/lazydocker/) |
| **Trash CLI** | [glib2](https://archlinux.org/packages/core/x86_64/glib2) (gio trash) |
Expand Down
14 changes: 14 additions & 0 deletions .github/cspell/cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
"version": "0.2",
"language": "en",
"ignoreRegExpList": ["/<[^>]*>/", "/&[a-z]+;/", "/`.*`/"],
"dictionaryDefinitions": [
{
"name": "repo_soft",
"path": "repo_soft.txt",
"addWords": true
}
],
"dictionaries": ["en_US", "softwareTerms", "repo_soft"]
}
59 changes: 59 additions & 0 deletions .github/cspell/repo_soft.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
pacman
cliphist
rofi
maint
sysupg
btop
waybar
fontconfig
kanshi
neofetch
acenoster
backlighting
paru
drun
swappy
touchpad
keybind
keybinds
full-screen
swaylock
swayidle
swaync
sworkstyle
swaybar
wttrbar
wttr
pulseaudio
pulsemixer
easyeffects
nmtui
sysz
pacnew
wlroots
swayosd
yazi
keymap
zathura
neovim
traceback
shellcheck
yamlfmt
gruvbox
pipewire
ohmyzsh
advcpmv
navi
lazygit
lazygit
vesktop
krita
wallpappers
nvim
greetd
tuigreet
lazydocker
aurpkglist
pkglist
logind
Aenami
39 changes: 39 additions & 0 deletions .github/workflows/cspell.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: cspell
# yamllint disable-line rule:truthy
on:
push:
branches:
- master
- development
pull_request:
branches:
- master
jobs:
check:
name: Spellcheck project
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: cspell run
uses: streetsidesoftware/cspell-action@v6
with:
# files: |
# *.md
# .*.md
# **.md
# .*/*.md
# .*/**/.*.md
files: "**/*.md"
check_dot_files: true
suggestions: false
# Limit the files checked to the ones in the pull request or push.
incremental_files_only: true
# Path to `cspell.json`
config: '.github/cspell/cspell.json'
# Log progress and other information during the action execution.
# Default: false
verbose: false
# Use the `files` setting found in the CSpell configuration instead of `input.files`.
use_cspell_files: false
2 changes: 1 addition & 1 deletion .system-config-backup/.github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ in the home directory. It also contains lists of installed packages.
version of electron.
- *94-check-pacnew.hook* - searches for .pacnew files and reports if any are
present.
- *95-backup-configs.hook* - copies the cofiguration files in .system-config-backup.
- *95-backup-configs.hook* - copies the configuration files in .system-config-backup.
- *96-build-nnn.hook* - clones and builds nnn with a flag to support icons.
- **reflector** - contains the configuration of the reflector.
- **systemd** - contains the configuration of the logind.
Expand Down
1 change: 1 addition & 0 deletions .system-config-backup/aurpkglist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ gruvbox-material-icon-theme-git
hide-client
intellij-idea-community-edition-jre
lazydocker
nodejs-cspell
paru
paru-debug
pkgtools
Expand Down

0 comments on commit 5d58220

Please sign in to comment.