_api-linter

#compdef api-linter

# -----------------------------------------------------------------------------
# The BSD-3-Clause License
#
# Copyright (c) 2018, Koichi Shiraishi
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
#
# * Neither the name of que nor the names of its
#   contributors may be used to endorse or promote products derived from
#   this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# -----------------------------------------------------------------------------
#
# github.com/googleapis/api-linter/cmd/api-linter
#
# -----------------------------------------------------------------------------
#
# Usage of api-linter:
#       --config string                   The linter config file.
#       --descriptor-set-in stringArray   The file containing a FileDescriptorSet for searching proto imports.
#                                         May be specified multiple times.
#       --disable-rule stringArray        Disable a rule with the given name.
#                                         May be specified multiple times.
#       --enable-rule stringArray         Enable a rule with the given name.
#                                         May be specified multiple times.
#       --output-format string            The format of the linting results.
#                                         Supported formats include "yaml", "json" and "summary" table.
#                                         YAML is the default.
#   -o, --output-path string              The output file path.
#                                         If not given, the linting results will be printed out to STDOUT.
#   -I, --proto-path stringArray          The folder for searching proto imports.
#                                         May be specified multiple times; directories will be searched in order.
#                                         The current working directory is always used.
#       --set-exit-status                 Return exit status 1 when lint errors are found.
#       --version                         Print version and exit.
#
# -----------------------------------------------------------------------------

function _api-linter() {
  local context curcontext=$curcontext state line expl ret=1
  declare -A opt_args

  _arguments -C \
    '--config[The linter config file.]:config file:_files' \
    '--descriptor-set-in[The file containing a FileDescriptorSet for searching proto imports.]:FileDescriptorSet files:_files' \
    '--disable-rule=[Disable a rule with the given name.]:disable rules' \
    '--enable-rule=[Enable a rule with the given name.]:enable rules' \
    '--output-format=[The format of the linting results.]:output format:(yaml json summary)' \
    {-o,--output-path}='[The output file path.]:output filename:_files' \
    {-I,--proto-path}'[The folder for searching proto imports.]:include paths:_directories' \
    '--set-exit-status[Return exit status 1 when lint errors are found.]' \
    '--version[Print version and exit.]' \
    '*:proto files:_path_files -g "**/*.proto(-.)"' \
  && ret=0

  return ret
}

_api-linter "$*"

# vim:ft=zsh:et:sts=2:sw=2