From 1e556ec3f737a90b83dbc4c8c44a7f561633b7f4 Mon Sep 17 00:00:00 2001 From: Valentin Popov Date: Tue, 4 Feb 2025 22:07:36 +0400 Subject: Added README.md and LICENSE.txt files --- LICENSE.txt | 7 +++++++ README.md | 26 ++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 LICENSE.txt diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..f14b40e --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,7 @@ +Copyright (c) 2025 TextCleaner Plugin + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index e69de29..e7ceef4 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,26 @@ +# TextCleaner Plugin + +TextCleaner is a Sublime Text 4 plugin that cleans up your document by performing several text transformations. It converts tabs to spaces, replaces invisible characters, standardizes quotes, trims extra whitespace, collapses multiple spaces, removes duplicate empty lines, and cleans up empty lines around brackets. + +## Settings + +You can customize which transformations are applied through the configuration file ([TextCleaner.sublime-settings](/TextCleaner.sublime-settings)). Below is a description of each setting: + +- `expand_tabs`: Converts tab characters to spaces. This setting will replace all tabs with 4 spaces. Adjust tab_size if you prefer a different number of spaces. +- `replace_invisible_chars`: Replaces various invisible characters (like BOM, zero-width spaces, non-breaking spaces, etc.) with a regular space. +- `replace_fancy_quotes`: Replaces smart quotes, apostrophes, and guillemets with standard ASCII quotes. With this enabled, characters like `“ ”`, `‘ ’`, `« »`, etc., will be converted to plain double or single quotes. +- `trim_line_whitespace`: Removes extra spaces and tabs at the beginning and end of each line. +- `replace_multiple_spaces`: Replaces multiple consecutive spaces with a single space. +- `remove_duplicate_empty_lines`: Collapses duplicate empty lines so that there is at most one empty line in a row. +- `remove_empty_lines_around_brackets`: Removes empty lines immediately after an opening bracket (\(, \[, \{) and immediately before a closing bracket (\), \], \}). + +Simply adjust the settings in the [TextCleaner.sublime-settings](/TextCleaner.sublime-settings) file to enable or disable specific transformations according to your needs. Enjoy a cleaner, more consistent code and text formatting in Sublime Text 4! + +## License + +This project is licensed under the [MIT License](/LICENSE.txt). + +## Credits + +Developed by Valentin Popov +E-Mail: [valentin@popov.link] \ No newline at end of file -- cgit v1.2.3