feat: Added definition for npm package

Closes yoheimuta#339

Author: carstencodes

.gitignore

@@ -21,3 +21,10 @@ atlassian-ide-plugin.xml
 # Gradle files
 /.gradle
 /build
+
+# JS files
+/bdist/js/bin/protolint
+/bdist/js/bin/protoc-gen-protolint
+/bdist/js/node_modules/
+/bdist/js/node_modules/*.tgz
+

README.md

@@ -69,6 +69,28 @@ However, I recommend using one of the pre-built binaries instead because it does
 go install github.com/yoheimuta/protolint/cmd/protolint@latest
 ```
 
+### Within JavaScript / TypeScript
+
+You can use `protolint` using your nodejs package manager like `npm` or `yarn`.
+
+```sh
+$ npm install protolint --save-dev
+```
+
+This will add a reference to a development dependency to your local `package.json`.
+
+During install, the [install.mjs](bdist/js/install.mjs) script will be called. It will download the matching `protolint` from github. Just like [@electron/get](https://github.com/electron/get/), you can bypass the download using the following environment variables:
+
+| Environment Variable          | Default value                         | Description                                   |
+|-------------------------------|---------------------------------------|-----------------------------------------------|
+| PROTOLINT_MIRROR_HOST         | https://github.com                    | HTTP/Web server base url hosting the binaries |
+| PROTOLINT_MIRROR_REMOTE_PATH  | yoheimuta/protolint/download/releases | Path to the archives on the remote host       |
+| PROTOLINT_MIRROR_USERNAME     |                                       | HTTP Basic auth user name                     |
+| PROTOLINT_MIRROR_PASSWORD     |                                       | HTTP Basic auth password                      |
+
+Within the remote path, the archives from the [releases](https://github.com/yoheimuta/protolint/releases/latest/) page must be
+mirrored.
+
 ## Usage
 
 ```sh

bdist/js/bin/protoc-gen-protolint.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+'use strict';
+
+var path = require('path');
+var execFile = require('child_process').execFile;
+
+var exe_ext = process.platform === 'win32' ? '.exe' : '';
+
+var protoc = path.resolve(__dirname, 'protoc-gen-protolint' + exe_ext);
+
+var args = process.argv.slice(2);
+
+var child_process = execFile(protoc, args, null);
+
+child_process.stdout.pipe(process.stdout);
+child_process.stderr.pipe(process.stderr);
+
+child_process.on("exit", (exit_code, _) => {
+    process.exit(exit_code);
+});

bdist/js/bin/protolint.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+'use strict';
+
+var path = require('path');
+var execFile = require('child_process').execFile;
+
+var exe_ext = process.platform === 'win32' ? '.exe' : '';
+
+var protoc = path.resolve(__dirname, 'protolint' + exe_ext);
+
+var args = process.argv.slice(2);
+
+var child_process = execFile(protoc, args, null);
+
+child_process.stdout.pipe(process.stdout);
+child_process.stderr.pipe(process.stderr);
+
+child_process.on("exit", (exit_code, _) => {
+    process.exit(exit_code);
+});
+

bdist/js/index.js

@@ -0,0 +1,8 @@
+'use strict';
+
+/**
+ * package.json requires this file to be present. In the future, this can
+ * export useful information about the included tools.
+ */
+
+module.exports = {};

bdist/js/install.mjs

@@ -0,0 +1,174 @@
+import { got } from 'got';
+import { createFetch } from 'got-fetch';
+import npmlog from 'npmlog';
+import { HttpProxyAgent } from 'http-proxy-agent';
+import * as fs from 'fs';
+import { temporaryFile } from 'tempy';
+import * as tar from 'tar';
+import * as pipeline from 'stream';
+
+const _arch_mapping = { "x64": "amd64" };
+const _platform_mapping = { "win32": "windows" };
+
+const _platform = process.platform;
+const _arch = process.arch;
+
+// TODO FIND correct paths -> "./bin" goes to node_modules
+
+const script_name = "protolint-install";
+
+const module_name = "protolint";
+const protolint_host = process.env.PROTOLINT_MIRROR_HOST ?? "https://github.com";
+const protolint_path = process.env.PROTOLINT_MIRROR_REMOTE_PATH ?? `yoheimuta/${module_name}/releases/download/`;
+const protolint_version = process.env.npm_package_version;
+const platform = _platform_mapping[_platform] ?? _platform;
+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;
+if (process.env.PROTOLINT_PROXY) {
+    agent = HttpProxyAgent(process.env.PROTOLINT_PROXY);
+}
+
+const instance = got.extend({
+    followRedirect: true,
+    maxRedirects: 3,
+    username: process.env.PROTOLINT_MIRROR_USERNAME ?? '',
+    password: process.env.PROTOLINT_MIRROR_PASSWORD ?? '',
+    agent: {
+        http: agent
+    }
+});
+
+function get_filename_with_extension(fileName) {
+    const ext = process.platform == "win32" ? ".exe" : "";
+    return `${fileName}${ext}`;
+}
+
+npmlog.info(script_name, "Fetching protolint executable from %s", url);
+
+const fetch = createFetch(instance);
+
+fetch(url).then(
+    async response => {
+        if (response.ok)
+        {
+            const targetFile = temporaryFile({ name: "_protolint.tar.gz"});
+            const out = fs.createWriteStream(targetFile, {
+                flags: "w+"
+            });
+            var success = undefined;
+            const streaming = pipeline.pipeline(
+                response.body,
+                out,
+                (err) => {
+                    if (err)
+                    {
+                        npmlog.error(script_name, "Failed to save downloaded file: %s", err);
+                        success = false;
+                    }
+                    else
+                    {
+                        npmlog.info(script_name, "Protolint saved to %s", targetFile);
+                        success = true;
+                    }
+                }
+            );
+
+            while (success === undefined)
+            {
+                await new Promise(resolve => setTimeout(resolve, 1000));
+            }
+
+            if (success)
+            {
+                return targetFile;
+            }
+
+            return null;
+        }
+        else
+        {
+            npmlog.error(script_name, "Failed to download %s. Got status: %i", response.url, response.status);
+            return null;
+        }
+    }
+).then(
+    previous => {
+        if (!fs.existsSync("./bin"))
+        {
+            fs.mkdirSync("./bin");
+        }
+
+        return previous;
+    }
+).then(
+    async file => {
+        if (file)
+        {
+            const result = await tar.x(
+                {
+                    "keep-existing": false,
+                    cwd: "./bin/",
+                    sync: false,
+                    file: file,
+                    strict: true,
+                },
+                [
+                    get_filename_with_extension("protolint"),
+                    get_filename_with_extension("protoc-gen-protolint"),
+                ],
+                (err) => {
+                    if (err) {
+                        npmlog.error(script_name, "Failed to extract protlint executables: %s");
+                    }
+                },
+            )
+            .then(
+                () => {
+                    return {
+                       protolint: `./bin/${get_filename_with_extension("protolint")}`, 
+                       protoc_gen_protolint: `./bin/${get_filename_with_extension("protoc-gen-protolint")}`,
+                    };
+                }
+            ).catch(
+                (err) => {
+                    npmlog.error(script_name, "Failed to extract files from downloaded tar file: %s", err);
+                    return {
+                       protolint: undefined, 
+                       protoc_gen_protolint: undefined,
+                    };
+                }
+            );
+
+            return result;
+        }
+        else
+        {
+            npmlog.warn(script_name, "Could not find downloaded protolint archive.");
+            return {
+                protolint: undefined, 
+                protoc_gen_protolint: undefined,
+             };
+        }
+    }
+).then(
+    (protolint_obj) => {
+        return (protolint_obj != null && protolint_obj.protolint != null && protolint_obj.protoc_gen_protolint != null);
+    }
+).then(
+    (result) => {
+        if (result){
+            npmlog.info(script_name, "Protolint installed successfully.");
+        }
+        else {
+            npmlog.warn(script_name, "Failed to download protolint. See previous messages for details");
+        }
+    }
+).catch(
+    reason => {
+        npmlog.error(script_name, "Failed to install protolint: %s", reason);
+        process.exit(1);
+    }
+);