community

Documentation

Index

• Variables
• func CreateManifest(cmd *cobra.Command, args []string) error
• func ManifestPrompt() (*manifest.Manifest, error)
• func SpellCheck(cmd *cobra.Command, args []string) error
• func ValidateIcons(cmd *cobra.Command, args []string) error
• func ValidateManifest(cmd *cobra.Command, args []string) error

Variables

var (
	FixSpelling    bool
	SilentSpelling bool
)

var CommunityCmd = &cobra.Command{
	Use:   "community",
	Short: "Utilities to manage the community repo",
	Long: `The community subcommand provides a set of utilities for managing the
community repo. This subcommand should be considered slightly unstable in that
we may determine a utility here should move to a more generalizable tool.`,
}

var CreateManifestCmd = &cobra.Command{
	Use:     "create-manifest <pathspec>",
	Short:   "Creates an app manifest from a prompt",
	Example: `  pixlet community create-manifest manifest.yaml`,
	Long:    `This command creates an app manifest by asking a series of prompts.`,
	Args:    cobra.ExactArgs(1),
	RunE:    CreateManifest,
}

var ListIconsCmd = &cobra.Command{
	Use:     "list-icons",
	Short:   "List icons that are available in our mobile app.",
	Example: `  pixlet community list-icons`,
	Long:    `This command lists all in your icons that are supported by our mobile app.`,
	RunE:    listIcons,
}

var SpellCheckCmd = &cobra.Command{
	Use:   "spell-check <filespec>",
	Short: "Spell check for a file",
	Example: `  pixlet community spell-check manifest.yaml
  pixlet community spell-check app.star`,
	Long: `This command checks the spelling of strings located in a file. This can be used
both for a manifest and Tidbyt app.`,
	Args: cobra.ExactArgs(1),
	RunE: SpellCheck,
}

var TargetDeterminatorCmd = &cobra.Command{
	Use:   "target-determinator",
	Short: "Determines what files have changed between old and new commit",
	Example: `  pixlet community target-determinator \
    --old 4d69e9bbf181434229a98e87909a619634072930 \
    --new 2fc2a1fcfa48bbb0b836084c1b1e259322c4e133`,
	Long: `This command determines what files have changed between two commits
so that we can limit the build in the community repo to only the files that
have changed.`,
	RunE: determineTargets,
}

var ValidateIconsCmd = &cobra.Command{
	Use:     "validate-icons <pathspec>",
	Short:   "Validates the schema icons used are available in our mobile app.",
	Example: `  pixlet community validate-icons app.star`,
	Long: `This command determines if the icons selected in your app schema are supported
by our mobile app.`,
	Args: cobra.ExactArgs(1),
	RunE: ValidateIcons,
}

var ValidateManifestCmd = &cobra.Command{
	Use:     "validate-manifest <pathspec>",
	Short:   "Validates an app manifest is ready for publishing",
	Example: `  pixlet community validate-manifest manifest.yaml`,
	Long: `This command determines if your app manifest is configured properly by
validating the contents of each field.`,
	Args: cobra.ExactArgs(1),
	RunE: ValidateManifest,
}

Functions

func CreateManifest

func CreateManifest(cmd *cobra.Command, args []string) error

func ManifestPrompt

func ManifestPrompt() (*manifest.Manifest, error)

func SpellCheck

func SpellCheck(cmd *cobra.Command, args []string) error

func ValidateIcons

func ValidateIcons(cmd *cobra.Command, args []string) error

func ValidateManifest

func ValidateManifest(cmd *cobra.Command, args []string) error