Merge branch 'zellij-org:main' into sync

Author: xuanyuan300

.github/ISSUE_TEMPLATE/blank_issue.md

@@ -1,4 +1,10 @@
 ---
 name: Blank Issue
 about: Create a blank issue.
+title: ''
+labels: ''
+assignees: ''
+
 ---
+
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,11 +1,21 @@
 ---
 name: "\U0001F41B Bug Report"
-about: "If something isn't working as expected."
+about: If something isn't working as expected.
+title: ''
 labels: bug
+assignees: ''
+
 ---
-Thank you for taking the time to file this issue! Please follow the instructions and fill in the missing parts below the instructions, if it is meaningful. Try to be brief and concise.
 
-**In Case of Graphical or Performance Issues**
+<!-- Please choose the relevant section, follow the instructions and delete the other sections:
+
+1. Graphical issue inside a terminal pane (eg. something does not look as it should or as it looks outside of Zellij)
+2. Issues with the Zellij UI / behavior
+
+** Please note: comparisons of desired behavior to tmux are usually not relevant. tmux and Zellij are two extremely different programs that do things very differently. Zellij is not, nor does it try to be, a tmux clone. Please try to refrain from such comparisons. **
+-->
+
+# 1. Graphical issue inside a terminal pane (eg. something does not look as it should)
 
 1. Delete the contents of `/tmp/zellij-1000/zellij-log`, ie with `cd /tmp/zellij-1000/` and `rm -fr zellij-log/` (`/tmp/` is `$TMPDIR/` on OSX)
 2. Run `zellij --debug`
@@ -18,12 +28,30 @@ Please attach the files that were created in `/tmp/zellij-1000/zellij-log/` to t
 **Basic information**
 
 `zellij --version`:
+
 `stty size`:
-`uname -av` or `ver`(Windows):
 
-List of programs you interact with as, `PROGRAM --version`: output cropped meaningful, for example:
-`nvim --version`: NVIM v0.5.0-dev+1299-g1c2e504d5  (used the appimage release)
-`alacritty --version`: alacritty 0.7.2 (5ac8060b)
+`uname -av` or `ver`(Windows):
 
-**Further information**
+## Further information
 Reproduction steps, noticeable behavior, related issues, etc
+
+# 2. Issues with the Zellij UI / behavior
+<!-- Please find a minimal reproduction. 
+
+If you have a complex setup that causes an issue, try to troubleshoot and narrow the problem down to as minimal a reproduction as possible. Remove as many parts of the equation as you can. 
+
+If you are unsure what to do, you are welcome to ask for help either in the issue itself or in one of our community chats (Discord / Matrix). We will be happy to try and assist or suggest directions, but please note that the responsibility to troubleshoot the issue and find the problem is ultimately on your shoulders. 
+
+You're the expert on your system and we believe you are in the best position to troubleshoot it. Thank you for understanding.
+
+Example of a good issue report: "The `default_tab_template` layout node does not work when resurrecting sessions".
+
+Example of an issue report that needs work before being submitted: "Zellij randomly crashes without an error when I use it with the attached script".
+-->
+
+## Issue description
+
+## Minimal reproduction
+
+## Other relevant information

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!--
+
+Note on new features: while Zellij tries to be as user friendly as possible, it must also be friendly to its maintainers. We take great care in considering which features should be included in the core Zellij functionality - because each such feature means more maintenance overhead for the project.
+
+On the other hand, we know our users care about the program a great deal and would like to see it improve. For this reason, we try to make an effort to allow users to develop their desired new features as Zellij plugins (https://zellij.dev/documentation/plugins). Please consider whether your feature can be a plugin itself, and if not - try to think which APIs you need in order to make it possible. A feature request for a plugin API will likely be given higher priority than one for a Zellij core feature.
+
+** Note on comparisons to tmux: Zellij is not, nor does it try to be, a tmux clone. While we appreciate that many people use it as a tmux alternative and are missing their favorite features - this is not what we do here. There are often native alternatives to tmux features that Zellij does differently. We would encourage you to look into those alternatives rather than try to make it work exactly like tmux. A good place to start would be our FAQ: https://zellij.dev/documentation/faq
+
+We believe each program has its strengths and weaknesses, and hope that users would want to use Zellij for what it can do, rather than trying to make it behave like something it does not want to be. Thank you for understanding! **
+
+-->

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [Unreleased]
+* feat(plugins): skip plugin cache flag when loading plugins (https://github.com/zellij-org/zellij/pull/2971)
+* fix(grid): recover from various errors (https://github.com/zellij-org/zellij/pull/2972)
+* fix(grid): flaky scroll with scroll region (https://github.com/zellij-org/zellij/pull/2935)
+* fix(plugins): display errors properly (https://github.com/zellij-org/zellij/pull/2975)
+* feat(terminal): implement synchronized renders (https://github.com/zellij-org/zellij/pull/2977)
+
+## [0.39.2] - 2023-11-29
+* fix(cli): typo in cli help (https://github.com/zellij-org/zellij/pull/2906)
+* fix(sessions): slow session updates in the session-manager (https://github.com/zellij-org/zellij/pull/2951)
+* fix: compiler warnings (https://github.com/zellij-org/zellij/pull/2873)
 
 ## [0.39.1] - 2023-11-13
 * fix: styled underlines in editors (https://github.com/zellij-org/zellij/pull/2918)

default-plugins/status-bar/src/second_line.rs

@@ -245,7 +245,7 @@ fn get_keys_and_hints(mi: &ModeInfo) -> Vec<(String, String, Vec<Key>)> {
             action_key(&km, &[A::SearchToggleOption(SOpt::WholeWord)])),
     ]} else if mi.mode == IM::Session { vec![
         (s("Detach"), s("Detach"), action_key(&km, &[Action::Detach])),
-        (s("Session Manager"), s("Manager"), action_key(&km, &[A::LaunchOrFocusPlugin(Default::default(), true, true, false), TO_NORMAL])), // not entirely accurate
+        (s("Session Manager"), s("Manager"), action_key(&km, &[A::LaunchOrFocusPlugin(Default::default(), true, true, false, false), TO_NORMAL])), // not entirely accurate
         (s("Select pane"), s("Select"), to_normal_key),
     ]} else if mi.mode == IM::Tmux { vec![
         (s("Move focus"), s("Move"), action_key_group(&km, &[

docs/THIRD_PARTY_INSTALL.md

@@ -13,7 +13,7 @@
 [![Packaging status](https://repology.org/badge/vertical-allrepos/zellij.svg)](https://repology.org/project/zellij/versions)
 
 ### Arch Linux
-You can install the `zellij` package from the [official community repository](https://archlinux.org/packages/community/x86_64/zellij/):
+You can install the `zellij` package from the [official extra repository](https://archlinux.org/packages/extra/x86_64/zellij/):
 
 ```
 pacman -S zellij

src/main.rs

@@ -31,6 +31,7 @@ fn main() {
             start_suspended,
         })) = opts.command
         {
+            let skip_plugin_cache = false; // N/A for this action
             let command_cli_action = CliAction::NewPane {
                 command,
                 plugin: None,
@@ -42,6 +43,7 @@ fn main() {
                 close_on_exit,
                 start_suspended,
                 configuration: None,
+                skip_plugin_cache,
             };
             commands::send_action_to_session(command_cli_action, opts.session, config);
             std::process::exit(0);
@@ -51,6 +53,7 @@ fn main() {
             floating,
             in_place,
             configuration,
+            skip_plugin_cache,
         })) = opts.command
         {
             let command_cli_action = CliAction::NewPane {
@@ -64,6 +67,7 @@ fn main() {
                 close_on_exit: false,
                 start_suspended: false,
                 configuration,
+                skip_plugin_cache,
             };
             commands::send_action_to_session(command_cli_action, opts.session, config);
             std::process::exit(0);

zellij-server/src/background_jobs.rs

@@ -78,7 +78,8 @@ impl From<&BackgroundJob> for BackgroundJobContext {
 
 static FLASH_DURATION_MS: u64 = 1000;
 static PLUGIN_ANIMATION_OFFSET_DURATION_MD: u64 = 500;
-static SESSION_READ_DURATION: u64 = 60000;
+static SESSION_READ_DURATION: u64 = 1000;
+static DEFAULT_SERIALIZATION_INTERVAL: u64 = 60000;
 
 pub(crate) fn background_jobs_main(
     bus: Bus<BackgroundJob>,
@@ -90,6 +91,7 @@ pub(crate) fn background_jobs_main(
     let current_session_name = Arc::new(Mutex::new(String::default()));
     let current_session_info = Arc::new(Mutex::new(SessionInfo::default()));
     let current_session_layout = Arc::new(Mutex::new((String::new(), BTreeMap::new())));
+    let last_serialization_time = Arc::new(Mutex::new(Instant::now()));
     let serialization_interval = serialization_interval.map(|s| s * 1000); // convert to
                                                                            // milliseconds
 
@@ -165,6 +167,7 @@ pub(crate) fn background_jobs_main(
                     let current_session_info = current_session_info.clone();
                     let current_session_name = current_session_name.clone();
                     let current_session_layout = current_session_layout.clone();
+                    let last_serialization_time = last_serialization_time.clone();
                     async move {
                         loop {
                             let current_session_name =
@@ -185,11 +188,20 @@ pub(crate) fn background_jobs_main(
                                 session_infos_on_machine,
                                 resurrectable_sessions,
                             ));
-                            let _ = senders.send_to_screen(ScreenInstruction::DumpLayoutToHd);
-                            task::sleep(std::time::Duration::from_millis(
-                                serialization_interval.unwrap_or(SESSION_READ_DURATION),
-                            ))
-                            .await;
+                            if last_serialization_time
+                                .lock()
+                                .unwrap()
+                                .elapsed()
+                                .as_millis()
+                                >= serialization_interval
+                                    .unwrap_or(DEFAULT_SERIALIZATION_INTERVAL)
+                                    .into()
+                            {
+                                let _ = senders.send_to_screen(ScreenInstruction::DumpLayoutToHd);
+                                *last_serialization_time.lock().unwrap() = Instant::now();
+                            }
+                            task::sleep(std::time::Duration::from_millis(SESSION_READ_DURATION))
+                                .await;
                         }
                     }
                 });
@@ -421,10 +433,15 @@ fn find_resurrectable_sessions(
                     {
                         Ok(created) => Some(created),
                         Err(e) => {
-                            log::error!(
-                                "Failed to read created stamp of resurrection file: {:?}",
-                                e
-                            );
+                            if e.kind() != std::io::ErrorKind::NotFound {
+                                // let's not spam the
+                                // logs if serialization
+                                // is disabled
+                                log::error!(
+                                    "Failed to read created stamp of resurrection file: {:?}",
+                                    e
+                                );
+                            }
                             None
                         },
                     };

zellij-server/src/os_input_output.rs

@@ -580,18 +580,17 @@ impl ServerOsApi for ServerOsInputOutput {
             .lock()
             .to_anyhow()
             .with_context(err_context)?;
-        let mut terminal_id = None;
-        {
-            let current_ids: BTreeSet<u32> = self
-                .terminal_id_to_raw_fd
-                .lock()
-                .to_anyhow()
-                .with_context(err_context)?
-                .keys()
-                .copied()
-                .collect();
-            terminal_id = current_ids.last().map(|l| l + 1).or(Some(0));
-        }
+        let terminal_id = self
+            .terminal_id_to_raw_fd
+            .lock()
+            .to_anyhow()
+            .with_context(err_context)?
+            .keys()
+            .copied()
+            .collect::<BTreeSet<u32>>()
+            .last()
+            .map(|l| l + 1)
+            .or(Some(0));
         match terminal_id {
             Some(terminal_id) => {
                 self.terminal_id_to_raw_fd
@@ -622,18 +621,17 @@ impl ServerOsApi for ServerOsInputOutput {
     fn reserve_terminal_id(&self) -> Result<u32> {
         let err_context = || "failed to reserve a terminal ID".to_string();
 
-        let mut terminal_id = None;
-        {
-            let current_ids: BTreeSet<u32> = self
-                .terminal_id_to_raw_fd
-                .lock()
-                .to_anyhow()
-                .with_context(err_context)?
-                .keys()
-                .copied()
-                .collect();
-            terminal_id = current_ids.last().map(|l| l + 1).or(Some(0));
-        }
+        let terminal_id = self
+            .terminal_id_to_raw_fd
+            .lock()
+            .to_anyhow()
+            .with_context(err_context)?
+            .keys()
+            .copied()
+            .collect::<BTreeSet<u32>>()
+            .last()
+            .map(|l| l + 1)
+            .or(Some(0));
         match terminal_id {
             Some(terminal_id) => {
                 self.terminal_id_to_raw_fd