Gotisan

gotisan is the command line interface inspired by laravel artisan for your golang projects that give you flexibility to have your custom file structures.

Why should use this package?

• doing comfortable tasks such as creating new handler, model or DTO
• flexibility to have your own file structure with using template files

Installation

you can easily install this package globally in your local machine and use it in your golang projects. for installing this package just run below command in your terminal.

  go install github.com/adel-hadadi/gotisan

Usage

to start using this package in your project just should go in your root directory of project and first of all run init command.

gotisan init 

this command will create a .gotisan folder in your root directory that contain template files. if you're using git in your project, gotisan will add .gotisan folder in .gitignore file.

optionally can set framework to one of the gin, echo or fiber to set default context of handlers:

gotisan init --framework=echo

then if create a restful handler with make:handler command with --restful flag you`ll see a handler file with structure like this:

package handlers

import (
	"github.com/labstack/echo/v4"
	"net/http"
)

type AuthHandler struct {
}

func NewAuthHandler() *AuthHandler {
	return &AuthHandler{}
}

func (a *AuthHandler) Index(ctx echo.Context) error {
	return ctx.JSON(http.StatusOK, interface{})
}

func (a *AuthHandler) Store(ctx echo,Context) error {
	return ctx.JSON(http.StatusCreated, interface{})
}

func (a *AuthHandler) Update(ctx echo.Context) error {
	return ctx.JSON(http.StatusOK, interface{})
}

func (a *AuthHandler) Delete(ctx echo.Context) error {
	return ctx.JSON(http.StatusOK, interface{})
}

Make Handler

gotisan make:handler [name] [options]

by default above command will create a handler with this structure:

package handlers

type UserHandler struct {

}

func InitUserHandler() *UserHandler {

}

but if you want a custom handler structure just go in .gotisan/templates/handler.tmp and customize to what you want.

by passing -r or --restful to make:handler command, package will create a restful handler with CRUD methods.

package handlers

import (

"net/http"

)

type UserHandler struct {

}

func InitUserHandler() *UserHandler {

}



func (c *UserHandler) Index(w http.ResponseWriter, r *http.Request) {

}


func (c *UserHandler) Store(w http.ResponseWriter, r *http.Request) {

}

func (c *UserHandler) Update(w http.ResponseWriter, r *http.Request) {

}


func (c *UserHandler) Delete(w http.ResponseWriter, r *http.Request) {

}

Make Model

gotisan make:model [name]

the above command just create a simple model with default structure that contain common use fields:

package models

import (
    "time"
)

type Car struct {
    ID uint
    CreatedAt time.Duration
    UpdatedAt time.Duration
    DeletedAt time.Duration
}

Make DTO

gotisan make:dto [name]

make dto command will create request and response objects. below example is for profile dto:

package dtos

type ProfileReq struct {
}

type ProfileRes struct {
}

func NewProfileReq(data interface{}) *ProfileReq {
	return &ProfileReq{}
}

func NewProfileRes(data interface{}) *ProfileRes {
	return &ProfileRes{}
}