github.com/yoheimuta/protolint@v0.49.8-0.20240515023657-4ecaebb7575d/bdist/js/ReadMe.md (about)

     1  # protolint
     2  
     3  Protolint is a go based linter for `.proto` files for google protobuf und gRPC. It follows the best practices at the [protobuf.dev](https://protobuf.dev/programming-guides/style/) (and ff.). Please note, that this should be a dev-dependency.
     4  
     5  The npm package provides a wrapper around the executables `protolint` and `protoc-gen-protolint`. During installation process, it will download the binaries matching the version and your operating system and CPU architecture from github.
     6  
     7  If your behind a proxy, you can add the `PROTOLINT_PROXY` environment variable including the HTTP basic authentication information like username and password.
     8  
     9  If your running an airgapped environment, you can add the following environment variables:
    10  
    11  `PROTOLINT_MIRROR_HOST`: The basic url you are using to serve the binaries. Defaults to `https://github.com`
    12  `PROTOLINT_MIRROR_REMOTE_PATH`: The relative path on the mirror host. Defaults to `yoheimuta/protolint/releases/download/`
    13  
    14  Within the remote path, make sure, that a folder `v<version>` exists containing the files downloaded from the github releases.
    15  
    16  If you are required to authenticate against your mirror, use the following environment variables:
    17  
    18  `PROTOLINT_MIRROR_USERNAME`: The user name. Defaults to an empty string.
    19  `PROTOLINT_MIRROR_PASSWORD`: The password or identifaction token. Defaults to an empty string.
    20  
    21  For node based projects, you can add the protobuf configuration to your `package.json` using a node called `protolint`.
    22  
    23  For more information about protolint, its parameters and command-line arguments refer to the original ReadMe in the [github repository](https://github.com/yoheimuta/protolint).