github.com/googleapis/api-linter@v1.65.2/rules/aip0191/filenames.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  	"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  var filename = &lint.FileRule{
    27  	Name: lint.NewRuleName(191, "filenames"),
    28  	LintFile: func(f *desc.FileDescriptor) []lint.Problem {
    29  		fn := strings.ReplaceAll(filepath.Base(f.GetName()), ".proto", "")
    30  		if versionRegexp.MatchString(fn) {
    31  			return []lint.Problem{{
    32  				Message:    "The proto version must not be used as the filename.",
    33  				Descriptor: f,
    34  				Location:   locations.FilePackage(f),
    35  			}}
    36  		}
    37  		if !validCharacterRegexp.MatchString(fn) {
    38  			return []lint.Problem{{
    39  				Message:    "The filename has invalid characters.",
    40  				Descriptor: f,
    41  				Location:   locations.FilePackage(f),
    42  			}}
    43  		}
    44  		return nil
    45  	},
    46  }