hjkl-editor 0.34.2

Front-door for the hjkl modal editor stack: vim engine + rope buffer + registers, in one crate.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! # hjkl-editor
//!
//! Front door for the hjkl modal editor stack. Re-exports the working
//! parts of [`hjkl_engine`] and [`hjkl_buffer`] under a curated
//! namespace so downstream consumers (sqeel, buffr, hjkl binary) add
//! one dependency instead of three and don't need to know the
//! crate-split.
//!
//! Two layers ride alongside each other during the 0.0.x churn:
//!
//! - **Legacy surface** (today's runtime): the [`runtime`] module
//!   re-exports the existing [`Editor`], [`VimMode`],
//!   [`Input`], [`Key`], [`SearchPrompt`], [`Registers`], [`Slot`], and
//!   [`LspIntent`]. This is what sqeel-tui consumes today.
//! - **Planned surface** (0.1.0 SPEC): the [`spec`] module re-exports
//!   the additive types from [`hjkl_engine::types`] —
//!   [`spec::Pos`], [`spec::Selection`], [`spec::SelectionSet`],
//!   [`spec::Edit`], [`spec::Mode`], [`spec::Style`], [`spec::Highlight`],
//!   [`spec::Options`], [`spec::Input`], [`spec::Host`], [`spec::EngineError`].
//!   Trait extraction will rewire the runtime onto these — once it
//!   ships, [`runtime`] becomes a thin compat layer.
//!
//! ## Usage
//!
//! ```no_run
//! use hjkl_editor::buffer;
//! use hjkl_editor::runtime::{DefaultHost, Editor, Options};
//!
//! let mut editor = hjkl_vim::vim_editor(buffer::View::new(), DefaultHost::new(), Options::default());
//! editor.set_content("hello world");
//! ```
//!
//! View and rope helpers are re-exported at the [`buffer`] module,
//! mirroring the [`hjkl_buffer`] surface.
//!
//! [`Editor`]: hjkl_engine::Editor
//! [`VimMode`]: hjkl_engine::VimMode
//! [`Input`]: hjkl_engine::Input
//! [`Key`]: hjkl_engine::Key
//! [`SearchPrompt`]: hjkl_engine::SearchPrompt
//! [`Registers`]: hjkl_engine::Registers
//! [`Slot`]: hjkl_engine::Slot
//! [`LspIntent`]: hjkl_engine::LspIntent
//!
//! Ex commands are now handled entirely by the `hjkl-ex` crate.
#![forbid(unsafe_code)]

pub mod buffer {
    //! Re-export of [`hjkl_buffer`]'s public surface.

    pub use hjkl_buffer::{
        Edit, Fold, MotionKind, Position, RowSpan, Selection, Span, View, Viewport, Wrap,
    };

    #[cfg(feature = "ratatui")]
    pub use hjkl_buffer_tui::{BufferView, Gutter, Sign, StyleResolver};
}

pub mod runtime {
    //! Legacy runtime surface — the working sqeel-vim port.
    //!
    //! These types drive editing today. The trait extraction lands a
    //! generic `Editor<B: View, H: Host>` into [`crate::spec`] that
    //! eventually replaces this surface; pre-1.0 churn means the swap
    //! can land on a patch bump.

    pub use hjkl_engine::types::{DefaultHost, Options};
    pub use hjkl_engine::{Editor, Input, Key, LspIntent, Registers, SearchPrompt, Slot, VimMode};
}

pub mod spec {
    //! Engine trait surface re-exported for consumers.
    //!
    //! All types are additive — they coexist with [`crate::runtime`]
    //! during the churn phase. Trait impls are forthcoming; today the
    //! types support host-side prep (e.g., buffr-modal's `BuffrHost`).

    pub use hjkl_engine::types::{
        Attrs, BufferEdit, BufferId, Color, Cursor, CursorShape, Edit, EngineError, FoldOp,
        FoldProvider, Highlight, HighlightKind, Host, Input, Mode, Modifiers, MouseEvent,
        MouseKind, NoopFoldProvider, Options, Pos, Query, Search, Selection, SelectionKind,
        SelectionSet, SpecialKey, Style, View, Viewport,
    };
    pub use hjkl_engine::{BufferFoldProvider, BufferFoldProviderMut};
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn editor_constructs() {
        let _ = hjkl_vim::vim_editor(
            buffer::View::new(),
            runtime::DefaultHost::new(),
            runtime::Options::default(),
        );
    }

    #[test]
    fn buffer_constructs() {
        let _ = buffer::View::from_str("hello\nworld");
    }

    #[test]
    fn spec_options_default() {
        let opts = spec::Options::default();
        assert_eq!(opts.tabstop, 4);
    }

    #[test]
    fn spec_selection_set_default() {
        let set = spec::SelectionSet::default();
        assert_eq!(set.items.len(), 1);
    }
}