refactor: new repo structure (#188)

CONTRIBUTING.md

@@ -9,6 +9,14 @@ The following should be to be installed on your device in order to contribute to
 
 ## Development
 
+### Folder Structure
+Charmil repository contains a number of components that can be consumed independently. In the root directory, the following folders can be found:
+
+- **cli**  -command line tool for using charmil.
+- **core** - charmil SDK 
+- **starter** - charmil starter template project
+- **validator** - validator and linter library to test cobra commands
+
 ### Running Charmil CLI Commands
 You can run the CLI commands files directly with go run. All commands and subcommands are in the ./pkg/cmd folder.
 ```bash
@@ -32,4 +40,4 @@ Runs unit tests
 - You can join [Aerogear’s discord server](https://discord.gg/hsDJUPkAWH) to participate in the discussions happening
 
 ## License
-By contributing, you agree that your contributions will be licensed under its Apache License 2.0
+By contributing, you agree that your contributions will be licensed under its Apache License 2.0

Makefile

@@ -7,37 +7,36 @@ help:
 	@echo ""
 	@echo "make lint                 	run golangci-lint"
 	@echo "make test                 	run  tests"
-	@echo "make format             		format files"
+	@echo "make format             	format files"
 	@echo "make build             		build files"
 	@echo "make setup/git/hooks      	setup git hooks"
 .PHONY: help
 
 run:
-	go run ./cmd/charmil
+	go run ./cli/cmd/charmil
 
 build:
-	go build ./cmd/charmil
+	go build ./cli/cmd/charmil
 
 install:
-	go install ./cmd/charmil
+	go install ./cli/cmd/charmil
 
 build/tags:
-	go build -tags ${TAGS} ./cmd/charmil
+	go build -tags ${TAGS} ./cli/cmd/charmil
 
 test:
 	go test ./...
 
 # Requires golangci-lint to be installed @ $(go env GOPATH)/bin/golangci-lint
 # https://golangci-lint.run/usage/install/
 lint:
-	golangci-lint run cmd/... pkg/... 
+	golangci-lint run ./...
 .PHONY: lint
 
 
 # clean up code and dependencies
 format:
 	@go mod tidy
-
 	@gofmt -w `find . -type f -name '*.go'`
 .PHONY: format
 

cmd/charmil/main.go → cli/cmd/charmil/main.go

@@ -6,15 +6,14 @@ import (
 	"log"
 	"os"
 
+	"github.com/aerogear/charmil/cli/internal/cmd/crud"
+	"github.com/aerogear/charmil/cli/internal/cmd/root"
 	c "github.com/aerogear/charmil/core/config"
 	"github.com/aerogear/charmil/core/factory"
 	"github.com/aerogear/charmil/core/localize"
 
 	"github.com/spf13/cobra"
 	"golang.org/x/text/language"
-
-	"github.com/aerogear/charmil/pkg/cmd/crud"
-	"github.com/aerogear/charmil/pkg/cmd/root"
 )
 
 // Defines the configuration keys of the host CLI.

pkg/cmd/crud/crud.go → cli/internal/cmd/crud/crud.go

@@ -7,8 +7,8 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/aerogear/charmil/cli/internal/template/crud"
 	"github.com/aerogear/charmil/core/factory"
-	"github.com/aerogear/charmil/pkg/template/crud"
 	"github.com/spf13/cobra"
 )
 

pkg/cmd/root/root.go → cli/internal/cmd/root/root.go

@@ -1,8 +1,8 @@
 package root
 
 import (
+	initialize "github.com/aerogear/charmil/cli/internal/cmd/init"
 	"github.com/aerogear/charmil/core/factory"
-	initialize "github.com/aerogear/charmil/pkg/cmd/init"
 	"github.com/spf13/cobra"
 )