CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.
Start of documentation: 2023-02-16 / v1.1.0

[1.6.5] - TBA

Minor Changes

• removed the prompt to open zip-files in binary mode.
• added --sf, --specific-format parameter to automatically format some file types like json or xml.
• renamed --config, --config to --cconfig, --cconfig.
• added --config, --config parameter to configure default parameters.
• added Shift-Arrow hotkeys to the editor to scroll through the file without moving the cursor.
• fix the editor for Python 3.12

[1.6.4] - 2023-11-14

Minor Changes

• providing a directory as an argument will no longer result in a recursive query. Recursion will still be possible using file-patterns.
• added -d, --dirs parameter to display all found directories.

Bugfixes

• tested compatibility with pypy-3.7 and pypy-3.10.

[1.6.3] - 2023-10-31

Bugfixes

• compatibility for Python v3.12.

[1.6.2] - 2023-10-10

Minor Changes

• special characters like ␛ and ␀ will now be able to be used in the editor.
• added -w, --wordcount parameter to count the occurrence of every token in all given files.

Bugfixes

• fix Bug where the colors used were not consistent.
• fix Bug where the --eval, --EVAL parameter would crash on invalid expressions.
• fix Bug where trunc= and [a:b] would crash on arithmetic errors.

[1.6.1] - 2023-09-22

Minor Changes

• added -!, --edit parameter to open a simple editor to write/edit any provided File.
• renamed --chr, --chr to --chr, --char.
• cat_win will now detect simple zip-archives and display the contained files.
• When using the Parameter Variant -E from -E, --echo the input will be decoded with unicode sequences.
• a combination of using --number and --file-prefix will result in a prefix of the scheme <sourcefile>:<lineno> in order to support GNU-style link formats.

[1.6.0] - 2023-08-22

Minor Changes

• encoding the content in base64 with --b64e will now also include the lineprefix.
• added -U, --url parameter to display the contents on any url passed in.
• the -p, --peek parameter will no longer display anything when searching for substrings or patterns.
• the --nb, --nobreak parameter will now also skip the 'open in binary mode' - dialogue.
• removed -t, --tabs and --eof, --eof parameters.
• added --chr, --chr parameter to display most special characters as readable tokens.
• changed -E, --ECHO to -E, -echo.
• added support for octal numbers when evaluating expressions using --eval.

Bugfixes

• implemented more exception handling.
• fix Bug where files would not be processed in the order in which they were provided.
• fix Bug where the shell would crash in rare cases.
• fix Bug where the --files parameter would display incorrect results.
• fix Bug where negative hexadecimal and binary numbers would not be recognized using --eval.

[1.5.1] - 2023-08-12

Bugfixes

• fix Bug where the OS would not be properly deteced.

[1.5.0] - /

Minor Changes

• display unknown arguments in order to indicate an erroneous command call.
• display argument suggestions to help fix an erraneous command call.
• -G, --GREP now shows the found keywords and matched patterns in the order in which they were found.
• included more special characters like '␉', '␀' in the rawviewer.
• allow for --peek to be used with the rawviewer.
• added --fp, --file-prefix parameter to include the file in every line prefix.
• added --dot, --dotfiles parameter to include dotfiles.
• added --plain, --plain-only parameter to skip all non-plain files automatically.
• warnings and errors will now be printed on the stderr-stream instead of stdout.
• display warning when trying to pipe a file into itself.
• added --oct, --OCT parameter to convert octal numbers.
• added some new bugs to fix later.

Bugfixes

• fix Bug where --sort would not correctly sort uppercase characters inbetween lowercase characters and have problems with special chars like 'ß', 'µ' ...
• fix Bug where -G, --GREP would not show prefixes like line number or line length.
• fix Bug where the asterisk symbol (*) would not display correctly when using -f, --files and a keyword has been found.
• fix Bug where the behaviour was unexpected when using -g, --grep but not providing any literal or pattern.
• fix Bug where the rawviewer would crash when using a different encoding.
• fix Bug where the -p, --peek parameter would crash when using a different encoding.
• fix Bug where --bin, --dec and --hex would display wrong outputs on negative numbers.

[1.4.3] - 2023-07-11

Minor Changes

• added --eval, --EVAL parameter to evaluate simple mathematical equations within any text.
• added --sort, --sort parameter to sort all lines alphabetically.
• added !clear command to the cat shell, to reset/delete all previously defined parameters.
• added -G, --GREP parameter to only show the substrings found or matching any queried pattern.

Bugfixes

• fix Bug where the shell command !del would not properly work when using a different command form.
• fix Bug where the trunc parameter would crash on not-evaluable inputs.
• fix Bug where the shell would unnecessarily import the clipboard module for each line again (when using the --clip parameter).
• fix Bug where the output of find= and match= was inconsistent and undeterministic.
• fix Bug where the slice and replace operators could only be used once per command.
• fix Bug where you could not replace certain substrings (individual chars are now escapable with \)

[1.4.2] - 2023-05-13

Minor Changes

• display a warning about resources when opening a large file.

Bugfixes

• some efficiency improvements
• fix DeprecationWarning

[1.4.1] - 2023-05-04

Minor Changes

• renamed -d, --debug to --debug, --debug and hid it from the help menu.
• renamed -R, --reconfigure to -R, --R
• added --Rin, --Rout, --Rerr parameters to specificly reconfigure the stdin, stdout or stderr stream to the given encoding.
• added !help command to the cat-shell (cats) in order to see a short help display explaining all other parameters
• added !exit command to the cat-shell (cats) in order to exit shell
• added !see command to the cat-shell (cats) in order to see the currently active parameters within one shell session.
• added !add <OPTION> and !del <OPTION> command to the cat-shell (cats) in order to change the parameters within one shell session.

Bugfixes

• fix Bug where match= and find= would display the wrong indices.

[1.4.0] - 2023-04-21

Major Changes

• added cats entry point, for a shell version of the programm. This way you can enter and edit custom input line by line, instead of restarting the programm every time. Useful for the number conversion feature or a line by line base64 encoding/decoding (note that some parameters will not work with this entry-point since they will not make any sense in the context).
• added -R, --reconfigure parameter to decide if the standard-input (stdin) and standard-output (stdout) should be reconfigured to the parsed encoding parameter. Some shells handle text encoding different than others, so there is no uniform output when using uncommon encoding formats. Using this parameter the users can decide for themselves if the stdout should be encoded. Some users may experience readable console output when using the parameter while others may experience it when not using the argument.

Minor Changes

• searching for patterns or literals within a file now also works for files that have been opened in binary mode (beware that some keywords might be overlooked).
• --hexview and --binview will now, dependant on the installed font, also show specific symbols for carriage return and line feed.
• creating a file with an specific text encoding set will now result in an actually encoded file.
• opening a file in binary will no longer display the b'' wrapper.

Bugfixes

• fix Bug where the ENTER-char '⏎' would be displayed incorrectly when using different encodings.

[1.3.1] - 2023-04-10

Minor Changes

• -f, --files now shows a * symbol on specific files, indicating the file contains a keyword or pattern that has been searched for using find= or match=.

[1.3.0] - 2023-03-29

Major Changes

• renamed -k, --keyword to -g, --grep
• removed requests dependency

Minor Changes

• -F and -f will now show Amount displaying the amount of files found.
• added --nk, --nokeyword parameter to reverse the --grep output, essentially showing only lines that do not match any queried keyword.

[1.2.0] - 2023-03-14

Major Changes

• removed cat entrypoint.

Minor Changes

• added --binview, --binview parameter to display the raw byte representation of any given file in binary.

[1.1.7] - 2023-03-12

Minor Changes

• added --hexview, --hexview parameter to display the raw byte representation of any given file in hexadecimal.

[1.1.6] - 2023-03-10

Minor Changes

• show file sizes on -f, --files parameter.
• added -S, --SUM parameter to only show the sum of lines of all files.

[1.1.5] - 2023-03-01

Minor Changes

• the match and find parameters now ignore previously set ANSI-Colorcodes, and therefor gain color priority. This solves the issue, that these parameters sometimes would not find a substring because of invisible escape codes within the line string.
• added some caches which should speed up the process a little, when passing the same file as parameter multiple times.

[1.1.4] - 2023-02-27

Major Changes

• reverted from colorama just_fix_windows_console() to init(), such that stripping ANSI-Codes (e.g. on piping) can be enabled.

Minor Changes

• -F, --FILES now also shows the size of the stdin content using -i.
• added -E, --ECHO parameter to ignore every following parameter and handle them like stdin.

[1.1.3] - 2023-02-26

Major Changes

• it is now possible to use either the 'pyclip', 'pyperclip3', or 'pyperclip' module in order to use the --clip parameter. If none of these options are installed, the --clip parameter will not work yet the programm won't crash. This change was made due to some problems using the --clip parameter on macOS.
• the default clipboard module was changed from 'pyperclip3' to 'pyperclip'. This module however is not included in the necessary dependencies. It can be added to the installation dependencies by using 'pip install cat_win[clip]'. This chang was made to ensure compatibility with pypy-3.8 and pypy-3.9.
• elevated dependency colorama from >=0.4.5 to >=0.4.6 (also switched from init() to just_fix_windows_console())

Minor Changes

• added appeal to raise official github issue when encountering an exception.
• added ability to create files in subdirectories that do not yet exist. The path will be created in the process, on error it will be cleaned up again.
• redesigned --config menu
• added file sizes to -F, --FILES
• added "NONE" - option to color --config, in order to disable highlighting for specific elements.

Bugfixes

• fix Bug where -f and -F together would result in an unwanted output.

[1.1.2] - 2023-02-22

Minor Changes

• added -k, --keyword parameter to only show lines containing queried keywords using find or match.
• added --nb, --nobreak parameter to not interrupt the output on queried keywords using find or match with a message in regard to the position of the keyword.

Bugfixes

• fix Bug where --nocolor would not apply to --FILES output or the update information.
• fix Bug where --FILES would have unwanted behaviour when no files have been found.
• fix Bug where -l, --linelength would have the wrong offset when using files with only one line.

[1.1.1] - 2023-02-19

Major Changes

• included cat and catw as entrypoint. Using cat will show a deprecation warning.

Minor Changes

• added message_information, message_important and message_warning as customizable colors to the --config menu.
• added unrecognized parameters to --debug menu.
• added -F, --FILES parameter which ONLY shows the found files. (useful when searching files with pattern like "**/*.txt")

Bugfixes

• fix Bug where background colors would colorize linebreaks and unnecessary whitespaces.
• fix Bug where parameters including --characters (like "test-file.txt") would not be recognized as an unknown file to write.

[1.1.0] - 2023-02-18

This release fully focuses on cleaning up, patching as many Bugs as possible, and renaming commands to a more logical name.

Major changes

• changed the entrypoint cat to catw. This change was made to resolve the conflict on various platforms using cat natively.

• changed -x, --linelength parameter to -l, --linelength

• changed -s, --squeeze parameter to -u, --unique

• changed -c, --count parameter to -s, --sum

• changed -col, --nocolor parameter to --nc, --nocolor

Minor Changes

• --config changes are now enumerated from 1 upwards, instead of 0 upwards.
• when using the --help or --version parameter and a new version is available, you will now be informed in case major changes have been made. This works by sticking to the versioning conventions.

Bugfixes

• fix Bug where --peek parameter does not show the correct number of lines skipped or prints unnecessary line breaks.
• fix Bug where --peek parameter does not evenly show the first and last lines.
• fix Bug where --linelength and --number prefix using background colors would incorrectly colorize whitespaces.
• fix Bug where --config change would crash.
• fix Bug where the Updatechecker would not recognize a new release.
• fix Bug where --clip parameter copied AnsiColor Codes resulting in a bizarre looking content.
• fix Bug where the User had to approve the creation of a temp file.