Merge pull request yoheimuta#363 from carstencodes/contrib/carstencodes/npm-download-issue

fix: Two different NPM Issues

Author: yoheimuta

bdist/js/ReadMe.md

@@ -0,0 +1,23 @@
+# protolint
+
+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.
+
+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.
+
+If your behind a proxy, you can add the `PROTOLINT_PROXY` environment variable including the HTTP basic authentication information like username and password.
+
+If your running an airgapped environment, you can add the following environment variables:
+
+`PROTOLINT_MIRROR_HOST`: The basic url you are using to serve the binaries. Defaults to `https://github.com`
+`PROTOLINT_MIRROR_REMOTE_PATH`: The relative path on the mirror host. Defaults to `yoheimuta/protolint/releases/download/`
+
+Within the remote path, make sure, that a folder `v<version>` exists containing the files downloaded from the github releases.
+
+If you are required to authenticate against your mirror, use the following environment variables:
+
+`PROTOLINT_MIRROR_USERNAME`: The user name. Defaults to an empty string.
+`PROTOLINT_MIRROR_PASSWORD`: The password or identifaction token. Defaults to an empty string.
+
+For node based projects, you can add the protobuf configuration to your `package.json` using a node called `protolint`.
+
+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).

bdist/js/install.mjs

@@ -26,20 +26,24 @@ const arch = _arch_mapping[_arch] ?? _arch;
 
 const url = `${protolint_host}/${protolint_path}/v${protolint_version}/${module_name}_${protolint_version}_${platform}_${arch}.tar.gz`;
 
-var agent = null;
+let agent;
 if (process.env.PROTOLINT_PROXY) {
     agent = HttpProxyAgent(process.env.PROTOLINT_PROXY);
 }
 
-const instance = got.extend({
+const agent_config = {
+    http: agent
+};
+
+const got_config = {
     followRedirect: true,
     maxRedirects: 3,
     username: process.env.PROTOLINT_MIRROR_USERNAME ?? '',
     password: process.env.PROTOLINT_MIRROR_PASSWORD ?? '',
-    agent: {
-        http: agent
-    }
-});
+    agent: agent_config,
+};
+
+const instance = got.extend(got_config);
 
 function get_filename_with_extension(fileName) {
     const ext = process.platform == "win32" ? ".exe" : "";

bdist/js/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "protolint",
-  "version": "0.46.0",
+  "version": "0.47.4",
   "description": "A pluggable linter and fixer to enforce Protocol Buffer style and conventions.",
   "main": "index.js",
   "bin": {
@@ -46,7 +46,7 @@
     "http-proxy-agent": "^7.0.0",
     "npmlog": "^7.0.1",
     "semver": "^7.5.4",
-    "tar": "^6.1.15",
+    "tar": "^6.2.0",
     "tempy": "^3.1.0"
   }
-}
+}