cleanup the repo

Cargo.toml

@@ -6,12 +6,14 @@ name = "nu_plugin_explore"
 anyhow = "1.0.73"
 console = "0.15.7"
 crossterm = "0.27.0"
-nu-plugin = { git = "https://github.com/nushell/nushell", rev = "c06ef201b72b3cbe901820417106b7d65c6f01e1", package = "nu-plugin" }
-nu-protocol = { git = "https://github.com/nushell/nushell", rev = "c06ef201b72b3cbe901820417106b7d65c6f01e1", package = "nu-protocol", features = ["plugin"] }
-nu-parser = { git = "https://github.com/nushell/nushell", rev = "c06ef201b72b3cbe901820417106b7d65c6f01e1", package = "nu-parser" }
+nu-plugin = { git = "https://github.com/nushell/nushell", rev = "55edef5ddaf3d3d55290863446c2dd50c012e9bc", package = "nu-plugin" }
+nu-protocol = { git = "https://github.com/nushell/nushell", rev = "55edef5ddaf3d3d55290863446c2dd50c012e9bc", package = "nu-protocol", features = ["plugin"] }
 ratatui = "0.26.1"
 url = "2.4.0"
 
+[dev-dependencies]
+nuon = { git = "https://github.com/nushell/nushell", rev = "55edef5ddaf3d3d55290863446c2dd50c012e9bc", package = "nuon" }
+
 [target.'cfg(target_os = "macos")'.dependencies]
 crossterm = { version = "0.27.0", features = ["use-dev-tty"] }
 
@@ -21,4 +23,4 @@ bench = false
 [package]
 edition = "2021"
 name = "nu_plugin_explore"
-version = "0.92.3-c06ef201b72b3cbe901820417106b7d65c6f01e1"
+version = "0.92.3-55edef5ddaf3d3d55290863446c2dd50c012e9bc"

Makefile

@@ -1,21 +1,24 @@
 CLIPPY_OPTIONS="-D warnings"
 
-.PHONY: all check test fmt doc build register install clean
-DEFAULT: check lock test
+.PHONY: fmt-check fmt check lock clippy test doc build register install clean
+DEFAULT: fmt-check check lock clippy test
 
-check:
+fmt-check:
 	cargo fmt --all --verbose -- --check --verbose
+fmt:
+	cargo fmt --all --verbose
+
+check:
 	cargo check --workspace --lib --tests
-	cargo clippy --workspace -- "${CLIPPY_OPTIONS}"
 
 lock: check
 	./.github/workflows/scripts/check-cargo-lock.sh
 
-test: check
-	cargo test --workspace
+clippy:
+	cargo clippy --workspace -- "${CLIPPY_OPTIONS}"
 
-fmt:
-	cargo fmt --all --verbose
+test:
+	cargo test --workspace
 
 doc:
 	cargo doc --document-private-items --no-deps --open

README.md

@@ -6,9 +6,8 @@ A fast *interactive explorer* tool for *structured data* inspired by [`nu-explor
     - [*the idea behind an explorer*](#the-idea-behind-an-explorer)
     - [*why not `nu-explore`?*](#why-not-nu-explore)
 - [*installation*](#installation)
-    - [*building from source*](#building-from-source)
-    - [*installing manually*](#installing-manually)
     - [*using `nupm install` (recommended)*](#using-nupm-install-recommended)
+    - [*building from source*](#building-from-source)
 - [*usage*](#usage)
     - [*demo*](#demo)
 - [*configuration*](#configuration)
@@ -42,21 +41,16 @@ will come very handy in a day-to-day basis for me at least :)
 so here we are... LET'S GO :muscle:
 
 # installation
-## requirements
-> **Note**  
-> this is the development version of `nu_plugin_explore`, thus it does not require Nushell to be
-> installed with a stable version.
-
-let's setup the Nushell dependencies locally, because `nu-plugin` and `nu-protocol` are not release
-in version `0.xx.1`, only the stable `0.xx.0` :open_mouth:
-
-- clone the [Nushell repository][nushell/nushell] somewhere
-- setup the dependencies
-```shell
-make dev-deps
+## using `nupm install` (recommended)
+- download [nushell/nupm](https://github.com/nushell/nupm)
+- load the `nupm` module
+```nushell
+use /path/to/nupm/
+```
+- run the install process
+```nushell
+nupm install --path .
 ```
-
-there are three ways to do it:
 ## building from source
 - build the plugin
 ```shell
@@ -71,35 +65,6 @@ make register
 > **Note**  
 > alternatively, you can use directly `make install`
 
-## installing manually
-- define the install root, e.g. `$env.CARGO_HOME` or `/some/where/plugins/`
-```nushell
-let install_root: path = ...
-```
-- build and install the plugin
-```nushell
-cargo install --path . --root $install_root
-```
-- register the plugin in [Nushell]
-```nushell
-nu --commands $"register ($install_root | path join "bin" $name)"
-```
-- do not forget to restart [Nushell]
-
-## using `nupm install` (recommended)
-> **Warning**  
-> this is a very alpha software
-
-- download [nushell/nupm](https://github.com/nushell/nupm)
-- load the `nupm` module
-```nushell
-use /path/to/nupm/
-```
-- run the install process
-```nushell
-nupm install --path .
-```
-
 # usage
 - get some help
 ```nushell
@@ -117,7 +82,7 @@ open Cargo.toml | nu_plugin_explore
 ## default configuration
 you can find it in [`default.nuon`](./examples/config/default.nuon).
 
-you can copy-paste it in your `config.nu` and set `$env.explore_config` to it:
+you can copy-paste it in your `config.nu` and set `$env.config.plugins.explore` to it:
 ```nushell
 $env.config.plugins.explore = {
     # content of the default config
@@ -157,8 +122,8 @@ in order to help, you can have a look at
 - [ ] when going into a file or URL, open it
 - [x] give different colors to names and type
 - [x] show true tables as such
-- [ ] get the config from `$env.config` => can parse configuration from CLI
-- [ ] add check for the config to make sure it's valid
+- [x] get the config from `$env.config` => can parse configuration from CLI
+- [x] add check for the config to make sure it's valid
 - [ ] support for editing cells in INSERT mode
   - [x] string cells
   - [ ] other simple cells

nupm.nuon

@@ -1,6 +1,6 @@
 {
     name: nu_plugin_explore,
-    version: "0.92.3-c06ef201b72b3cbe901820417106b7d65c6f01e1",
+    version: "0.92.3-55edef5ddaf3d3d55290863446c2dd50c012e9bc"
     description: "A fast structured data explorer for Nushell.",
     license: LICENSE,
     type: custom

src/app.rs

@@ -4,27 +4,26 @@ use nu_protocol::{
     Span, Value,
 };
 
-use crate::edit::Editor;
+use crate::{config::Config, edit::Editor};
 
 /// the mode in which the application is
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Default)]
 pub enum Mode {
-    /// the NORMAL mode is the *navigation* mode, where the user can move around in the data
+    /// the *navigation* mode, where the user can move around in the data
+    #[default]
     Normal,
-    /// the INSERT mode lets the user edit cells of the structured data
+    /// lets the user edit cells of the structured data
     Insert,
-    /// the PEEKING mode lets the user *peek* data out of the application, to be reused later
+    /// lets the user *peek* data out of the application, to be reused later
     Peeking,
+    /// indicates that the user has arrived to the very bottom of the nested data, i.e. there is
+    /// nothing more to the right
     Bottom,
+    /// waits for more keys to perform an action, e.g. jumping to a line or motion repetition that
+    /// both require to enter a number before the actual action
     Waiting(usize),
 }
 
-impl Default for Mode {
-    fn default() -> Self {
-        Self::Normal
-    }
-}
-
 impl std::fmt::Display for Mode {
     fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
         let repr = match self {
@@ -38,6 +37,7 @@ impl std::fmt::Display for Mode {
     }
 }
 
+#[derive(Clone)]
 /// the complete state of the application
 pub struct App {
     /// the full current path in the data
@@ -50,6 +50,8 @@ pub struct App {
     pub editor: Editor,
     /// the value that is being explored
     pub value: Value,
+    /// the configuration for the app
+    pub config: Config,
 }
 
 impl Default for App {
@@ -60,6 +62,7 @@ impl Default for App {
             mode: Mode::default(),
             editor: Editor::default(),
             value: Value::default(),
+            config: Config::default(),
         }
     }
 }
@@ -103,11 +106,7 @@ impl App {
     }
 
     pub(super) fn enter_editor(&mut self) -> Result<(), String> {
-        let value = self
-            .value
-            .clone()
-            .follow_cell_path(&self.position.members, false)
-            .unwrap();
+        let value = self.value_under_cursor(None);
 
         if matches!(value, Value::String { .. }) {
             self.mode = Mode::Insert;
@@ -122,4 +121,27 @@ impl App {
             ))
         }
     }
+
+    pub(crate) fn value_under_cursor(&self, alternate_cursor: Option<CellPath>) -> Value {
+        self.value
+            .clone()
+            .follow_cell_path(
+                &alternate_cursor.unwrap_or(self.position.clone()).members,
+                false,
+            )
+            .unwrap_or_else(|_| {
+                panic!(
+                    "unexpected error when following {:?} in {}",
+                    self.position.members,
+                    self.value
+                        .to_expanded_string(" ", &nu_protocol::Config::default())
+                )
+            })
+    }
+
+    pub(crate) fn with_config(&self, config: Config) -> Self {
+        let mut app = self.clone();
+        app.config = config;
+        app
+    }
 }