initialize

package

v0.63.0 Latest Latest Go to latest Published: Sep 14, 2025 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gitkumi/snowflake

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func IsDirectoryEmpty(name string) (bool, error)
func RemoveEmptyDirs(paths map[string]bool) error
func Run(cfg *Config) error
type AppType
- func (t AppType) IsValid() bool
- func (t AppType) String() string
type Command
type Config
type Database
type FileExclusion
type FileRename
type Project
- func NewProject(cfg *Config) *Project
type Queue
- func (t Queue) IsValid() bool
- func (t Queue) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var AllAppTypes = []AppType{
	AppTypeAPI,
	AppTypeWeb,
}

View Source

var AllDatabases = []Database{
	DatabaseNone,
	DatabaseSQLite3,
	DatabasePostgres,
	DatabaseMySQL,
}

View Source

var AllQueues = []Queue{
	QueueNone,
	QueueBasic,
	QueueSQS,
}

Functions ¶

func IsDirectoryEmpty ¶ added in v0.48.0

func IsDirectoryEmpty(name string) (bool, error)

func RemoveEmptyDirs ¶ added in v0.48.0

func RemoveEmptyDirs(paths map[string]bool) error

func Run ¶ added in v0.35.0

func Run(cfg *Config) error

Types ¶

type AppType ¶

type AppType string

const (
	AppTypeAPI AppType = "api"
	AppTypeWeb AppType = "web"
)

func (AppType) IsValid ¶

func (t AppType) IsValid() bool

func (AppType) String ¶ added in v0.48.0

func (t AppType) String() string

type Command ¶

type Command struct {
	Message string
	Name    string
	Args    []string
}

type Config ¶

type Config struct {
	Quiet     bool
	OutputDir string
	Git       bool

	Name     string
	AppType  AppType
	Database Database
	Queue    Queue

	SMTP    bool
	Storage bool
	Redis   bool

	OAuthGoogle    bool
	OAuthDiscord   bool
	OAuthGitHub    bool
	OAuthInstagram bool
	OAuthMicrosoft bool
	OAuthReddit    bool
	OAuthSpotify   bool
	OAuthTwitch    bool
	OAuthFacebook  bool
	OAuthLinkedIn  bool
	OAuthSlack     bool
	OAuthStripe    bool
	OAuthX         bool

	OIDCFacebook  bool
	OIDCGoogle    bool
	OIDCLinkedIn  bool
	OIDCMicrosoft bool
	OIDCTwitch    bool
	OIDCDiscord   bool
}

type Database ¶

type Database string

const (
	DatabaseSQLite3  Database = "sqlite3"
	DatabasePostgres Database = "postgres"
	DatabaseMySQL    Database = "mysql"
	DatabaseNone     Database = "none"
)

func (Database) ConnString ¶

func (d Database) ConnString(projectName string) string

func (Database) Driver ¶

func (d Database) Driver() string

func (Database) Import ¶

func (d Database) Import() string

func (Database) IsValid ¶

func (d Database) IsValid() bool

func (Database) SQLCEngine ¶

func (d Database) SQLCEngine() string

func (Database) String ¶

func (d Database) String() string

type FileExclusion ¶ added in v0.56.0

type FileExclusion struct {
	FilePaths []string
	Check     func(*Project) bool
}

type FileRename ¶ added in v0.56.0

type FileRename struct {
	OldPath string
	NewPath string
	Check   func(*Project) bool
}

type Project ¶

type Project struct {
	Name     string
	AppType  AppType
	Database Database
	Queue    Queue

	SMTP    bool
	Storage bool
	Redis   bool

	OAuthGoogle    bool
	OAuthDiscord   bool
	OAuthGitHub    bool
	OAuthInstagram bool
	OAuthMicrosoft bool
	OAuthReddit    bool
	OAuthSpotify   bool
	OAuthTwitch    bool
	OAuthFacebook  bool
	OAuthLinkedIn  bool
	OAuthSlack     bool
	OAuthStripe    bool
	OAuthX         bool

	OIDCFacebook  bool
	OIDCGoogle    bool
	OIDCLinkedIn  bool
	OIDCMicrosoft bool
	OIDCTwitch    bool
	OIDCDiscord   bool
	// contains filtered or unexported fields
}

func NewProject ¶ added in v0.48.0

func NewProject(cfg *Config) *Project

func (*Project) ExcludeFile ¶ added in v0.56.0

func (p *Project) ExcludeFile(templateFileName string) bool

func (*Project) HasOAuth ¶ added in v0.59.0

func (p *Project) HasOAuth() bool

func (*Project) HasOIDC ¶ added in v0.59.0

func (p *Project) HasOIDC() bool

func (*Project) RenameFiles ¶ added in v0.56.0

func (p *Project) RenameFiles(outputPath string) error

func (*Project) UsesDockerOnDev ¶ added in v0.54.0

func (p *Project) UsesDockerOnDev() bool

type Queue ¶ added in v0.59.0

type Queue string

const (
	QueueNone  Queue = "none"
	QueueBasic Queue = "basic"
	QueueSQS   Queue = "sqs"
)

func (Queue) IsValid ¶ added in v0.59.0

func (t Queue) IsValid() bool

func (Queue) String ¶ added in v0.59.0

func (t Queue) String() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
template

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL