linter

package

v0.7.0 Latest Latest Go to latest Published: Jun 28, 2026 License: MPL-2.0 Imports: 17 Imported by: 0

Details

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

Repository

github.com/vi-dev/nem

Links

Open Source Insights

Documentation ¶

Index ¶

type Finding
type InstallProbe
type Result
- func Lint(path string) (Result, error)
- func LintWithInstall(ctx context.Context, path string, userAuth auth.Config, probe InstallProbe) (Result, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Finding ¶

type Finding struct {
	File    string
	Field   string
	Message string
}

func LintCatalogDir ¶

func LintCatalogDir(dir string) []Finding

LintCatalogDir walks dir one level deep and lints every <entry>/pkg.yaml.

func LintFile ¶

func LintFile(pkgYamlPath string) []Finding

func LintPackage ¶ added in v0.4.0

func LintPackage(pkgYamlPath string, pkg *catalog.Package) []Finding

LintPackage runs the offline checks on an already-parsed package, avoiding a re-read of pkgYamlPath. pkgYamlPath supplies the parent-directory identity check and the File field of findings.

func LintPackageDir ¶

func LintPackageDir(dir string) []Finding

type InstallProbe ¶

type InstallProbe func(ctx context.Context, name string) (latestVersion string, err error)

InstallProbe runs install + test for one package against a prepared NEM_HOME. Injected to keep internal/linter free of internal/app.

type Result ¶

type Result struct {
	Findings  []Finding
	Manifests []string
}

func Lint ¶

func Lint(path string) (Result, error)

Lint returns an operational error only when path cannot be stat'd; per-manifest problems are Findings.

func LintWithInstall ¶

func LintWithInstall(ctx context.Context, path string, userAuth auth.Config, probe InstallProbe) (Result, error)

LintWithInstall runs Lint(path) then drives probe against every manifest that passed the offline checks. On a fatal install-pass error, any findings accumulated so far are still returned alongside the error.

Source Files ¶

View all Source files

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