Merge remote-tracking branch 'origin/main'

Author: Canop

.github/workflows/deny.yml

@@ -0,0 +1,35 @@
+on: [push, pull_request]
+
+name: cargo-deny
+
+jobs:
+  deny:
+    name: deny
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        checks:
+          - advisories
+          - bans licenses sources
+
+    # Prevent sudden announcement of a new advisory from failing ci:
+    continue-on-error: ${{ matrix.checks == 'advisories' }}
+
+    steps:
+      - name: Checkout sources
+        uses: actions/[email protected]
+
+      - name: Install toolchain
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: 1.73.0
+
+      - name: Cache
+        uses: Swatinem/rust-cache@v2
+
+      - name: cargo-deny
+        uses: EmbarkStudios/cargo-deny-action@v1
+        with:
+          command: check ${{ matrix.checks }}
+

CHANGELOG.md

@@ -1,5 +1,57 @@
 *If you're reading this because you try make sense of some new API or a breaking change, you might also be interested in coming to the chat for explanations or guidance.*
 
+<a name="v0.29.4"></a>
+### v0.29.4 - 2024-06-17
+- fix compilation with `default-features = false` - Fix #62
+
+<a name="v0.29.3"></a>
+### v0.29.3 - 2024-06-13
+- `ask!` macro doesn't need separate imports anymore
+
+<a name="v0.29.2"></a>
+### v0.29.2 - 2024-04-24
+- update Crokey to 1.0.0
+
+<a name="v0.29.1"></a>
+### v0.29.1 - 2024-02-10
+- event source's `combining` now `false` by default
+
+<a name="v0.29.0"></a>
+### v0.29.0 - 2024-01-29
+- list items are now by default indented as blocks. It's possible to revert to the old rendering (only the first line indented) with the list_items_identation_mod field of the skin - Fix #21
+
+<a name="v0.28.2"></a>
+### v0.28.2 - 2024-01-26
+- Better support of repeated keys in EventSource
+
+<a name="v0.28.1"></a>
+### v0.28.1 - 2024-01-20
+- EventSource by default mandates modifier (or space) for combinations with multiple simple keys. This can be changed with an option
+
+<a name="v0.28.0"></a>
+### v0.28.0 - 2024-01-18
+- Major change: termimad and its coolor and crokey dependencies now use the version 0.27 of Crossterm, which brings many breaking changes but allows new capabilities in key events handling. Termimad's EventSource now outputs key combinations along crossterm events.
+
+<a name="v0.27.0"></a>
+### v0.27.0 - 2024-01-08
+- paragraphs, code blocks, headers, and tables can be given a left_margin and a right_margin - Fix #11
+
+<a name="v0.26.1"></a>
+### v0.26.1 - 2023-11-05
+- can_move_left and can_move_right functions on InputField
+
+<a name="v0.26.0"></a>
+### v0.26.0 - 2023-11-03
+- MadSkin and other structs now implement serde::Serialize - Fix #19
+
+<a name="v0.25.7"></a>
+### v0.25.7 - 2023-10-31
+- upgrade coolor, removing the ansi_colours dependency, fixing a license incompatibility - Fix #51
+
+<a name="v0.25.6"></a>
+### v0.25.6 - 2023-10-31
+- upgrade terminal-clipboard due to RUSTSEC-2021-0019 in its X11 dependency
+
 <a name="v0.25.5"></a>
 ### v0.25.5 - 2023-10-16
 - dependency version updated

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "termimad"
-version = "0.25.5"
+version = "0.29.4"
 authors = ["dystroy <[email protected]>"]
 repository = "https://github.com/Canop/termimad"
 description = "Markdown Renderer for the Terminal"
@@ -17,25 +17,27 @@ special-renders = []
 default = ["special-renders"]
 
 [dependencies]
-minimad = "0.13.0"
-coolor = { version="0.7.0", features=["crossterm"] }
-crossterm = "=0.23.2"
+coolor = { version="0.9.0", features=["crossterm"] }
+crokey = "1.0.0"
 crossbeam = "0.8"
 lazy-regex = "3.2"
+minimad = "0.13.0"
 serde = { version = "1.0", features = ["derive"] }
 thiserror = "1.0"
-unicode-width = "0.1.10"
+unicode-width = "0.1.11"
 # cli-log = "2.0"
 
 [dev-dependencies]
 anyhow = "1.0"
 cli-log = "2"
-crokey = "0.4"
 deser-hjson = "2"
-terminal-clipboard = ">=0.3.1"
+pretty_assertions = "1.4"
+serde_json = "1"
+terminal-clipboard = "0.4.1"
 
 [patch.crates-io]
 # coolor = { path = "../coolor" }
+# crokey = { path = "../crokey" }
 # crossterm = { path = "../crossterm" }
 # minimad = { path = "../minimad" }
 # terminal-clipboard = { path = "../terminal-clipboard" }

README.md

@@ -320,4 +320,4 @@ If you're the author of another application using Termimad, please tell me.
 
 [Crossterm](https://github.com/crossterm-rs/crossterm) is a 0.x library which means its API isn't frozen. And it does change sometimes so libraries based on Crossterm can't always use its last version.
 
-Crossterm 0.23.x is reexported by Termimad so you don't have to declare the import yourself. You may use crossterm as `termimad::crossterm`.
+Crossterm 0.27.x is reexported by Termimad so you don't have to declare the import yourself. You may use crossterm as `termimad::crossterm`.

bacon.toml

@@ -9,6 +9,10 @@ default_job = "check-all"
 command = ["cargo", "check", "--color", "always"]
 need_stdout = false
 
+[jobs.check-no-features]
+command = ["cargo", "check", "--no-default-features", "--color", "always"]
+need_stdout = false
+
 [jobs.check-all]
 command = ["cargo", "check", "--all-targets", "--color", "always"]
 need_stdout = false

deny.toml

@@ -0,0 +1,71 @@
+[licenses]
+# The lint level for crates which do not have a detectable license
+unlicensed = "deny"
+
+# List of explicitly allowed licenses
+# See https://spdx.org/licenses/ for list of possible licenses
+# [possible values: any SPDX 3.7 short identifier (+ optional exception)].
+allow = []
+
+# List of explicitly disallowed licenses
+# See https://spdx.org/licenses/ for list of possible licenses
+# [possible values: any SPDX 3.7 short identifier (+ optional exception)].
+deny = []
+
+# The lint level for licenses considered copyleft
+copyleft = "deny"
+
+# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses
+# * both - The license will only be approved if it is both OSI-approved *AND* FSF/Free
+# * either - The license will be approved if it is either OSI-approved *OR* FSF/Free
+# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF/Free
+# * fsf-only - The license will be approved if is FSF/Free *AND NOT* OSI-approved
+# * neither - The license will be denied if is FSF/Free *OR* OSI-approved
+allow-osi-fsf-free = "either"
+
+# The confidence threshold for detecting a license from license text.
+# The higher the value, the more closely the license text must be to the
+# canonical license text of a valid SPDX license file.
+# [possible values: any between 0.0 and 1.0].
+confidence-threshold = 0.8
+
+exceptions = [
+]
+
+[bans]
+# Lint level for when multiple versions of the same crate are detected
+multiple-versions = "warn"
+
+# The graph highlighting used when creating dotgraphs for crates
+# with multiple versions
+# * lowest-version - The path to the lowest versioned duplicate is highlighted
+# * simplest-path - The path to the version with the fewest edges is highlighted
+# * all - Both lowest-version and simplest-path are used
+highlight = "all"
+
+# List of crates that are allowed. Use with care!
+allow = [
+]
+
+# List of crates to deny
+deny = [
+    # Each entry the name of a crate and a version range. If version is
+    # not specified, all versions will be matched.
+]
+
+# Certain crates/versions that will be skipped when doing duplicate detection.
+skip = [
+]
+
+# Similarly to `skip` allows you to skip certain crates during duplicate detection,
+# unlike skip, it also includes the entire tree of transitive dependencies starting at
+# the specified crate, up to a certain depth, which is by default infinite
+skip-tree = [
+]
+
+
+[advisories]
+ignore = [
+]
+
+

examples/fit-width/main.rs

@@ -8,7 +8,7 @@ use {
         cursor::{self, Hide, Show},
         event::{self, Event},
         ExecutableCommand,
-        terminal::{self, EnterAlternateScreen, LeaveAlternateScreen},
+        terminal::{self, Clear, ClearType, EnterAlternateScreen, LeaveAlternateScreen},
         style::Color::*,
     },
     termimad::*,
@@ -75,9 +75,14 @@ fn run_app(skin: &MadSkin) -> Result<(), Error> {
             Ok(Event::Key(_)) => {
                 break;
             }
-            Ok(Event::Resize(w, h)) => {
-                width = w;
-                height = h;
+            Ok(Event::Resize(new_width, new_height)) => {
+                width = new_width;
+                height = new_height;
+                cli_log::debug!("Resized to width: {}, height: {}", width, height);
+                // To fix a bug in Kitty, which rewrites the terminal on resize and
+                // thus writes characters below the "height" limit, we clear
+                // the whole terminal.
+                w.execute(Clear(ClearType::All))?;
             }
             _ => {}
         }
@@ -100,6 +105,7 @@ fn make_skin() -> MadSkin {
 }
 
 fn main() -> Result<(), Error> {
+    cli_log::init_cli_log!();
     let skin = make_skin();
     run_app(&skin)
 }

examples/indented-code/main.rs

@@ -0,0 +1,24 @@
+use termimad::*;
+
+static MD: &str = r#"
+# Indented Code
+
+To indent code (as demonstrated here) do this:
+
+```rust
+fn main() {
+    let mut skin = MadSkin::default();
+    skin.code_block.left_margin = 4;
+    skin.print_text(MD);
+}
+```
+
+Note that you can add some margin to other kinds of lines, not just code blocks.
+
+"#;
+
+fn main() {
+    let mut skin = MadSkin::default();
+    skin.code_block.left_margin = 4;
+    skin.print_text(MD);
+}

examples/inputs/view.rs

@@ -1,11 +1,11 @@
 use {
     crate::clipboard,
     anyhow::{self},
-    crokey::key,
+    crokey::{key, KeyCombination},
     std::io::Write,
     termimad::*,
     termimad::crossterm::{
-        event::{Event, KeyEvent, MouseEvent},
+        event::{Event, MouseEvent},
         queue,
         terminal::{
             Clear,
@@ -132,15 +132,15 @@ impl View {
         self.area = area;
         true
     }
-    pub fn apply_key_event(&mut self, key: KeyEvent) -> bool {
+    pub fn apply_key_combination(&mut self, key: KeyCombination) -> bool {
         if key == key!(esc) {
             self.set_focus(Focus::Introduction);
             true
         } else if key == key!(tab) {
             self.focus_next();
             true
         } else if let Some(input) = self.focused_input() {
-            input.apply_key_event(key) || {
+            input.apply_key_combination(key) || {
                 if key == key!(ctrl-c) {
                     clipboard::copy_from_input(input)
                 } else if key == key!(ctrl-x) {
@@ -152,7 +152,7 @@ impl View {
                 }
             }
         } else {
-            self.introduction.apply_key_event(key)
+            self.introduction.apply_key_combination(key)
         }
     }
     pub fn apply_mouse_event(&mut self, mouse_event: MouseEvent, double_click: bool) -> bool {
@@ -169,9 +169,10 @@ impl View {
     }
     pub fn apply_timed_event(&mut self, timed_event: TimedEvent) -> bool {
         match timed_event.event {
-            Event::Key(key) => self.apply_key_event(key),
+            Event::Key(key) => self.apply_key_combination(key.into()),
             Event::Mouse(me) => self.apply_mouse_event(me, timed_event.double_click),
             Event::Resize(w, h) => self.resize(Area::new(0, 0, w, h)),
+            _ => false,
         }
     }
     /// draw the view (not flushing)

examples/render-input-markdown/main.rs

@@ -56,7 +56,7 @@ fn run_in_alternate<W: Write>(w: &mut W) -> anyhow::Result<()> {
         debug!("event: {:?}", timed_event);
         if timed_event.is_key(key!(ctrl-q)) {
             quit = true;
-        } else if view.apply_timed_event(timed_event) {
+        } else if view.apply_timed_event(&timed_event) {
             view.queue_on(w)?;
             w.flush()?;
         }