diagnostic.go

/*
 * Cadence lint - The Cadence linter
 *
 * Copyright Flow Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package lint

import (
	"github.com/onflow/cadence/ast"
	"github.com/onflow/cadence/common"
	"github.com/onflow/cadence/tools/analysis"
)

type diagnostic struct {
	diagnostic analysis.Diagnostic
	report     func(analysis.Diagnostic)
}

func newDiagnostic(
	location common.Location,
	report func(analysis.Diagnostic),
	message string,
	position ast.Range,
) *diagnostic {
	return &diagnostic{
		diagnostic: analysis.Diagnostic{
			Location:       location,
			SuggestedFixes: []analysis.SuggestedFix{},
			Range:          position,
			Message:        message,
		},
		report: report,
	}
}

func (d *diagnostic) WithCode(code string) *diagnostic {
	d.diagnostic.Code = code
	return d
}

func (d *diagnostic) WithURL(url string) *diagnostic {
	d.diagnostic.URL = url
	return d
}

func (d *diagnostic) WithCategory(category string) *diagnostic {
	d.diagnostic.Category = category
	return d
}

func (d *diagnostic) WithSimpleReplacement(replacement string) *diagnostic {
	message := "Replace with `" + replacement + "`"
	if replacement == "" {
		message = "Remove code"
	}

	suggestedFix := analysis.SuggestedFix{
		Message: message,
		TextEdits: []ast.TextEdit{
			{
				Range:       ast.NewRangeFromPositioned(nil, d.diagnostic.Range),
				Replacement: replacement,
			},
		},
	}

	d.diagnostic.SuggestedFixes = append(d.diagnostic.SuggestedFixes, suggestedFix)
	return d
}

func (d *diagnostic) Report() {
	d.report(d.diagnostic)
}