8000 v1 by sayanarijit · Pull Request #741 · sayanarijit/xplr · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

v1 #741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 21, 2025
Merged

v1 #741

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ path = './benches/criterion.rs'

[package]
name = 'xplr'
version = '0.21.10'
version = '1.0.0'
authors = ['Arijit Basu <hi@arijitbasu.in>']
edition = '2021'
description = 'A hackable, minimal, fast TUI file explorer'
Expand All @@ -22,18 +22,18 @@ categories = ['command-line-interface', 'command-line-utilities']
include = ['src/**/*', 'docs/en/src/**/*', 'LICENSE', 'README.md']

[dependencies]
libc = "0.2.169"
libc = "0.2.171"
humansize = "2.1.3"
natord = "1.0.9"
anyhow = "1.0.95"
anyhow = "1.0.97"
serde_yaml = "0.9.34"
crossterm = { version = "0.28.1", features = [], default-features = false }
ansi-to-tui = "7.0.0"
regex = "1.11.1"
gethostname = "1.0.0"
serde_json = "1.0.138"
path-absolutize = "3.1.1"
which = "7.0.1"
which = "7.0.2"
nu-ansi-term = "0.50.1"
textwrap = "0.16.1"
snailquote = "0.3.1"
Expand Down
25 changes: 20 additions & 5 deletions docs/en/src/upgrade-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
When you upgrade xplr, you might see an error like this

```
Incompatible script version in: /home/sayanarijit/.config/xplr/init.lua. The script version is: 0.9.0, the required version is: 0.10.1. Visit https://github.com/sayanarijit/xplr/wiki/Upgrade-Guide
Incompatible script version in: /home/user/.config/xplr/init.lua. The script version is: 0.21.0, the required version is: 1.0.0. Visit https://xplr.dev/en/upgrade-guide
```

All you need to do is follow the [instructions][1] starting from
Expand Down Expand Up @@ -37,14 +37,28 @@ e.g.
e.g. `app-1.0.0` with `config-1.1.0`. But vice versa is fine.
- `1.0.0` -> `x.x.x`: Not compatible at all.

Note that until we're `v1`, we'll be using the `{minor}` version number as
`{major}`, and the `{patch}` number as `{minor}` to determine
compatibility.

</details>

### Instructions

#### [v0.21.10][49] -> [v0.1.0][51]

- This release added a new message `TryCompletePath` which will try to complete
the path in the input buffer. You should use this message instead of the
fragile `xplr.fn.builtin.try_complete_path` Lua function, which will still
keep working (with a warning log message) for compatibility reasons.

**ANNOUNCEMENT:**

This is not really a breaking change, but a declaration of the first stable
release. You cat set `version = "1.0.0"` in your config file without any
concern. With this release, xplr v1 can be considered feature complete.

As of now, there is no plan for xplr v2, and so, the project will enter cleanup
and maintenance mode. Thank you everyone, who directly or indirectly contributed
to xplr, for all your effort, support and feedback. Looking forward to more
such collaborations in the future.

#### [v0.20.2][48] -> [v0.21.10][49]

- Some plugins might stop rendering colors. Wait for them to update.
Expand Down Expand Up @@ -531,3 +545,4 @@ Else do the following:
[48]: https://github.com/sayanarijit/xplr/releases/tag/v0.20.2
[49]: https://github.com/sayanarijit/xplr/releases/tag/v0.21.10
[50]: https://github.com/lotabout/skim#search-syntax
[51]: https://github.com/sayanarijit/xplr/releases/tag/v1.0.0
16 changes: 8 additions & 8 deletions src/lua/mod.rs
< A1F1 /tr>
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use std::fs;
pub mod util;

const DEFAULT_LUA_SCRIPT: &str = include_str!("../init.lua");
const UPGRADE_GUIDE_LINK: &str = "https://xplr.dev/en/upgrade-guide.html";
const UPGRADE_GUIDE_LINK: &str = "https://xplr.dev/en/upgrade-guide";

pub fn serialize<T: Serialize + Sized>(
lua: &mlua::Lua,
Expand Down Expand Up @@ -153,24 +153,24 @@ mod tests {
assert!(check_version(VERSION, "foo path").is_ok());

// Current release if OK
assert!(check_version("0.21.10", "foo path").is_ok());
assert!(check_version("1.0.0", "foo path").is_ok());

// Prev major release is ERR
// - Not yet
assert!(check_version("0.20.0", "foo path").is_err());

// Prev minor release is ERR (Change when we get to v1)
assert!(check_version("0.20.10", "foo path").is_err());
// assert!(check_version("1.-1.0", "foo path").is_err());

// Prev bugfix release is OK
assert!(check_version("0.21.9", "foo path").is_ok());
// assert!(check_version("1.0.-1", "foo path").is_ok());

// Next major release is ERR
assert!(check_version("1.20.10", "foo path").is_err());
assert!(check_version("2.0.0", "foo path").is_err());

// Next minor release is ERR
assert!(check_version("0.22.10", "foo path").is_err());
assert!(check_version("1.1.0", "foo path").is_err());

// Next bugfix release is ERR (Change when we get to v1)
assert!(check_version("0.21.11", "foo path").is_err());
assert!(check_version("1.0.1", "foo path").is_err());
}
}
Loading
0