New way to add plugins #250

neiromaster · 2023-02-28T14:19:04Z

License Acceptance

This repository is Apache version 2.0 licensed (some scripts may have alternate licensing inline in their code) and by making this PR, I am contributing my changes to the repository under the terms of the Apache 2 license.

Description

The way to add plugins using a list file has been updated. The ability to add plugins as separate files has been added

resolves #242

Type of changes

Checklist

I have read the CONTRIBUTING document.
I have updated the readme if this PR changes/updates quickstart functionality.
All new and existing tests pass.
Any scripts added use #!/usr/bin/env interpreter instead of potentially platform-specific direct paths (#!/bin/sh is an allowed exception)
Scripts are marked executable
Scripts do not have a language file extension unless they are meant to be sourced and not run standalone. No one should have to know if a script was written in bash, python, ruby or whatever. Not including file extensions makes it easier to rewrite the script in another language later without having to change every reference to the previous version.
I have added a credit line to README.md for the script
If there was no author credit in a script added in this PR, I have added one.
I have confirmed that the link(s) in my PR are valid.

codeclimate · 2023-02-28T14:19:34Z

Code Climate has analyzed commit 8bd2cd1 and detected 0 issues on this pull request.

View more on Code Climate.

Signed-off-by: neiromaster <[email protected]>

unixorn

A few minor changes, but otherwise this is looking good.

zsh/.zshrc

…d-plugins Signed-off-by: neiromaster <[email protected]>

unixorn · 2023-02-28T14:55:38Z

@neiromaster
Something was nagging at me and I remembered what it was. It's not an inherent problem with having the plugins get loaded from a directory like this, but with how the kit currently determines when to regenerate init.zsh

Currently, the kit (inside ~/.zgen_setup) looks at the modification dates of REAL_ZGEN_SETUP, which is either ~/.zgen-local-plugins or when present, ~/.zsh-quickstart-local-plugins, and calls setup-zgen-repos which creates a new init.zsh.

If we're going to load fragment files from a directory, we have to figure out a way to detect changes to it without regenerating init.zsh every session startup.

Something with the directory's modification date?

unixorn · 2023-02-28T14:58:39Z

Hit submit too soon.

Add a check of the directory's modification date and ~/.zgenon/init.zsh so that we call setup-zgen-repos if the directory has been updated too.

neiromaster · 2023-02-28T14:59:03Z

I'm going to think about how to solve this problem. I may have to check every file

unixorn

Yeah, it's an ugly edge case to deal with.

If reading the directory's modification timestamp directly doesn't work, maybe loop over the mod timestamps of every file in the directory. I hate to add more loops of stuff during session startup, but that may be the only solution.

If you do end up going with the loop, make sure it breaks and calls setup-zgen-repos as soon as it finds a modified file - no point in checking the rest of the fragments since at that point we know we have to call it.

The rest of the PR looks solid

zsh/.zshrc

neiromaster · 2023-02-28T15:18:12Z

Changing the content of a file under the directory will not change the directory’s last modification time. So we have to do the cycle. I don't think there will be too many files in there for any of the users, so I don't think it will have any effect on the launch speed at all

unixorn · 2023-02-28T15:29:35Z

I was afraid of that. Go ahead with the loop, you're right about the number of files not really affecting start speed.

Also please update readme to explicitly state that a fragment in the directory can have multiple plugins inside, and that less files will mean a faster startup.

Maybe include an example where there are 00-everywhere, 01-personal-only-plugins and 02-work-only-plugins files?

I appreciate the contribution, I'm always interested in ways to customize the kit that don't require users to maintain their own forks.

neiromaster · 2023-02-28T16:07:21Z

Can you give me a hint? Should I add the example as an image (in pseudo-graphics) in the readme or add an example folder to the repository?

unixorn · 2023-02-28T19:32:06Z

Go ahead and do the code and I'll add some examples of all/home/work files into the readme

neiromaster · 2023-03-01T08:15:39Z

I was able to do the check by checking the date of the files. But if I uninstall a plugin, it still persists even after zgen-setup and zqs update. This is old behavior. Perhaps it would be a good idea to add a command to zqs to clean up the saved files so you don't have to do it manually

unixorn · 2023-03-01T17:15:56Z

Go ahead and add your code here, then we can add zqs cleanup in #252

…e init file Signed-off-by: neiromaster <[email protected]>

Signed-off-by: neiromaster <[email protected]>

neiromaster · 2023-03-01T18:37:09Z

Check my changes. I haven't written bash scripts for quite a long time, so I might have made a mistake somewhere. But locally it works correctly for me

unixorn · 2023-03-01T20:40:55Z

zsh/.zgen-setup

@@ -290,5 +290,29 @@ fi
 if [ $(get_file_modification_time ${REAL_ZGEN_SETUP}) -gt $(get_file_modification_time ~/.zgenom/init.zsh) ]; then
 echo "$(basename ${REAL_ZGEN_SETUP}) ($REAL_ZGEN_SETUP) updated; creating a new init.zsh from plugin list in ${REAL_ZGEN_SETUP}"
 setup-zgen-repos
+elif [ -d ~/.zshrc.add-plugins.d ]; then


Thanks for only looking at the plugin fragments if we don't already need to rebuild init.zsh because of $REAL_ZGEN_SETUP. Every bit of speedup helps.

unixorn · 2023-03-01T23:04:00Z

Thanks for the contribution!

Update the plugin customization section of the readme now that #250 is merged. Signed-off-by: Joe Block <[email protected]>

Update the plugin customization section of the readme now that unixorn#250 is merged. Signed-off-by: Joe Block <[email protected]>

New way to add plugins

2729163

Signed-off-by: neiromaster <[email protected]>

neiromaster force-pushed the main branch from 9daeff7 to 2729163 Compare February 28, 2023 14:24

unixorn requested changes Feb 28, 2023

View reviewed changes

zsh/.zshrc Outdated Show resolved Hide resolved

The new plugins will be moved to .zshrc.add-plugins.d/0000-transferre…

3fb066b

…d-plugins Signed-off-by: neiromaster <[email protected]>

neiromaster force-pushed the main branch from c985506 to 3fb066b Compare February 28, 2023 14:49

unixorn reviewed Feb 28, 2023

View reviewed changes

zsh/.zshrc Show resolved Hide resolved

unixorn mentioned this pull request Mar 1, 2023

Add zqs cleanup command #252

Closed

neiromaster added 2 commits March 1, 2023 21:34

Checking the time of the files in the plugins folder to regenerate th…

db537f0

…e init file Signed-off-by: neiromaster <[email protected]>

Various checks of the plugin folder

8bd2cd1

Signed-off-by: neiromaster <[email protected]>

unixorn approved these changes Mar 1, 2023

View reviewed changes

unixorn merged commit b750af7 into unixorn:main Mar 1, 2023

unixorn added a commit that referenced this pull request Mar 1, 2023

Update plugin customization documentation.

9156145

Update the plugin customization section of the readme now that #250 is merged. Signed-off-by: Joe Block <[email protected]>

This was referenced Mar 1, 2023

Update plugin customization documentation. #256

Merged

Make the quickstart kit easier to customize without maintaining a separate fork #205

Open

seanb4t pushed a commit to seanb4t/zsh-quickstart-kit that referenced this pull request May 12, 2023

Update plugin customization documentation.

807c621

Update the plugin customization section of the readme now that unixorn#250 is merged. Signed-off-by: Joe Block <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New way to add plugins #250

New way to add plugins #250

neiromaster commented Feb 28, 2023 •

edited

Loading

codeclimate bot commented Feb 28, 2023 •

edited

Loading

unixorn left a comment

unixorn commented Feb 28, 2023

unixorn commented Feb 28, 2023

neiromaster commented Feb 28, 2023

unixorn left a comment

neiromaster commented Feb 28, 2023

unixorn commented Feb 28, 2023

neiromaster commented Feb 28, 2023

unixorn commented Feb 28, 2023

neiromaster commented Mar 1, 2023

unixorn commented Mar 1, 2023

neiromaster commented Mar 1, 2023

unixorn Mar 1, 2023

unixorn commented Mar 1, 2023

New way to add plugins #250

New way to add plugins #250

Conversation

neiromaster commented Feb 28, 2023 • edited Loading

License Acceptance

Description

Type of changes

Checklist

codeclimate bot commented Feb 28, 2023 • edited Loading

unixorn left a comment

Choose a reason for hiding this comment

unixorn commented Feb 28, 2023

unixorn commented Feb 28, 2023

neiromaster commented Feb 28, 2023

unixorn left a comment

Choose a reason for hiding this comment

neiromaster commented Feb 28, 2023

unixorn commented Feb 28, 2023

neiromaster commented Feb 28, 2023

unixorn commented Feb 28, 2023

neiromaster commented Mar 1, 2023

unixorn commented Mar 1, 2023

neiromaster commented Mar 1, 2023

unixorn Mar 1, 2023

Choose a reason for hiding this comment

unixorn commented Mar 1, 2023

neiromaster commented Feb 28, 2023 •

edited

Loading

codeclimate bot commented Feb 28, 2023 •

edited

Loading