many fixes

Author: m-YoC

Makefile

@@ -20,5 +20,8 @@ install-linux-amd64: ## Install mdtk to /usr/local/bin/
 install-linux-arm64: ## Install mdtk to /usr/local/bin/
 	cp ./sources/mdtk_bin/linux_arm64/mdtk /usr/local/bin/mdtk
 
+size:
+	@cd ./sources/mdtk_bin/linux_amd64 && ls -lh
+
 help: ## Display this help screen.
 	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk -F ':.*?## ' '{printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

README.md

@@ -28,20 +28,27 @@ Download the appropriate binary for your environment and move it to $PATH direct
     - {$} is a special variable for --script option, replaced by positional parameter $1...$9.
 
 ### * options
-    --file, -f  [+value]      Specify a task file.
+    --file, -f  [+value]      Select 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.
+    --all-task, -a            Can select private groups at the command.
+                              Or show all tasks that include private groups at task help.
     --script, -s              Display run-script.
                               (= shebang + 'set -euo pipefail' + expanded-script)
-                              If --debug option is not present, do not run.
+                              If --debug option is not set, do not run.
     --debug, -d               Display expanded-script and run.
-                              If --script option is present, display run-script.
+                              If --script option is set, display run-script.
+    --make-cache, -c          Make taskdata cache.
+    --lib, -l  [+value]       Select a library file.
+                              This is a special version of --file option.
+                              No need to add an extension '.mdtklib'.
+    --make-library  [+value]  Make taskdata library.
+                              Value is library name.
     --version, -v             Show version.
     --help, -h                Show command help.
     --manual, -m              Show mdtk manual.
-    --task-help-all, -a       Show all tasks that include private groups at task help.
+    --write-configbase        Write config base file to current directory.
 
 
 
@@ -99,8 +106,8 @@ It cannot be used in normal task run.
 Some comments written as '#xxxx> comment' have a special behavior.
 
 ~~~
-#embed>  <group>:<task>         : The specified task is directly embedded.
-#task>   <group>:<task> -- args : The specified task is embedded as a subshell.
+#embed>  <group>:<task>         : The selected task is directly embedded.
+#task>   <group>:<task> -- args : The selected task is embedded as a subshell.
 #task> @ <group>:<task> -- args : The config once flag is temporarily reset.
                                   The rest is the same as without @.
 #config> once                   : When called multiple times, it is called only the first time.
@@ -109,16 +116,16 @@ Some comments written as '#xxxx> comment' have a special behavior.
 
 
 ### * Filename
-mdtk uses Taskfile.md in the current directory unless you specify a file path with --file/-f flag.  
+mdtk uses Taskfile.md in the current directory unless you select a file path with --file/-f flag.  
 Instead of Taskfile.md, you can use *.taskrun.md.  
 In this case, however, only one *.taskrun.md file should be placed in the same directory. 
 
 Search Order: --file path -> Taskfile.md -> *.taskrun.md  
 
 
 ### * Sub Taskfile
-You can load sub taskfile in the following code block.  
-There must be no duplicate group/task combinations throughout all loaded files.
+You can read sub taskfile in the following code block.  
+There must be no duplicate group/task combinations throughout all read files.
 
 ~~~markdown
 ```taskfile
@@ -130,10 +137,22 @@ There must be no duplicate group/task combinations throughout all loaded files.
 
 
 ### * Task Cache
-You can make a taskdata cache by specifying --make-cache option.  
+You can make a taskdata cache by setting --make-cache option.  
 The cache 'may' speed up task reading.  
 If the cache already exists, it will be read automatically with no option.  
-However, note that if taskfiles have some updates at this time, the cache will be remake, 
- which is slower than if there was no cache.
+However, note that if taskfiles have some updates at this time, the cache will be remade
+ and run-speed is slower than it without cache.  
 Good to use for taskfiles that are being updated less frequently.  
 To disable the cache, simply delete the relevant cache.  
+
+You can also make a taskdata library. It is similar to cache and use --make-library option.  
+Differences of the library and the cache are as follows.  
+- The library is not read automatically and not remade automataically.  
+- Select library file directly using --file/-f or --lib/-l option.  
+- Therefore, can use it alone. Not need to hold '.md' taskfiles at the same place.  
+- Embedded comments of all public tasks will be expanded.  
+- All private tasks will be removed.  
+- All file-path data of tasks will be removed.  
+
+In 'taskfile' code block, you cannot read the cache/library.  
+Please use mdtk command in task when you use them at outside.  

memo/TODO.md

@@ -4,9 +4,6 @@
 - v0.1.0以降
     - [x] version表示オプション追加 (--version, -v)
         - version情報は外部ファイルに`VERSION=xx.yy.zz`の形で記載してgo:embedで読み込む
-    - [ ] group名の衝突を回避する手段を実装する
-        - taskfile読み込み時にaliasを付けられると言い？
-        - そもそもmdtk in mdtkで読み込めば別データ扱いで管理できるのでいらないかもしれない
     - [x] scriptを全部読み込んでバイナリで保持しておく.cache機能
     - [x] command helpとmarkdown helpを外部ファイルに出してgo:embedで読み込むように変更
     - [x] helpのPAGER表示 (今のところ長くなっているmarkdown helpのみ)
@@ -17,12 +14,26 @@
     - [x] scriptの書き出し用にdebugとは別に生成されたスクリプトを標準出力に出すだけのオプションを用意する
         - 実行はされない
         - [x] 変数に`{$}`を入れると位置パラメータ(positional parameter) `$1 ~ $9`が順番に入るようにする
-    - [ ] pager表示を調整する
-        - pager表示しなくてもいいようにする
-        - PAGER環境変数がなければ何もしないようにするべき？
-        - 起動行数指定もいるため、コンフィグファイルで変えられるようにするべき
     - [x] 指定グループのタスクヘルプだけ見れるようにする
     - [x] shorthandオプションをまとめて書けるように変更
         - `-abc`
     - [x] stdoutに出力しないquietモードを用意する
-    
+- v0.3.0以降
+    - [ ] group名の衝突を回避する手段を実装する
+        - taskfile読み込み時にaliasを付けられると言い？
+        - そもそもmdtk in mdtkで読み込めば別データ扱いで管理できるのでいらないかもしれない
+    - [x] pager表示を調整する
+        - pager表示しなくてもいいようにする
+        - PAGER環境変数がなければ何もしないようにするべき？
+        - 起動行数指定もいるため、コンフィグファイルで変えられるようにするべき
+    - [ ] change color
+        - config?
+    - [x] configファイルの読み込み、デフォルトコンフィグの書き出し
+    - [x] mdtklibファイルの読み込みと書き出し機能
+        - cacheと同じように構造体で保持するが、publicタスクを全て展開し、privateタスクは消去する
+        - cacheとは異なり.mdtklibファイルを`--file`オプションで直接指定する。読み込めなければ失敗する
+            - mdtk in mdtkで使用することを想定
+        - FilePathデータは削除されている
+        - cacheと異なり自動更新はされない
+        - 読み込み時のコストを考えるとコンパクトなmdtklibを複数作成した方がいい
+    - [x] コマンドオプションの調整

sources/mdtk/cache/cache.go

@@ -0,0 +1,40 @@
+package cache
+
+import (
+	"os"
+	"mdtk/path"
+	"mdtk/taskset"
+)
+
+func toCacheName(filename path.Path) string {
+	return string(filename) + ".cache"
+}
+
+func ExistCacheFile(filename path.Path) bool {
+	_, err := os.Stat(toCacheName(filename))
+	return err == nil
+}
+
+func IsLatestCache(tds taskset.TaskDataSet, filename path.Path) bool {
+	status, err := os.Stat(toCacheName(filename))
+	if err != nil {
+		return false
+	}
+
+	for k, _ := range tds.FilePath {
+		substatus, err := os.Stat(string(k))
+		if err != nil || status.ModTime().Before(substatus.ModTime()) {
+			return false
+		}
+	}
+
+	return true
+}
+
+func WriteCache(tds taskset.TaskDataSet, filename path.Path) error {
+	return writeBase(tds, toCacheName(filename))
+}
+
+func ReadCache(filename path.Path) (taskset.TaskDataSet, error) {
+	return readBase(toCacheName(filename))
+}

sources/mdtk/cache/mdtklib.go

@@ -0,0 +1,53 @@
+package cache
+
+import (
+	"mdtk/grtask"
+	"mdtk/taskset"
+	"mdtk/args"
+	"mdtk/path"
+	"path/filepath"
+)
+
+func expandPublicGroupTask(tds taskset.TaskDataSet, nestsize int) taskset.TaskDataSet {
+
+	for i, data := range tds.Data {
+		if data.Group.IsPrivate() {
+			continue
+		}
+		code := tds.GetTaskStart(grtask.Create(data.Group, data.Task), args.Args{}, nestsize)
+		tds.Data[i].Code = code
+	}
+
+	return tds
+}
+
+func removePrivateGroupTask(tds taskset.TaskDataSet) taskset.TaskDataSet {
+	d := []taskset.TaskData{}
+	for _, data := range tds.Data {
+		if !data.Group.IsPrivate() {
+			d = append(d, data)
+		}
+	}
+	tds.Data = d
+	return tds
+}
+
+func cleanFilePath(tds taskset.TaskDataSet, s string) taskset.TaskDataSet {
+	tds.FilePath = map[path.Path]bool{path.Path(s): true}
+	for i, _ := range tds.Data {
+		tds.Data[i].FilePath = path.Path(s)
+	}
+	return tds
+}
+
+
+func WriteLib(tds taskset.TaskDataSet, dir path.Path, output_namebase string, nestsize int) error {
+	tdsb := expandPublicGroupTask(tds, nestsize)
+	tdsb = removePrivateGroupTask(tdsb)
+	tdsb = cleanFilePath(tdsb, output_namebase)
+	return writeBase(tdsb, filepath.Join(string(dir), output_namebase + ".mdtklib"))
+}
+
+func ReadLib(filename path.Path) (taskset.TaskDataSet, error) {
+	return readBase(string(filename))
+}

sources/mdtk/cache/readwrite.go

@@ -3,37 +3,11 @@ package cache
 import (
 	"os"
 	"encoding/gob"
-	"mdtk/path"
 	"mdtk/taskset"
 )
 
-func toCacheName(filename path.Path) string {
-	return string(filename) + ".cache"
-}
-
-func ExistCacheFile(filename path.Path) bool {
-	_, err := os.Stat(toCacheName(filename))
-	return err == nil
-}
-
-func IsLatestCache(tds taskset.TaskDataSet, filename path.Path) bool {
-	status, err := os.Stat(toCacheName(filename))
-	if err != nil {
-		return false
-	}
-
-	for k, _ := range tds.FilePath {
-		substatus, err := os.Stat(string(k))
-		if err != nil || status.ModTime().Before(substatus.ModTime()) {
-			return false
-		}
-	}
-
-	return true
-}
-
-func WriteCache(tds taskset.TaskDataSet, filename path.Path) error {
-	file, err := os.Create(toCacheName(filename))
+func writeBase(tds taskset.TaskDataSet, filename string) error {
+	file, err := os.Create(filename)
 	defer file.Close()
 	if err != nil {
 		return err
@@ -43,8 +17,8 @@ func WriteCache(tds taskset.TaskDataSet, filename path.Path) error {
 	return nil
 }
 
-func ReadCache(filename path.Path) (taskset.TaskDataSet, error) {
-	file, err := os.Open(toCacheName(filename))
+func readBase(filename string) (taskset.TaskDataSet, error) {
+	file, err := os.Open(filename)
 	defer file.Close()
 	if err != nil {
 		return taskset.TaskDataSet{}, err
@@ -59,3 +33,5 @@ func ReadCache(filename path.Path) (taskset.TaskDataSet, error) {
 	return tds, nil
 }
 
+
+

sources/mdtk/code/code_embed_codes.go

@@ -21,7 +21,7 @@ func (code Code) ApplyEmbedCodes(tf TaskDataSetInterface, nestsize int) (Code, e
 		if err != nil {
 			return "", err
 		}
-		// subcode = subcode.RemoveEmbedArgsComment()
+		subcode = subcode.RemoveEmbedArgsComment()
 		res = strings.Replace(res, embed[0], string(subcode), 1)
 	}
 

sources/mdtk/code/code_embed_tasks.go

@@ -55,7 +55,7 @@ func (code Code) ApplySubTasks(tf TaskDataSetInterface, nestsize int) (Code, err
 		if err2 != nil {
 			return "", err2
 		}
-		// subcode = subcode.RemoveEmbedArgsComment()
+		subcode = subcode.RemoveEmbedArgsComment()
 		rsubcode := indent + strings.Replace(string(subcode), "\n", "\n" + indent, -1)
 		execsubcode := "\n# subtask: " + string(grtaskname) + "\n(\n" + rsubcode + "\n) # end: " + string(grtaskname) + "\n"
 		res = strings.Replace(res, task[0], execsubcode, 1)

sources/mdtk/config/default_config.txt

@@ -0,0 +1,2 @@
+pager=less -R
+pager_min_limit=30