feat: migrator for npm packages #1156
Conversation
🦋 Changeset detectedLatest commit: c1a2b19 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @DenKoren, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new npm-migrations package designed to manage postinstall migrations for individual npm packages within the monorepo. It provides a Migrator class that allows defining and running sequential migration steps, tracking their completion directly within the package.json file. The system ensures that migrations are applied incrementally and handles initial setup by marking all existing migrations as complete if no prior record is found.
Highlights
- New
npm-migrationsPackage: Introduced a new package,@platforma-sdk/npm-migrations, designed to manage postinstall migrations for npm packages within the monorepo. - Migration Tracking in
package.json: The system tracks the state of applied migrations by storing a version number for each package in a dedicatedmigrationssection within itspackage.jsonfile. - Sequential Migration Execution: Migrations are applied one-by-one from the last recorded index to the latest available migration, ensuring incremental updates.
- Preservation of
package.jsonFormatting: The migrator includes logic to update the migration version inpackage.jsonwhile attempting to preserve the existing file formatting, such as indentation and line endings. - Comprehensive Test Coverage: A robust suite of Vitest tests has been added to validate the
Migrator's behavior across various scenarios, including initial setup, sequential application, and formatting preservation.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new utility package @platforma-sdk/npm-migrations for running migrations during npm postinstall. The implementation is clean and includes a good set of tests. I've found a few issues, including a critical one related to error handling that could cause the process to crash, and a couple of high-severity bugs in the logic for updating package.json that could lead to data loss or incorrect behavior. I've also included a medium-severity suggestion to optimize the published package size.
No description provided.