github.com/googleapis/api-linter@v1.65.2/docs/rules/0191/filenames.md (about)

     1  ---
     2  rule:
     3    aip: 191
     4    name: [core, '0191', filenames]
     5    summary: Proto files must use reasonable filenames.
     6  permalink: /191/filenames
     7  redirect_from:
     8    - /0191/filenames
     9  ---
    10  
    11  # Filenames
    12  
    13  This rule attempts to enforce reasonable filenames for proto files, as mandated
    14  in [AIP-191][].
    15  
    16  ## Details
    17  
    18  Because proto filenames show up in client libraries (for example, as import
    19  paths), it is important not to have odd paths.
    20  
    21  This rule currently complains if the filename:
    22  
    23  - ...is set to the proto version.
    24  - ...contains invalid cahracters.
    25  
    26  ## Examples
    27  
    28  **Incorrect** filenames for this rule:
    29  
    30  - `v1.proto`
    31  - `v1beta1.proto`
    32  - `library.service.proto`
    33  - `library#.proto`
    34  - `library$.proto`
    35  - `library service.proto`
    36  - `library_Service.proto`
    37  
    38  **Correct** filenames for this rule:
    39  
    40  - `library.proto`
    41  - `library_service.proto`
    42  
    43  ## Disabling
    44  
    45  If you need to violate this rule, use a comment at the top of the file.
    46  Remember to also include an [aip.dev/not-precedent][] comment explaining why.
    47  
    48  ```proto
    49  // (-- api-linter: core::0191::filenames=disabled
    50  //     aip.dev/not-precedent: We need to do this because reasons. --)
    51  syntax = "proto3";
    52  ```
    53  
    54  [aip-191]: https://aip.dev/191
    55  [aip.dev/not-precedent]: https://aip.dev/not-precedent