plugindocs

package
v0.40.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Analyzer = &analysis.Analyzer{
	Name:     "plugindocs",
	Requires: []*analysis.Analyzer{nestedmetadata.Analyzer, sourcecode.Analyzer},
	Run:      run,
	Rules: []*analysis.Rule{
		pluginDocsError,
		pluginDocsWarning,
		pluginDocsInfo,
		pluginDocsCliFailure,
	},
	ReadmeInfo: analysis.ReadmeInfo{
		Name:         "Plugin Docs",
		Description:  fmt.Sprintf("Runs the `%s validate` command to check multi-page documentation (only for plugins that set `docsPath` in `plugin.json`).", cliPackage),
		Dependencies: "`node`, `npx`",
	},
}

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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