augment parseNameAndVersion

Author: ds300

src/PackageDetails.test.ts

@@ -1,6 +1,7 @@
 import {
   getPackageDetailsFromPatchFilename,
   getPatchDetailsFromCliString,
+  parseNameAndVersion,
 } from "./PackageDetails"
 
 describe("getPackageDetailsFromPatchFilename", () => {
@@ -280,3 +281,93 @@ Object {
     )
   })
 })
+
+describe("parseNameAndVersion", () => {
+  it("works for good-looking names", () => {
+    expect(parseNameAndVersion("lodash+2.3.4")).toMatchInlineSnapshot(`
+Object {
+  "packageName": "lodash",
+  "version": "2.3.4",
+}
+`)
+    expect(parseNameAndVersion("patch-package+2.0.0-alpha.3"))
+      .toMatchInlineSnapshot(`
+Object {
+  "packageName": "patch-package",
+  "version": "2.0.0-alpha.3",
+}
+`)
+  })
+  it("works for scoped package names", () => {
+    expect(parseNameAndVersion("@react-spring+rafz+2.0.0-alpha.3"))
+      .toMatchInlineSnapshot(`
+Object {
+  "packageName": "@react-spring/rafz",
+  "version": "2.0.0-alpha.3",
+}
+`)
+    expect(parseNameAndVersion("@microsoft+api-extractor+2.2.3"))
+      .toMatchInlineSnapshot(`
+Object {
+  "packageName": "@microsoft/api-extractor",
+  "version": "2.2.3",
+}
+`)
+  })
+  it("works for ordered patches", () => {
+    expect(parseNameAndVersion("patch-package+2.0.0+01"))
+      .toMatchInlineSnapshot(`
+Object {
+  "packageName": "patch-package",
+  "sequenceNumber": 1,
+  "version": "2.0.0",
+}
+`)
+    expect(parseNameAndVersion("@react-spring+rafz+2.0.0-alpha.3+23"))
+      .toMatchInlineSnapshot(`
+Object {
+  "packageName": "@react-spring/rafz",
+  "sequenceNumber": 23,
+  "version": "2.0.0-alpha.3",
+}
+`)
+    expect(parseNameAndVersion("@microsoft+api-extractor+2.0.0+001"))
+      .toMatchInlineSnapshot(`
+Object {
+  "packageName": "@microsoft/api-extractor",
+  "sequenceNumber": 1,
+  "version": "2.0.0",
+}
+`)
+  })
+
+  it("works for ordered patches with names", () => {
+    expect(parseNameAndVersion("patch-package+2.0.0+021+FixImportantThing"))
+      .toMatchInlineSnapshot(`
+Object {
+  "packageName": "patch-package",
+  "sequenceName": "FixImportantThing",
+  "sequenceNumber": 21,
+  "version": "2.0.0",
+}
+`)
+    expect(parseNameAndVersion("@react-spring+rafz+2.0.0-alpha.3+000023+Foo"))
+      .toMatchInlineSnapshot(`
+Object {
+  "packageName": "@react-spring/rafz",
+  "sequenceName": "Foo",
+  "sequenceNumber": 23,
+  "version": "2.0.0-alpha.3",
+}
+`)
+    expect(parseNameAndVersion("@microsoft+api-extractor+2.0.0+001+Bar"))
+      .toMatchInlineSnapshot(`
+Object {
+  "packageName": "@microsoft/api-extractor",
+  "sequenceName": "Bar",
+  "sequenceNumber": 1,
+  "version": "2.0.0",
+}
+`)
+  })
+})

src/PackageDetails.ts

@@ -15,30 +15,72 @@ export interface PatchedPackageDetails extends PackageDetails {
   isDevOnly: boolean
 }
 
-function parseNameAndVersion(
-  s: string,
+export function parseNameAndVersion(
+  str: string,
 ): {
-  name: string
+  packageName: string
   version?: string
+  sequenceName?: string
+  sequenceNumber?: number
 } | null {
-  const parts = s.split("+")
-  switch (parts.length) {
+  const parts = str
+    .split("+")
+    .map((s) => s.trim())
+    .filter(Boolean)
+  if (parts.length === 0) {
+    return null
+  }
+  if (parts.length === 1) {
+    return { packageName: str }
+  }
+  const versionIndex = parts.findIndex((part) =>
+    part.match(/^\d+\.\d+\.\d+.*$/),
+  )
+  if (versionIndex === -1) {
+    const [scope, name] = parts
+    return { packageName: `${scope}/${name}` }
+  }
+  const nameParts = parts.slice(0, versionIndex)
+  let packageName
+  switch (nameParts.length) {
+    case 0:
+      return null
+    case 1:
+      packageName = nameParts[0]
+      break
+    case 2:
+      const [scope, name] = nameParts
+      packageName = `${scope}/${name}`
+      break
+    default:
+      return null
+  }
+
+  const version = parts[versionIndex]
+  const sequenceParts = parts.slice(versionIndex + 1)
+  if (sequenceParts.length === 0) {
+    return { packageName, version }
+  }
+
+  // expect sequenceParts[0] to be a number, strip leading 0s
+  const sequenceNumber = parseInt(sequenceParts[0].replace(/^0+/, ""), 10)
+  if (isNaN(sequenceNumber)) {
+    return null
+  }
+  switch (sequenceParts.length) {
     case 1: {
-      return { name: parts[0] }
+      return { packageName, version, sequenceNumber }
     }
     case 2: {
-      const [nameOrScope, versionOrName] = parts
-      if (versionOrName.match(/^\d+/)) {
-        return {
-          name: nameOrScope,
-          version: versionOrName,
-        }
+      return {
+        packageName,
+        version,
+        sequenceName: sequenceParts[1],
+        sequenceNumber,
       }
-      return { name: `${nameOrScope}/${versionOrName}` }
     }
-    case 3: {
-      const [scope, name, version] = parts
-      return { name: `${scope}/${name}`, version }
+    default: {
+      return null
     }
   }
   return null
@@ -85,17 +127,19 @@ export function getPackageDetailsFromPatchFilename(
   }
 
   return {
-    name: lastPart.name,
+    name: lastPart.packageName,
     version: lastPart.version,
     path: join(
       "node_modules",
-      parts.map(({ name }) => name).join("/node_modules/"),
+      parts.map(({ packageName: name }) => name).join("/node_modules/"),
     ),
     patchFilename,
-    pathSpecifier: parts.map(({ name }) => name).join("/"),
-    humanReadablePathSpecifier: parts.map(({ name }) => name).join(" => "),
+    pathSpecifier: parts.map(({ packageName: name }) => name).join("/"),
+    humanReadablePathSpecifier: parts
+      .map(({ packageName: name }) => name)
+      .join(" => "),
     isNested: parts.length > 1,
-    packageNames: parts.map(({ name }) => name),
+    packageNames: parts.map(({ packageName: name }) => name),
     isDevOnly: patchFilename.endsWith(".dev.patch"),
   }
 }