[Release] HSTR 3.2.0

.github/copilot-instructions.md

@@ -0,0 +1,58 @@
+# Copilot instructions
+
+This document provides instructions to the copilot AI assistants and agents.
+
+## General instructions
+
+- Write beautiful code.
+- Handle for errors, and exceptions and corner cases.
+- Do good and don't be evil.
+
+## Functional architecture instructions
+
+- This repository is a repo of a TUI based application for the completion from the Bash or Zsh history.
+
+## Technology stack instructions
+
+- Frontend: ncurses.
+- Backend: C.
+
+## Backend code instructions
+
+- Application backend is written in C.
+- Always start comments you generate with lowercase letter.
+
+## Security instructions
+
+- ALWAYS follow security best practices.
+- NEVER log form data that may contain sensitive information.
+- ALWAYS consider overflow and memory corruption issues when writing C code.
+
+## Backend code quality instructions
+
+- NEVER use hacks or workarounds to make tests pass - always write clean, production-quality code.
+- NEVER modify production code with ugly hacks just to make tests work - fix tests properly or remove them.
+- ALWAYS follow clean code principles.
+
+## Frontend instructions
+
+- Application frontend is written in NCurses.
+
+## Test instructions
+
+- Test code is stored in the `tests/src` directory.
+- Use `valgrind` to check for memory leaks and memory corruption issues after code changes.
+- Tests can be run with `cd build && make test`.
+- Write backend tests for all bugs being fixed.
+- Use https://github.com/ThrowTheSwitch/Unity framework for testing.
+- Each test (function) is structured into 3 sections: // GIVEN, // WHEN, and // THEN. // GIVEN section prepares the data, // WHEN section performs the actual test, and // THEN section asserts, checks and prints the results.
+- Use `DONE` instead of emoji character ✓ (do not use emoji/unicode characters, use the text inside)
+
+## Build instructions
+
+- The project is built with `automake` and `make`.
+- You can use `cd build && make build` to build the project.
+
+## Documentation instructions
+
+- ALWAY document new features in the man page located in the `man/` directory.

.github/workflows/build_ubuntu.yml

@@ -4,14 +4,14 @@ on: [push]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
         with:
           submodules: recursive
 
-      - name: Install packages
-        run: sudo apt-get update && sudo apt install -y build-essential qt5-default qt5-qmake ccache libncursesw5-dev libreadline-dev
+      - name: Install packages for Ubuntu 24.04
+        run: sudo apt-get update && sudo apt install -y build-essential qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools ccache libncursesw5-dev libreadline-dev
 
       - name: Build lib and run unit tests using Unity test framework
         run: cd test && qmake hstr-unit-tests.pro && make clean all && ./hstr-unit-tests

.gitignore

@@ -1,19 +1,24 @@
 /autom4te.cache/
 /aclocal.m4
+/confdefs.h
 /compile
 /config.guess
 /config.log
 /config.status
 /config.sub
 /configure
+/configure~
 /depcomp
 /install-sh
 /missing
 /src/hstr
 /src/hh
 .deps/
 .vscode
-Makefile
+/Makefile
+/man/Makefile
+/src/Makefile
+/test/Makefile
 Makefile.in
 *.o
 *.pro.user
@@ -32,3 +37,4 @@ test/hstr-unit-tests
 /hstr.pro.user*
 *.stash
 *.save
+/.vibe

CONFIGURATION.md

@@ -1,5 +1,5 @@
 # Configuration
-Get most of HSTR by configuring it with:
+Get the most out of HSTR by configuring it with:
 
 ```bash
 # bash
@@ -147,7 +147,7 @@ To show the prompt at the bottom of the screen (instead at the top) use:
 export HSTR_CONFIG=prompt-bottom
 ```
 
-To show the basic help and history help labels on the opposite site (instead of next to the prompt) use:
+To show the basic help and history help labels on the opposite side (instead of next to the prompt) use:
 
 ```bash
 export HSTR_CONFIG=help-on-opposite-side
@@ -213,8 +213,8 @@ export HSTR_CONFIG=duplicates
 ```
 
 ### Static favorites
-Last selected favorite command is put the head of favorite commands list
-by default. If you want to disable this behavior and make favorite
+Last selected favorite command is put at the head of the favorite commands list
+by default. If you want to disable this behavior and make the favorite
 commands list static, then use the following configuration:
 
 ```bash
@@ -238,7 +238,7 @@ to `HSTR_CONFIG` environment variable:
 export HSTR_CONFIG=blacklist
 ```
 
-Commands to be stored in `~/.hstr_blacklist` file with trailing empty line. For instance:
+Commands are to be stored in `~/.hstr_blacklist` file with a trailing empty line. For instance:
 
 ```
 cd
@@ -293,7 +293,7 @@ export HSTR_CONFIG=keywords-matching,hicolor,debug
 ```
 
 ## Bash History Settings
-Use the following `bash` settings to get most out of HSTR.
+Use the following `bash` settings to get the most out of HSTR.
 
 Increase the size of history maintained by `bash` - variables defined below 
 increase the number of history items and history file size (default value is 500):
@@ -331,4 +331,4 @@ If you use `zsh`, set `HISTFILE` environment variable in `~/.zshrc`:
 export HISTFILE=~/.zsh_history
 ```
 
-Please check your system configuration - history might be store in `~/.zsh_history`, `~/.zhistory` or other file.
+Please check your system configuration - history might be stored in `~/.zsh_history`, `~/.zhistory` or other file.