generate

package

v0.0.0-...-8ca9140 Latest Latest Go to latest Published: Apr 28, 2024 License: MIT Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/robloxapi/roar

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func FilterBuilds(repo *archive.Repo, builds []archive.Build) []archive.Build
func GeneratePages(index *index.Root, rootPath string)
func MergeHistory(repo *archive.Repo, storedHist *history.Root) *history.Root
func NormalizeHistoryTags(hist *history.Root)
func ReadHistory(histPath string) (storedhist *history.Root, err error)
func WriteFile(site, file string, value any) error
type Command
- func (c *Command) Run(opt snek.Options) error
- func (c *Command) SetFlags(flagset snek.FlagSet)
type Disable
type Pages

Constants ¶

View Source

const PageTemplate = `+++
title = %[1]q
+++
`

Variables ¶

View Source

var Def = snek.Def{
	Name: "generate",
	Doc: snek.Doc{
		Summary:     "Generate site.",
		Arguments:   "[flags] [config]",
		Description: usage,
	},
	New: func() snek.Command { return &Command{} },
}

Functions ¶

func FilterBuilds ¶

func FilterBuilds(repo *archive.Repo, builds []archive.Build) []archive.Build

Filters out builds meeting some criteria.

- Excludes a build when it is missing API-Dump.json and Full-API-Dump.json. - Excludes a build when a later build has the same GUID and an older date.

func GeneratePages ¶

func GeneratePages(index *index.Root, rootPath string)

func NormalizeHistoryTags ¶

func NormalizeHistoryTags(hist *history.Root)

Normalizes any tags and security context values within hist to their canonical forms. For example, "WriteOnly" and "writeonly" are considered equivalent tags, which are normalized by selecting which ever has the most uppercase latters.

func ReadHistory ¶

func ReadHistory(histPath string) (storedhist *history.Root, err error)

Reads history JSON from histPath.

func WriteFile ¶

func WriteFile(site, file string, value any) error

Writes JSON to file at path.

Types ¶

type Command ¶

type Command struct {
	Site       string
	Source     string
	Docs       string
	Update     bool
	NoCache    bool
	Disable    Disable
	CPUProfile string
}

func (*Command) Run ¶

func (c *Command) Run(opt snek.Options) error

func (*Command) SetFlags ¶

func (c *Command) SetFlags(flagset snek.FlagSet)

type Disable ¶

type Disable struct {
	Index   bool // Don't generate index data.
	History bool // Don't write history data (cache).
	Dump    bool // Don't generate dump data.
	Reflect bool // Don't generate reflection metadata.
	Pages   bool // Don't generate website pages.
	Icons   bool // Don't generate icon resources.
}

type Pages ¶

type Pages map[string]struct{}

func (Pages) Add ¶

func (p Pages) Add(page string)

func (Pages) Print ¶

func (p Pages) Print()

func (Pages) Remove ¶

func (p Pages) Remove(page string)

Source Files ¶

View all Source files

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