@quobix/vacuum 0.0.13 → 0.0.15

package/README.md

@@ -10,6 +10,31 @@ An **ultra-super-fast**, lightweight OpenAPI linter and quality checking tool, w
 
 It's also compatible with existing [Spectral](https://github.com/stoplightio/spectral) rulesets.
 
+## Install using [homebrew](https://brew.sh) tap
+
+```
+brew install daveshanley/vacuum/vacuum
+```
+
+## Install using [npm](https://npmjs.com)
+
+```
+npm i -g @quobix/vacuum
+```
+
+## Install using [yarn](https://yarnpkg.com/)
+
+```
+yarn global add @quobix/vacuum
+```
+
+## Install using curl
+
+```
+curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
+```
+
+
 ## Documentation
 
 ### [Quick Start Guide 🚀](https://quobix.com/vacuum/start)
@@ -78,20 +103,13 @@ No external dependencies, the HTML report will run completely offline.
 
 ---
 
-If you want to try out vacuum:
-
-> Please be warned, this is _early_ code. I am actively working on it.
->> **_Supports OpenAPI Version 2 (Swagger) and Version 3+_**
+> **_Supports OpenAPI Version 2 (Swagger) and Version 3+_**
 
 You can use either **YAML** or **JSON** vacuum supports both.
 
-## Install using [homebrew](https://brew.sh) tap
 
-```
-brew install daveshanley/vacuum/vacuum
-```
 
-> This is the _recommended_ way to consume the binary version of vacuum.
+
 
 ## Check out the code
 

package/bin/vacuum.js

@@ -1,16 +1,16 @@
-#!/usr/bin/env node
-import { execFileSync } from "child_process";
-import path from "path";
-import { exit } from "process";
-import { fileURLToPath } from "url";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-try {
-    execFileSync(path.resolve(`${__dirname}/vacuum`), process.argv.slice(2), {
-        stdio: "inherit",
-    });
-} catch (e) {
-    exit(1)
-}
+#!/usr/bin/env node
+import { execFileSync } from "child_process";
+import path from "path";
+import { exit } from "process";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+try {
+    execFileSync(path.resolve(`${__dirname}/vacuum`), process.argv.slice(2), {
+        stdio: "inherit",
+    });
+} catch (e) {
+    exit(1)
+}

package/npm-install/config.js

@@ -1,15 +1,15 @@
-export const CONFIG = {
-    name: "vacuum",
-    path: "./bin",
-    url: "https://github.com/daveshanley/vacuum/releases/download/v{{version}}/{{bin_name}}_{{version}}_{{platform}}_{{arch}}.tar.gz",
-};
-export const ARCH_MAPPING = {
-    ia32: "i386",
-    x64: "x86_64",
-    arm64: "arm64",
-};
-export const PLATFORM_MAPPING = {
-    darwin: "Darwin",
-    linux: "Linux",
-    win32: "Windows",
+export const CONFIG = {
+    name: "vacuum",
+    path: "./bin",
+    url: "https://github.com/daveshanley/vacuum/releases/download/v{{version}}/{{bin_name}}_{{version}}_{{platform}}_{{arch}}.tar.gz",
+};
+export const ARCH_MAPPING = {
+    ia32: "i386",
+    x64: "x86_64",
+    arm64: "arm64",
+};
+export const PLATFORM_MAPPING = {
+    darwin: "Darwin",
+    linux: "Linux",
+    win32: "Windows",
 };

package/npm-install/postinstall.js

@@ -1,57 +1,57 @@
-import { createWriteStream } from "fs";
-import * as fs from "fs/promises";
-import fetch from "node-fetch";
-import { pipeline } from "stream/promises";
-import tar from "tar";
-import { execSync } from "child_process";
-
-import { ARCH_MAPPING, CONFIG, PLATFORM_MAPPING } from "./config.js";
-
-async function install() {
-    if (process.platform === "android") {
-        console.log("Installing, may take a moment...");
-        const cmd =
-            "pkg upgrade && pkg install golang git -y && git clone https://github.com/daveshanley/vacuum.git && cd cli/ && go build -o $PREFIX/bin/vacuum";
-        execSync(cmd, { encoding: "utf-8" });
-        console.log("Installation successful!");
-        return;
-    }
-    const packageJson = await fs.readFile("package.json").then(JSON.parse);
-    let version = packageJson.version;
-
-    if (typeof version !== "string") {
-        throw new Error("Missing version in package.json");
-    }
-
-    if (version[0] === "v") version = version.slice(1);
-
-    let { name: binName, path: binPath, url } = CONFIG;
-
-    url = url.replace(/{{arch}}/g, ARCH_MAPPING[process.arch]);
-    url = url.replace(/{{platform}}/g, PLATFORM_MAPPING[process.platform]);
-    url = url.replace(/{{version}}/g, version);
-    url = url.replace(/{{bin_name}}/g, binName);
-
-
-    console.log('fetching from URL', url)
-    const response = await fetch(url);
-    if (!response.ok) {
-        throw new Error("Failed fetching the binary: " + response.statusText);
-    }
-
-    const tarFile = "downloaded.tar.gz";
-
-    await fs.mkdir(binPath, { recursive: true });
-    await pipeline(response.body, createWriteStream(tarFile));
-    await tar.x({ file: tarFile, cwd: binPath });
-    await fs.rm(tarFile);
-}
-
-install()
-    .then(async () => {
-        process.exit(0);
-    })
-    .catch(async (err) => {
-        console.error(err);
-        process.exit(1);
+import { createWriteStream } from "fs";
+import * as fs from "fs/promises";
+import fetch from "node-fetch";
+import { pipeline } from "stream/promises";
+import tar from "tar";
+import { execSync } from "child_process";
+
+import { ARCH_MAPPING, CONFIG, PLATFORM_MAPPING } from "./config.js";
+
+async function install() {
+    if (process.platform === "android") {
+        console.log("Installing, may take a moment...");
+        const cmd =
+            "pkg upgrade && pkg install golang git -y && git clone https://github.com/daveshanley/vacuum.git && cd cli/ && go build -o $PREFIX/bin/vacuum";
+        execSync(cmd, { encoding: "utf-8" });
+        console.log("Installation successful!");
+        return;
+    }
+    const packageJson = await fs.readFile("package.json").then(JSON.parse);
+    let version = packageJson.version;
+
+    if (typeof version !== "string") {
+        throw new Error("Missing version in package.json");
+    }
+
+    if (version[0] === "v") version = version.slice(1);
+
+    let { name: binName, path: binPath, url } = CONFIG;
+
+    url = url.replace(/{{arch}}/g, ARCH_MAPPING[process.arch]);
+    url = url.replace(/{{platform}}/g, PLATFORM_MAPPING[process.platform]);
+    url = url.replace(/{{version}}/g, version);
+    url = url.replace(/{{bin_name}}/g, binName);
+
+
+    console.log('fetching from URL', url)
+    const response = await fetch(url);
+    if (!response.ok) {
+        throw new Error("Failed fetching the binary: " + response.statusText);
+    }
+
+    const tarFile = "downloaded.tar.gz";
+
+    await fs.mkdir(binPath, { recursive: true });
+    await pipeline(response.body, createWriteStream(tarFile));
+    await tar.x({ file: tarFile, cwd: binPath });
+    await fs.rm(tarFile);
+}
+
+install()
+    .then(async () => {
+        process.exit(0);
+    })
+    .catch(async (err) => {
+        console.error(err);
+        process.exit(1);
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quobix/vacuum",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "The world's fastest, most scalable and complete OpenAPI parser",
   "type": "module",
   "author": "Dave Shanley",