Merge pull request #24 from b4b4r07/fix/inconsistency

Fix inconsistency parts and remove bad implementations coming from old package

Author: b4b4r07

docs/configuration/command.md

@@ -4,84 +4,11 @@ afx's goal is to finally support to install packages as `command`, `plugin` or b
 
 ## Parameters
 
-### build.steps
-
-Type | Required
----|---
-list | yes (when using `build`)
-
-`build.steps` can be specified build commands to build a package.
-
-=== "Case 1"
-
-    ```yaml hl_lines="7 8 9 10" title="Using sudo"
-    github:
-    - name: jhawthorn/fzy
-      description: A better fuzzy finder
-      owner: jhawthorn
-      repo: fzy
-      command:
-        build:
-          steps:
-          - make
-          - sudo make install
-    ```
-
-    In this case, build steps has `sudo` command but it can be run as expected. But in advance you will be asked to input sudo password.
-
-=== "Case 2"
-
-    ```yaml hl_lines="7 8 9" title="Using go build"
-    github:
-    - name: iovisor/kubectl-trace
-      description: Schedule bpftrace programs on your kubernetes cluster using the kubectl
-      owner: iovisor
-      repo: kubectl-trace
-      command:
-        build:
-          steps:
-          - go build -o kubectl-trace cmd/kubectl-trace/root.go
-        link:
-        - from: kubectl-trace
-          to: kubectl-trace
-    ```
-
-    In this case, build steps run `go build` command because this package does not provide GitHub releases on its own page. So we need to build by ourselves. afx build feature is very helpful in such a case.
-
-    `go build` command creates `red` command to current working directory so you need to have `link` section to install the built binary to your PATH.
-
-### build.env
-
-Type | Required
----|---
-map | no
-
-`build.env` can be specified environemnt variables used when running build a package.
-
-=== "Case 1"
-
-    ```yaml hl_lines="11 12"
-    github:
-    - name: jhawthorn/fzy
-      description: A better fuzzy finder
-      owner: jhawthorn
-      repo: fzy
-      command:
-        build:
-          steps:
-          - make
-          - sudo make install
-          env:
-            VERSION: 1.0
-    ```
-
-    In this case, VERSION is specified to change version used in build steps.
-
 ### link.from
 
-Type | Required
+Type | Default
 ---|---
-string | yes (when using `link`)
+string | (required)
 
 `link.from` can be specified where to install from.
 
@@ -121,11 +48,11 @@ string | yes (when using `link`)
 
 ### link.to
 
-Type | Required
+Type | Default
 ---|---
-string | no
+string | `$AFX_COMMAND_PATH/(command-name)`
 
-`link.to` can be specified where to install to.
+`link.to` can be specified where to install to. If omitted, the command will be installed to `$AFX_COMMAND_PATH`.
 
 === "Case 1"
 
@@ -183,9 +110,9 @@ string | no
 
 ### env
 
-Type | Required
+Type | Default
 ---|---
-map | no
+map | `{}`
 
 `env` allows you to set environment variables. By having this section in same YAML file of package declaration, you can manage it with same file. When we don't have afx, we should have environment variables in shell config (e.g. zshrc) even if not installed it yet or failed to install it. But thanks to afx, afx users can keep it with same files and enable it only while a package is installed.
 
@@ -221,9 +148,9 @@ map | no
 
 ### alias
 
-Type | Required
+Type | Default
 ---|---
-map | no
+map | `{}`
 
 `alias` allows you to set command aliases.
 
@@ -288,11 +215,84 @@ map | no
         - from: '**/bat'
     ```
 
+### build.steps
+
+Type | Default
+---|---
+list | `[]`
+
+`build.steps` can be specified build commands to build a package.
+
+=== "Case 1"
+
+    ```yaml hl_lines="7 8 9 10" title="Using sudo"
+    github:
+    - name: jhawthorn/fzy
+      description: A better fuzzy finder
+      owner: jhawthorn
+      repo: fzy
+      command:
+        build:
+          steps:
+          - make
+          - sudo make install
+    ```
+
+    In this case, build steps has `sudo` command but it can be run as expected. But in advance you will be asked to input sudo password.
+
+=== "Case 2"
+
+    ```yaml hl_lines="7 8 9" title="Using go build"
+    github:
+    - name: iovisor/kubectl-trace
+      description: Schedule bpftrace programs on your kubernetes cluster using the kubectl
+      owner: iovisor
+      repo: kubectl-trace
+      command:
+        build:
+          steps:
+          - go build -o kubectl-trace cmd/kubectl-trace/root.go
+        link:
+        - from: kubectl-trace
+          to: kubectl-trace
+    ```
+
+    In this case, build steps run `go build` command because this package does not provide GitHub releases on its own page. So we need to build by ourselves. afx build feature is very helpful in such a case.
+
+    `go build` command creates `red` command to current working directory so you need to have `link` section to install the built binary to your PATH.
+
+### build.env
+
+Type | Required
+---|---
+map | `{}`
+
+`build.env` can be specified environemnt variables used when running build a package.
+
+=== "Case 1"
+
+    ```yaml hl_lines="11 12"
+    github:
+    - name: jhawthorn/fzy
+      description: A better fuzzy finder
+      owner: jhawthorn
+      repo: fzy
+      command:
+        build:
+          steps:
+          - make
+          - sudo make install
+          env:
+            VERSION: 1.0
+    ```
+
+    In this case, VERSION is specified to change version used in build steps.
+
 ### snippet
 
 Type | Required
 ---|---
-string | no
+string | `""`
 
 `snippet` allows you to specify the command which are runned when starting new shell.
 
@@ -318,7 +318,7 @@ string | no
 
 Type | Required
 ---|---
-string | no
+string | `""`
 
 `if` allows you to specify the condition to load packages. If it returns true, then the command will be linked. But if it returns false, the command will not be linked.
 

docs/configuration/plugin.md

@@ -6,9 +6,9 @@ afx's goal is to finally support to install packages as `command`, `plugin` or b
 
 ### sources
 
-Type | Required
+Type | Default
 ---|---
-list | yes
+list | (required)
 
 `sources` allows you to select what to load files when starting shell.
 
@@ -56,9 +56,9 @@ list | yes
 
 ### env
 
-Type | Required
+Type | Default
 ---|---
-list | no
+map | `{}`
 
 `env` allows you to set environment variables. By having this section in same YAML file of package declaration, you can manage it with same file. When we don't have afx, we should have environment variables in shell config (e.g. zshrc) even if not installed it yet or failed to install it. But thanks to afx, afx users can keep it with same files and enable it only while a package is installed.
 
@@ -88,9 +88,9 @@ list | no
 
 ### snippet
 
-Type | Required
+Type | Default
 ---|---
-string | no
+string | `""`
 
 `snippet` allows you to specify the command which are runned when starting new shell.
 
@@ -114,9 +114,9 @@ string | no
 
 ### snippet-prepare (beta)
 
-Type | Required
+Type | Default
 ---|---
-string | no
+string | `""`
 
 `snippet-prepare` allows you to specify the command which are runned when starting new shell. Unlike `snippet`, this `snippet-prepare` is run before `source` command.
 
@@ -147,9 +147,9 @@ This option comes from https://github.com/b4b4r07/afx/issues/6.
 
 ### if
 
-Type | Required
+Type | Default
 ---|---
-string | no
+string | `""`
 
 `if` allows you to specify the condition to load packages. If it returns true, then the plugin will be loaded. But if it returns false, the plugin will not be loaded.
 

pkg/config/command.go

@@ -20,7 +20,7 @@ import (
 // Command is
 type Command struct {
 	Build   *Build            `yaml:"build"`
-	Link    []*Link           `yaml:"link"` // validate:"required"
+	Link    []*Link           `yaml:"link" validate:"required"`
 	Env     map[string]string `yaml:"env"`
 	Alias   map[string]string `yaml:"alias"`
 	Snippet string            `yaml:"snippet"`
@@ -107,20 +107,21 @@ func (c Command) GetLink(pkg Package) ([]Link, error) {
 		if err != nil {
 			return links, errors.Wrapf(err, "%s: failed to get links", pkg.GetName())
 		}
+
+		log.Printf("[DEBUG] Run file globbing: %s", file)
 		var src string
 		switch len(matches) {
 		case 0:
-			log.Printf("[ERROR] %s: no matches\n", file)
-			continue
+			return links, fmt.Errorf("%s: %q no matches", pkg.GetName(), link.From)
 		case 1:
 			// OK pattern: matches should be only one
 			src = matches[0]
 		case 2:
 			// TODO: Update this with more flexiblities
-			msg := fmt.Sprintf("[ERROR] %s: %d files matched: %#v\n", pkg.GetName(), len(matches), matches)
-			return links, errors.New(msg)
+			return links, fmt.Errorf("%s: %d files matched: %#v\n", pkg.GetName(), len(matches), matches)
 		default:
-			return links, errors.New("unknown error occured")
+			log.Printf("[ERROR] matched files: %#v", matches)
+			return links, errors.New("too many files are matched in file glob")
 		}
 		links = append(links, Link{
 			From: src,

pkg/config/config.go

@@ -79,29 +79,8 @@ func parse(cfg Config) []Package {
 	var pkgs []Package
 
 	for _, pkg := range cfg.GitHub {
-		// TODO: Remove?
-		if pkg.HasReleaseBlock() {
-			msg := fmt.Sprintf(
-				"[DEBUG] %s: added '**/%s' to link.from to complete missing links in github release",
-				pkg.GetName(), pkg.Release.Name,
-			)
-			defaultLinks := []*Link{
-				{From: filepath.Join("**", pkg.Release.Name)},
-			}
-			if pkg.HasCommandBlock() {
-				links, _ := pkg.Command.GetLink(pkg)
-				if len(links) == 0 {
-					log.Printf(msg)
-					pkg.Command.Link = defaultLinks
-				}
-			} else {
-				log.Printf(msg)
-				pkg.Command = &Command{Link: defaultLinks}
-			}
-		}
 		pkgs = append(pkgs, pkg)
 	}
-
 	for _, pkg := range cfg.Gist {
 		pkgs = append(pkgs, pkg)
 	}

pkg/config/github.go

@@ -40,7 +40,7 @@ type GitHub struct {
 	Release *Release `yaml:"release"`
 
 	Plugin  *Plugin  `yaml:"plugin"`
-	Command *Command `yaml:"command"` //  validate:"required_with=Release"
+	Command *Command `yaml:"command" validate:"required_with=Release"` // TODO: (not required Release)
 
 	DependsOn []string `yaml:"depends-on"`
 }
@@ -602,7 +602,7 @@ func (r *GitHubRelease) Unarchive(asset Asset) error {
 		return errors.Wrapf(err, "%s: failed to unarchive", r.Name)
 	}
 
-	log.Printf("[DEBUG] removed archive file: %s\n", asset.Path)
+	log.Printf("[DEBUG] removed archive file: %s", asset.Path)
 	os.Remove(asset.Path)
 
 	return nil