Upstream/waveterm
1
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm.git synced 2025-02-08 00:21:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

roadmap updates, and 1 other doc change (#1859)

Browse Source
This commit is contained in:
Mike Sawka 2025-01-27 16:02:30 -08:00 committed by GitHub
parent 2895b61e10
commit 5450fd8269
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 28 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
ROADMAP.md
View File

@ -8,7 +8,7 @@ Legend: ✅ Done | 🔧 In Progress | 🔷 Planned | 🤞 Stretch Goal
## v0.11.0 ## v0.11.0
Currently in beta, targeting release on 1/24. Released on 1/25/25
- ✅ File/Directory Preview improvements - ✅ File/Directory Preview improvements
- ✅ Reworked fileshare layer running over RPC - ✅ Reworked fileshare layer running over RPC
@ -26,22 +26,29 @@ Currently in beta, targeting release on 1/24.
## v0.11.1 ## v0.11.1
Likely to follow v0.11 by 1 week. Targeting 1/31/25
- 🔧 Reduce main-line 2FA requests to 1 per connection - 🔧 Reduce main-line 2FA requests to 1 per connection
- 🔷 Frontend Only Widgets, React + Babel Transpiling in an iframe/webview
- 🔷 Monaco Theming
- 🔧 Remote S3 bucket browsing (directory + files) - 🔧 Remote S3 bucket browsing (directory + files)
- 🔷 Drag & drop between preview blocks - 🔷 Drag & drop between preview blocks
- 🔷 Drag into a preview directory from the native file browser or desktop to copy a file - 🔷 Drag into/out of a preview block from native file explorer
- 🔷 Wave Apps (Go SDK) - 🔷 Wave Apps (Go SDK)
- 🤞 Explore VSCode Extension Compatibility with standalone Monaco Editor (language servers) - 🔷 JSON schema support (basic)
- 🤞 Frontend Only Widgets, React + Babel Transpiling in an iframe/webview
## v0.12 ## v0.12
Targeting mid-February (more will get added before work on v0.12 kicks off)
- 🔷 Import/Export Tab Layouts and Widgets - 🔷 Import/Export Tab Layouts and Widgets
- 🔷 log viewer - 🔷 log viewer
- 🔷 binary viewer - 🔷 binary viewer
- 🔷 New layout actions (splitting, replacing blocks)
- 🔷 Rewrite of window/tab system
- 🔷 Minimized / Non-Visible blocks
- 🔷 Custom keybindings to quickly switch / invoke built-in and custom widgets
- 🔷 More Drag & Drop support of files/URLs to create blocks
- 🔷 Tab Templates
## Planned (Unscheduled) ## Planned (Unscheduled)
@ -50,3 +57,8 @@ Likely to follow v0.11 by 1 week.
- 🔷 Re-assign system keybindings - 🔷 Re-assign system keybindings
- 🔷 Command Palette - 🔷 Command Palette
- 🔷 AI Context - 🔷 AI Context
- 🔷 Monaco Theming
- 🔷 File system watching for Preview
- 🔷 File system watching for drag and drop
- 🤞 Explore VSCode Extension Compatibility with standalone Monaco Editor (language servers)
- 🤞 VSCode File Icons in Preview

12
docs/docs/customwidgets.mdx
View File

@ -96,19 +96,27 @@ The `WidgetConfigType` takes the usual options common to all widgets. The `MetaT
| "view" | A string that specifies the general type of widget. In the case of custom terminal widgets, this must be set to `"term"`. | | "view" | A string that specifies the general type of widget. In the case of custom terminal widgets, this must be set to `"term"`. |
| "controller" | A string that specifies the type of command being used. For more persistent shell sessions, set it to "shell". For one off commands, set it to `"cmd"`. When `"cmd"` is set, the widget has an additional refresh button in its header that allows the command to be re-run. | | "controller" | A string that specifies the type of command being used. For more persistent shell sessions, set it to "shell". For one off commands, set it to `"cmd"`. When `"cmd"` is set, the widget has an additional refresh button in its header that allows the command to be re-run. |
| "cmd" | (optional) When the `"controller"` is set to `"cmd"`, this option provides the actual command to be run. Note that because it is run as a command, there is no shell session unless you are launching a command that contains a shell session itself. Defaults to an empty string. | | "cmd" | (optional) When the `"controller"` is set to `"cmd"`, this option provides the actual command to be run. Note that because it is run as a command, there is no shell session unless you are launching a command that contains a shell session itself. Defaults to an empty string. |
| "cmd:args" | (optional, array of strings) arguments to pass to the `cmd` |
| "cmd:shell" | (optional) if cmd:shell if false (default), then we use `cmd` + `cmd:args` (suitable to pass to `execve`). if cmd:shell is true, then we just use `cmd`, and cmd can include spaces, and shell syntax (like pipes or redirections, etc.) |
| "cmd:interactive" | (optional) When the `"controller"` is set to `"term", this boolean adds the interactive flag to the launched terminal. Defaults to false. | | "cmd:interactive" | (optional) When the `"controller"` is set to `"term", this boolean adds the interactive flag to the launched terminal. Defaults to false. |
| "cmd:login" | (optional) When the `"controller"` is set to `"term"`, this boolean adds the login flag to the term command. Defaults to false. | | "cmd:login" | (optional) When the `"controller"` is set to `"term"`, this boolean adds the login flag to the term command. Defaults to false. |
| "cmd:runonstart" | (optional) The command will rerun when the app is started. Without it, you must manually run the command. Defaults to true. | | "cmd:runonstart" | (optional) The command will rerun when the block is created or the app is started. Without it, you must manually run the command. Defaults to true. |
| "cmd:runonce" | (optional) Runs on start, but then sets "cmd:runonce" and "cmd:runonstart" to false (so future runs require manual restarts) | | "cmd:runonce" | (optional) Runs on start, but then sets "cmd:runonce" and "cmd:runonstart" to false (so future runs require manual restarts) |
| "cmd:clearonstart" | (optional) When the cmd runs, the contents of the block are cleared out. Defaults to false. | | "cmd:clearonstart" | (optional) When the cmd runs, the contents of the block are cleared out. Defaults to false. |
| "cmd:closeonexit" | (optional) Automatically closes the block if the command successfully exits (exit code = 0) | | "cmd:closeonexit" | (optional) Automatically closes the block if the command successfully exits (exit code = 0) |
| "cmd:closeonexitforce" | (optional) Automatically closes the block if when the command exits (success or failure) | | "cmd:closeonexitforce" | (optional) Automatically closes the block if when the command exits (success or failure) |
| "cmd:closeonexitdelay | (optional) Change the delay between when the command exits and when the block gets closed, in milliseconds, default 2000 | | "cmd:closeonexitdelay | (optional) Change the delay between when the command exits and when the block gets closed, in milliseconds, default 2000 |
| "cmd:env" | (optional) A key-value object represting environment variables to be run with the command. Currently only works locally. Defaults to an empty object. | | "cmd:env" | (optional) A key-value object represting environment variables to be run with the command. Defaults to an empty object. |
| "cmd:cwd" | (optional) A string representing the current working directory to be run with the command. Currently only works locally. Defaults to the home directory. | | "cmd:cwd" | (optional) A string representing the current working directory to be run with the command. Currently only works locally. Defaults to the home directory. |
| "cmd:nowsh" | (optional) A boolean that will turn off wsh integration for the command. Defaults to false. | | "cmd:nowsh" | (optional) A boolean that will turn off wsh integration for the command. Defaults to false. |
| "term:localshellpath" | (optional) Sets the shell used for running your widget command. Only works locally. If left blank, wave will determine your system default instead. | | "term:localshellpath" | (optional) Sets the shell used for running your widget command. Only works locally. If left blank, wave will determine your system default instead. |
| "term:localshellopts" | (optional) Sets the shell options meant to be used with `"term:localshellpath"`. This is useful if you are using a nonstandard shell and need to provide a specific option that we do not cover. Only works locally. Defaults to an empty string. | | "term:localshellopts" | (optional) Sets the shell options meant to be used with `"term:localshellpath"`. This is useful if you are using a nonstandard shell and need to provide a specific option that we do not cover. Only works locally. Defaults to an empty string. |
| "cmd:initscript" | (optional) for "shell" controller only. an init script to run before starting the shell (can be an inline script or an absolute local file path) |
| cmd:initscript.sh" | (optional) same as `cmd:initscript` but applies to bash/zsh shells only |
| cmd:initscript.bash" | (optional) same as `cmd:initscript` but applies to bash shells only |
| cmd:initscript.zsh" | (optional) same as `cmd:initscript` but applies to zsh shells only |
| cmd:initscript.pwsh" | (optional) same as `cmd:initscript` but applies to pwsh/powershell shells only |
| cmd:initscript.fish" | (optional) same as `cmd:initscript` but applies to fish shells only |
### Example Local Shell Widgets ### Example Local Shell Widgets