feat(init): Continue on template
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Matthieu 'JP' DERASSE 2022-08-09 21:37:57 +00:00
parent 3536298742
commit cf7901890c
Signed by: mderasse
GPG Key ID: 55141C777B16A705
13 changed files with 206 additions and 7 deletions

View File

@ -124,7 +124,7 @@ func runInitAction(cmd *cobra.Command, args []string) {
// ask project name // ask project name
log.Info("Name of the project:") log.Info("Name of the project:")
config.ProjectName = helpers.StringInput() config.ProjectName = helpers.AlphanumericalAndSpaceInput()
// ask project description // ask project description
log.Info("Description of the project:") log.Info("Description of the project:")
@ -188,4 +188,9 @@ func runInitAction(cmd *cobra.Command, args []string) {
} }
log.Info("Creating API skeleton") log.Info("Creating API skeleton")
err = apiType.CreateProjectSkeleton(projectDirPath, config)
if err != nil {
log.Errorf("Fail to create the project skeleton. The following error happen: %s", err.Error())
return
}
} }

1
go.mod
View File

@ -4,6 +4,7 @@ go 1.17
require ( require (
github.com/blang/semver v3.5.1+incompatible github.com/blang/semver v3.5.1+incompatible
github.com/iancoleman/strcase v0.2.0
github.com/juju/errors v1.0.0 github.com/juju/errors v1.0.0
github.com/sirupsen/logrus v1.8.1 github.com/sirupsen/logrus v1.8.1
github.com/spf13/cobra v1.5.0 github.com/spf13/cobra v1.5.0

2
go.sum
View File

@ -4,6 +4,8 @@ github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46t
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/iancoleman/strcase v0.2.0 h1:05I4QRnGpI0m37iZQRuskXh+w77mr6Z41lwQzuHLwW0=
github.com/iancoleman/strcase v0.2.0/go.mod h1:iwCmte+B7n89clKwxIoIXy/HfoL7AsD47ZCWhYzw7ho=
github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM= github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
github.com/juju/errors v1.0.0 h1:yiq7kjCLll1BiaRuNY53MGI0+EQ3rF6GB+wvboZDefM= github.com/juju/errors v1.0.0 h1:yiq7kjCLll1BiaRuNY53MGI0+EQ3rF6GB+wvboZDefM=

View File

@ -0,0 +1,13 @@
package base
import (
"github.com/juju/errors"
"git.home.m-and-m.ovh/mderasse/gouick/helpers"
"git.home.m-and-m.ovh/mderasse/gouick/models"
)
// CreateProjectSkeleton will generate all the files needed to start a new project.
func (a APIType) CreateProjectSkeleton(path string, config *models.Config) error {
return errors.NotImplementedf("%s not implemented for %s", helpers.GetCurrentFuncName(), a.GetName())
}

View File

@ -0,0 +1,13 @@
package base
import (
"github.com/juju/errors"
"git.home.m-and-m.ovh/mderasse/gouick/helpers"
"git.home.m-and-m.ovh/mderasse/gouick/models"
)
// GenerateMakefile will generate makefile based on the given config.
func (a APIType) GenerateMakefile(path string, config *models.Config) error {
return errors.NotImplementedf("%s not implemented for %s", helpers.GetCurrentFuncName(), a.GetName())
}

View File

@ -0,0 +1,4 @@
package go_swagger
// templateDirectory contain the path to the templates for that apiType.
const templateDirectory = "templates/go-swagger"

View File

@ -0,0 +1,44 @@
package go_swagger
import (
"path/filepath"
"github.com/juju/errors"
"git.home.m-and-m.ovh/mderasse/gouick/helpers"
log "github.com/sirupsen/logrus"
)
var standardDirectories = []string{
"api",
"chart",
"cmd",
"models",
"pkg",
"restapi",
"testdata",
}
// createDirectories will create all skeleton directories for the project.
func (a APIType) createDirectories(path string) error {
log.Debugf("Starting %s - %s", a.GetName(), helpers.GetCurrentFuncName())
for _, directory := range standardDirectories {
log.Debugf("Will create directory %s", directory)
fullPath := filepath.Join(path, directory)
created, err := helpers.CheckAndCreateDir(fullPath)
if err != nil {
log.Errorf("Failed to create directory %s", directory)
return errors.Trace(err)
}
if !created {
log.Debugf("Skipping directory %s", directory)
}
}
return nil
}

View File

@ -1,13 +1,32 @@
package go_swagger package go_swagger
import ( import (
"github.com/juju/errors"
"git.home.m-and-m.ovh/mderasse/gouick/helpers"
"git.home.m-and-m.ovh/mderasse/gouick/models"
log "github.com/sirupsen/logrus" log "github.com/sirupsen/logrus"
) )
// CreateProjectSkeleton will generate all the files needed to start a new project. // CreateProjectSkeleton will generate all the files needed to start a new project.
// it will return a list of created files or an error func (a APIType) CreateProjectSkeleton(path string, config *models.Config) error {
func (a APIType) CreateProjectSkeleton(path string) ([]string, error) { log.Debugf("Starting %s - %s", a.GetName(), helpers.GetCurrentFuncName())
log.Debugf("Starting %s create project skeleton", string(a.GetName()))
return nil, nil err := a.createDirectories(path)
if err != nil {
log.Error("Fail to create project directories")
return errors.Trace(err)
}
// Generate Makefile
err = a.GenerateMakefile(path, config)
if err != nil {
log.Error("Fail to generate Makefile")
return errors.Trace(err)
}
// Generate Readme
// Generate api.yaml
return nil
} }

View File

@ -0,0 +1,36 @@
package go_swagger
import (
"path/filepath"
"github.com/iancoleman/strcase"
"github.com/juju/errors"
"git.home.m-and-m.ovh/mderasse/gouick/helpers"
"git.home.m-and-m.ovh/mderasse/gouick/models"
log "github.com/sirupsen/logrus"
)
type makefile struct {
AppNameKebabCase string
}
// GenerateMakefile will generate makefile based on the given config.
func (a APIType) GenerateMakefile(path string, config *models.Config) error {
log.Debugf("Starting %s - %s", a.GetName(), helpers.GetCurrentFuncName())
templatePath := filepath.Join(templateDirectory, "Makefile.tmpl")
savePath := filepath.Join(path, "Makefile")
data := makefile{
AppNameKebabCase: strcase.ToKebab(config.ProjectName),
}
err := helpers.WriteTemplate(templatePath, savePath, data)
if err != nil {
return errors.Trace(err)
}
return nil
}

View File

@ -5,6 +5,8 @@ import "git.home.m-and-m.ovh/mderasse/gouick/models"
// APITypeInterface is the interface that need to be respected by an APIType. // APITypeInterface is the interface that need to be respected by an APIType.
type APITypeInterface interface { type APITypeInterface interface {
CheckInitialize() error CheckInitialize() error
GetName() models.APITypeName CreateProjectSkeleton(path string, config *models.Config) error
GenerateMakefile(path string, config *models.Config) error
GetInitializeUserInput(params *models.Config) (*models.Config, error) GetInitializeUserInput(params *models.Config) (*models.Config, error)
GetName() models.APITypeName
} }

View File

@ -3,6 +3,7 @@ package helpers
import ( import (
"io/fs" "io/fs"
"os" "os"
"path"
"path/filepath" "path/filepath"
"github.com/juju/errors" "github.com/juju/errors"
@ -136,3 +137,12 @@ func RemoveDirectoryContent(path string) error {
return nil return nil
} }
// GetExecutableDirectory will return the directory of Gouick.
func GetExecutableDirectory() (string, error) {
e, err := os.Executable()
if err != nil {
return "", errors.Trace(err)
}
return path.Dir(e), nil
}

50
helpers/template.go Normal file
View File

@ -0,0 +1,50 @@
package helpers
import (
"os"
"path/filepath"
"text/template"
"github.com/juju/errors"
log "github.com/sirupsen/logrus"
)
// WriteTemplate will parse the given template filepath, and write the result to the savePath.
func WriteTemplate(templatePath string, savePath string, data interface{}) error {
execDirectory, err := GetExecutableDirectory()
if err != nil {
log.Error("Fail to get Gouick directory")
return errors.Trace(err)
}
templatePath = filepath.Join(execDirectory, templatePath)
template, err := template.ParseFiles(templatePath)
if err != nil {
log.Errorf("Fail to parse the template %s", templatePath)
return errors.Trace(err)
}
//nolint: gosec // We compute the savePath
fh, err := os.Create(savePath)
if err != nil {
log.Errorf("Fail to create saving path %s", savePath)
return errors.Trace(err)
}
defer func() {
if err := fh.Close(); err != nil {
log.Errorf("Error closing file: %s", err)
}
}()
err = template.Execute(fh, data)
if err != nil {
log.Errorf("Fail to write compute the template content for %s", savePath)
return errors.Trace(err)
}
return nil
}

View File

@ -8,4 +8,4 @@ generate:
gouick generate gouick generate
launch: launch:
@$(CMD) @$(CMD)