mroot/yazi
1
0
Fork 0
mirror of https://github.com/sxyazi/yazi.git synced 2026-07-25 08:41:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

feat: add the plugin name to the deprecated API warning to make it more clear

Browse source
This commit is contained in:
sxyazi 2024-10-11 22:01:38 +08:00
parent c84917c5e8
commit da1b2365b9
No known key found for this signature in database
1 changed files with 20 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
yazi-plugin/src/cha/cha.rs
View file

@ -3,20 +3,25 @@ use std::time::{Duration, SystemTime, UNIX_EPOCH};
use mlua::{AnyUserData, ExternalError, Lua, Table, UserDataFields, UserDataMethods}; use mlua::{AnyUserData, ExternalError, Lua, Table, UserDataFields, UserDataMethods};
use yazi_shared::fs::ChaKind; use yazi_shared::fs::ChaKind;
use crate::bindings::Cast; use crate::{RtRef, bindings::Cast};
pub struct Cha; pub struct Cha;
static WARNED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false); static WARNED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
#[inline] #[inline]
fn warn_deprecated() { fn warn_deprecated(id: Option<&str>) {
if !WARNED.swap(true, std::sync::atomic::Ordering::Relaxed) { if !WARNED.swap(true, std::sync::atomic::Ordering::Relaxed) {
let id = match id {
Some(id) => format!("`{id}.yazi` plugin"),
None => "`init.lua` config".to_owned(),
};
let s = "The `created`, `modified`, `accessed`, `length`, and `permissions` properties of `Cha` have been renamed in Yazi v0.4.
Please use the new `btime`, `mtime`, `atime`, `len`, and `perm` instead, in your {id}. See https://github.com/sxyazi/yazi/pull/1761 for details.";
yazi_proxy::AppProxy::notify(yazi_proxy::options::NotifyOpt { yazi_proxy::AppProxy::notify(yazi_proxy::options::NotifyOpt {
title: "Deprecated API".to_owned(), title: "Deprecated API".to_owned(),
content: "The `created`, `modified`, `accessed`, `length`, and `permissions` properties of `Cha` have been renamed. content: s.replace("{id}", &id),
Please use the new `btime`, `mtime`, `atime`, `len`, and `perm` instead. See https://github.com/sxyazi/yazi/pull/1761 for details.".to_string(),
level: yazi_proxy::options::NotifyLevel::Warn, level: yazi_proxy::options::NotifyLevel::Warn,
timeout: Duration::from_secs(20), timeout: Duration::from_secs(20),
}); });
@ -70,24 +75,24 @@ impl Cha {
// TODO: remove these deprecated properties in the future // TODO: remove these deprecated properties in the future
{ {
reg.add_field_method_get("length", |_, me| { reg.add_field_method_get("length", |lua, me| {
warn_deprecated(); warn_deprecated(lua.named_registry_value::<RtRef>("rt")?.current());
Ok(me.len) Ok(me.len)
}); });
reg.add_field_method_get("created", |_, me| { reg.add_field_method_get("created", |lua, me| {
warn_deprecated(); warn_deprecated(lua.named_registry_value::<RtRef>("rt")?.current());
Ok(me.btime.and_then(|t| t.duration_since(UNIX_EPOCH).map(|d| d.as_secs_f64()).ok())) Ok(me.btime.and_then(|t| t.duration_since(UNIX_EPOCH).map(|d| d.as_secs_f64()).ok()))
}); });
reg.add_field_method_get("modified", |_, me| { reg.add_field_method_get("modified", |lua, me| {
warn_deprecated(); warn_deprecated(lua.named_registry_value::<RtRef>("rt")?.current());
Ok(me.mtime.and_then(|t| t.duration_since(UNIX_EPOCH).map(|d| d.as_secs_f64()).ok())) Ok(me.mtime.and_then(|t| t.duration_since(UNIX_EPOCH).map(|d| d.as_secs_f64()).ok()))
}); });
reg.add_field_method_get("accessed", |_, me| { reg.add_field_method_get("accessed", |lua, me| {
warn_deprecated(); warn_deprecated(lua.named_registry_value::<RtRef>("rt")?.current());
Ok(me.atime.and_then(|t| t.duration_since(UNIX_EPOCH).map(|d| d.as_secs_f64()).ok())) Ok(me.atime.and_then(|t| t.duration_since(UNIX_EPOCH).map(|d| d.as_secs_f64()).ok()))
}); });
reg.add_method("permissions", |_, _me, ()| { reg.add_method("permissions", |lua, _me, ()| {
warn_deprecated(); warn_deprecated(lua.named_registry_value::<RtRef>("rt")?.current());
Ok( Ok(
#[cfg(unix)] #[cfg(unix)]
Some(yazi_shared::fs::permissions(_me.perm, _me.is_dummy())), Some(yazi_shared::fs::permissions(_me.perm, _me.is_dummy())),