doc: updated structure (no content yet)

action.go

@@ -166,6 +166,35 @@ func (a Action) Shift(n int) Action {
 	})
 }
 
+// Split splits `Context.Value` using a shell lexer and replaces `Context.Args` with the tokens.
+func (a Action) Split() Action {
+	return ActionCallback(func(c Context) Action {
+		tokenset, err := lexer.Split(c.Value)
+		if err != nil {
+			return ActionMessage(err.Error())
+		}
+
+		c.Args = tokenset.Tokens[:len(tokenset.Tokens)-1]
+		c.Parts = []string{}
+		c.Value = tokenset.Tokens[len(tokenset.Tokens)-1]
+		invoked := a.Invoke(c)
+		for index, value := range invoked.rawValues {
+			if !invoked.meta.Nospace.Matches(value.Value) {
+				switch tokenset.State {
+				case lexer.OPEN_DOUBLE:
+					invoked.rawValues[index].Value = fmt.Sprintf(`"%v" `, strings.Replace(value.Value, `"`, `\"`, -1))
+				case lexer.OPEN_SINGLE:
+					invoked.rawValues[index].Value = fmt.Sprintf(`'%v' `, strings.Replace(value.Value, `'`, `'"'"'`, -1))
+				default:
+					invoked.rawValues[index].Value = strings.Replace(value.Value, ` `, `\ `, -1) + ` `
+				}
+			}
+		}
+		invoked.Prefix(tokenset.Prefix)
+		return invoked.ToA().NoSpace()
+	})
+}
+
 // Style sets the style.
 //
 //	ActionValues("yes").Style(style.Green)
@@ -295,32 +324,3 @@ func (a Action) UsageF(f func() string) Action {
 		return a
 	})
 }
-
-// Split splits `Context.Value` using a shell lexer.
-func (a Action) Split() Action {
-	return ActionCallback(func(c Context) Action {
-		tokenset, err := lexer.Split(c.Value)
-		if err != nil {
-			return ActionMessage(err.Error())
-		}
-
-		c.Args = tokenset.Tokens[:len(tokenset.Tokens)-1]
-		c.Parts = []string{}
-		c.Value = tokenset.Tokens[len(tokenset.Tokens)-1]
-		invoked := a.Invoke(c)
-		for index, value := range invoked.rawValues {
-			if !invoked.meta.Nospace.Matches(value.Value) {
-				switch tokenset.State {
-				case lexer.OPEN_DOUBLE:
-					invoked.rawValues[index].Value = fmt.Sprintf(`"%v" `, strings.Replace(value.Value, `"`, `\"`, -1))
-				case lexer.OPEN_SINGLE:
-					invoked.rawValues[index].Value = fmt.Sprintf(`'%v' `, strings.Replace(value.Value, `'`, `'"'"'`, -1))
-				default:
-					invoked.rawValues[index].Value = strings.Replace(value.Value, ` `, `\ `, -1) + ` `
-				}
-			}
-		}
-		invoked.Prefix(tokenset.Prefix)
-		return invoked.ToA().NoSpace()
-	})
-}

docs/src/SUMMARY.md

@@ -1,11 +1,18 @@
 # Summary
 
 - [carapace](./carapace.md)
+  - [Introduction](./carapace/introduction.md)
   - [Gen](./carapace/gen.md)
+    - [DashAnyCompletion](./carapace/gen/dashAnyCompletion.md)
+    - [DashCompletion](./carapace/gen/dashCompletion.md)
+    - [FlagCompletion](./carapace/gen/flagCompletion.md) 
     - [Hidden Subcommand](./carapace/gen/hiddenSubcommand.md)
+    - [PositionalAnyCompletion](./carapace/gen/positionalAnyCompletion.md)
     - [PositionalCompletion](./carapace/gen/positionalCompletion.md)
-    - [FlagCompletion](./carapace/gen/flagCompletion.md) 
-    - [DashCompletion](./carapace/gen/dashCompletion.md)
+    - [PreInvoke](./carapace/gen/preInvoke.md) 
+    - [PreRun](./carapace/gen/preRun.md) 
+    - [Snippet](./carapace/gen/snippet.md) 
+    - [Standalone](./carapace/gen/standalone.md) 
   - [Action](./carapace/action.md)
     - [Cache](./carapace/action/cache.md)
     - [Chdir](./carapace/action/chdir.md)
@@ -28,10 +35,12 @@
     - [Timeout](./carapace/action/timeout.md)
     - [UniqueList](./carapace/action/uniqueList.md)
     - [Usage](./carapace/action/usage.md)
+    - [UsageF](./carapace/action/usageF.md)
   - [InvokedAction](./carapace/invokedAction.md)
     - [Filter](./carapace/invokedAction/filter.md)
     - [Merge](./carapace/invokedAction/merge.md)
     - [Prefix](./carapace/invokedAction/prefix.md)
+    - [Retain](./carapace/invokedAction/retain.md)
     - [Suffix](./carapace/invokedAction/suffix.md)
     - [ToA](./carapace/invokedAction/toA.md)
     - [ToMultiPartsA](./carapace/invokedAction/toMultiPartsA.md)
@@ -48,17 +57,28 @@
     - [ActionMultiParts](./carapace/defaultActions/actionMultiParts.md)
     - [ActionMultiPartsN](./carapace/defaultActions/actionMultiPartsN.md)
     - [ActionPositional](./carapace/defaultActions/actionPositional.md)
-    - [ActionStyles](./carapace/defaultActions/actionStyles.md)
     - [ActionStyleConfig](./carapace/defaultActions/actionStyleConfig.md)
     - [ActionStyledValues](./carapace/defaultActions/actionStyledValues.md)
     - [ActionStyledValuesDescribed](./carapace/defaultActions/actionStyledValuesDescribed.md)
+    - [ActionStyles](./carapace/defaultActions/actionStyles.md)
     - [ActionValues](./carapace/defaultActions/actionValues.md)
     - [ActionValuesDescribed](./carapace/defaultActions/actionValuesDescribed.md)
   - [CustomActions](./carapace/customActions.md)
   - [Context](./carapace/context.md)
+    - [Abs](./carapace/context/abs.md)
+    - [Command](./carapace/context/command.md)
+    - [Envsubst](./carapace/context/envSubst.md)
+    - [GetEnv](./carapace/context/getEnv.md)
+    - [LookupEnv](./carapace/context/lookupEnv.md)
+    - [SetEnv](./carapace/context/setEnv.md)
   - [Batch](./carapace/batch.md)
+    - [Invoke](./carapace/batch/invoke.md)
+    - [ToA](./carapace/batch/ToA.md)
+  - [InvokedBatch](./carapace/invokedBatch.md)
+    - [Merge](./carapace/invokedBatch/merge.md)
   - [Export](./carapace/export.md)
-  - [Group](./carapace/group.md)
+  - [Command](./carapace/command.md)
+    - [Group](./carapace/command/group.md)
   - [Standalone](./carapace/standalone.md)
     - [carapace-parse](./carapace/standalone/carapace-parse.md)
     - [pflag](./carapace/standalone/pflag.md)

docs/src/carapace/action/split.md

@@ -1,6 +1,6 @@
 # Split
 
-[`Split`] splits `Context.Value` using a shell lexer.
+[`Split`] splits `Context.Value` using a shell lexer and replaces `Context.Args` with the tokens.
 
 ```go
 carapace.ActionCallback(func(c carapace.Context) carapace.Action {

docs/src/carapace/action/usageF.md

@@ -0,0 +1 @@
+# UsageF

docs/src/carapace/batch/ToA.md

@@ -0,0 +1 @@
+# ToA

docs/src/carapace/batch/invoke.md

@@ -0,0 +1 @@
+# Invoke

docs/src/carapace/command.md

@@ -0,0 +1 @@
+# Command

docs/src/carapace/context/abs.md

@@ -0,0 +1 @@
+# Abs

docs/src/carapace/context/command.md

@@ -0,0 +1 @@
+# Command

docs/src/carapace/context/envSubst.md

@@ -0,0 +1 @@
+# Envsubst

docs/src/carapace/context/getEnv.md

@@ -0,0 +1 @@
+# GetEnv

docs/src/carapace/context/lookupEnv.md

@@ -0,0 +1 @@
+# LookupEnv

docs/src/carapace/context/setEnv.md

@@ -0,0 +1 @@
+# SetEnv

docs/src/carapace/gen/dashAnyCompletion.md

@@ -0,0 +1 @@
+# DashAnyCompletion

docs/src/carapace/gen/positionalAnyCompletion.md

@@ -0,0 +1 @@
+# PositionalAnyCompletion

docs/src/carapace/gen/preInvoke.md

@@ -0,0 +1 @@
+# PreInvoke

docs/src/carapace/gen/preRun.md

@@ -0,0 +1 @@
+# PreRun

docs/src/carapace/gen/snippet.md

@@ -0,0 +1 @@
+# Snippet

docs/src/carapace/gen/standalone.md

@@ -0,0 +1 @@
+# Standalone

docs/src/carapace/introduction.md

@@ -0,0 +1 @@
+# Introduction

docs/src/carapace/invokedAction/retain.md

@@ -0,0 +1 @@
+# Retain

docs/src/carapace/invokedBatch.md

@@ -0,0 +1 @@
+# InvokedBatch

docs/src/carapace/invokedBatch/merge.md

@@ -0,0 +1 @@
+# Merge