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

     1  // Copyright 2019 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  	"fmt"
    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  var javaPackage = &lint.FileRule{
    27  	Name: lint.NewRuleName(191, "java-package"),
    28  	OnlyIf: func(f *desc.FileDescriptor) bool {
    29  		return hasPackage(f) && !strings.HasSuffix(f.GetPackage(), ".master")
    30  	},
    31  	LintFile: func(f *desc.FileDescriptor) []lint.Problem {
    32  		javaPkg := f.GetFileOptions().GetJavaPackage()
    33  		if javaPkg == "" {
    34  			return []lint.Problem{{
    35  				Message:    "Proto files must set `option java_package`.",
    36  				Descriptor: f,
    37  				Location:   locations.FilePackage(f),
    38  			}}
    39  		}
    40  		if !strings.HasSuffix(javaPkg, f.GetPackage()) {
    41  			return []lint.Problem{{
    42  				Message:    "The Java Package should mirror the proto package.",
    43  				Suggestion: fmt.Sprintf(`option java_package = "com.%s";`, f.GetPackage()),
    44  				Descriptor: f,
    45  				Location:   locations.FileJavaPackage(f),
    46  			}}
    47  		}
    48  		return nil
    49  	},
    50  }