From 2bd926e65f58c49fb979880553311b2a24528aed Mon Sep 17 00:00:00 2001 From: chris48s Date: Mon, 11 Nov 2024 19:34:08 +0000 Subject: [PATCH] rename postfix param to suffix (#10667) --- services/version.js | 6 +++--- services/version.spec.js | 8 ++++---- services/wordpress/wordpress-platform.service.js | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/services/version.js b/services/version.js index ef413e2be5..5534b7a7a6 100644 --- a/services/version.js +++ b/services/version.js @@ -235,7 +235,7 @@ function rangeStart(v) { * @param {string} [options.tag] - The tag to display on the badge, such as "alpha" or "beta" * @param {string} [options.defaultLabel] - The default label to display on the badge, such as "npm" or "github" * @param {string} [options.prefix] - The prefix to display on the message, such as ">=", "v", overrides the default behavior of using addv - * @param {string} [options.postfix] - The postfix to display on the message, such as "tested" + * @param {string} [options.suffix] - The suffix to display on the message, such as "tested" * @param {Function} [options.versionFormatter=versionColor] - The function to use to format the color of the badge based on the version number * @param {boolean} [options.isPrerelease] - Whether the version is explicitly marked as a prerelease by upstream API * @returns {object} A badge object that has three properties: label, message, and color @@ -249,7 +249,7 @@ function renderVersionBadge({ tag, defaultLabel, prefix, - postfix, + suffix, versionFormatter = versionColor, isPrerelease, }) { @@ -257,7 +257,7 @@ function renderVersionBadge({ label: tag ? `${defaultLabel}@${tag}` : defaultLabel, message: (prefix ? `${prefix}${version}` : addv(version)) + - (postfix ? ` ${postfix}` : ''), + (suffix ? ` ${suffix}` : ''), color: versionFormatter(isPrerelease ? 'pre' : version), } } diff --git a/services/version.spec.js b/services/version.spec.js index 251cfc892a..90f87140bf 100644 --- a/services/version.spec.js +++ b/services/version.spec.js @@ -155,7 +155,7 @@ describe('Version helpers', function () { message: 'v1.2.3', color: 'blue', }) - given({ version: '1.2.3', postfix: 'tested' }).expect({ + given({ version: '1.2.3', suffix: 'tested' }).expect({ label: undefined, message: 'v1.2.3 tested', color: 'blue', @@ -164,7 +164,7 @@ describe('Version helpers', function () { version: '1.2.3', tag: 'beta', defaultLabel: 'github', - postfix: 'tested', + suffix: 'tested', }).expect({ label: 'github@beta', message: 'v1.2.3 tested', @@ -197,7 +197,7 @@ describe('Version helpers', function () { given({ version: '1.2.3', prefix: '^', - postfix: 'tested', + suffix: 'tested', }).expect({ label: undefined, message: '^1.2.3 tested', @@ -208,7 +208,7 @@ describe('Version helpers', function () { tag: 'beta', defaultLabel: 'github', prefix: '^', - postfix: 'tested', + suffix: 'tested', }).expect({ label: 'github@beta', message: '^1.2.3 tested', diff --git a/services/wordpress/wordpress-platform.service.js b/services/wordpress/wordpress-platform.service.js index 4de1087ff6..d3f859e529 100644 --- a/services/wordpress/wordpress-platform.service.js +++ b/services/wordpress/wordpress-platform.service.js @@ -94,7 +94,7 @@ class WordpressPluginTestedVersion extends BaseWordpress { const color = await versionColorForWordpressVersion(testedVersion) return renderVersionBadge({ version: testedVersion, - postfix: 'tested', + suffix: 'tested', versionFormatter: () => color, }) }