Change version to 0.3.0-rc

josefpihrt · Nov 14, 2021 · b31f6f9 · b31f6f9
1 parent c7c042d
commit b31f6f9
Show file tree

Hide file tree

Showing 24 changed files with 1,926 additions and 989 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,32 @@
+## 0.3.0-rc (2021-11-14)
+
+* Change shortcut for `--attributes-to-skip` from `-b` to `-A`
+* Empty name pattern matches entire name (or its part): `--name ""`
+* Empty content pattern matches entire file's content: `--content ""`
+* Matching lines/values are not indented by default
+* Add allowed values for option `--modify`
+ * `count`
+ * `sort-by=count`
+* Add option `--max-matches-in-file`
+* Add option `--max-matching-files`
+* Add option `--max-word-length` (command `spellcheck`)
+* Add option `-P,--no-path` (a shortcut for `--path-mode omit`)
+* Add option `-C,--no-content` (a shortcut for `--content-mode omit`)
+* Deprecate option `--display` and replace it with:
+ * `--after-context`
+ * `--before-context`
+ * `--content-mode`
+ * `--context`
+ * `--count`
+ * `--line-number`
+ * `--path-mode`
+ * `-u,--summary`
+ * `--align-columns`
+* Deprecate command `escape` and replace it with `regex escape`
+* Deprecate command `list-patterns` and replace it with `regex list`
+* Deprecate command `match` and replace it with `regex match`
+* Deprecate command `split` and replace it with `regex split`
+
 ## 0.2.2 (2021-07-21)
 
 * Add command `sync` ([commit](https://github.com/JosefPihrt/Roslynator/commit/81b2f412f81edb4f205195226777f0a7f565a350))

diff --git a/docs/cli/OptionValues.md b/docs/cli/OptionValues.md
@@ -4,17 +4,15 @@
 * [\<ATTRIBUTES>](#attributes)
 * [\<COMPARE_OPTIONS>](#compare_options)
 * [\<CONFLICT_RESOLUTION>](#conflict_resolution)
-* [\<CONTENT_DISPLAY>](#content_display)
-* [\<DISPLAY_OPTIONS>](#display_options)
+* [\<CONTENT_MODE>](#content_mode)
 * [\<EXTENSION_OPTIONS>](#extension_options)
 * [\<FILE_PROPERTIES>](#file_properties)
 * [\<HIGHLIGHT>](#highlight)
 * [\<INPUT_OPTIONS>](#input_options)
-* [\<MAX_OPTIONS>](#max_options)
 * [\<MODIFY_OPTIONS>](#modify_options)
 * [\<NAME_PART>](#name_part)
 * [\<OUTPUT_OPTIONS>](#output_options)
-* [\<PATH_DISPLAY>](#path_display)
+* [\<PATH_MODE>](#path_mode)
 * [\<PATTERN_OPTIONS>](#pattern_options)
 * [\<PIPE_MODE>](#pipe_mode)
 * [\<REGEX_OPTIONS>](#regex_options)
@@ -74,7 +72,7 @@
 | suffix | | Add suffix to file name if it already exists\. |
 | skip | s | Do not copy or move a file if it already exists\. |
 
-## \<CONTENT\_DISPLAY>
+## \<CONTENT\_MODE>
 
 | Value | | Description |
 | ---------------- | --- | ---------------------------------------------------------------------------------------- |
@@ -85,26 +83,6 @@
 | value\-detail | d | Display matched value and include information about each value such as index or length\. |
 | omit | o | Do not display file's content\. |
 
-## \<DISPLAY\_OPTIONS>
-
-| Value | | Description |
-| ---------------------------------------------- | --- | ---------------------------------------------------------------------- |
-| content=[\<CONTENT_DISPLAY>](#content_display) | c | |
-| context=\<NUM> | co | A number of lines to display before and after matching line\. |
-| context\-before=\<NUM> | b | A number of lines to display before matching line\. |
-| context\-after=\<NUM> | a | A number of lines to display after matching line\. |
-| count | c | Include number of matches in file\. |
-| creation\-time | ct | Include file creation time\. |
-| indent=\<INDENT> | | Indentation for a list of results\. Default indentation are 2 spaces\. |
-| line\-number | l | Include line number\. |
-| modified\-time | mt | Include file last modified time\. |
-| no\-align | | Do not align columns\. |
-| path=[\<PATH_DISPLAY>](#path_display) | p | |
-| size | s | Include file size\. |
-| separator=\<SEPARATOR> | s | String that separate each value\. |
-| summary | su | Include summary\. |
-| trim\-line | | Trim leading and trailing white\-space from a line\. |
-
 ## \<EXTENSION\_OPTIONS>
 
 | Value | | Description |
@@ -119,11 +97,11 @@
 
 ## \<FILE\_PROPERTIES>
 
-| Value | | Description |
-| ---------------------- | --- | --------------------------------------------------------------------------------- |
-| creation\-time=\<DATE> | ct | Filter files by creation time \(See 'Expression syntax' for other expressions\)\. |
-| modified\-time=\<DATE> | mt | Filter files by modified time \(See 'Expression syntax' for other expressions\)\. |
-| size=\<NUM> | s | Filter files by size \(See 'Expression syntax' for other expressions\)\. |
+| Value | | Description  |
+| ---------------------- | --- | ------------------------------------------------------------------------------------------------------------- |
+| creation\-time=\<DATE> | ct | Show file's creation time and optionally define condition \(See 'Expression syntax' for other expressions\)\. |
+| modified\-time=\<DATE> | mt | Show file's modified time and optionally define condition \(See 'Expression syntax' for other expressions\)\. |
+| size=\<NUM> | s | Show file's size and optionally define condition \(See 'Expression syntax' for other expressions\)\. |
 
 ## \<HIGHLIGHT>
 
@@ -150,13 +128,6 @@
 | ------ | --- | ------------------------------------------------------------------------------ |
 | escape | e | Interpret literals \\a, \\b, \\f, \\n, \\r, \\t and \\v as character escapes\. |
 
-## \<MAX\_OPTIONS>
-
-| Value | | Description |
-| -------------- | --- | --------------------------------------------------------------- |
-| \<NUM> | | Stop searching after \<NUM> matching files and/or directories\. |
-| matches=\<NUM> | m | Stop searching in each file after \<NUM> matches\. |
-
 ## \<MODIFY\_OPTIONS>
 
 | Value | | Description |
@@ -170,6 +141,7 @@
 | except | | Return values from first file except values from second file\. |
 | intersect | | Return values that were found in all files\. |
 | group | | Group matching files by matched values\. |
+| count | | Show number of values in a group\. |
 | ignore\-case | i | Use case\-insensitive matching\. |
 | remove\-empty | re | Remove values that are empty strings\. |
 | remove\-white\-space | rw | Remove values that are empty or consist of white\-space\. |
@@ -197,7 +169,7 @@
 | verbosity=[\<VERBOSITY>](#verbosity) | v | |
 | append | a | If the file exists output will be appended to the end of the file\. |
 
-## \<PATH\_DISPLAY>
+## \<PATH\_MODE>
 
 | Value | | Description |
 | -------- | --- | ----------------------------------------------- |
@@ -294,6 +266,7 @@
 | Value | | Description |
 | ------ | --- | ------------------------------- |
 | length | l | Sort values by value's length\. |
+| count | c | Sort values by group's count\. |
 
 ## \<SYNC\_CONFLICT\_RESOLUTION>
 
@@ -317,8 +290,10 @@
 | miscellaneous | m | |
 | named\-blocks | n | |
 | options | o | |
+| regex\-options | ro | |
 | quantifiers | q | |
 | substitutions | s | |
+| all | | |
 
 ## \<VERBOSITY>
 
@@ -341,6 +316,6 @@
 | `x>=n` |
 | `x=<min;max>` | Inclusive interval |
 | `x=(min;max)` | Exclusive interval |
-| `x=-d\|[d.]hh:mm[:ss]` | x is greater than actual date \- \<VALUE> |
+| `x=-d|[d.]hh:mm[:ss]` | x is greater than actual date \- \<VALUE> |
 
 *\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
diff --git a/docs/cli/README.md b/docs/cli/README.md
@@ -4,21 +4,21 @@ Search, replace, rename and delete files and its content using the power of \.NE
 
 ## Commands
 
-| Command  | Description |
-| ----------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| [copy](copy-command.md)  | Searches the file system for files and directories and copy them to a destination directory\. |
-| [delete](delete-command.md)  | Deletes files and directories\. |
-| [escape](escape-command.md) | Escapes special characters by replacing them with their escape codes\.  |
-| [find](find-command.md)  | Searches the file system for files and directories and optionally searches files' content\. |
-| [help](help-command.md)  | Displays help\.  |
-| [list-patterns](list-patterns-command.md) | Lists regular expression patterns\.  |
-| [match](match-command.md)   | Searches the input string for occurrences of the regular expression\. |
-| [move](move-command.md)   | Searches the file system for files and directories and move them to a destination directory\. |
-| [rename](rename-command.md)  | Renames files and directories\.  |
-| [replace](replace-command.md) | Searches the file system for files and replaces its content\. |
-| [spellcheck](spellcheck-command.md) | Searches the files' content for potential misspellings and typos\. |
-| [split](split-command.md)   | Splits the input string into an list of substrings at the positions defined by a regular expression\. |
-| [sync](sync-command.md)  | Synchronizes content of two directories\. |
+| Command | Description |
+| --------------------------------------- | ----------------------------------------------------------------------------------------------------- |
+| [copy](copy-command.md) | Searches the file system for files and directories and copy them to a destination directory\. |
+| [delete](delete-command.md) | Deletes files and directories\. |
+| [find](find-command.md)  | Searches the file system for files and directories and optionally searches files' content\. |
+| [help](help-command.md) | Displays help\.  |
+| [move](move-command.md) | Searches the file system for files and directories and move them to a destination directory\. |
+| [regex escape](regex-escape-command.md) | Escapes special characters by replacing them with their escape codes\. |
+| [regex list](regex-list-command.md) | Lists regular expression patterns\.   |
+| [regex match](regex-match-command.md) | Searches the input string for occurrences of the regular expression\.   |
+| [regex split](regex-split-command.md) | Splits the input string into an list of substrings at the positions defined by a regular expression\. |
+| [rename](rename-command.md) | Renames files and directories\.  |
+| [replace](replace-command.md)  | Searches the file system for files and replaces its content\.  |
+| [spellcheck](spellcheck-command.md) | Searches the files' content for potential misspellings and typos\.   |
+| [sync](sync-command.md) | Synchronizes content of two directories\. |
 
 
 ## Exit Code