use declared package version. add header comments to patchfiles

Author: milahu

package.json

@@ -83,6 +83,7 @@
     "open": "^7.4.2",
     "rimraf": "^2.6.3",
     "semver": "^5.6.0",
+    "shlex": "^2.0.2",
     "slash": "^2.0.0",
     "tmp": "^0.0.33"
   },

src/getPackageResolution.ts

@@ -5,9 +5,9 @@ import { readFileSync, existsSync } from "fs-extra"
 import { parse as parseYarnLockFile } from "@yarnpkg/lockfile"
 import findWorkspaceRoot from "find-yarn-workspace-root"
 import { getPackageVersion } from "./getPackageVersion"
-import { execSync } from "child_process"
+//import { execSync } from "child_process"
 
-const isVerbose = global.patchPackageIsVerbose
+//const isVerbose = global.patchPackageIsVerbose
 const isDebug = global.patchPackageIsDebug
 
 export function getPackageResolution({
@@ -91,6 +91,12 @@ export function getPackageResolution({
       )
     }
 
+    // TODO validate: declaredVersion must not be wildcard
+    return { version: declaredVersion }
+
+    // TODO dont use lockfiles at all?
+    // package versions should be pinned in /package.json, so it works with all package managers at all times
+    /*
     const lockfile = require("js-yaml").load(
       require("fs").readFileSync(join(appPath, "pnpm-lock.yaml"), "utf8"),
     )
@@ -174,6 +180,7 @@ export function getPackageResolution({
       )
     }
     return { version: resolvedVersion }
+    */
   } else {
     const lockfile = require(join(
       appPath,

src/makePatch.ts

@@ -25,11 +25,12 @@ import { resolveRelativeFileDependencies } from "./resolveRelativeFileDependenci
 import { getPackageResolution } from "./getPackageResolution"
 import { parsePatchFile } from "./patch/parse"
 import { gzipSync } from "zlib"
-import { getPackageVersion } from "./getPackageVersion"
+//import { getPackageVersion } from "./getPackageVersion"
 import {
   maybePrintIssueCreationPrompt,
   openIssueCreationLink,
 } from "./createIssue"
+import { quote as shlexQuote } from "shlex"
 
 const isVerbose = global.patchPackageIsVerbose
 const isDebug = global.patchPackageIsDebug
@@ -123,15 +124,25 @@ export function makePatch({
       }),
     )
 
+    /*
     // originCommit is more precise than pkg.version
     if (isDebug) {
       console.log(
         `patch-package/makePatch: resolvedVersion.originCommit = ${resolvedVersion.originCommit}`,
       )
+      console.log(
+        `patch-package/makePatch: resolvedVersion.version = ${resolvedVersion.version}`,
+      )
     }
     const packageVersion =
       resolvedVersion.originCommit ||
       getPackageVersion(join(resolve(packageDetails.path), "package.json"))
+    */
+
+    // this is broken when installing from git -> version can be a pseudo-version like 1.0.0-canary
+    //const packageVersion = getPackageVersion(join(resolve(packageDetails.path), "package.json"))
+
+    const packageVersion = resolvedVersion.version
 
     if (isDebug) {
       console.log(`patch-package/makePatch: packageVersion = ${packageVersion}`)
@@ -359,6 +370,36 @@ export function makePatch({
       }
     })
 
+    const patchPackageVersion = require("../package.json").version
+
+    // patchfiles are parsed in patch/parse.ts function parsePatchLines
+    // -> header comments are ignored
+    let diffHeader = ""
+    diffHeader += `# generated by patch-package ${patchPackageVersion} on ${new Date().toLocaleString(
+      "lt",
+    )}\n`
+    diffHeader += `#\n`
+    const prettyArgv = process.argv.slice()
+    if (prettyArgv[0].match(/node/)) {
+      prettyArgv[0] = "npx"
+    }
+    if (prettyArgv[1].match(/patch-package/)) {
+      prettyArgv[1] = "patch-package"
+    }
+    diffHeader += `# command:\n`
+    diffHeader += `#   ${prettyArgv.map((a) => shlexQuote(a)).join(" ")}\n`
+    diffHeader += `#\n`
+    diffHeader += `# declared package:\n`
+    diffHeader += `#   ${packageDetails.name}: ${resolvedVersion.version}\n` // TODO rename to declaredVersion
+    if (packageDetails.packageNames.length > 1) {
+      diffHeader += `#\n`
+      diffHeader += `# package names:\n`
+      packageDetails.packageNames.forEach((packageName) => {
+        diffHeader += `#   ${packageName}\n`
+      })
+    }
+    diffHeader += `#\n`
+
     const patchFileName = createPatchFileName({
       packageDetails,
       packageVersion,
@@ -369,7 +410,7 @@ export function makePatch({
       // scoped package
       mkdirSync(dirname(patchPath))
     }
-    writeFileSync(patchPath, diffResult.stdout)
+    writeFileSync(patchPath, diffHeader + diffResult.stdout)
     console.log(
       `${chalk.green("✔")} Created file ${join(patchDir, patchFileName)}\n`,
     )
@@ -397,9 +438,18 @@ function createPatchFileName({
   packageDetails: PackageDetails
   packageVersion: string
 }) {
+  const packageVersionFilename = packageVersion.includes("#")
+    ? packageVersion.split("#")[1] // extract commit hash
+    : packageVersion.replace(/\//g, "_")
+  if (isVerbose) {
+    console.log(
+      `patch-package/makePatch: packageVersion ${packageVersion} -> packageVersionFilename ${packageVersionFilename}`,
+    )
+  }
+
   const packageNames = packageDetails.packageNames
     .map((name) => name.replace(/\//g, "+"))
     .join("++")
 
-  return `${packageNames}+${packageVersion}.patch`
+  return `${packageNames}+${packageVersionFilename}.patch`
 }

src/patch/parse.ts

@@ -175,7 +175,16 @@ function parsePatchLines(
     const line = lines[i]
 
     if (state === "parsing header") {
-      if (line.startsWith("@@")) {
+      if (line.startsWith("#")) {
+        // ignore metadata comment line in header
+        // in the unidiff format, all header lines before `--- a/` are comment lines
+        // git-diff uses these comment lines to store metadata
+        // https://stackoverflow.com/questions/18979120
+        if (global.patchPackageIsDebug) {
+          console.log(`patch-package/patch/parse: ignore comment line: ${line}`)
+        }
+        continue
+      } else if (line.startsWith("@@")) {
         state = "parsing hunks"
         currentFilePatch.hunks = []
         i--
@@ -206,9 +215,10 @@ function parsePatchLines(
       } else if (line.startsWith("rename to ")) {
         currentFilePatch.renameTo = line.slice("rename to ".length).trim()
       } else if (line.startsWith("index ")) {
-        const match = line.match(/(\w+)\.\.(\w+)/)
+        const match = line.match(/(\w+)\.\.(\w+)/) // TODO match whole line
+        //const match = line.match(/^index (\w+)\.\.(\w+)$/)
         if (!match) {
-          continue
+          continue // TODO handle parse error?
         }
         currentFilePatch.beforeHash = match[1]
         currentFilePatch.afterHash = match[2]

src/nodejsGlobal.d.ts renamed to src/types/nodejs.global.d.ts

@@ -18,7 +18,8 @@
     "object-literal-key-quotes": [false],
     "max-line-length": false,
     "no-default-export": true,
-    "no-namespace": false
+    "no-namespace": false,
+    "comment-format": false
   },
   "rulesDirectory": []
 }