-
-
Notifications
You must be signed in to change notification settings - Fork 805
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# `wezterm.plugin.list()` | ||
|
||
{{since('???')}} | ||
|
||
Returns an array of all the plugins within the plugin directory. | ||
|
||
The elements consists of tables with: | ||
`url` from where the git repository is hosted. | ||
`component`, that is the name of the local root repository root directory. | ||
`plugin_dir` the full path to the repository root directory. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# `wezterm.plugin.plugin_dir()` | ||
|
||
{{since('???')}} | ||
|
||
Returns the path of the plugin root directory. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# `wezterm.plugin.require()` | ||
|
||
{{since('???')}} | ||
|
||
Takes a `url` string as argument, which it will use to clone the git repository if not already cloned, and then require the lua files. | ||
|
||
It will do so by making a directory based on the `url` but with `/` and `\` replaced by `sZs`, `:` replaced by `sCs` and `.` replaced by `sDs`. | ||
It will place this directory in the plugins directory and then clone the repository into it. | ||
|
||
It will try to require `init.lua` from the repository root or in the `plugin/` sub directory. | ||
|
||
It is recommended to use [require_as_alias](./require_as_alias.md) instead to make it easy to require lua files via the alias instead of the modified url name. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# `wezterm.plugin.require_as_alias()` | ||
|
||
{{since('???')}} | ||
|
||
Takes a `url` string and a `alias` string as argument. | ||
|
||
It will make a sub directory with the name of the alias in the plugins sub directory and then clone the git repository from the url into this directory. | ||
|
||
It is assumed that the lua files are placed in a `init.lua` in the repository root or in the `plugin/` sub-directory of the repository root. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# `wezterm.plugin.update_all()` | ||
|
||
{{since('???')}} | ||
|
||
Will update each plugin in the plugin directory, by first fetching, then merging if there are any changes. | ||
|