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.

Sign up for GitHub

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

feat: configurable autoclose when shell exits #1699

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

feat: configurable autoclose when shell exits #1699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43f81e1
work with cmd+N but not clicking the "terminal" button
weilirs Jan 8, 2025
6fcb5a0
feat: configurable autoclose when shell exits
weilirs Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions frontend/app/store/keymodel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getAllBlockComponentModels,
getApi,
getBlockComponentModel,
getSettingsKeyAtom,
globalStore,
refocusNode,
WOS,
Expand Down Expand Up @@ -162,12 +163,19 @@ function globalRefocus() {
}

async function handleCmdN() {
const termAutoClose = globalStore.get(getSettingsKeyAtom("term:autoclose")) as boolean | undefined;
const termAutoCloseOnError = globalStore.get(getSettingsKeyAtom("term:autocloseonerror")) as boolean | undefined;
const termAutoCloseDelay = globalStore.get(getSettingsKeyAtom("term:autoclosedelay")) as number | undefined;

const termBlockDef: BlockDef = {
meta: {
view: "term",
controller: "shell",
"cmd:closeonexitforce": termAutoCloseOnError ?? false,
"cmd:closeonexitdelay": termAutoCloseDelay ?? 2000,
Comment on lines +174 to +175
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Add the missing terminal auto-close setting

The cmd:closeonexit setting should be added as suggested. This is consistent with:

  • The default configuration in pkg/wconfig/defaultconfig/widgets.json
  • The documented behavior where this setting specifically handles auto-closing on successful exit
  • The pattern of using all three close-related settings together
🔗 Analysis chain

Use the extracted settings consistently.

The termAutoClose setting is retrieved but not used in the block definition.

Consider if this setting should affect the block definition:

 meta: {
     view: "term",
     controller: "shell",
     "cmd:closeonexitforce": termAutoCloseOnError ?? false,
     "cmd:closeonexitdelay": termAutoCloseDelay ?? 2000,
+    "cmd:closeonexit": termAutoClose ?? true,
 },
🏁 Scripts executed

The following scripts were executed for the analysis:

Error: No shell scripts found

Script:

#!/bin/bash
# Find termAutoClose definition and usage
rg "termAutoClose" -A 3 -B 3

# Search for terminal close-related settings
rg "cmd:closeonexit" -A 2 -B 2

# Search for similar block definitions
ast-grep --pattern 'meta: {
  view: "term",
  $$$
}'

Length of output: 6226

},
};

const layoutModel = getLayoutModelForStaticTab();
const focusedNode = globalStore.get(layoutModel.focusedNode);
if (focusedNode != null) {
Expand Down
3 changes: 3 additions & 0 deletions frontend/types/gotypes.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,6 +601,9 @@ declare global {
"term:copyonselect"?: boolean;
"term:transparency"?: number;
"term:allowbracketedpaste"?: boolean;
"term:autoclose"?: boolean;
"term:autocloseonerror"?: boolean;
"term:autoclosedelay"?: number;
"editor:minimapenabled"?: boolean;
"editor:stickyscrollenabled"?: boolean;
"editor:wordwrap"?: boolean;
Expand Down
5 changes: 4 additions & 1 deletion pkg/wconfig/defaultconfig/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,8 @@
"window:confirmclose": true,
"window:savelastwindow": true,
"telemetry:enabled": true,
"term:copyonselect": true
"term:copyonselect": true,
"term:autoclose": true,
"term:autocloseonerror": false,
"term:autoclosedelay": 2000
Comment on lines +24 to +27
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Terminal auto-close settings need documentation

While the auto-close feature is mentioned in the README, the specific configuration options (term:autoclose, term:autocloseonerror, term:autoclosedelay) are not documented. Consider:

  • Adding these settings to the user documentation
  • Including descriptions of their purpose and effects
  • Documenting the default values and their rationale
🔗 Analysis chain

LGTM! Terminal autoclose settings are well-structured.

The new terminal settings follow consistent naming conventions and provide sensible defaults:

  • term:autoclose: true (enables the feature by default)
  • term:autocloseonerror: false (prevents unexpected closures on errors)
  • term:autoclosedelay: 2000 (provides reasonable 2-second delay)

Let's verify these settings are properly documented:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if these settings are documented in README or docs
rg -i "term:autoclose|term:autocloseonerror|term:autoclosedelay" docs/ README.md || echo "Settings documentation not found"

Length of output: 157

Script:

#!/bin/bash
# Search for any markdown files containing terminal-related documentation
fd -e md | xargs rg -i "terminal|term" -A 2 -B 2

# Look for schema files and check terminal settings
fd "schema|config" -e json | xargs rg -i "term:autoclose|term:autocloseonerror|term:autoclosedelay" -A 2 -B 2

# Check for comments near the settings definition
rg -C 5 "term:autoclose" pkg/wconfig/defaultconfig/settings.json

Length of output: 13695

}
5 changes: 4 additions & 1 deletion pkg/wconfig/defaultconfig/widgets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
"blockdef": {
"meta": {
"view": "term",
"controller": "shell"
"controller": "shell",
"cmd:closeonexit": true,
"cmd:closeonexitforce": false,
"cmd:closeonexitdelay": 2000
}
}
},
Expand Down
3 changes: 3 additions & 0 deletions pkg/wconfig/metaconsts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ const (
ConfigKey_TermCopyOnSelect = "term:copyonselect"
ConfigKey_TermTransparency = "term:transparency"
ConfigKey_TermAllowBracketedPaste = "term:allowbracketedpaste"
ConfigKey_TermAutoClose = "term:autoclose"
ConfigKey_TermAutoCloseOnError = "term:autocloseonerror"
ConfigKey_TermAutoCloseDelay = "term:autoclosedelay"

ConfigKey_EditorMinimapEnabled = "editor:minimapenabled"
ConfigKey_EditorStickyScrollEnabled = "editor:stickyscrollenabled"
Expand Down
3 changes: 3 additions & 0 deletions pkg/wconfig/settingsconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ type SettingsType struct {
TermCopyOnSelect *bool `json:"term:copyonselect,omitempty"`
TermTransparency *float64 `json:"term:transparency,omitempty"`
TermAllowBracketedPaste *bool `json:"term:allowbracketedpaste,omitempty"`
TermAutoClose *bool `json:"term:autoclose,omitempty"`
TermAutoCloseOnError *bool `json:"term:autocloseonerror,omitempty"`
TermAutoCloseDelay *float64 `json:"term:autoclosedelay,omitempty"`

EditorMinimapEnabled bool `json:"editor:minimapenabled,omitempty"`
EditorStickyScrollEnabled bool `json:"editor:stickyscrollenabled,omitempty"`
Expand Down