types

Documentation

Overview

Package types is the type definitions for the build plan in Zbpack.

Index

• Variables
• func IsNitroBasedFramework(framework string) bool
• type BunFramework
• type DartFramework
• type DenoFramework
• type DotnetFramework
• type ElixirFramework
• type JavaFramework
• type JavaProjectType
• type NodePackageManager
• type NodeProjectFramework
• type PHPFramework
• type PlanMeta
• type PlanType
• type PythonFramework
• type PythonPackageManager
• type RubyFramework
• type SwiftFramework
• type ZeaburOutputConfig
• type ZeaburOutputConfigRoute
• type ZeaburOutputFunctionConfig
  • func (c ZeaburOutputFunctionConfig) WriteTo(funcPath string) error

Variables

var NitroBasedFrameworks = []NodeProjectFramework{
	NodeProjectFrameworkNuxtJs,
	NodeProjectFrameworkNitropack,
	NodeProjectFrameworkSolidStartVinxi,
}

Functions

func IsNitroBasedFramework

func IsNitroBasedFramework(framework string) bool

Types

type BunFramework

type BunFramework string

BunFramework represents the framework of a Bun project.

const (
	BunFrameworkElysia BunFramework = "elysia"
	BunFrameworkBaojs  BunFramework = "baojs"
	BunFrameworkBagel  BunFramework = "bagel"
	BunFrameworkHono   BunFramework = "hono"
	BunFrameworkNone   BunFramework = "none"
)

type DartFramework

type DartFramework string

const (
	DartFrameworkFlutter   DartFramework = "flutter"
	DartFrameworkServerpod DartFramework = "serverpod"
	DartFrameworkNone      DartFramework = "none"
)

type DenoFramework

type DenoFramework string

DenoFramework represents the framework of a Deno project.

const (
	DenoFrameworkFresh DenoFramework = "fresh"
	DenoFrameworkNone  DenoFramework = "none"
)

type DotnetFramework

type DotnetFramework string

DotnetFramework represents the framework of a Dotnet project.

const (
	DotnetFrameworkAspnet     DotnetFramework = "aspnet"
	DotnetFrameworkBlazorWasm DotnetFramework = "blazorwasm"
	DotnetFrameworkConsole    DotnetFramework = "console"
)

type ElixirFramework

type ElixirFramework string

ElixirFramework represents the framework of a Elixir project.

const (
	ElixirFrameworkPhoenix ElixirFramework = "phoenix"
)

type JavaFramework

type JavaFramework string

JavaFramework represents the framework of a Java project.

const (
	JavaFrameworkSpringBoot JavaFramework = "spring-boot"
	JavaFrameworkNone       JavaFramework = "none"
)

type JavaProjectType

type JavaProjectType string

JavaProjectType represents the type of a Java project.

const (
	JavaProjectTypeMaven  JavaProjectType = "maven"
	JavaProjectTypeGradle JavaProjectType = "gradle"
	JavaProjectTypeNone   JavaProjectType = "none"
)

type NodePackageManager

type NodePackageManager string

NodePackageManager represents the package manager used in a Node.js project.

const (
	NodePackageManagerYarn    NodePackageManager = "yarn"
	NodePackageManagerPnpm    NodePackageManager = "pnpm"
	NodePackageManagerNpm     NodePackageManager = "npm"
	NodePackageManagerBun     NodePackageManager = "bun"
	NodePackageManagerUnknown NodePackageManager = "unknown"
)

type NodeProjectFramework

type NodeProjectFramework string

NodeProjectFramework represents the framework of a Node.js project.

const (
	NodeProjectFrameworkWaku             NodeProjectFramework = "waku"
	NodeProjectFrameworkVite             NodeProjectFramework = "vite"
	NodeProjectFrameworkQwik             NodeProjectFramework = "qwik"
	NodeProjectFrameworkCreateReactApp   NodeProjectFramework = "create-react-app"
	NodeProjectFrameworkNextJs           NodeProjectFramework = "next.js"
	NodeProjectFrameworkRemix            NodeProjectFramework = "remix"
	NodeProjectFrameworkNuxtJs           NodeProjectFramework = "nuxt.js"
	NodeProjectFrameworkVueCli           NodeProjectFramework = "vue-cli"
	NodeProjectFrameworkAngular          NodeProjectFramework = "angular"
	NodeProjectFrameworkNone             NodeProjectFramework = "none"
	NodeProjectFrameworkUmi              NodeProjectFramework = "umi"
	NodeProjectFrameworkSvelte           NodeProjectFramework = "svelte"
	NodeProjectFrameworkNestJs           NodeProjectFramework = "nest.js"
	NodeProjectFrameworkHexo             NodeProjectFramework = "hexo"
	NodeProjectFrameworkVitepress        NodeProjectFramework = "vitepress"
	NodeProjectFrameworkAstro            NodeProjectFramework = "astro"
	NodeProjectFrameworkAstroStatic      NodeProjectFramework = "astro-static"
	NodeProjectFrameworkAstroSSR         NodeProjectFramework = "astro-ssr"
	NodeProjectFrameworkAstroStarlight   NodeProjectFramework = "astro-starlight"
	NodeProjectFrameworkSliDev           NodeProjectFramework = "sli.dev"
	NodeProjectFrameworkDocusaurus       NodeProjectFramework = "docusaurus"
	NodeProjectFrameworkSolidStart       NodeProjectFramework = "solid-start"
	NodeProjectFrameworkSolidStartVinxi  NodeProjectFramework = "solid-start-vinxi"
	NodeProjectFrameworkSolidStartNode   NodeProjectFramework = "solid-start-node"
	NodeProjectFrameworkSolidStartStatic NodeProjectFramework = "solid-start-static"
	NodeProjectFrameworkNueJs            NodeProjectFramework = "nuejs"
	NodeProjectFrameworkVocs             NodeProjectFramework = "vocs"
	NodeProjectFrameworkRspress          NodeProjectFramework = "rspress"
	NodeProjectFrameworkGrammY           NodeProjectFramework = "grammy"
	NodeProjectFrameworkNitropack        NodeProjectFramework = "nitropack"
)

type PHPFramework

type PHPFramework string

PHPFramework represents the framework of a PHP project.

const (
	PHPFrameworkLaravel     PHPFramework = "laravel"
	PHPFrameworkNone        PHPFramework = "none"
	PHPFrameworkThinkphp    PHPFramework = "thinkphp"
	PHPFrameworkCodeigniter PHPFramework = "codeigniter"
	PHPFrameworkSymfony     PHPFramework = "symfony"
)

type PlanMeta

type PlanMeta map[string]string

PlanMeta is the metadata for the build plan. For example, the runtime version, the package manager or the framework used.

type PlanType

type PlanType string

PlanType is primary category of the build plan. For example, the programing language or the runtime.

const (
	PlanTypeNodejs PlanType = "nodejs"
	PlanTypeGo     PlanType = "go"
	PlanTypePython PlanType = "python"
	PlanTypeRuby   PlanType = "ruby"
	PlanTypeDocker PlanType = "docker"
	PlanTypePHP    PlanType = "php"
	PlanTypeJava   PlanType = "java"
	PlanTypeDeno   PlanType = "deno"
	PlanTypeRust   PlanType = "rust"
	PlanTypeDotnet PlanType = "dotnet"
	PlanTypeElixir PlanType = "elixir"
	PlanTypeGleam  PlanType = "gleam"
	PlanTypeBun    PlanType = "bun"
	PlanTypeStatic PlanType = "static"
	PlanTypeSwift  PlanType = "swift"
	PlanTypeDart   PlanType = "dart"
	PlanTypeNix    PlanType = "nix"
)

type PythonFramework

type PythonFramework string

PythonFramework represents the framework of a Python project.

const (
	PythonFrameworkFlask   PythonFramework = "flask"
	PythonFrameworkDjango  PythonFramework = "django"
	PythonFrameworkFastapi PythonFramework = "fastapi"
	PythonFrameworkTornado PythonFramework = "tornado"
	PythonFrameworkSanic   PythonFramework = "sanic"
	PythonFrameworkNone    PythonFramework = "none"

	// PythonFrameworkStreamlit https://github.com/streamlit/streamlit
	PythonFrameworkStreamlit PythonFramework = "streamlit"

	// PythonFrameworkReflex https://github.com/reflex-dev/reflex
	PythonFrameworkReflex PythonFramework = "reflex"
)

type PythonPackageManager

type PythonPackageManager string

PythonPackageManager is the type of the package manager.

const (
	PythonPackageManagerUnknown PythonPackageManager = "unknown"
	PythonPackageManagerPip     PythonPackageManager = "pip"
	PythonPackageManagerPoetry  PythonPackageManager = "poetry"
	PythonPackageManagerPipenv  PythonPackageManager = "pipenv"
	PythonPackageManagerPdm     PythonPackageManager = "pdm"
	PythonPackageManagerRye     PythonPackageManager = "rye"
	PythonPackageManagerUv      PythonPackageManager = "uv"
)

type RubyFramework

type RubyFramework string

RubyFramework represents the framework of a Ruby project.

const (
	RubyFrameworkRails RubyFramework = "rails"
	RubyFrameworkNone  RubyFramework = "none"
)

type SwiftFramework

type SwiftFramework string

const (
	SwiftFrameworkVapor SwiftFramework = "vapor"
	SwiftFrameworkNone  SwiftFramework = "none"
)

type ZeaburOutputConfig

type ZeaburOutputConfig struct {
	// Routes is a list of routes to override the default route
	Routes []ZeaburOutputConfigRoute `json:"routes"`
}

ZeaburOutputConfig is the output config of Zeabur

type ZeaburOutputConfigRoute

type ZeaburOutputConfigRoute struct {
	Src  string `json:"src"`
	Dest string `json:"dest"`
}

ZeaburOutputConfigRoute is a route in the output config to override the default route src is the path regex want to override, dest is the path you want to override it with for example, assume we already have an index.html in .zeabur/output/static, and our service is a Single Page App, we want to override all routes to serve index.html we would add the following to the output config: { "src": ".*", "dest": "/index.html" }

type ZeaburOutputFunctionConfig

type ZeaburOutputFunctionConfig struct {
	Runtime string `json:"runtime"`
	Entry   string `json:"entry,omitempty"`
}

ZeaburOutputFunctionConfig is the output config of Zeabur for a function. Tells Zeabur how to run the function

func (ZeaburOutputFunctionConfig) WriteTo

func (c ZeaburOutputFunctionConfig) WriteTo(funcPath string) error

WriteTo writes the output config to the given path of function