aboutsummaryrefslogtreecommitdiff
path: root/helix-core
diff options
context:
space:
mode:
authorVince Mutolo2022-05-02 14:24:22 +0000
committerGitHub2022-05-02 14:24:22 +0000
commitf9baced216df60122f2aae08d382931d77901ca9 (patch)
tree44326181702d03e18f5d9c810331c2993524296c /helix-core
parent567ddef388986dd2cea5c7f3eb1aa1a978c3e6d3 (diff)
add reflow command (#2128)
* add reflow command Users need to be able to hard-wrap text for many applications, including comments in code, git commit messages, plaintext documentation, etc. It often falls to the user to manually insert line breaks where appropriate in order to hard-wrap text. This commit introduces the "reflow" command (both in the TUI and core library) to automatically hard-wrap selected text to a given number of characters (defined by Unicode "extended grapheme clusters"). It handles lines with a repeated prefix, such as comments ("//") and indentation. * reflow: consider newlines to be word separators * replace custom reflow impl with textwrap crate * Sync reflow command docs with book * reflow: add default max_line_len language setting Co-authored-by: Vince Mutolo <vince@mutolo.org>
Diffstat (limited to 'helix-core')
-rw-r--r--helix-core/Cargo.toml1
-rw-r--r--helix-core/src/lib.rs1
-rw-r--r--helix-core/src/syntax.rs1
-rw-r--r--helix-core/src/wrap.rs7
4 files changed, 10 insertions, 0 deletions
diff --git a/helix-core/Cargo.toml b/helix-core/Cargo.toml
index 6e019a42..ab937f0b 100644
--- a/helix-core/Cargo.toml
+++ b/helix-core/Cargo.toml
@@ -41,6 +41,7 @@ encoding_rs = "0.8"
chrono = { version = "0.4", default-features = false, features = ["alloc", "std"] }
etcetera = "0.3"
+textwrap = "0.15.0"
[dev-dependencies]
quickcheck = { version = "1", default-features = false }
diff --git a/helix-core/src/lib.rs b/helix-core/src/lib.rs
index 02341265..a022a42a 100644
--- a/helix-core/src/lib.rs
+++ b/helix-core/src/lib.rs
@@ -27,6 +27,7 @@ pub mod syntax;
pub mod test;
pub mod textobject;
mod transaction;
+pub mod wrap;
pub mod unicode {
pub use unicode_general_category as category;
diff --git a/helix-core/src/syntax.rs b/helix-core/src/syntax.rs
index 3f9e7bcf..eab3ab79 100644
--- a/helix-core/src/syntax.rs
+++ b/helix-core/src/syntax.rs
@@ -67,6 +67,7 @@ pub struct LanguageConfiguration {
pub shebangs: Vec<String>, // interpreter(s) associated with language
pub roots: Vec<String>, // these indicate project roots <.git, Cargo.toml>
pub comment_token: Option<String>,
+ pub max_line_length: Option<usize>,
#[serde(default, skip_serializing, deserialize_with = "deserialize_lsp_config")]
pub config: Option<serde_json::Value>,
diff --git a/helix-core/src/wrap.rs b/helix-core/src/wrap.rs
new file mode 100644
index 00000000..eabc47d4
--- /dev/null
+++ b/helix-core/src/wrap.rs
@@ -0,0 +1,7 @@
+use smartstring::{LazyCompact, SmartString};
+
+/// Given a slice of text, return the text re-wrapped to fit it
+/// within the given width.
+pub fn reflow_hard_wrap(text: &str, max_line_len: usize) -> SmartString<LazyCompact> {
+ textwrap::refill(text, max_line_len).into()
+}