Update changelog and configuration for v4.0.0 release

bensadeh · Oct 12, 2024 · fc7890f · fc7890f
1 parent ed0ec2d
commit fc7890f
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,26 @@
 
 ## 4.0.0
 
+### Overview
+
+This release contains several new feature and breaking changes. From a user perspective, the most notable change is the
+addition of a JSON highlighter. From a developer's perspective, the highlighting engine powering `tailspin` has been
+decoupled and extracted into a separate library called `[manifold](https://github.com/bensadeh/manifold)`.
+
+`manifold` will still be used internally by `tailspin`, but it will also be available as a standalone library for other
+projects to use.
+
+### New features:
+
+- Added a JSON highlighter. `tailspin` will recognize if the line is a valid JSON object and highlight it accordingly.
+
+### Breaking changes:
+
+- Removed the `border` from the style from the keyword styling. Instead, the border will be enabled implicitly by
+  setting a background color for the keyword.
+- Removed date highlighting for formats like `Aug 14` and `Sun Dec 14` etc.
+- One highlighting group for both date and time
+
 ## 3.0.2
 
 - Add completion hint so shells understand they can complete with file names (Thanks @alerque !)

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
   <img src="assets/tailspin.png" width="230"/>
 </p>
 
-#                                                                                                                                                                                                                                                                                                           
+#                                                                                                                                                                                                                                                                                                               
 
 <p align="center">
 A log file highlighter
@@ -213,15 +213,7 @@ Expand the section below to see the default config for the highlight groups:
 
 ```toml
 [date]
-number = { fg = "magenta" }
-separator = { faint = true }
-
-[date_word] # e.g. "Jan 01", "Mon Feb 28"
-day = { fg = "magenta" }
-month = { fg = "magenta" }
-number = { fg = "magenta" }
-
-[time]
+date = { fg = "magenta" }
 time = { fg = "blue" }
 zone = { fg = "red" }
 separator = { faint = true }

diff --git a/config.toml b/config.toml
@@ -2,13 +2,13 @@
 number = { fg = "green" }
 letter = { fg = "blue" }
 separator = { fg = "red" }
- separator_token = "a"
+separator_token = "a"
 x = { fg = "red" }
 
 [[regexps]]
-regular_expression = 'Started (.*)\.'
+regex = 'Started (.*)\.'
 style = { fg = "red" }
 
 [[regexps]]
-regular_expression = 'Stopped .*'
+regex = 'Stopped .*'
 style = { fg = "magenta" }