Make custom key bindings an optional Cargo feature #615
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Cargo tree output now looks like this: $ cargo tree -e no-dev --no-default-features
rustyline v9.1.2 (/Users/lopopolo/dev/repos/rustyline)
├── bitflags v1.3.2
├── cfg-if v1.0.0
├── fd-lock v3.0.5
│ ├── cfg-if v1.0.0
│ └── rustix v0.34.2
│ ├── bitflags v1.3.2
│ ├── errno v0.2.8
│ │ └── libc v0.2.122
│ ├── io-lifetimes v0.6.1
│ └── libc v0.2.122
├── libc v0.2.122
├── log v0.4.16
│ └── cfg-if v1.0.0
├── memchr v2.4.1
├── nix v0.23.1
│ ├── bitflags v1.3.2
│ ├── cfg-if v1.0.0
│ ├── libc v0.2.122
│ └── memoffset v0.6.5
│ [build-dependencies]
│ └── autocfg v1.1.0
├── unicode-segmentation v1.9.0
├── unicode-width v0.1.9
└── utf8parse v0.2.0 |
|
|
thanks for the review @gwenn. I took a stab at your feedback using a similar approach I take in some other crates I maintain. When building the docs like this: RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --openThese methods on
|
Add a cargo feature called `custom-bindings` which is enabled by default. The `custom-bindings` feature enables APIs which allow users of `rustyline` to define custom keybindings. Custom keybindings are the only use of `radix_trie` in this crate. If the `custom-bindings` feature is disabled, `radix_tree` is not included in `rustyline`. Motivation of this commit is to reduce dependencies. The approach I've taken in this commit is to stub out internal APIs when `custom-bindings` feature is not active to minimize the number of code changes that need to occur. Similarly, when the `custom-bindings` feature is not enabled, I've added `allow(dead_code)` to `mod bindings`. The splitting out of default functionality into a new feature that is enabled by default I believe is a breaking change, because users may have previously been using custom keybindings with default-features = false. This commit adds a step to the GitHub Actions CI to run `cargo check` with no default features.
lopopolo
commented
Apr 11, 2022
src/keymap.rs
Outdated
Comment on lines
11
to
12
| #[cfg(feature = "custom-bindings")] | ||
| mod custom_bindings { |
There was a problem hiding this comment.
I'm not sure if you'd prefer for me to use cfg_if::cfg_if! here
|
Oh sorry @gwenn I missed the notification on my fork |
lopopolo
added a commit
to artichoke/artichoke
that referenced
this pull request
Aug 2, 2022
`rustyline` 10.0.0 includes a breaking change where `Editor::new` now returns result. The REPL propagates this error as an unhandled readline error, which will exit the REPL with an error message. This is a handcrafted version of @dependabot's PR in #1999 to address this breaking change. `rustyline` 10.0.0 includes several commits (a few of which I authored) that reduce the number of deps pulled in a bunch: - kkawakam/rustyline#613 - kkawakam/rustyline#614 - kkawakam/rustyline#615 - kkawakam/rustyline#623
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a cargo feature called
custom-bindingswhich is enabled bydefault. The
custom-bindingsfeature enables APIs which allow users ofrustylineto define custom keybindings.Custom keybindings are the only use of
radix_triein this crate. Ifthe
custom-bindingsfeature is disabled,radix_treeis not includedin
rustyline.Motivation of this commit is to reduce dependencies.
The approach I've taken in this commit is to stub out internal APIs when
custom-bindingsfeature is not active to minimize the number of codechanges that need to occur. Similarly, when the
custom-bindingsfeature is not enabled, I've added
allow(dead_code)tomod bindings.The splitting out of default functionality into a new feature that is
enabled by default I believe is a breaking change, because users may
have previously been using custom keybindings with default-features =
false.
This commit adds a step to the GitHub Actions CI to run
cargo checkwith no default features.