framework

package

v1.1.0 Latest Latest Go to latest Published: Mar 3, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/rubrical-studios/gh-pmu

Links

Open Source Insights

Documentation ¶

Index ¶

func DetectFramework(dir string) (string, error)
func ValidateCommand(framework, command string) error
type CommandRestrictionError
- func (e *CommandRestrictionError) Error() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DetectFramework ¶

func DetectFramework(dir string) (string, error)

DetectFramework detects the framework from config files in the given directory. It checks in order:

.gh-pmu.yml - framework field
framework-config.json - projectType.processFramework field

Returns empty string if no framework is configured (no restriction applied).

func ValidateCommand ¶

func ValidateCommand(framework, command string) error

ValidateCommand checks if a command is applicable for the given framework. Returns nil if the command is allowed, or a CommandRestrictionError with a helpful suggestion if the command is not applicable.

Types ¶

type CommandRestrictionError ¶

type CommandRestrictionError struct {
	Framework  string
	Command    string
	Suggestion string
}

CommandRestrictionError represents an error when a command is not applicable for a framework

func (*CommandRestrictionError) Error ¶

func (e *CommandRestrictionError) Error() string

Source Files ¶

View all Source files

detect.go

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