github.com/googleapis/api-linter@v1.65.2/rules/aip0191/proto_package.go (about)

     1  // Copyright 2021 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package aip0191
    16  
    17  import (
    18  	"path/filepath"
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/locations"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  // Protobuf package must match the directory structure.
    27  var protoPkg = &lint.FileRule{
    28  	Name: lint.NewRuleName(191, "proto-package"),
    29  	LintFile: func(f *desc.FileDescriptor) []lint.Problem {
    30  		dir := filepath.Dir(f.GetName())
    31  		pkg := strings.ReplaceAll(f.GetPackage(), ".", string(filepath.Separator))
    32  
    33  		if dir != "." && dir != pkg {
    34  			return []lint.Problem{{
    35  				Message:    "Proto package and directory structure mismatch: The proto package must match the proto directory structure.",
    36  				Descriptor: f,
    37  				Location:   locations.FilePackage(f),
    38  			}}
    39  		}
    40  
    41  		return nil
    42  	},
    43  }