refactor(pgpm): rename Sqitch types and functions to PGPM naming #505
Conversation
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
- Rename SqitchRow to PgpmRow (keep SqitchRow as deprecated alias) - Rename writeSqitchPlan to writePgpmPlan (keep alias) - Rename writeSqitchFiles to writePgpmFiles (keep alias) - Update internal helper functions (writeDeploy, writeVerify, writeRevert) to use PgpmRow - Update export-migrations.ts to use new names - Update tests to use new names - All backwards-compatible aliases are marked with @deprecated JSDoc
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
This PR renames legacy "Sqitch" naming conventions to "PGPM" throughout the pgpm/core package:
SqitchRow→PgpmRowwriteSqitchPlan→writePgpmPlanwriteSqitchFiles→writePgpmFilesAll old names are preserved as deprecated type aliases for backwards compatibility. Internal call sites in
export-migrations.tsand tests have been updated to use the new names.Review & Testing Checklist for Human
Verify barrel exports: Check that
pgpm/core/src/files/index.tsproperly re-exports both the new names (PgpmRow,writePgpmPlan,writePgpmFiles) and the deprecated aliases (SqitchRow,writeSqitchPlan,writeSqitchFiles). The diff doesn't show changes to this file.Search for other consumers: Run
grep -r "SqitchRow\|writeSqitchPlan\|writeSqitchFiles" --include="*.ts"across the monorepo to verify no other files import these that weren't updated.Test deprecated aliases: The tests were updated to use new names. Consider adding a small test that imports the deprecated aliases to ensure backwards compatibility works.
Notes
This is PR 2 of a planned series for the export-migrations.ts refactor. PR 1 (#504) adds the
license: 'CLOSED'field and comments out security-related SQL.Link to Devin run: https://app.devin.ai/sessions/7e7813472a0643aa88ccb509b288050a
Requested by: Dan Lynch (@pyramation)