github.com/googleapis/api-linter@v1.65.2/.github/quality-checker/rule_documented.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 main
    16  
    17  import (
    18  	"fmt"
    19  	"os"
    20  )
    21  
    22  func checkRuleDocumented(aip int, name string) []error {
    23  	// Ensure that the expected documentation file exists.
    24  	wantFile := fmt.Sprintf("docs/rules/%04d/%s.md", aip, name)
    25  	if _, err := os.ReadFile(wantFile); err != nil {
    26  		return []error{fmt.Errorf("missing rule documentation: %s", wantFile)}
    27  	}
    28  	return nil
    29  }