Update README.md

.gitignore

@@ -0,0 +1,30 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# Go
+go.work
+go.work.sum
+
+# project
+*.cert
+*.key
+*.log
+bin/

README.md

@@ -6,23 +6,28 @@
 ===============
 ```bash
 go install github.com/elza2/go-cyclic@latest
-# path 路径要设置为 go.mod 文件所在的全路径. 
+# path 路径要设置为 go.mod 文件所在的路径.
 go-cyclic gocyclic --dir .path
 ```
 
 运行测试
 ===============
 ```bash
-git 
-go run ./cmd/main.go gocyclic --dir .path
+git clone https://github.com/elza2/go-cyclic.git
+# path 路径要设置为 go.mod 文件所在的路径.
+go run ./main.go gocyclic --dir .path
 ```
 
+运行结果
+===============
 ```bash
 # success output.
 Success. Not circular dependence.
 
 # failed output.
-┌---→    daji.go
+Failed. 1 circular dependence chains were found.
+
+┌---→    app.go
 ┆          ↓
 ┆       routes.go
 ┆          ↓

cmd/actions/cmd.go → cmd/cmd.go

@@ -1,9 +1,11 @@
-package actions
+package cmd
 
 import (
-	"github.com/spf13/cobra"
-	"go-cyclic/tool"
 	"log"
+
+	"github.com/spf13/cobra"
+
+	"github.com/elza2/go-cyclic/tool"
 )
 
 func RunCyclic(cmd *cobra.Command, args []string) {
@@ -12,7 +14,7 @@ func RunCyclic(cmd *cobra.Command, args []string) {
 		log.Fatalf("get dir params failed: %v\n", err)
 	}
 	if err = tool.CheckCycleDepend(dir); err != nil {
-		log.Fatalf("run failed: %v\n", err)
+		log.Fatalf("run failed. %v\n", err)
 	}
 }
 

cmd/actions/root.go → cmd/root.go

@@ -1,12 +1,13 @@
-package actions
+package cmd
 
 import (
-	"github.com/spf13/cobra"
 	"log"
 	"os"
+
+	"github.com/spf13/cobra"
 )
 
-const Service = "go-cyclic"
+const Service = "github.com/elza2/go-cyclic"
 
 var (
 	rootCmd = &cobra.Command{Use: Service}

errors/errors.go

@@ -1,8 +1,22 @@
 package errors
 
-import "errors"
-
-var (
-	GoModNotExist    = errors.New("not find go.mod file")
-	GoModParseFailed = errors.New("go.mod file parse failed")
+import (
+	"errors"
+	"fmt"
 )
+
+func PathNotExist(filepath string) error {
+	return errors.New(fmt.Sprintf("path: %v, not exist.", filepath))
+}
+
+func PathNotIsFile(filepath string) error {
+	return errors.New(fmt.Sprintf("path: %v, cannot is a file.", filepath))
+}
+
+func GoModNotExist(filepath string) error {
+	return errors.New(fmt.Sprintf("path: %v, not find go.mod file.", filepath))
+}
+
+func GoModParseFailed(filepath string) error {
+	return errors.New(fmt.Sprintf("path: %v/go.mod, go.mod file parse failed.", filepath))
+}

example_cyclic_test.go

@@ -1,8 +1,9 @@
 package main
 
 import (
-	"go-cyclic/tool"
 	"testing"
+
+	"github.com/elza2/go-cyclic/tool"
 )
 
 func TestCyclic(t *testing.T) {

go.mod

@@ -1,4 +1,4 @@
-module go-cyclic
+module github.com/elza2/go-cyclic
 
 go 1.18
 

main.go

@@ -0,0 +1,7 @@
+package main
+
+import "github.com/elza2/go-cyclic/cmd"
+
+func main() {
+	cmd.Execute()
+}

resolver/resolver.go

@@ -2,13 +2,15 @@ package resolver
 
 import (
 	"fmt"
-	"go-cyclic/errors"
-	"go-cyclic/sprite"
 	"go/parser"
 	"go/token"
-	"golang.org/x/mod/modfile"
-	"io/ioutil"
+	"os"
 	"strings"
+
+	"golang.org/x/mod/modfile"
+
+	"github.com/elza2/go-cyclic/errors"
+	"github.com/elza2/go-cyclic/sprite"
 )
 
 var (
@@ -18,29 +20,39 @@ var (
 )
 
 // ParseDir parse path.
-func ParseDir(dir string) string {
+func ParseDir(dir string) (path string, err error) {
+	stat, err := os.Stat(dir)
+	if err != nil {
+		if os.IsNotExist(err) {
+			return "", errors.PathNotExist(dir)
+		}
+		return "", err
+	}
+	if !stat.IsDir() {
+		return "", errors.PathNotIsFile(dir)
+	}
 	idx := strings.LastIndex(dir, "/")
 	if idx == -1 {
-		return dir
+		return dir, nil
 	}
-	return dir[idx+1:]
+	return dir[idx+1:], nil
 }
 
-func ParseGoModule(dir string) (moduleName string, err error) {
-	readFile, err := ioutil.ReadFile(dir + "/" + GoMod)
+func ParseGoModule(dir string) (module string, err error) {
+	readFile, err := os.ReadFile(dir + "/" + GoMod)
 	if err != nil {
-		return "", errors.GoModNotExist
+		return "", errors.GoModNotExist(dir)
 	}
 	modFile, err := modfile.Parse(GoMod, readFile, nil)
 	if err != nil {
-		return "", errors.GoModParseFailed
+		return "", errors.GoModParseFailed(dir)
 	}
 	return modFile.Module.Mod.Path, nil
 }
 
 func ParseNodeSprite(root string, module string, dir string) (nodes []*sprite.NodeSprite, err error) {
 	nodeSprites := make([]*sprite.NodeSprite, 0)
-	files, err := ioutil.ReadDir(dir)
+	files, err := os.ReadDir(dir)
 	if err != nil {
 		return nil, err
 	}

tool/tool.go

@@ -1,21 +1,29 @@
 package tool
 
 import (
-	"go-cyclic/resolver"
-	"go-cyclic/sprite"
-	"go-cyclic/topology"
+	"github.com/elza2/go-cyclic/resolver"
+	"github.com/elza2/go-cyclic/sprite"
+	"github.com/elza2/go-cyclic/topology"
+	"path/filepath"
 )
 
 func CheckCycleDepend(dir string) error {
+	abs, err := filepath.Abs(dir)
+	if err != nil {
+		return err
+	}
 	// parse root path.
-	root := resolver.ParseDir(dir)
+	root, err := resolver.ParseDir(abs)
+	if err != nil {
+		return err
+	}
 	// parse module name.
-	module, err := resolver.ParseGoModule(dir)
+	module, err := resolver.ParseGoModule(abs)
 	if err != nil {
 		return err
 	}
 	// parse sprite nodes by path.
-	sprites, err := resolver.ParseNodeSprite(root, module, dir)
+	sprites, err := resolver.ParseNodeSprite(root, module, abs)
 	if err != nil {
 		return err
 	}

topology/topology.go

@@ -2,9 +2,10 @@ package topology
 
 import (
 	"fmt"
-	"github.com/fatih/color"
-	"go-cyclic/sprite"
 	"strings"
+
+	"github.com/elza2/go-cyclic/sprite"
+	"github.com/fatih/color"
 )
 
 var (