doc/ale-proto.txt

   1 ===============================================================================
   2 ALE Proto Integration                                       *ale-proto-options*
   3
   4
   5 ===============================================================================
   6 Integration Information
   7
   8 To enable `.proto` file linting, update |g:ale_linters| as appropriate:
   9 >
  10   " Enable linter for .proto files
  11   let g:ale_linters = {'proto': ['buf-lint', 'protoc-gen-lint', 'protolint']}
  12 <
  13 To enable `.proto` file fixing, update |g:ale_fixers| as appropriate:
  14 >
  15   " Enable linter for .proto files
  16   let b:ale_fixers = {'proto': ['buf-format', 'protolint']}
  17 <
  18
  19 ===============================================================================
  20 buf-format                                               *ale-proto-buf-format*
  21
  22   The formatter uses `buf`, a fully-featured Protobuf compiler that doesn't depend
  23   on `protoc`. Make sure the `buf` binary is available in the system path, or
  24   set ale_proto_buf_format_executable.
  25
  26                                       *ale-options.proto_buf_format_executable*
  27                                             *g:ale_proto_buf_format_executable*
  28 proto_buf_format_executable
  29 g:ale_proto_buf_format_executable
  30   Type: |String|
  31   Default: `'buf'`
  32
  33   This variable can be changed to modify the executable used for buf.
  34
  35
  36 ===============================================================================
  37 buf-lint                                                   *ale-proto-buf-lint*
  38
  39   The linter uses `buf`, a fully-featured Protobuf compiler that doesn't depend
  40   on `protoc`. Make sure the `buf` binary is available in the system path, or
  41   set ale_proto_buf_lint_executable.
  42
  43                                         *ale-options.proto_buf_lint_executable*
  44                                               *g:ale_proto_buf_lint_executable*
  45 proto_buf_lint_executable
  46 g:ale_proto_buf_lint_executable
  47   Type: |String|
  48   Default: `'buf'`
  49
  50   This variable can be changed to modify the executable used for buf.
  51
  52                                             *ale-options.proto_buf_lint_config*
  53                                                   *g:ale_proto_buf_lint_config*
  54 proto_buf_lint_config
  55 g:ale_proto_buf_lint_config
  56   Type: |String|
  57   Default: `''`
  58
  59   A path to a buf configuration file.
  60
  61   The path to the configuration file can be an absolute path or a relative
  62   path. ALE will search for the relative path in parent directories.
  63
  64
  65 ===============================================================================
  66 clang-format                                            *ale-proto-clangformat*
  67
  68 See |ale-c-clangformat| for information about the available options.
  69 Note that the C options are also used for Proto.
  70
  71
  72 ===============================================================================
  73 protoc-gen-lint                                     *ale-proto-protoc-gen-lint*
  74
  75   The linter is a plugin for the `protoc` binary. As long as the binary resides
  76   in the system path, `protoc` will find it.
  77
  78                                     *ale-options.proto_protoc_gen_lint_options*
  79                                           *g:ale_proto_protoc_gen_lint_options*
  80 proto_protoc_gen_lint_options
  81 g:ale_proto_protoc_gen_lint_options
  82   Type: |String|
  83   Default: `''`
  84
  85   This variable can be changed to modify flags given to protoc. Note that the
  86   directory of the linted file is always passed as an include path with '-I'
  87   before any user-supplied options.
  88
  89
  90 ===============================================================================
  91 protolint                                                 *ale-proto-protolint*
  92
  93   The linter is a pluggable tool that doesn't depend on the `protoc` binary.
  94   This supports both linting and fixing.
  95   Make sure the binary is available in the system path, or set
  96   ale_proto_protolint_executable.
  97   Note that the binary with v0.22.0 or above is supported.
  98
  99                                        *ale-options.proto_protolint_executable*
 100                                              *g:ale_proto_protolint_executable*
 101 proto_protolint_executable
 102 g:ale_proto_protolint_executable
 103   Type: |String|
 104   Default: `'protolint'`
 105
 106   This variable can be changed to modify the executable used for protolint.
 107
 108                                            *ale-options.proto_protolint_config*
 109                                                  *g:ale_proto_protolint_config*
 110 proto_protolint_config
 111 g:ale_proto_protolint_config
 112   Type: |String|
 113   Default: `''`
 114
 115   A path to a protolint configuration file.
 116
 117   The path to the configuration file can be an absolute path or a relative
 118   path. ALE will search for the relative path in parent directories.
 119
 120
 121 ===============================================================================
 122   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: