Skip to content
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

Added new Docs page to describe Plugins. #6188

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

alecthegeek
Copy link

@alecthegeek alecthegeek commented Sep 24, 2024

TODO:

  1. Add a section to the reference for wezterm.plugins
  2. Create a plugin starter project NOTE: Seperate project at https://gitlab.com/alecthegeek/wezterm-plugin-mgr

#6177

WIP for review

TODO:

1. Add a section to the reference for `wezterm.plugins`
2. Create a plugin starter project

wez#6177
1. Remove references to my specific example repo
2. Improve Lua code
@alecthegeek alecthegeek marked this pull request as draft September 25, 2024 03:44
@alecthegeek alecthegeek marked this pull request as ready for review September 25, 2024 03:47
@MLFlexer
Copy link
Contributor

There are some details described in the docs included in #5820 about the names derived from the url, which might be useful for this PR

@alecthegeek
Copy link
Author

There are some details described in the docs included in #5820 about the names derived from the url, which might be useful for this PR

Thanks fot the review @MLFlexer -- much appreciated.

I assume you are referring to the URL encoding to derive the plugin dir?

I did consider that, but decided it was easier to leave it out. It's not really needed as users and developers can use list function to get the plugin location.

Also one less thing to update if it changes in the future.

Is there some use case I have not considered?

Cheers

@MLFlexer
Copy link
Contributor

Thanks fot the review @MLFlexer -- much appreciated.

I assume you are referring to the URL encoding to derive the plugin dir?

I did consider that, but decided it was easier to leave it out. It's not really needed as users and developers can use list function to get the plugin location.

Also one less thing to update if it changes in the future.

Is there some use case I have not considered?

Cheers

The only thing I as a plugin developer could have benefited from was knowing how the directory name was computed, as it is useful for adding sub-modules to the plugins via. adding the plugin directory to the lua path. However thinking more about it, I agree that it should be left out, as it does not provide a good solution to the sub-module problem anyways.

I'm also of the belief that the docs should be keeps simple, stupid, as to keep them readable and to not confuse others. So I agree with leaving it out.

Copy link
Contributor

@MLFlexer MLFlexer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, there are some very nice examples and tips which would have helped me when developing plugins 😄

docs/config/lua/wezterm.plugin/index.markdown Outdated Show resolved Hide resolved
docs/config/lua/wezterm.plugin/list.md Outdated Show resolved Hide resolved
docs/config/lua/wezterm.plugin/require.md Show resolved Hide resolved
docs/config/lua/wezterm.plugin/update_all.md Outdated Show resolved Hide resolved
docs/config/plugins.md Outdated Show resolved Hide resolved
docs/config/plugins.md Show resolved Hide resolved
docs/config/plugins.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants