Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update variable and function names #5

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Conversation

ss-o
Copy link
Member

@ss-o ss-o commented Dec 19, 2023

✨ Updates codebase following current zsh plugin standard.


Breaking change:

Enable ZUI demos only if ZUI[DEMOS] is set before loading the plugin, i.e.: typeset -A ZUI; ZUI[DEMOS]=1


🆙 This change updates variable and function names in the files stdlib.lzui, utillib.lzui, and zui.plugin.zsh. The updates include changing the names from using underscores to using hyphens, following a more consistent naming convention throughout the codebase.

☑️ By updating the names, the codebase becomes more readable and adheres to best practices. This change also improves maintainability, as the code is now more self-explanatory. There are no significant consequences or considerations resulting from this change.

Resolves: #4

ss-o added 2 commits December 19, 2023 03:01
… and zui.plugin.zsh

Breaking change:

Enable ZUI demos only if ZUI[DEMOS] is set, i.e.: typeset -A ZUI; ZUI[DEMOS]=1

This change updates variable and function names in the files stdlib.lzui, utillib.lzui, and zui.plugin.zsh. The updates include changing the names from using underscores to using hyphens, following a more consistent naming convention throughout the codebase.

By updating the names, the codebase becomes more readable and adheres to best practices. This change also improves maintainability, as the code is now more self-explanatory. There are no significant consequences or considerations resulting from this change.

Resolves: #4
Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
- Updated the `.editorconfig` file to include `*.lzui` file extension with a consistent indent style and size of 2.
- Created new files `.github/.cspell/project-ignored.txt` and `.github/.cspell/project-words.txt` to ignore specific words in code spell checking.
- Added a new GitHub Actions workflow for syncing labels.
- Updated the GitHub Actions workflow for trunk checks, removing a weekend schedule.
- Added a new `.trunk/.gitignore` file to customize what files are ignored by Trunk.
- Renamed and relocated the `.markdownlint.yaml` configuration file.
- Added a new `.trunk/configs/.yamllint.yaml` configuration file for Yamllint.
- Updated

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
@ss-o ss-o added breaking-change 💥 A change that changes the API or breaks backward compatibility for users. fix ⚡ Has been fixed and is therefore considered resolved. plugin ⚙️ Related with plugin labels Dec 19, 2023
@ss-o ss-o self-assigned this Dec 19, 2023
ss-o and others added 10 commits December 19, 2023 03:21
The link in the README has been fixed to point to the correct location in the wiki.

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
Signed-off-by: Sall <sall@w-ss.io>
This commit enhances the ZUI standard library initialization by refactoring the code in `stdlib.lzui`. The changes introduce consistency in the variable naming conventions, fix a typo, and optimize the code structure.

The improvements ensure that ZUI applications have better readability and maintainability.
No issues

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
This commit adds a new GitHub Actions workflow named "Zsh" to perform continuous integration for Zsh files in the repository. The workflow is triggered on push events to the "main" branch and for tags following the "v*.*.*" pattern. It also runs on pull requests that modify Zsh files or files in the "functions" directory. The workflow consists of two jobs:

1. "zsh-matrix": This job sets up a matrix of Zsh files based on the files in the repository. It uses the `find` command combined with `jq` to identify and set the Zsh files for the matrix.
2. "zsh-n": This job runs the Zsh linter (`zsh -n`) and the Zsh compiler (`zcompile`) for each file in the matrix created by the previous job.

This new workflow will help ensure the quality and correctness of Zsh files in the repository, providing early feedback on potential issues. It will promote better code reliability and maintainability in Zsh scripts.

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
error handling

This change updates the terminal reattachment logic and error handling in the `zui-usetty-wrapper` function. The code now checks for the availability of a terminal and handles cases where there is no terminal or `/dev/tty` is not present. It also correctly restores the file descriptor state after running the command. These improvements ensure robustness and prevent potential errors when reattaching to the terminal.

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
@ss-o ss-o force-pushed the fix-zui-functions branch from 22e8b51 to 327a9c0 Compare December 20, 2023 23:09
ss-o added 2 commits December 28, 2023 06:02
The commit adds new ignored words and files
to improve spell checking accuracy.

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
@ss-o ss-o force-pushed the fix-zui-functions branch from e5f763c to 5eaaf6a Compare December 28, 2023 06:39
This refactor improves the indentation structure and readability. It enhances maintainability and makes it easier to comprehend the rendering process.

Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
@ss-o ss-o force-pushed the fix-zui-functions branch from 5eaaf6a to 0e23194 Compare December 28, 2023 07:23
Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
@ss-o ss-o force-pushed the fix-zui-functions branch from 0e5a510 to fae4237 Compare December 28, 2023 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change 💥 A change that changes the API or breaks backward compatibility for users. fix ⚡ Has been fixed and is therefore considered resolved. plugin ⚙️ Related with plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[bug]: ZUI Functions are not added to $fpath when used with Oh My Zsh (OMZ)
2 participants