Cannot inline disable a custom rule

[dduugg]

I would like to implement a custom rule, requiring an ownership label in each protofile, e.g.

option (ownership.team) = TEAM_B2B;

My naïve, starting implementation is:

package customrules

import (
	"github.com/yoheimuta/go-protoparser/v4/parser"
	"github.com/yoheimuta/go-protoparser/v4/parser/meta"

	"github.com/yoheimuta/protolint/linter/report"
	"github.com/yoheimuta/protolint/linter/rule"
	"github.com/yoheimuta/protolint/linter/visitor"
)

// FileHasOwnerRule verifies that field names use allowed names.
type FileHasOwnerRule struct {
}

// NewFileHasOwnerRule creates a new FileHasOwnerRule.
func NewFileHasOwnerRule() FileHasOwnerRule {
	return FileHasOwnerRule{}
}

// ID returns the ID of this rule.
func (r FileHasOwnerRule) ID() string {
	return "FILE_HAS_OWNER"
}

// Purpose returns the purpose of this rule.
func (r FileHasOwnerRule) Purpose() string {
	return "Verifies that files have ownership annotations."
}

// IsOfficial decides whether or not this rule is enabled by default.
func (r FileHasOwnerRule) IsOfficial() bool {
	return true
}

// Severity gets the severity of the rule
func (r FileHasOwnerRule) Severity() rule.Severity {
	return rule.SeverityError
}

// Apply applies the rule to the proto.
func (r FileHasOwnerRule) Apply(proto *parser.Proto) ([]report.Failure, error) {
	v := &fileHasOwnerVisitor{
		BaseAddVisitor: visitor.NewBaseAddVisitor(r.ID(), string(r.Severity())),
		seenOwner:      false,
	}
	return visitor.RunVisitor(v, proto, r.ID())
}

type fileHasOwnerVisitor struct {
	*visitor.BaseAddVisitor
	seenOwner bool
	filename  string
}

func (v *fileHasOwnerVisitor) VisitOption(o *parser.Option) bool {
	if o.OptionName == "(ownership.team)" {
		v.seenOwner = true
	}
	return false
}

// OnStart checks the file.
func (v *fileHasOwnerVisitor) OnStart(proto *parser.Proto) error {
	v.filename = proto.Meta.Filename
	return nil
}

func (v *fileHasOwnerVisitor) Finally() error {
	if !v.seenOwner {
		v.AddFailuref(
			meta.Position{
				Filename: v.filename,
				Offset:   0,
				Line:     1,
				Column:   1,
			},
			"The file should have an owner annotation.",
		)
	}
	return nil
}

Since I only know the option is missing once i've processed all the options, I don't add a failure until the Finally block. However, I've noticed that I'm unable to inline disable existing violations, with e.g. // protolint:disable:this FILE_HAS_OWNER in the first line of the file.

How can I implement the rule in such a way that inline disabling is supported?

[yoheimuta]

Custom rules can be disabled.

e.g. // protolint:disable:this FILE_HAS_OWNER in the first line of the file.

How about // protolint:disable FILE_HAS_OWNER in the first line of the file?

• ref.

  protolint/_testdata/rules/max_line_length_rule.proto

  Line 5 in 5011675

  // protolint:disable MAX_LINE_LENGTH

[dduugg]

Other custom rules I've written could be disabled, but not this one. I'll try to come up with a minimum repo to reproduce the problem when I have some free cycles.