added some docs

README.md

@@ -0,0 +1,79 @@
+# Clean Architecture checker for Golang
+
+go-cleanarch was created to keep Clean Architecture rules,
+like a _The Dependency Rule_ and _interaction between modules_ in your Go projects.
+More about Clean Architecture you can read in [Uncle's Bob article](https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html).
+
+![Clean Architecture](docs/go-cleanarch.png)
+
+## Installing
+
+    go get github.com/roblaszczak/go-cleanarch
+
+_go-cleanarch was only tested on Linux and also should work on OS X.
+Probably it doesn't work well on Windows._
+
+## Running
+
+To run in current directory:
+
+    cleanarch
+
+To run in provided directory
+
+    cleanarch go/src/github.com/roblaszczak/awesome-cms
+
+### Project schema requirements
+
+go-cleanarch assumes this files structure:
+
+    [GOPATH]/[PACKAGE_NAME]/[LAYER_NAME]
+
+or
+
+    [GOPATH]/[PACKAGE_NAME]/[MODULE_NAME]/[LAYER_NAME]
+
+For example
+
+* go/src/github.com/roblaszczak/awesome-app
+    * auth
+        * domain
+        * application
+        * interfaces
+    * content
+        * domain
+        * application
+        * interfaces
+    * frontend
+        * domain
+        * application
+        * interfaces
+
+For examples please go to [examples](examples/) directory,
+with contains examples of valid and invalid architectures.
+
+For more informations about Clean Architecture please read [Uncle's Bob article](https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html)
+
+## Running the tests
+
+    make test
+
+## And coding style tests
+
+    make qa
+
+## Contributing
+
+Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
+
+## Credits
+
+Made without love by Robert Laszczak </3
+
+## License
+
+This project is licensed under the MIT License.

cleanarch/cleanarch_test.go

@@ -11,11 +11,11 @@ func TestValidator_Validate(t *testing.T) {
 		Path    string
 		IsValid bool
 	}{
-		{"../tests/valid-simple", true},
-		{"../tests/invalid-infra-in-domain-import", false},
-		{"../tests/invalid-app-in-domain-import", false},
-		{"../tests/invalid-import-between-modules-apps", false},
-		{"../tests/valid-cross-module-deps", true},
+		{"../examples/valid-simple", true},
+		{"../examples/invalid-infra-in-domain-import", false},
+		{"../examples/invalid-app-to-domain-import", false},
+		{"../examples/invalid-cross-module-deps", false},
+		{"../examples/valid-cross-module-deps", true},
 	}
 
 	for _, c := range testCases {

examples/invalid-app-to-domain-import/README.md

@@ -0,0 +1,3 @@
+# Invalid `app` to `domain` import
+
+![Schema](schema.png)

examples/invalid-app-to-domain-import/domain/product.go

@@ -0,0 +1,7 @@
+package domain
+
+import "github.com/roblaszczak/go-cleanarch/examples/invalid-app-to-domain-import/app"
+
+type Product struct {
+	Price app.Price
+}

examples/invalid-cross-module-deps/README.md

@@ -0,0 +1,6 @@
+# Invalid cross modules deps
+
+![Schema](schema.png)
+
+In this example modules are interacting directly
+(without using `interfaces` and `infrastructure` layers).

examples/invalid-cross-module-deps/forum/user/app/user.go

@@ -0,0 +1,7 @@
+package app
+
+import "github.com/roblaszczak/go-cleanarch/examples/invalid-cross-module-deps/forum/post/app"
+
+type User struct {
+	Posts []app.Post
+}

examples/invalid-infra-in-domain-import/README.md

@@ -0,0 +1,3 @@
+# Invalid `infrastructure` in domain `import`
+
+![Schema](schema.png)

tests/invalid-infra-in-domain-import/domain/order.go → examples/invalid-infra-in-domain-import/domain/order.go

@@ -1,6 +1,6 @@
 package domain
 
-import "github.com/roblaszczak/go-cleanarch/tests/invalid-infra-in-domain-import/infrastructure"
+import "github.com/roblaszczak/go-cleanarch/examples/invalid-infra-in-domain-import/infrastructure"
 
 type OrderAdder struct {
 	// please, don't do this :(

examples/valid-cross-module-deps/README.md

@@ -0,0 +1,3 @@
+# Invalid cross module deps
+
+![Schema](schema.png)

examples/valid-cross-module-deps/cms/auth/interfaces/access.go

@@ -0,0 +1,7 @@
+package interfaces
+
+import "github.com/roblaszczak/go-cleanarch/examples/valid-cross-module-deps/cms/auth/usecases"
+
+func CheckAccess(username string) bool {
+	return usecases.LoginAccessChecker(username)
+}

examples/valid-cross-module-deps/cms/auth/usecases/access.go

@@ -0,0 +1,5 @@
+package usecases
+
+func LoginAccessChecker(username string) bool {
+	return username == "admin"
+}

examples/valid-cross-module-deps/cms/cms.go

@@ -0,0 +1,10 @@
+package main
+
+import (
+	"github.com/roblaszczak/go-cleanarch/examples/valid-cross-module-deps/cms/content/infrastructure"
+	"github.com/roblaszczak/go-cleanarch/examples/valid-cross-module-deps/cms/content/usecases"
+)
+
+func main() {
+	usecases.AddArticle{infrastructure.AuthModuleAuthChecker{}}.AddArticle("admin", "test article")
+}

examples/valid-cross-module-deps/cms/content/infrastructure/auth.go

@@ -0,0 +1,11 @@
+package infrastructure
+
+import (
+	"github.com/roblaszczak/go-cleanarch/examples/valid-cross-module-deps/cms/auth/interfaces"
+)
+
+type AuthModuleAuthChecker struct{}
+
+func (a AuthModuleAuthChecker) CheckAuth(username string) bool {
+	return interfaces.CheckAccess(username)
+}

examples/valid-cross-module-deps/cms/content/usecases/add_article.go

@@ -0,0 +1,24 @@
+package usecases
+
+import (
+	"fmt"
+)
+
+type AuthChecker interface {
+	CheckAuth(username string) bool
+}
+
+type AddArticle struct {
+	AuthChecker AuthChecker
+}
+
+func (c AddArticle) AddArticle(username string, title string) error {
+	if !c.AuthChecker.CheckAuth(username) {
+		return fmt.Errorf("user %s is not allowed to add article", username)
+	}
+
+	// todo - some article adding logic
+	fmt.Printf("added %s article by %s\n", title, username)
+
+	return nil
+}

examples/valid-simple/README.md

@@ -0,0 +1,3 @@
+# Simple valid architecture
+
+![Schema](schema.png)

tests/valid-simple/app/payment.go → examples/valid-simple/app/payment.go

@@ -1,6 +1,6 @@
 package app
 
-import "github.com/roblaszczak/go-cleanarch/tests/valid-simple/domain"
+import "github.com/roblaszczak/go-cleanarch/examples/valid-simple/domain"
 
 type Payment struct {
 	Amount domain.Price

tests/valid-simple/infrastructure/payments.go → examples/valid-simple/infrastructure/payments.go

@@ -2,7 +2,7 @@ package infrastructure
 
 import (
 	"fmt"
-	"github.com/roblaszczak/go-cleanarch/tests/valid-simple/app"
+	"github.com/roblaszczak/go-cleanarch/examples/valid-simple/app"
 )
 
 type MysqlPaymentsRepository struct{}

tests/valid-simple/main.go → examples/valid-simple/main.go

@@ -1,9 +1,9 @@
 package main
 
 import (
-	"github.com/roblaszczak/go-cleanarch/tests/valid-simple/app"
-	"github.com/roblaszczak/go-cleanarch/tests/valid-simple/domain"
-	"github.com/roblaszczak/go-cleanarch/tests/valid-simple/infrastructure"
+	"github.com/roblaszczak/go-cleanarch/examples/valid-simple/app"
+	"github.com/roblaszczak/go-cleanarch/examples/valid-simple/domain"
+	"github.com/roblaszczak/go-cleanarch/examples/valid-simple/infrastructure"
 )
 
 func main() {