Skip to content

Commit 918b853

Browse files
committed
Updated README.md to contain the new configuration options.
1 parent b6e4494 commit 918b853

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

Diff for: README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ The LogView plug-in distinguishes three types of log entries:
3131
- warnings
3232
- marks
3333

34+
Matching lines are marked with an icon within the gutter, too. If you only want the lines to have icons and no other hilighting should be performed set the `highlight_style` parameter within the config file to `none`.
35+
3436
It is possible to set a regular expression for detecting every type of log entry within the configuration file. If a file is loaded (or the file type is changed to "Logfile") it is automatically processed and all lines, that contain matches to the configured regular expressions are automatically highlighted and bookmarked. This way it is possible to analyse logfiles much faster and find the relevant portions with the "goto bookmark" (<kbd>F2</kbd>) functionality. The line highlighting feature shows the critical areas in the logfile via the Minimap. Portions of the logfile with a high density of red or yellow marks may hint at a problem.
3537

3638
If more than one regular expression matches for a given line of the logfile all matches are counted. For highlighting the line the error_filter takes precedence over the warning_filter and the warning_filter takes precedence over the mark_filter.
@@ -40,14 +42,15 @@ The "error_filter", "warning_filter" and "mark_filer" regular expressions contai
4042
# Configuration parameters
4143
| Parameter | Default | Description |
4244
| :--------------------- | :----------------------------- | :---------- |
43-
| error_filter | `error|fail|exception` | All lines containing a match for this regular expression are marked with the scope defined by the error_scope setting and bookmarked. |
44-
| error_scope | `invalid` | Scope used for marking lines containing a match of the error_filter regular expression. |
45+
| error_filter | `error\|fail\|exception` | All lines containing a match for this regular expression are marked with the scope defined by the error_scope setting and bookmarked. |
46+
| error_scope | `markup.deleted` | Scope used for marking lines containing a match of the error_filter regular expression. |
4547
| error_status_caption | `Errors` | Prefix for the number of lines containing a match of the error_filter regular expression. This can be used for I18N. |
46-
| warning_filter | `warning|not found|[^\w]defer` | All lines containing a match for this regular expression are marked with the scope defined by the warning_scope setting and bookmarked. |
48+
| warning_filter | `warning\|not found\|[^\w]defer` | All lines containing a match for this regular expression are marked with the scope defined by the warning_scope setting and bookmarked. |
4749
| warning_scope | `markup.changed` | Scope used for marking lines containing a match of the warning_filter regular expression. |
4850
| warning_status_caption | `Warnings` | Prefix for the number of lines containing a match of the warning_filter regular expression. This can be used for I18N. |
49-
| mark_filter | `[^\w](start|quit|end|shut(ing)* down)[^\w]` | All lines containing a match for this regular expression are marked with the scope defined by the mark_scope setting and bookmarked. |
51+
| mark_filter | `[^\w](start\|quit\|end\|shut(ing)* down)[^\w]` | All lines containing a match for this regular expression are marked with the scope defined by the mark_scope setting and bookmarked. |
5052
| mark_scope | `markup.inserted` | Scope used for marking lines containing a match of the mark_filter regular expression. |
5153
| mark_status_caption | `Marks` | Prefix for the number of lines containing a match of the mark_filter regular expression. This can be used for I18N. |
54+
| highlight_style | `underline` | Configures the style for marking the lines selected by the filters. Available styles are: fill, outline, underline and none. See default config for details. |
5255

5356
All configuration parameters can be set via the Preferences menu. Just open Preferences > Package Settings > Log View > Settings - User. To have a look at the default settings use the "Settings - Default" menu option.

0 commit comments

Comments
 (0)