which-webstorm 3.2.2 → 4.0.0

package/package.json

@@ -1,49 +1,72 @@
 {
+  "$schema": "https://json.schemastore.org/package.json",
   "name": "which-webstorm",
-  "version": "3.2.2",
+  "version": "4.0.0",
   "description": "Find WebStorm binary",
+  "license": "MIT",
+  "author": "Oliver Salzburg <oliver.salzburg@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/oliversalzburg/which-webstorm.git"
+  },
+  "type": "module",
   "main": "index.js",
-  "types": "index.d.ts",
   "bin": {
-    "wstorm": "bin/webstorm.js",
-    "which-webstorm": "index.js"
+    "which-webstorm": "index.js",
+    "wstorm": "bin/webstorm.js"
   },
   "scripts": {
+    "build": "node build.js",
+    "clean": "rm -rf ./output",
+    "lint": "yarn run lint:all",
+    "lint:all": "yarn run lint:eslint && yarn run lint:prettier && yarn run lint:tsc",
+    "lint:eslint": "eslint .",
+    "lint:prettier": "prettier --check .",
+    "lint:tsc": "tsc --noEmit",
     "npm:publish": "npm publish",
+    "npm:publish:major": "npm version major && npm publish",
     "npm:publish:minor": "npm version minor && npm publish",
     "npm:publish:patch": "npm version patch && npm publish",
-    "style:check": "prettier --check .",
-    "style:write": "prettier --write .",
-    "test": "nyc mocha"
+    "test": "tsc && node $(yarn bin mocha) output/*.test.js",
+    "test:coverage": "tsc && c8 --reporter=html-spa node $(yarn bin mocha) output/*.test.js"
   },
-  "keywords": [
-    "webstorm"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/oliversalzburg/which-webstorm.git"
-  },
-  "author": "Oliver Salzburg <oliver.salzburg@gmail.com>",
-  "license": "MIT",
+  "types": "index.d.ts",
   "dependencies": {
+    "@oliversalzburg/js-utils": "0.0.28",
     "execa": "8.0.1",
-    "semver": "7.5.4",
+    "semver": "7.6.0",
     "which": "4.0.0"
   },
   "devDependencies": {
-    "@jsdevtools/chai-exec": "2.1.1",
-    "@types/node": "20.8.7",
-    "chai": "4.3.10",
-    "chai-as-promised": "7.1.1",
-    "mocha": "10.2.0",
+    "@eslint/js": "9.1.1",
+    "@types/chai": "4.3.14",
+    "@types/eslint": "8.56.10",
+    "@types/mocha": "10.0.6",
+    "@types/mock-fs": "4.13.4",
+    "@types/node": "20.12.7",
+    "@types/which": "3.0.3",
+    "c8": "9.1.0",
+    "chai": "5.1.0",
+    "esbuild": "0.20.2",
+    "eslint": "8.57.0",
+    "globals": "15.0.0",
+    "lint-staged": "15.2.2",
+    "mocha": "10.4.0",
     "mock-fs": "5.2.0",
-    "nyc": "15.1.0",
-    "prettier": "3.0.3"
+    "prettier": "3.2.5",
+    "prettier-package-json": "2.8.0",
+    "prettier-plugin-organize-imports": "3.2.4",
+    "typescript": "5.4.5",
+    "typescript-eslint": "7.7.1"
+  },
+  "keywords": [
+    "webstorm"
+  ],
+  "engines": {
+    "node": ">= 18"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
-  "engines": {
-    "node": ">=12"
-  }
+  "packageManager": "yarn@4.1.1"
 }

package/.prettierrc.json

@@ -1 +0,0 @@
-{}

package/index.d.ts

@@ -1,27 +0,0 @@
-/// <reference types="node" />
-import * as fs from "fs";
-declare module "which-webstorm" {
-	type findWebstormAsync = () => Promise<string>;
-	type findWebstormSync = {
-		sync: () => string;
-		webstormBinary: () => string;
-	};
-	const findWebstorm: findWebstormAsync & findWebstormSync;
-
-	type readDirResult = string[] | Buffer[] | fs.Dirent[];
-
-	export class WebStormLocator {
-		webstormBinary: () => string;
-		findWebstorm: () => string;
-		findWebstormAsync: () => Promise<string>;
-		findJetbrainsProducts: () => readDirResult;
-		findJetbrainsProductsAsync: () => Promise<readDirResult>;
-		findManual: () => string;
-		findManualAsync: () => string;
-		findManualWindows: (
-			jetbrainsProducts: readDirResult,
-			validateSynchronously: boolean
-		) => string;
-	}
-}
-export default findWebstorm;

package/index.js

@@ -1,108 +0,0 @@
-#!/usr/bin/env node
-
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-const which = require("which");
-const semver = require("semver");
-
-class WebStormLocator {
-	webstormBinary() {
-		return process.arch === "x64" ? "webstorm64.exe" : "webstorm.exe";
-	}
-
-	findWebstorm() {
-		try {
-			return which.sync(this.webstormBinary());
-		} catch (error) {
-			// Not found on PATH, attempt manual lookup.
-			return this.findManual();
-		}
-	}
-	async findWebstormAsync() {
-		try {
-			return await which(this.webstormBinary());
-		} catch (error) {
-			// Not found on PATH, attempt manual lookup.
-			return this.findManual();
-		}
-	}
-
-	findJetbrainsProducts() {
-		return fs.readdirSync(path.join(process.env["ProgramFiles(x86)"], "JetBrains"));
-	}
-	findJetbrainsProductsAsync() {
-		return fs.promises.readdir(
-			path.join(process.env["ProgramFiles(x86)"], "JetBrains")
-		);
-	}
-
-	findManual() {
-		switch (process.platform) {
-			case "win32":
-				return this.findManualWindows(this.findJetbrainsProducts());
-
-			default:
-				throw new Error(`Platform '${process.platform}' is not supported.`);
-		}
-	}
-	async findManualAsync() {
-		switch (process.platform) {
-			case "win32":
-				return this.findManualWindows(await this.findJetbrainsProductsAsync());
-
-			default:
-				throw new Error(`Platform '${process.platform}' is not supported.`);
-		}
-	}
-
-	findManualWindows(jetbrainsProducts, validateSynchronously = true) {
-		return this._getLatest(
-			jetbrainsProducts
-				.filter((entry) => entry.match(/WebStorm/))
-				.map((entry) => {
-					return path.join(
-						process.env["ProgramFiles(x86)"],
-						"JetBrains",
-						entry,
-						"bin",
-						this.webstormBinary()
-					);
-				})
-				.filter((candidate) => fs.existsSync(candidate))
-				.map((entry) => {
-					const ver = entry.match(/WebStorm[^0-9]([0-9\.]+)/) || ["", ""];
-					return {
-						version: semver.valid(semver.coerce(ver[1])),
-						path: entry,
-					};
-				})
-				.sort(this._customSort)
-		);
-	}
-
-	_customSort(a, b) {
-		return semver.gt(a.version, b.version) ? -1 : 1;
-	}
-
-	_getLatest(entries) {
-		if (!entries || !entries.length) {
-			throw new Error("WebStorm not found");
-		}
-		return entries[0].path;
-	}
-}
-
-if (module.parent) {
-	const locator = new WebStormLocator();
-
-	// For compatibility with older versions, export a matching interface.
-	module.exports = locator.findWebstormAsync.bind(locator);
-	module.exports.sync = locator.findWebstorm.bind(locator);
-	module.exports.webstormBinary = locator.webstormBinary.bind(locator);
-	// Also export the class itself for external consumption.
-	module.exports.WebStormLocator = WebStormLocator;
-} else {
-	new WebStormLocator().findWebstormAsync().then(console.log).catch(console.error);
-}

package/test/test.js

@@ -1,193 +0,0 @@
-"use strict";
-
-const mocha = require("mocha");
-
-const after = mocha.after;
-const before = mocha.before;
-const chai = require("chai");
-const chaiAsPromised = require("chai-as-promised");
-const chaiExec = require("@jsdevtools/chai-exec");
-const describe = mocha.describe;
-const expect = require("chai").expect;
-const it = mocha.it;
-const mockFs = require("mock-fs");
-
-chai.use(chaiAsPromised);
-chai.use(chaiExec);
-
-describe("which-webstorm", () => {
-	const whichWebstorm = require("..");
-
-	describe("x86", () => {
-		let originalArch;
-		before(() => {
-			originalArch = process.arch;
-			Object.defineProperty(process, "arch", {
-				value: "x86",
-			});
-		});
-		after(() => {
-			Object.defineProperty(process, "arch", {
-				value: originalArch,
-			});
-		});
-		it("should return the x86 binary name", () => {
-			expect(whichWebstorm.webstormBinary()).to.equal("webstorm.exe");
-		});
-	});
-
-	describe("x64", () => {
-		let originalArch;
-		before(() => {
-			originalArch = process.arch;
-			Object.defineProperty(process, "arch", {
-				value: "x64",
-			});
-		});
-		after(() => {
-			Object.defineProperty(process, "arch", {
-				value: originalArch,
-			});
-		});
-		it("should return the x64 binary name", () => {
-			expect(whichWebstorm.webstormBinary()).to.equal("webstorm64.exe");
-		});
-	});
-
-	describe("eap directory (async)", () => {
-		let originalArch;
-		before(() => {
-			originalArch = process.arch;
-			Object.defineProperty(process, "arch", {
-				value: "x64",
-			});
-		});
-		after(() => {
-			Object.defineProperty(process, "arch", {
-				value: originalArch,
-			});
-		});
-
-		before(() =>
-			mockFs({
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 163.9999\\bin\\webstorm64.exe":
-					"foo",
-			})
-		);
-		after(() => mockFs.restore());
-
-		it("should return the webstorm binary", () => {
-			return expect(whichWebstorm()).to.eventually.equal(
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 163.9999\\bin\\webstorm64.exe"
-			);
-		});
-	});
-
-	describe("eap directory", () => {
-		let originalArch;
-		before(() => {
-			originalArch = process.arch;
-			Object.defineProperty(process, "arch", {
-				value: "x64",
-			});
-		});
-		after(() => {
-			Object.defineProperty(process, "arch", {
-				value: originalArch,
-			});
-		});
-
-		before(() =>
-			mockFs({
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 163.9999\\bin\\webstorm64.exe":
-					"foo",
-			})
-		);
-		after(() => mockFs.restore());
-
-		it("should return the webstorm binary", () => {
-			return expect(whichWebstorm.sync()).to.equal(
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 163.9999\\bin\\webstorm64.exe"
-			);
-		});
-	});
-
-	describe("return latest", () => {
-		let originalArch;
-		before(() => {
-			originalArch = process.arch;
-			Object.defineProperty(process, "arch", {
-				value: "x64",
-			});
-		});
-		after(() => {
-			Object.defineProperty(process, "arch", {
-				value: originalArch,
-			});
-		});
-
-		before(() =>
-			mockFs({
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 2020.1\\bin\\webstorm64.exe":
-					"foo",
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 17.9.0\\bin\\webstorm64.exe":
-					"foo",
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 2020.1.4\\bin\\webstorm64.exe":
-					"foo",
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 2020.2\\bin\\webstorm64.exe":
-					"foo",
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 163.9999\\bin\\webstorm64.exe":
-					"foo",
-			})
-		);
-		after(() => mockFs.restore());
-
-		it("should return the LATEST webstorm binary", () => {
-			return expect(whichWebstorm.sync()).to.equal(
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 2020.2\\bin\\webstorm64.exe"
-			);
-		});
-	});
-	describe("return latest (async)", () => {
-		let originalArch;
-		before(() => {
-			originalArch = process.arch;
-			Object.defineProperty(process, "arch", {
-				value: "x64",
-			});
-		});
-		after(() => {
-			Object.defineProperty(process, "arch", {
-				value: originalArch,
-			});
-		});
-
-		before(() =>
-			mockFs({
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 2020.1\\bin\\webstorm64.exe":
-					"foo",
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 17.9.0\\bin\\webstorm64.exe":
-					"foo",
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 2020.1.4\\bin\\webstorm64.exe":
-					"foo",
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 2020.2\\bin\\webstorm64.exe":
-					"foo",
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 163.9999\\bin\\webstorm64.exe":
-					"foo",
-			})
-		);
-		after(() => mockFs.restore());
-
-		it("should return the LATEST webstorm binary", () => {
-			return expect(whichWebstorm()).to.eventually.equal(
-				"C:\\Program Files (x86)\\JetBrains\\WebStorm 2020.2\\bin\\webstorm64.exe"
-			);
-		});
-	});
-	describe("CLI", () => {
-		it("should not throw when being executed", () => {
-			const cli = chaiExec("node index.js");
-			return expect(cli).to.exit.with.code(0);
-		});
-	});
-});