cliv3

README

yze-go-cliv3

A go/analysis analyzer in the gomatic yze suite. It enforces the gomatic CLI standard that command-line programs use urfave/cli v3 — reporting any import of the legacy github.com/urfave/cli (v1) or github.com/urfave/cli/v2 paths.

• Rule id: yze/cliv3
• Capability: convention:cliv3

Use

Run via the yze aggregator (recommended) or standalone:

go run github.com/gomatic/yze-go-cliv3/cmd/yze-go-cliv3@latest ./...

A finding looks like:

main.go:4:2: use urfave/cli/v3; the legacy urfave/cli v1/v2 import path is forbidden by the gomatic CLI standard

Documentation

Overview

Package cliv3 provides a go/analysis analyzer enforcing the gomatic CLI standard that command-line programs use urfave/cli v3 — never the legacy v1 ("github.com/urfave/cli") or v2 ("github.com/urfave/cli/v2") import paths.

Index

• Variables

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "cliv3",
	Doc:      "reports imports of the legacy urfave/cli v1/v2, which the gomatic CLI standard forbids in favor of v3",
	Requires: []*analysis.Analyzer{inspect.Analyzer},
	Run:      run,
}

Analyzer reports imports of the legacy urfave/cli v1/v2 packages.

var Registration = goyze.Registration{
	Name:       "cliv3",
	Categories: []goyze.Category{"cli"},
	URL:        "https://docs.gomatic.dev/yze/cliv3",
	Analyzer:   Analyzer,
}

Registration declares this analyzer to the yze framework.