Initial outline

Author: pimterry

README.md

@@ -1,2 +1,28 @@
-# check-vc-redistributable
-An npm package to easily show a warning if the Microsoft Visual C++ Redistributable is not installed on Windows
+# Check-MSVC-Runtime
+
+> _Part of [HTTP Toolkit](https://httptoolkit.com/): powerful tools for building, testing & debugging HTTP_
+
+An npm package to easily show a warning if the Microsoft Visual C++ (MSVC) Redistributable is not installed on Windows.
+
+Many Windows binaries won't run without the MSVC runtime installed, so this can cause problems, but those applications often don't provide a clear error. This makes it easy to end up with a hard-to-set up npm project. To handle that, this package makes it easy to cleanly detect and warn whenever this happens, so developers can easily resolve it themselves.
+
+To use this:
+
+* `npm install check-msvc-runtime`
+* Add `"preinstall": "check-msvc-runtime"` to your package.json scripts
+
+Now, any time you `npm install` in your repo on Windows, if the MSVC runtime isn't installed it'll fail and show:
+
+```bash
+> [email protected] preinstall
+> ./bin.js
+
+***********************
+The Microsoft Visual C++ Runtime is not installed, and is required to set up this project on Windows.
+Install it from https://learn.microsoft.com/cpp/windows/latest-supported-vc-redist
+***********************
+
+npm ERR! code 1
+npm ERR! path .../check-msvc-runtime
+npm ERR! command failed
+```

bin.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+
+const { isMsvcRuntimeInstalled } = require('./check');
+
+isMsvcRuntimeInstalled().then((installed) => {
+    if (process.platform !== 'win32') {
+        // We only check on Windows - not relevant elsewhere
+        // process.exit(0);
+    }
+
+    if (installed) {
+        console.log('Visual C++ Redistributable is installed.');
+        process.exit(0);
+    } else {
+        console.error(
+            '\n***********************\n' +
+            'The Microsoft Visual C++ Runtime is not installed, and is required to set up this project on Windows.\n' +
+            'Install it from https://learn.microsoft.com/cpp/windows/latest-supported-vc-redist\n' +
+            '***********************\n'
+        );
+        process.exit(1);
+    }
+});

check.js

@@ -0,0 +1,17 @@
+const { exec } = require('child_process');
+const { promisify } = require('util');
+
+const execAsync = promisify(exec);
+
+exports.isMsvcRuntimeInstalled = async function () {
+    if (process.platform !== 'win32') return false;
+
+    try {
+        await execAsync('where vcruntime140.dll');
+        console.log('Visual C++ Redistributable is installed.');
+        return true;
+    } catch (error) {
+        console.error('Visual C++ Redistributable is not installed. Please install it from https://aka.ms/vs/16/release/vc_redist.x64.exe');
+        return false;
+    }
+};

package-lock.json

@@ -0,0 +1,30 @@
+{
+  "name": "check-msvc-runtime",
+  "version": "0.0.0",
+  "description": "Easily show a warning if the Microsoft Visual C++ Redistributable is not installed on Windows ",
+  "main": "check.js",
+  "bin": {
+    "check-msvc-runtime": "bin.js"
+  },
+  "scripts": {
+    "preinstall": "./bin.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/httptoolkit/check-msvc-runtime.git"
+  },
+  "keywords": [
+    "msvc",
+    "visual",
+    "c++",
+    "redistributable",
+    "redist",
+    "microsoft"
+  ],
+  "author": "Tim Perry <[email protected]>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/httptoolkit/check-msvc-runtime/issues"
+  },
+  "homepage": "https://github.com/httptoolkit/check-msvc-runtime#readme"
+}