Merge pull request #17 from mskelton/feature/special-versions

Support for special types of versions

Author: mskelton

package-lock.json

@@ -69,19 +69,19 @@
   "main": "./out/extension.js",
   "devDependencies": {
     "@mskelton/eslint-config": "^7.1.0",
-    "@types/jest": "^29.2.4",
-    "@types/node": "^18.11.17",
+    "@types/jest": "^29.2.6",
+    "@types/node": "^18.11.18",
     "@types/vscode": "^1.74.0",
-    "@typescript-eslint/eslint-plugin": "^5.47.0",
-    "@typescript-eslint/parser": "^5.47.0",
-    "esbuild": "^0.16.10",
-    "eslint": "^8.30.0",
-    "eslint-plugin-jest": "^27.1.7",
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "@typescript-eslint/parser": "^5.48.2",
+    "esbuild": "^0.17.3",
+    "eslint": "^8.32.0",
+    "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.3.1",
-    "prettier": "^2.8.1",
-    "semantic-release-vsce": "^5.5.2",
-    "ts-jest": "^29.0.3",
+    "prettier": "^2.8.3",
+    "semantic-release-vsce": "^5.5.5",
+    "ts-jest": "^29.0.5",
     "typescript": "^4.9.4"
   },
   "dependencies": {

package.json

@@ -245,7 +245,7 @@ export const generatePackagesDiagnostics = async (
         return
       }
 
-      if (packageInfo.isVersionComplex()) {
+      if (packageInfo.isVersionComplex() || packageInfo.isVersionIgnorable()) {
         return
       }
 

src/Diagnostic.ts

@@ -17,6 +17,12 @@ const PACKAGE_NAME_REGEXP =
 
 const PACKAGE_VERSION_COMPLEX_REGEXP = /\s|\|\|/
 
+const PACKAGE_VERSION_PATH_REGEXP = /^(?:\.\.?|~)?\//
+
+const PACKAGE_VERSION_PROTOCOL_REGEX = /^[\w+]+:/
+
+const PACKAGE_VERSION_GITHUB_REGEX = /^[a-zA-Z0-9][\w-]*[a-zA-Z0-9]\//
+
 const PACKAGE_DIFF_LEVELS: Record<ReleaseType, number> = {
   major: 2,
   minor: 1,
@@ -56,6 +62,16 @@ export class PackageInfo {
     return PACKAGE_VERSION_COMPLEX_REGEXP.test(this.version)
   }
 
+  // Check if a valid version, but not a semver.
+  // Anyway, it will be ignored, but not marked as invalid.
+  public isVersionIgnorable(): boolean {
+    return (
+      PACKAGE_VERSION_PATH_REGEXP.test(this.version) ||
+      PACKAGE_VERSION_PROTOCOL_REGEX.test(this.version) ||
+      PACKAGE_VERSION_GITHUB_REGEX.test(this.version)
+    )
+  }
+
   // If the version specified by the user is a valid range.
   // Eg. { "package": "blah blah blah" } must be invalid and "^3.0" valid.
   public isVersionValidRange(): boolean {

src/PackageInfo.ts

@@ -14,6 +14,7 @@ import { name as packageName } from "./plugin.json"
 
 import * as Utils from "./Utils"
 
+// eslint-disable-next-line jest/no-untyped-mock-factory
 jest.mock("./Utils", () => ({
   __esModule: true,
 

src/TestUtils.ts

@@ -1,6 +1,6 @@
 import { cacheEnabled, fetchLite, lazyCallback, promiseLimit } from "./Utils"
 
-const TIMER_MULTIPLER = 3
+const TIMER_MULTIPLIER = 3
 
 describe("utils", () => {
   it("lazy callback: immediate call", async () => {
@@ -14,18 +14,18 @@ describe("utils", () => {
 
     // Must run immediately:
     lazy(() => {
-      expect(Date.now() - now).toBeLessThan(25 * TIMER_MULTIPLER)
+      expect(Date.now() - now).toBeLessThan(25 * TIMER_MULTIPLIER)
     })
 
-    await new Promise((resolve) => setTimeout(resolve, 50 * TIMER_MULTIPLER))
+    await new Promise((resolve) => setTimeout(resolve, 50 * TIMER_MULTIPLIER))
   })
 
   it("lazy callback: avoid first call", async () => {
     expect.assertions(1)
 
     const lazy = lazyCallback((callNumber: () => void) => {
       callNumber()
-    }, 25 * TIMER_MULTIPLER)
+    }, 25 * TIMER_MULTIPLIER)
 
     const now = Date.now()
 
@@ -34,27 +34,27 @@ describe("utils", () => {
 
     // Must run after 25ms:
     lazy(() => {
-      expect(Date.now() - now).toBeGreaterThanOrEqual(25 * TIMER_MULTIPLER)
+      expect(Date.now() - now).toBeGreaterThanOrEqual(25 * TIMER_MULTIPLIER)
     })
 
-    await new Promise((resolve) => setTimeout(resolve, 50 * TIMER_MULTIPLER))
+    await new Promise((resolve) => setTimeout(resolve, 50 * TIMER_MULTIPLIER))
   })
 
   it("lazy callback: wait first call", async () => {
     expect.assertions(1)
 
     const lazy = lazyCallback((callNumber: () => void) => {
       callNumber()
-    }, 25 * TIMER_MULTIPLER)
+    }, 25 * TIMER_MULTIPLIER)
 
     const now = Date.now()
 
     // Must run after 25ms:
     lazy(() => {
-      expect(Date.now() - now).toBeGreaterThanOrEqual(25 * TIMER_MULTIPLER)
+      expect(Date.now() - now).toBeGreaterThanOrEqual(25 * TIMER_MULTIPLIER)
     })
 
-    await new Promise((resolve) => setTimeout(resolve, 50 * TIMER_MULTIPLER))
+    await new Promise((resolve) => setTimeout(resolve, 50 * TIMER_MULTIPLIER))
   })
 
   it("lazy callback: avoid second call", async () => {
@@ -65,13 +65,13 @@ describe("utils", () => {
         callNumber()
       },
       0,
-      25 * TIMER_MULTIPLER
+      25 * TIMER_MULTIPLIER
     )
 
     const now = Date.now()
 
     // Must run immediately:
-    lazy(() => expect(Date.now() - now).toBeLessThan(25 * TIMER_MULTIPLER))
+    lazy(() => expect(Date.now() - now).toBeLessThan(25 * TIMER_MULTIPLIER))
 
     // Must be skipped: too fast call.
     lazy(() => {
@@ -82,11 +82,11 @@ describe("utils", () => {
     lazy(() => {
       const nowDiff = Date.now() - now
 
-      expect(nowDiff).toBeGreaterThanOrEqual(25 * TIMER_MULTIPLER)
-      expect(nowDiff).toBeLessThan(50 * TIMER_MULTIPLER)
+      expect(nowDiff).toBeGreaterThanOrEqual(25 * TIMER_MULTIPLIER)
+      expect(nowDiff).toBeLessThan(50 * TIMER_MULTIPLIER)
     })
 
-    await new Promise((resolve) => setTimeout(resolve, 50 * TIMER_MULTIPLER))
+    await new Promise((resolve) => setTimeout(resolve, 50 * TIMER_MULTIPLIER))
   })
 
   it("promise limit: prevent multiple simultaneous processes", async () => {
@@ -95,7 +95,7 @@ describe("utils", () => {
     const processesLimit = promiseLimit(2)
 
     const delay = (): Promise<unknown> =>
-      new Promise((resolve) => setTimeout(resolve, 25 * TIMER_MULTIPLER))
+      new Promise((resolve) => setTimeout(resolve, 25 * TIMER_MULTIPLIER))
 
     const now = Date.now()
 
@@ -108,7 +108,7 @@ describe("utils", () => {
     ])
 
     // The total time should be 50ms.
-    expect(Date.now() - now).toBeGreaterThanOrEqual(50 * TIMER_MULTIPLER)
+    expect(Date.now() - now).toBeGreaterThanOrEqual(50 * TIMER_MULTIPLIER)
   })
 
   it("promise limit: run all processes simultaneous (no limit)", async () => {
@@ -117,7 +117,7 @@ describe("utils", () => {
     const processesLimit = promiseLimit(0)
 
     const delay = (): Promise<unknown> =>
-      new Promise((resolve) => setTimeout(resolve, 25 * TIMER_MULTIPLER))
+      new Promise((resolve) => setTimeout(resolve, 25 * TIMER_MULTIPLIER))
 
     const now = Date.now()
 
@@ -129,7 +129,7 @@ describe("utils", () => {
     ])
 
     // The total time should be lower than 50ms.
-    expect(Date.now() - now).toBeLessThan(50 * TIMER_MULTIPLER)
+    expect(Date.now() - now).toBeLessThan(50 * TIMER_MULTIPLIER)
   })
 
   it("cache enabled (mock function-only)", () => {

src/Utils.test.ts

@@ -1,3 +1,4 @@
+// eslint-disable-next-line jest/no-untyped-mock-factory
 jest.mock("child_process", () => ({
   __esModule: true,
   ...jest.requireActual("child_process"),
@@ -795,4 +796,52 @@ describe("security advisories", () => {
     expect(decorations[0]).toHaveLength(1)
     expect(decorations[1]).toContain("Security advisory (HIGH/5.6):")
   })
+
+  it("ignore directory-versions", async () => {
+    const { decorations, diagnostics } = await vscodeSimulator({
+      packageJson: {
+        dependencies: {
+          "npm-outdated-2": "../src",
+          "npm-outdated-3": "./src",
+          "npm-outdated-4": "~/src",
+          "npm-outdated-5": "/src",
+        },
+      },
+    })
+
+    expect(diagnostics).toHaveLength(0)
+    expect(decorations).toHaveLength(0)
+  })
+
+  it("ignore protocol versions", async () => {
+    const { decorations, diagnostics } = await vscodeSimulator({
+      packageJson: {
+        dependencies: {
+          "npm-outdated-1": "file:/src",
+          "npm-outdated-2": "http://...",
+          "npm-outdated-3": "https://...",
+          "npm-outdated-4": "git://...",
+          "npm-outdated-5": "git+ssh://...",
+        },
+      },
+    })
+
+    expect(diagnostics).toHaveLength(0)
+    expect(decorations).toHaveLength(0)
+  })
+
+  it("ignore github packages", async () => {
+    const { decorations, diagnostics } = await vscodeSimulator({
+      packageJson: {
+        dependencies: {
+          "npm-outdated-1": "mskelton/vscode-npm-outdated",
+          "npm-outdated-2": "mskelton/vscode-npm-outdated#1234567890",
+          "npm-outdated-3": "mskelton/vscode-npm-outdated#feature/branch",
+        },
+      },
+    })
+
+    expect(diagnostics).toHaveLength(0)
+    expect(decorations).toHaveLength(0)
+  })
 })