@wpelevator/wp-release 0.4.0 → 0.5.0

package/dist/version-check.js

@@ -4,6 +4,7 @@ import ignore from 'ignore';
 import { normalizeTag } from "./deploy-options.js";
 import { ValidationError } from "./errors.js";
 import { selectFiles } from "./file-selection.js";
+import { findFileHeaderLine, findReadmeHeaderLine, getLineNumber, readFileStart, } from "./package-meta.js";
 export const GIT_TAG_FORMAT = '{version}';
 const TAG_REF_PREFIX = 'refs/tags/';
 /**
@@ -11,6 +12,39 @@ const TAG_REF_PREFIX = 'refs/tags/';
  * dependencies with their own versions.
  */
 const CONSTANT_SEARCH_IGNORE = ['node_modules/', 'vendor/', '.*'];
+/**
+ * Get the problems of version mismatches, with their files relative to the
+ * working directory instead of the plugin directory.
+ *
+ * @param sourceDir  Directory that the mismatch files are relative to.
+ * @param mismatches Mismatches from findVersionMismatches().
+ * @return Problems.
+ */
+export function getVersionMismatchProblems(sourceDir, mismatches) {
+    return mismatches.map(({ message, file, line }) => ({
+        message,
+        file: file ? join(sourceDir, file) : null,
+        line,
+        title: 'Version mismatch',
+    }));
+}
+/**
+ * Versions that don't agree, thrown by a deploy before anything is written.
+ * The message lists every mismatch, and the problems have their files and
+ * lines.
+ */
+export class VersionMismatchError extends ValidationError {
+    name = 'VersionMismatchError';
+    /** Directory that the mismatch files are relative to. */
+    sourceDir;
+    /** Every mismatch. */
+    mismatches;
+    constructor(sourceDir, mismatches) {
+        super(mismatches.map(({ message }) => message).join('\n'), getVersionMismatchProblems(sourceDir, mismatches));
+        this.sourceDir = sourceDir;
+        this.mismatches = mismatches;
+    }
+}
 /**
  * Get the version from a git tag with a format like v{version} or
  * {slug}-{version}. A leading "v" is stripped from the version, like for
@@ -44,6 +78,17 @@ function escapeRegExp(text) {
  * @return Values in the order they appear.
  */
 export function findConstantValues(contents, name) {
+    return findConstantDefinitions(contents, name).map(({ value }) => value);
+}
+/**
+ * Find the definitions of a PHP constant set with define( 'NAME', '1.2.0' )
+ * or const NAME = '1.2.0'.
+ *
+ * @param contents PHP code.
+ * @param name     Constant name.
+ * @return Values and their line numbers, in the order they appear.
+ */
+export function findConstantDefinitions(contents, name) {
     const quotedName = `(['"])${escapeRegExp(name)}\\1`;
     const patterns = [
         new RegExp(`\\bdefine\\s*\\(\\s*${quotedName}\\s*,\\s*(['"])(.*?)\\2\\s*[,)]`, 'g'),
@@ -52,7 +97,10 @@ export function findConstantValues(contents, name) {
     return patterns
         .flatMap((pattern) => [...contents.matchAll(pattern)])
         .sort((a, b) => (a.index ?? 0) - (b.index ?? 0))
-        .map((match) => match[3] ?? '');
+        .map((match) => ({
+        value: match[3] ?? '',
+        line: getLineNumber(contents, match.index ?? 0),
+    }));
 }
 /**
  * Compare a version with the expected one.
@@ -100,16 +148,17 @@ async function compareConstants(sourceDir, constants, expected) {
     })));
     return constants.flatMap((name) => {
         const source = `Constant ${name}`;
-        const definitions = sources.flatMap(({ file, contents }) => findConstantValues(contents, name).map((actual) => ({
+        const definitions = sources.flatMap(({ file, contents }) => findConstantDefinitions(contents, name).map(({ value, line }) => ({
             source,
             file,
-            actual,
+            line,
+            actual: value,
         })));
         if (definitions.length) {
             return definitions.map((definition) => compareVersion(definition, expected));
         }
         return [
-            compareVersion({ source, file: null, actual: null }, expected),
+            compareVersion({ source, file: null, line: null, actual: null }, expected),
         ];
     });
 }
@@ -127,11 +176,12 @@ function compareGitTag(input, expected) {
         return {
             source: 'Git tag',
             file: null,
+            line: null,
             actual: tag,
             message: `Git tag ${tag} doesn't match the format ${input.gitTagFormat}.`,
         };
     }
-    return compareVersion({ source: `Git tag ${tag}`, file: null, actual }, expected);
+    return compareVersion({ source: `Git tag ${tag}`, file: null, line: null, actual }, expected);
 }
 /**
  * Check that the Version header, readme Stable tag, PHP constants and git tag
@@ -152,6 +202,7 @@ export async function findVersionMismatches(input) {
                 {
                     source: 'Version header',
                     file: meta.mainFile,
+                    line: null,
                     actual: null,
                     message: `Version header is missing in ${meta.mainFile}.`,
                 },
@@ -164,12 +215,14 @@ export async function findVersionMismatches(input) {
         compareVersion({
             source: 'Version header',
             file: meta.mainFile,
+            line: findFileHeaderLine((await readFileStart(join(sourceDir, meta.mainFile))) ?? '', 'Version'),
             actual: meta.version,
         }, expected),
         checkStableTag && !readme
             ? {
                 source: 'Stable tag',
                 file: null,
+                line: null,
                 actual: null,
                 message: `Readme is missing, expected Stable tag ${expected}.`,
             }
@@ -178,6 +231,7 @@ export async function findVersionMismatches(input) {
             ? compareVersion({
                 source: 'Stable tag',
                 file: readme.file,
+                line: findReadmeHeaderLine(await readFile(join(sourceDir, readme.file), 'utf8'), 'Stable tag'),
                 actual: readme.headers['Stable tag'] ?? null,
             }, expected)
             : null,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wpelevator/wp-release",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"description": "Package, checksum, sign, verify and version-check WordPress plugins and themes, and deploy plugins to WordPress.org SVN",
 	"license": "MIT",
 	"repository": {