project

Documentation

Index

• Constants
• Variables
• type MongoDB
• type MySQL
• type Pcenter
• type Project
  • func LoadConfigFromCLI() (*Project, error)
  • func LoadProjectFromYAML(path string) (*Project, error)
  • func (p *Project) FuncMap() template.FuncMap
  • func (p *Project) Init() error
  • func (p *Project) LoadMongoDBConfig() error
  • func (p *Project) LoadMySQLConfig() error
  • func (p *Project) LoadPcenterConfig() error
  • func (p *Project) SaveFile(filePath string) error
  • func (p *Project) ToYAML() (string, error)

Constants

const PROJECT_SETTING_FILE_PATH = ".phoenix.yaml"

Variables

var Cmd = &cobra.Command{
	Use:   "init",
	Short: "初始化",
	Long:  `初始化一个 phoenix 项目`,
	Run: func(cmd *cobra.Command, args []string) {
		p, err := LoadConfigFromCLI()
		if err != nil {
			if err == terminal.InterruptErr {
				fmt.Println("项目初始化取消")
				return
			}

			cobra.CheckErr(err)
		}

		err = p.Init()
		cobra.CheckErr(err)
	},
}

InitCmd 初始化系统

Types

type MongoDB

type MongoDB struct {
	Endpoints []string
	UserName  string
	Password  string
	Database  string
	AuthDB    string
}

type MySQL

type MySQL struct {
	Host     string
	Port     string
	Database string
	UserName string
	Password string
}

type Pcenter

type Pcenter struct {
	Host         string
	Port         string
	ClientID     string
	ClientSecret string
}

Mcenter 鉴权服务配置

type Project

type Project struct {
	PKG           string   `yaml:"pkg"`
	Name          string   `yaml:"name"`
	Description   string   `yaml:"description"`
	Pcenter       *Pcenter `yaml:"-"`
	EnableMySQL   bool     `yaml:"enable_mysql"`
	MySQL         *MySQL   `yaml:"-"`
	EnableMongoDB bool     `yaml:"enable_mongodb"`
	MongoDB       *MongoDB `yaml:"-"`
	GenExample    bool     `yaml:"gen_example"`
	HttpFramework string   `yaml:"http_framework"`
	EnableCache   bool     `yaml:"enable_cache"`
	// contains filtered or unexported fields
}

Project todo

func LoadConfigFromCLI

func LoadConfigFromCLI() (*Project, error)

LoadConfigFromCLI 配置

func LoadProjectFromYAML

func LoadProjectFromYAML(path string) (*Project, error)

func (*Project) FuncMap

func (p *Project) FuncMap() template.FuncMap

func (*Project) Init

func (p *Project) Init() error

Init 初始化项目

func (*Project) LoadMongoDBConfig

func (p *Project) LoadMongoDBConfig() error

func (*Project) LoadMySQLConfig

func (p *Project) LoadMySQLConfig() error

func (*Project) LoadPcenterConfig

func (p *Project) LoadPcenterConfig() error

func (*Project) SaveFile

func (p *Project) SaveFile(filePath string) error

func (*Project) ToYAML

func (p *Project) ToYAML() (string, error)