Repository navigation
chore: use American spellings in comments, docs, copy and internal names - #263
Conversation
Co-Authored-By: chance <chance.strickland@gmail.com>
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
Original prompt from chance
|
Co-Authored-By: chance <chance.strickland@gmail.com>
Co-Authored-By: chance <chance.strickland@gmail.com>
[Low impact] This PR appears safe to merge; the spelling changes preserve cancellation behavior and public values. SummarySwitches comments, docs, messages, and internal cancellation names to American spelling.
Author acknowledgments: Reviews (1) · Last reviewed commit: "style: format readonly installer fixture" · Reviewed by Greptile |
|
Internal names aren't really that important here, the main thing is consistency in external comms in alignment with our style guide https://app.notion.com/p/workos/Writing-In-Our-Product-6975915fa9a74150916c669d562afe16?source=copy_link#81e2466abcfa4c4fb8288c40dac50eb8 However, I think updating internal names is good to keep agents consistent here as well. So I think it's worth the churn. |
|
Makes sense. The internal renames stay in so agents copy the American spelling. The only |
|
This PR doesn't change any part of the public The
|
Summary
Switches British spellings (mostly
cancelled) to American ones in comments, docs, test names, human-facing copy and internal identifiers. This is the CLI follow-up to workos/workos#76416. The monorepo syncsREADME.mdintopackages/docs/src/content/cli-readmes/cli.md, so the exit-code table fix ("Canceled") has to land here.Renamed internal identifiers:
ExitCode.CANCELED,abortIfCanceled,assertNotCanceled, the XStatecanceledstate, theGIT_CANCELED/SCAFFOLD_CANCELEDevents,git:dirty:canceled, and the TUIcanceledtask status / outcome / content key. None of them reach JSON output, NDJSON events or telemetry. The headless adapter doesn't forward state names orgit:dirty:*, and the package only ships abin.These
cancelledvalues are public contracts, so they're unchanged:cancelled(resolveErrorCode, configuration-recovery, preflight)termination.reason,installer.outcomeandsetup.outcometelemetry valuesworkos debug reset --jsonkeycancelledCLAUDE.mdgains a short Spelling section that lists these contracts.Human-readable messages also change, for example
Delete canceled.andInstall canceled.in the JSON errormessage. Errorcodes don't change.Also fixes a
Testfailure that is currently onmain. #237 added amaybeOfferSkillsUpdate()call inbin.ts, butsrc/test/readonly-installer.fixture.tsmockscommands/setup.jswithout that export, sobin-readonly-installer.integration.spec.tsfails. The fixture now stubs it.Link to Devin session: https://app.devin.ai/sessions/b6af537d308d4266993ee86ed4f8d475
Open in Devin Desktop: https://app.devin.ai/desktop/session/b6af537d308d4266993ee86ed4f8d475?variant=devin
Requested by: @chaance