Merge pull request #814 from yorukot/prompt_tutorial

lazysegtree · web-flow · commit f291156a8b63 · 2025-05-16T07:47:45.000+05:30
SPF Prompt tutorial and fixes
diff --git a/asset/prompt_shell_mode.png b/asset/prompt_shell_mode.png
diff --git a/asset/prompt_spf_mode.png b/asset/prompt_spf_mode.png
diff --git a/src/internal/ui/prompt/consts.go b/src/internal/ui/prompt/consts.go
@@ -19,7 +19,7 @@ const (
 	failureMessagePrefix = "Error"
 
 	shellModeString = "(Shell Mode)"
-	spfModeString   = "(Prompt Mode)"
+	spfModeString   = "(SPF Mode)"
 
 	// Error message string
 	tokenizationError    = "Failed during tokenization"
diff --git a/src/internal/ui/prompt/model.go b/src/internal/ui/prompt/model.go
@@ -123,7 +123,7 @@ func (m *Model) HandleSPFActionResults(success bool, msg string) {
 
 func (m *Model) Render() string {
 	r := ui.PromptRenderer(m.maxHeight, m.width)
-	r.SetBorderTitle(m.headline + modeString(m.shellMode))
+	r.SetBorderTitle(m.headline + " " + modeString(m.shellMode))
 	r.AddLines(" " + m.textInput.View())
 
 	if !m.shellMode {
@@ -148,7 +148,7 @@ func (m *Model) Render() string {
 		}
 	} else if m.textInput.Value() == "" {
 		r.AddSection()
-		r.AddLines(" '" + m.spfPromptHotkey + "' - Get into SPF Prompt mode")
+		r.AddLines(" '" + m.spfPromptHotkey + "' - Get into SPF mode")
 	}
 
 	if m.resultMsg != "" {
diff --git a/src/internal/ui/prompt/model_test.go b/src/internal/ui/prompt/model_test.go
@@ -239,19 +239,19 @@ func TestModel_Render(t *testing.T) {
 		m.setShellMode(true)
 		res := ansi.Strip(m.Render())
 		exp := "" +
-			"╭─┤ " + icon.Terminal + " Superfile Prompt(Shell Mode) ├───╮\n" +
-			// 000123--------4------------56789012345678901234567890123456789
+			"╭─┤ " + icon.Terminal + " Superfile Prompt (Shell Mode) ├──╮\n" +
+			// 23--------4------------56789012345678901234567890123456789
 			"│ :                                    │\n" +
-			// 000123456789012345678901234567890123456789
+			// 23456789012345678901234567890123456789
 			"├──────────────────────────────────────┤\n" +
-			"│ '>' - Get into SPF Prompt mode       │\n" +
+			"│ '>' - Get into SPF mode              │\n" +
 			"╰──────────────────────────────────────╯"
 		assert.Equal(t, exp, res)
 		m.setShellMode(false)
 		res = ansi.Strip(m.Render())
 		exp = "" +
-			"╭─┤ " + icon.Terminal + " Superfile Prompt(Prompt Mode) ├──╮\n" +
-			// 000123--------4------------56789012345678901234567890123456789
+			"╭─┤ " + icon.Terminal + " Superfile Prompt (SPF Mode) ├────╮\n" +
+			// 23--------4------------56789012345678901234567890123456789
 			"│ >                                    │\n" +
 			"├──────────────────────────────────────┤\n" +
 			"│ ':' - Get into Shell mode            │\n" +
@@ -292,25 +292,25 @@ func TestModel_Render(t *testing.T) {
 		m.HandleShellCommandResults(0, "")
 		res := ansi.Strip(m.Render())
 		exp := "" +
-			"╭─┤ " + icon.Terminal + " Superfile Prompt(Shell Mode) ├─────────────╮\n" +
-			// 000123--------4------------567890123456789012345678901234567890123456789
+			"╭─┤ " + icon.Terminal + " Superfile Prompt (Shell Mode) ├────────────╮\n" +
+			// 23--------4------------567890123456789012345678901234567890123456789
 			"│ :                                              │\n" +
-			// 0001234567890123456789012345678901234567890123456789
+			// 234567890123456789012345678901234567890123456789
 			"├────────────────────────────────────────────────┤\n" +
-			"│ '>' - Get into SPF Prompt mode                 │\n" +
+			"│ '>' - Get into SPF mode                        │\n" +
 			"├────────────────────────────────────────────────┤\n" +
 			"│ Success : Command exited with status 0         │\n" +
 			"╰────────────────────────────────────────────────╯"
 		assert.Equal(t, exp, res)
 		m.HandleShellCommandResults(1, "")
 		res = ansi.Strip(m.Render())
 		exp = "" +
-			"╭─┤ " + icon.Terminal + " Superfile Prompt(Shell Mode) ├─────────────╮\n" +
-			// 000123--------4------------567890123456789012345678901234567890123456789
+			"╭─┤ " + icon.Terminal + " Superfile Prompt (Shell Mode) ├────────────╮\n" +
+			// 23--------4------------567890123456789012345678901234567890123456789
 			"│ :                                              │\n" +
-			// 0001234567890123456789012345678901234567890123456789
+			// 234567890123456789012345678901234567890123456789
 			"├────────────────────────────────────────────────┤\n" +
-			"│ '>' - Get into SPF Prompt mode                 │\n" +
+			"│ '>' - Get into SPF mode                        │\n" +
 			"├────────────────────────────────────────────────┤\n" +
 			"│ Error : Command exited with status 1           │\n" +
 			"╰────────────────────────────────────────────────╯"
diff --git a/src/internal/ui/prompt/utils.go b/src/internal/ui/prompt/utils.go
@@ -57,7 +57,7 @@ func getPromptAction(shellMode bool, value string, cwdLocation string) (common.M
 
 	default:
 		return noAction, invalidCmdError{
-			uiMsg: "Invalid spf prompt command : " + promptArgs[0],
+			uiMsg: "Invalid spf command : " + promptArgs[0],
 		}
 	}
 }
diff --git a/src/internal/ui/prompt/utils_test.go b/src/internal/ui/prompt/utils_test.go
@@ -68,7 +68,7 @@ func TestModel_getPromptAction(t *testing.T) {
 			shellMode:      false,
 			expectecAction: common.NoAction{},
 			expectedErr:    true,
-			expectedErrMsg: "Invalid spf prompt command : abcd",
+			expectedErrMsg: "Invalid spf command : abcd",
 		},
 		{
 			name:           "Correct split command",
diff --git a/website/src/content/docs/getting-started/tutorial.md b/website/src/content/docs/getting-started/tutorial.md
@@ -177,3 +177,31 @@ If your directory editor does not support opening the current directory with an
 
 (Sorry, this video has a little bit of lag)
 [demo video](https://github.com/yorukot/superfile/assets/107802416/d0770b3f-025e-40c9-ad3f-8b2adaf1c6c5)
+
+### SPF Prompt
+#### Shell Mode
+Press `:` to open the prompt in shell mode, and execute any shell command in the current directory.
+![Prompt-Shell-Mode](https://github.com/yorukot/superfile/blob/main/asset/prompt_shell_mode.png?raw=true)
+
+:::note
+You won't receive any stdout outputs.
+For now, this is meant for executing more complex file manipulations via the shell,
+rather than handling interactive outputs.
+You will be able to see the exit code of the command.
+:::
+
+#### SPF Mode
+Press `>` to open the prompt in SPF mode. 
+![Prompt-SPF-Mode](https://github.com/yorukot/superfile/blob/main/asset/prompt_spf_mode.png?raw=true)
+
+In this mode, you can execute these spf commands :
+- `split` - Open a new panel at a current file panel's path.
+- `open <PATH>` - Open a new panel at a specified path.
+- `cd <PATH>` - Change directory of current panel.
+
+In this mode, You can substitute shell environment variables via `${}`, shell commands via `$()` and prefix path with `~` to get substituted to home directory 
+For example 
+- `cd ${HOME}` or `cd ~/xyz`
+- `open $(dirname $(which bash))`
+
+Press `esc` or `ctrl`+`c` to exit Prompt.
diff --git a/website/src/content/docs/list/hotkey-list.md b/website/src/content/docs/list/hotkey-list.md
@@ -33,7 +33,8 @@ These are the default hotkeys and you can [change](/configure/custom-hotkeys) th
 | Focus on the processbar panel    | `p`                        | `focus_on_process_bar`      |
 | Focus on the sidebar             | `s`                        | `focus_on_side_bar`         |
 | Focus on the metadata panel      | `m`                        | `focus_on_metadata`         |
-| Open command execution bar       | `:`                        | `open_command_line`         |
+| Open prompt in shell mode        | `:`                        | `open_command_line`         |
+| Open prompt in spf mode          | `>`                        | `open_spf_prompt`           |
 
 ## Panel movement
 

Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ func (m *Model) HandleSPFActionResults(success bool, msg string) {`
`123`	`123`
`124`	`124`	`func (m *Model) Render() string {`
`125`	`125`	`r := ui.PromptRenderer(m.maxHeight, m.width)`
`126`		`- r.SetBorderTitle(m.headline + modeString(m.shellMode))`
	`126`	`+ r.SetBorderTitle(m.headline + " " + modeString(m.shellMode))`
`127`	`127`	`r.AddLines(" " + m.textInput.View())`
`128`	`128`
`129`	`129`	`if !m.shellMode {`
`@@ -148,7 +148,7 @@ func (m *Model) Render() string {`
`148`	`148`	`}`
`149`	`149`	`} else if m.textInput.Value() == "" {`
`150`	`150`	`r.AddSection()`
`151`		`- r.AddLines(" '" + m.spfPromptHotkey + "' - Get into SPF Prompt mode")`
	`151`	`+ r.AddLines(" '" + m.spfPromptHotkey + "' - Get into SPF mode")`
`152`	`152`	`}`
`153`	`153`
`154`	`154`	`if m.resultMsg != "" {`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ func getPromptAction(shellMode bool, value string, cwdLocation string) (common.M`
`57`	`57`
`58`	`58`	`default:`
`59`	`59`	`return noAction, invalidCmdError{`
`60`		`- uiMsg: "Invalid spf prompt command : " + promptArgs[0],`
	`60`	`+ uiMsg: "Invalid spf command : " + promptArgs[0],`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ func TestModel_getPromptAction(t *testing.T) {`
`68`	`68`	`shellMode: false,`
`69`	`69`	`expectecAction: common.NoAction{},`
`70`	`70`	`expectedErr: true,`
`71`		`- expectedErrMsg: "Invalid spf prompt command : abcd",`
	`71`	`+ expectedErrMsg: "Invalid spf command : abcd",`
`72`	`72`	`},`
`73`	`73`	`{`
`74`	`74`	`name: "Correct split command",`