refactor: refactor the package structure and layout

Author: Enda Phelan

CONTRIBUTING.md

@@ -26,11 +26,10 @@ go run ./cmd/rhoas kafka create "test" --provider=aws --region=us-east-1
 
 To use QA environment we need to login using following arguments
 
-```
+```shell
 rhoas login --api-gateway=stage --mas-auth-url=stage
 ```
 
-
 ### Development features
 
 To enable development and early access commands please set environment variable in your terminal:

Makefile

@@ -33,15 +33,14 @@ endif
 # The details of the application:
 binary:=rhoas
 
-amsapi_dir=./pkg/api/ams/amsclient
-rbacapi_dir=./pkg/api/rbac/rbacclient
+amsapi_dir=./pkg/apis/ams/amsclient
 
 # Enable Go modules:
 export GO111MODULE=on
 
 # Requires golangci-lint to be installed @ $(go env GOPATH)/bin/golangci-lint
 # https://golangci-lint.run/usage/install/
-lint: ## Lint Go files for errors
+lint: lint-lang ## Lint Go files for errors
 	golangci-lint run cmd/... pkg/... internal/...
 
 generate: ## Scan code for generate comments and run generators
@@ -58,7 +57,7 @@ install: ## Compile and install rhoas and add it to the PAth
 .PHONY: install
 
 test: ## Run unit tests
-	go test ./pkg/...
+	go test ./pkg/... ./internal/...
 .PHONY: test
 
 generate-ams-sdk: ## Generate the Account Management Service SDK
@@ -94,7 +93,7 @@ generate-modular-docs: generate-docs ## Generate modular command-line reference
 
 lint-lang: ## Lint i18n files
 	go install github.com/redhat-developer/app-services-go-linter/cmd/app-services-go-linter@latest
-	app-services-go-linter ./...
+	app-services-go-linter -path ./pkg/core/localize/locales ./...
 .PHONY: lint-lang
 
 # Check http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html

cmd/modular-docs/main.go

@@ -2,13 +2,12 @@ package main
 
 import (
 	"fmt"
+	"github.com/redhat-developer/app-services-cli/internal/doc"
 	"os"
-
-	"github.com/redhat-developer/app-services-cli/internal/docs"
 )
 
 func main() {
-	err := docs.CreateModularDocs()
+	err := doc.CreateModularDocs()
 	if err != nil {
 		fmt.Print(err.Error())
 		os.Exit(1)

cmd/rhoas/main.go

@@ -3,22 +3,22 @@ package main
 import (
 	"context"
 	"fmt"
+	"github.com/redhat-developer/app-services-cli/pkg/cmd/debug"
+	"github.com/redhat-developer/app-services-cli/pkg/cmd/root"
 	"os"
 	"strings"
 
-	"github.com/redhat-developer/app-services-cli/pkg/icon"
+	"github.com/redhat-developer/app-services-cli/internal/telemetry"
+	"github.com/redhat-developer/app-services-cli/pkg/core/cmdutil/factory"
+	"github.com/redhat-developer/app-services-cli/pkg/core/cmdutil/factory/defaultfactory"
+	"github.com/redhat-developer/app-services-cli/pkg/core/config"
+	"github.com/redhat-developer/app-services-cli/pkg/core/ioutil/icon"
+	"github.com/redhat-developer/app-services-cli/pkg/core/localize"
+	"github.com/redhat-developer/app-services-cli/pkg/core/localize/goi18n"
+
 	"github.com/spf13/cobra"
 
 	"github.com/redhat-developer/app-services-cli/internal/build"
-	"github.com/redhat-developer/app-services-cli/pkg/localize"
-	"github.com/redhat-developer/app-services-cli/pkg/localize/goi18n"
-	"github.com/redhat-developer/app-services-cli/pkg/telemetry"
-
-	"github.com/redhat-developer/app-services-cli/internal/config"
-
-	"github.com/redhat-developer/app-services-cli/pkg/cmd/debug"
-	"github.com/redhat-developer/app-services-cli/pkg/cmd/factory"
-	"github.com/redhat-developer/app-services-cli/pkg/cmd/root"
 )
 
 func main() {
@@ -29,7 +29,7 @@ func main() {
 	}
 
 	buildVersion := build.Version
-	cmdFactory := factory.New(localizer)
+	cmdFactory := defaultfactory.New(localizer)
 
 	err = initConfig(cmdFactory)
 	if err != nil {

internal/build/build.go

@@ -6,10 +6,11 @@ import (
 	"strings"
 	"time"
 
+	"github.com/redhat-developer/app-services-cli/pkg/core/ioutil/color"
+	"github.com/redhat-developer/app-services-cli/pkg/core/localize"
+	"github.com/redhat-developer/app-services-cli/pkg/core/logging"
+
 	"github.com/google/go-github/v39/github"
-	"github.com/redhat-developer/app-services-cli/pkg/color"
-	"github.com/redhat-developer/app-services-cli/pkg/localize"
-	"github.com/redhat-developer/app-services-cli/pkg/logging"
 )
 
 type buildSource string

pkg/doc/cmd_test.go internal/doc/cmd_test.gopkg/doc/cmd_test.go renamed to internal/doc/cmd_test.go

@@ -1,4 +1,3 @@
-// Copyright 2015 Red Hat Inc. All rights reserved.
 // Copyright 2021 Red Hat Inc. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,7 +16,6 @@ package doc
 import (
 	"bytes"
 	"fmt"
-	"github.com/spf13/pflag"
 	"io"
 	"os"
 	"path/filepath"
@@ -26,6 +24,8 @@ import (
 	"text/template"
 	"time"
 
+	"github.com/spf13/pflag"
+
 	"github.com/spf13/cobra"
 )
 

pkg/doc/modular_adoc_docs.go internal/doc/modular_adoc_docs.gopkg/doc/modular_adoc_docs.go renamed to internal/doc/modular_adoc_docs.go

@@ -1,4 +1,4 @@
-``# Generating AsciiDoc Docs For Your Own cobra.Command
+# Generating AsciiDoc Docs For Your Own cobra.Command
 
 Generating AsciiDoc pages from a cobra command is incredibly easy. An example is as follows:
 
@@ -34,8 +34,8 @@ This program can actually generate docs for the kubectl command in the kubernete
 package main
 
 import (
-	"log"
 	"io/ioutil"
+	"log"
 	"os"
 
 	"k8s.io/kubernetes/pkg/kubectl/cmd"
@@ -57,14 +57,15 @@ This will generate a whole series of files, one for each command in the tree, in
 
 ## Generate AsciiDoc docs for a single command
 
-You may wish to have more control over the output, or only generate for a single command, instead of the entire command tree. If this is the case you may prefer to `GenAsciidoc` instead of `GenAsciidocTree`
+You may wish to have more control over the output, or only generate for a single command, instead of the entire command
+tree. If this is the case you may prefer to `GenAsciidoc` instead of `GenAsciidocTree`
 
 ```go
-	out := new(bytes.Buffer)
-	err := doc.GenAsciidoc(cmd, out)
-	if err != nil {
-		log.Fatal(err)
-	}
+out := new(bytes.Buffer)
+err := doc.GenAsciidoc(cmd, out)
+if err != nil {
+	log.Fatal(err)
+}
 ```
 
 This will write the AsciiDoc doc for ONLY "cmd" into the out, buffer.
@@ -74,18 +75,19 @@ This will write the AsciiDoc doc for ONLY "cmd" into the out, buffer.
 Both `GenAsciidoc` and `GenAsciidocTree` have alternate versions with callbacks to get some control of the output:
 
 ```go
-func GenAsciidocTreeCustom(cmd *Command, dir string, filePrepender, linkHandler func(string) string) error {
+func GenAsciidocTreeCustom(cmd *Command, dir string, filePrepender, linkHandler func (string) string) error {
 	//...
 }
 ```
 
 ```go
-func GenAsciidocCustom(cmd *Command, out *bytes.Buffer, linkHandler func(string) string) error {
+func GenAsciidocCustom(cmd *Command, out *bytes.Buffer, linkHandler func (string) string) error {
 	//...
 }
 ```
 
-The `filePrepender` will prepend the return value given the full filepath to the rendered Asciidoc file. A common use case is to add front matter to use the generated documentation with [Hugo](http://gohugo.io/):
+The `filePrepender` will prepend the return value given the full filepath to the rendered Asciidoc file. A common use
+case is to add front matter to use the generated documentation with [Hugo](http://gohugo.io/):
 
 ```go
 const fmTemplate = `---

pkg/doc/modular_adoc_docs.md internal/doc/modular_adoc_docs.mdpkg/doc/modular_adoc_docs.md renamed to internal/doc/modular_adoc_docs.md

@@ -1,4 +1,4 @@
-package docs
+package doc
 
 import (
 	"fmt"
@@ -13,7 +13,7 @@ import (
 	"github.com/pkg/errors"
 )
 
-// Create Modular Documentation from the CLI generated docs
+// CreateModularDocs Create Modular Documentation from the CLI generated docs
 func CreateModularDocs() error {
 	srcDir := os.Getenv("SRC_DIR")
 	if srcDir == "" {