fix: incorrect enum value, swapped log rotation descriptions, wrong JSDoc, and stray artifacts in error messages#1279
Open
ZLeventer wants to merge 1 commit into
Conversation
…wrong JSDoc
- org.ts:1868 — TRIAL_EXPIRATION_DATE = 'trailExpirationDate' → 'trialExpirationDate'
This enum value is used as a property key when reading auth fields from the org.
The Salesforce API returns 'trialExpirationDate' (not 'trail'); the typo would
cause trial expiration date lookups to silently return undefined.
- envVars.ts:263 — SFDX_LAZY_LOAD_MODULES used getMessage(SFDX_USE_PROGRESS_BAR)
Copy-paste bug: the description for SFDX_LAZY_LOAD_MODULES displayed the help
text for SFDX_USE_PROGRESS_BAR instead of its own description.
- envVars.md — sfdxLogRotationCount/sfdxLogRotationPeriod descriptions were swapped
(both SFDX_ and SF_ variants). Count had the period description ("'1d' will rotate
logs daily") and Period had the count description ("3 backup files to keep").
- configAggregator.ts:291-293 — getLocation() JSDoc listed GLOBAL for env var and
ENVIRONMENT for global config, which is the opposite of what the code returns.
- scratchOrgInfoGenerator.md — 5 error messages had trailing '", ' artifacts
(remnants of a JSON-to-markdown format migration) that would appear verbatim in
user-facing error output.
jshackell-sfdc
approved these changes
Apr 27, 2026
Contributor
jshackell-sfdc
left a comment
There was a problem hiding this comment.
approve markdown updates only
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Five bugs found across
org.ts,envVars.ts,envVars.md,configAggregator.ts, andscratchOrgInfoGenerator.md:src/org/org.ts:1868—TRIAL_EXPIRATION_DATEenum has wrong string valueThis enum value is used as a property key when reading auth fields from the org. The Salesforce API returns
trialExpirationDate; the typo (trail) would cause trial expiration date lookups to silently returnundefined.src/config/envVars.ts:263—SFDX_LAZY_LOAD_MODULESshows wrong descriptionSFDX_LAZY_LOAD_MODULESdisplayed the help text forSFDX_USE_PROGRESS_BARinstead of its own description. Every other entry inSUPPORTED_ENV_VARScorrectly references its own key.messages/envVars.md—sfdxLogRotationCount/sfdxLogRotationPerioddescriptions are swapped (both SFDX_ and SF_ variants)sfdxLogRotationCounthad the rotation-period description ("Example '1d' will rotate logs daily"), andsfdxLogRotationPeriodhad the count description ("3 backup files to keep"). Same swap in thesfLogRotationCount/sfLogRotationPeriodentries. Fixed by swapping both pairs back to their correct keys.src/config/configAggregator.ts:291-293—getLocation()JSDoc listsGLOBALandENVIRONMENTbackwardsThe JSDoc said
GLOBALfor env vars andENVIRONMENTfor global config, which is the opposite of what the method actually returns. Corrected to match the implementation.messages/scratchOrgInfoGenerator.md— 5 error messages have trailing",artifactsRemnants of a JSON-to-markdown migration. Each affected message would appear with a literal trailing
",in user-facing error output (e.g.,"...scratch org definition.","). Removed the artifacts from all 5 messages.Test plan
yarn buildpassessf env var listshould show correct descriptions forSFDX_LAZY_LOAD_MODULESand log rotation vars