many fixes

Author: m-YoC

README.md

@@ -21,21 +21,27 @@ Download the appropriate binary for your environment and move it to $PATH direct
     - Can write without group. In this case, all groups will be searched.
     - Special group-task names are as follows.
         - '_' group : Searchs only empty-name group.
-        - 'help'    : Show task help.
+        - 'help' task : Show task help. If write group, show only written group's tasks.
         - empty     : If 'default' task is defined, run it. Otherwise, run 'help'.
 - args       -> arg_name=arg_value
     - Write after 2 hyphens.
+    - {$} is a special variable for --script option, replaced by positional parameter $1...$9.
 
 ### * options
     --file, -f  [+value]      Specify a task file.
     --nest, -n  [+value]      Set the nest maximum times of embedded comment (embed/task).
                               Default is 20.
+    --quiet, -q               Task output is not sent to standard output.
     --make-cache, -c          Make taskdata cache.
-    --debug                   Show run-script.
+    --script, -s              Display run-script.
+                              (= shebang + 'set -euo pipefail' + expanded-script)
+                              If --debug option is not present, do not run.
+    --debug, -d               Display expanded-script and run.
+                              If --script option is present, display run-script.
     --version, -v             Show version.
     --help, -h                Show command help.
     --manual, -m              Show mdtk manual.
-    --task-help-all           Show all tasks that include private groups at task help.
+    --task-help-all, -a       Show all tasks that include private groups at task help.
 
 
 
@@ -85,6 +91,9 @@ In the command, as follows, write the variables and its values after '--'.
 mdtk does not check for the existence of variables during script generation.  
 It leaves this to the SHELL environment at runtime.
 
+{$} is a special variable for --script option, replaced by positional parameter $1...$9.  
+It cannot be used in normal task run.
+
 
 ### * Embedded Comments
 Some comments written as '#xxxx> comment' have a special behavior.

memo/TODO.md

@@ -13,4 +13,16 @@
     - [x] PAGER表示の拡張
         - cmd helpとtask helpも
         - 改行数をカウントして、長くなったらPAGER表示に自動的に切り替わるようにする
-
+- v0.2.0以降
+    - [x] scriptの書き出し用にdebugとは別に生成されたスクリプトを標準出力に出すだけのオプションを用意する
+        - 実行はされない
+        - [x] 変数に`{$}`を入れると位置パラメータ(positional parameter) `$1 ~ $9`が順番に入るようにする
+    - [ ] pager表示を調整する
+        - pager表示しなくてもいいようにする
+        - PAGER環境変数がなければ何もしないようにするべき？
+        - 起動行数指定もいるため、コンフィグファイルで変えられるようにするべき
+    - [x] 指定グループのタスクヘルプだけ見れるようにする
+    - [x] shorthandオプションをまとめて書けるように変更
+        - `-abc`
+    - [x] stdoutに出力しないquietモードを用意する
+    

sources/Taskfile.md.cache

@@ -1,7 +1,9 @@
 package code
 
 import (
+	"fmt"
 	"strings"
+	"strconv"
 	"mdtk/args"
 )
 
@@ -20,12 +22,23 @@ func (code Code) ApplyArgs(args args.Args, enclose_with_quotes bool) (Code, erro
 		q = "'"
 	}
 
+	count := 1
+
 	for _, arg := range args {
 		name, value, err := arg.GetData()
 		if err != nil {
 			return "", err
 		}
-		argstr += name + "=" + escapeQuoteAndEnclose(value, q) + "; "
+		if enclose_with_quotes && value == "{$}" {
+			if count > 9 {
+				return "", fmt.Errorf("you set too many special variable {$} ( > 9).")
+			}
+			argstr += name + "=$" + strconv.Itoa(count) + "; "
+			count++
+		} else {
+			argstr += name + "=" + escapeQuoteAndEnclose(value, q) + "; "
+		}
+		
 	}
 
 	return Code(argstr + "\n" + string(code)), nil

sources/mdtk/code/code_embed_args.go

@@ -26,23 +26,29 @@ func getShell() string {
 	return sh
 }
 
+func GetShHead() string {
+	return "set -euo pipefail"
+}
+
 func ToExecCode(code string, eos string) string {
-	shhead := "set -euo pipefail\n"
-	return "cat - << '" + eos + "' | " + shname + "\n" + shhead + code + "\n" + eos
+	return "cat - << '" + eos + "' | " + shname + "\n" + GetShHead() + "\n" + code + "\n" + eos
 }
 
-func Run(code string) {
+func Run(code string, quiet_mode bool) {
 	execcode := ToExecCode(code, "EOS")
 	// fmt.Println(execcode)
 
 	out, err := exec.Command(Shname(), "-c", execcode).CombinedOutput()
-	if err != nil {
+	if quiet_mode {
+		out = nil	
+	}
+	if err != nil {	
 		PrintExecError(out)
 		os.Exit(1)
 	}
 
 	// 実行したコマンドの結果を出力
-	fmt.Printf("%s", string(out))
+	fmt.Print(string(out))
 }
 
 func PrintExecError(out []byte) {

sources/mdtk/exec/exec.go

@@ -10,9 +10,12 @@ mdtk is a markdown task-runner using codeblock.
                     Can write without group.
                     In this case, all groups will be searched.
                     Special group-task names are as follows.
-                    - '_' group : Searchs only empty-name group.
-                    - 'help'    : Show task help.
-                    - empty     : If 'default' task is defined, run it.
-                                  Otherwise, run 'help'.
+                    - '_' group   : Searchs only empty-name group.
+                    - 'help' task : Show task help.
+                                    If write group, show only written group's tasks.
+                    - empty       : If 'default' task is defined, run it.
+                                    Otherwise, run 'help'.
     args       -> arg_name=arg_value
                     Write after 2 hyphens.
+                    {$} is a special variable for --script option, 
+                    replaced by positional parameter $1...$9.

sources/mdtk/help/cmd_help.txt

@@ -9,13 +9,13 @@ import (
 //go:embed cmd_help.txt
 var cmdhelp string
 
-func ShowCommandHelp(f parse.Flag, descline int) {
+func ShowCommandHelp(f parse.Flag, descline uint, pager_min_row uint) {
 	s := fmt.Sprintln(cmdhelp)
 
 	s += fmt.Sprintln("  options")
 	s += fmt.Sprintf("%s\n", f.GetHelpStr(4, descline))
 
-	PagerOutput(s, 40)
+	PagerOutput(s, pager_min_row)
 }
 
 

sources/mdtk/help/command_help.go

@@ -9,10 +9,13 @@ import (
 )
 
 func ShouldShowHelp(gtname grtask.GroupTask, tds taskset.TaskDataSet) bool {
-	return string(gtname) == "help" || (string(gtname) == "default" && doNotExistExplicitDefaultTask(tds))
+	_, t, _ := gtname.Split()
+	return string(t) == "help" || (string(gtname) == "default" && doNotExistExplicitDefaultTask(tds))
 }
 
-func ShowHelp(filename path.Path, tds taskset.TaskDataSet, show_private bool) {
+func ShowHelp(filename path.Path, gtname grtask.GroupTask, tds taskset.TaskDataSet, show_private bool, pager_min_row uint) {
+	g, _, _ := gtname.Split()
+
 	tds = getEmbedArgsTexts(tds)
 	tds = getTaskNameMaxLength(tds)
 
@@ -54,6 +57,10 @@ func ShowHelp(filename path.Path, tds taskset.TaskDataSet, show_private bool) {
 	s := fmt.Sprintf(bgray + "[%s help]" + clear + "\n", filename)
 
 	for _, k := range group_arr {
+		if g != "" && string(g) != k {
+			continue
+		}
+
 		if k == "_" {
 			for _, t := range group_map["_"] {
 				if counts[k + ":" + string(t.Task)] > 1 {
@@ -93,5 +100,5 @@ func ShowHelp(filename path.Path, tds taskset.TaskDataSet, show_private bool) {
 		} 
 	}
 
-	PagerOutput(s, 40)
+	PagerOutput(s, pager_min_row)
 }

sources/mdtk/help/help.go

@@ -7,7 +7,7 @@ import (
 //go:embed mdtk_manual.txt
 var mdtkman string
 
-func ShowManual() {
+func ShowManual(pager_min_row uint) {
 	// fmt.Println(mdhelp)
-	PagerOutput(mdtkman, 40)
+	PagerOutput(mdtkman, pager_min_row)
 }

sources/mdtk/help/mdtk_manual.go

@@ -32,6 +32,9 @@ In the command, as follows, write the variables and its values after '--'.
 mdtk does not check for the existence of variables during script generation.
 It leaves this to the SHELL environment at runtime.
 
+{$} is a special variable for --script option, replaced by positional parameter $1...$9.
+It cannot be used in normal task run.
+
 
 * Embedded Comments
 Some comments written as '#xxxx> comment' have a special behavior.