cmd

Documentation

Index

• Constants
• func Execute()
• func GenCommandMarkdown(m *markdown.Markdown, cmdPath []string, command *cobra.Command)
• func GenCommandsMarkdown(m *markdown.Markdown, commandPath []string, command *cobra.Command, ...)
• func GenMarkdownDocumentation(cmd *cobra.Command, filePath string, skipCommands []string) error
• func GenRootCommandMarkdown(m *markdown.Markdown, command *cobra.Command, skipCommands []string)

Constants

const Format = "format"

const FormatDescription = "specification format to convert specification from: spec-2.0, openapi"

const GeneratePath = "generate-path"

const GeneratePathDescription = "path to generate source code into"

const InFile = "in-file"

const InFileDescription = "path for input specification file"

const KotlinJsonLib = "jsonlib"

const KotlinJsonLibDescription = "Kotlin JSON library: jackson"

const ModuleName = "module-name"

const ModuleNameDescription = "module name"

const OutFile = "out-file"

const OutFileDescription = "path to output file"

const PackageName = "package-name"

const PackageNameDescription = "package name"

const ServicesPath = "services-path"

const ServicesPathDescription = "path to scaffold services code"

const SpecFile = "spec-file"

const SpecFileDescription = "path to specification file"

const SwaggerPath = "swagger-path"

const SwaggerPathDescription = "path of generated OpenAPI (Swagger) specification file"

const TsClient = "client"

const TsClientDescription = "client TypeScript library: axios, node-fetch, browser-fetch"

const TsServer = "server"

const TsServerDescription = "server TypeScript library: express, koa"

const TsValidation = "validation"

const TsValidationDescription = "validation TypeScript library: superstruct, io-ts"

Functions

func Execute

func Execute()

func GenCommandMarkdown

func GenCommandMarkdown(m *markdown.Markdown, cmdPath []string, command *cobra.Command)

func GenCommandsMarkdown

func GenCommandsMarkdown(m *markdown.Markdown, commandPath []string, command *cobra.Command, skipCommands []string)

func GenMarkdownDocumentation

func GenMarkdownDocumentation(cmd *cobra.Command, filePath string, skipCommands []string) error

func GenRootCommandMarkdown

func GenRootCommandMarkdown(m *markdown.Markdown, command *cobra.Command, skipCommands []string)