refactor: remove "tegg-" and "egg-" prefixs for package name #5642
Conversation
plugin names: - aopModule => teggAop - eventbusModule => teggEventbus
|
Important Review skippedMore than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review. 111 files out of 218 files are above the max files limit of 100. Please upgrade to Pro plan to get higher limits. You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Deploying egg with
|
| Latest commit: |
cea39e4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://384e4f9e.egg-cci.pages.dev |
| Branch Preview URL: | https://prepare-release-tegg.egg-cci.pages.dev |
There was a problem hiding this comment.
Pull Request Overview
This pull request refactors package naming across the Eggjs tegg ecosystem by removing "tegg-" and "egg-" prefixes from package names, making them more concise while maintaining their @eggjs scope. The changes affect core modules, plugins, documentation, and configuration files throughout the codebase.
Key changes:
- Package names simplified (e.g.,
@eggjs/tegg-metadata→@eggjs/metadata,@eggjs/tegg-aop-plugin→@eggjs/aop-plugin) - Plugin names updated:
aopModule→teggAop,eventbusModule→teggEventbus - All import statements and dependencies updated to reflect new package names
Reviewed Changes
Copilot reviewed 217 out of 219 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
tools/egg-bin/test/postinstall.test.ts |
Updated NODE_DEBUG constant and test formatting; removed wrapper parentheses and enabled debug logging |
tools/egg-bin/scripts/postinstall.mjs |
Changed debug format specifiers from %o to %s with boolean coercion |
tools/create-egg/src/templates/tegg/package.json |
Removed tegg plugin dependencies; updated vitest version from beta to 4 |
tools/create-egg/src/templates/tegg/config/plugin.ts |
Removed all tegg plugin configurations (tegg, teggConfig, teggController, teggSchedule, eventbusModule, aopModule) |
tegg/standalone/standalone/test/index.test.ts |
Updated package reference from @eggjs/tegg-ajv-plugin to @eggjs/ajv-plugin; added error stack to assertion |
tegg/standalone/standalone/test/fixtures/dal-*-module/package.json |
Changed dependency from @eggjs/tegg-dal-plugin to @eggjs/dal-plugin |
tegg/standalone/standalone/src/*.ts |
Updated imports from @eggjs/tegg-metadata to @eggjs/metadata and @eggjs/tegg-lifecycle to @eggjs/lifecycle |
tegg/standalone/standalone/package.json |
Changed package name to @eggjs/standalone; updated all tegg-prefixed dependencies |
tegg/plugin/*/test/fixtures/apps/*/config/plugin.ts |
Changed plugin name from aopModule to teggAop, eventbusModule to teggEventbus |
tegg/plugin/*/src/**/*.ts |
Updated all imports to use renamed packages (removed tegg-/egg- prefixes) |
tegg/plugin/*/package.json |
Renamed all plugin packages (removed tegg- prefix); updated dependencies |
tegg/plugin/*/README.md |
Updated documentation to reflect new package names |
tegg/core/*/package.json |
Renamed core packages (removed tegg- prefix from names like metadata, lifecycle, etc.) |
tegg/core/*/src/**/*.ts |
Updated imports throughout core modules to use new package names |
packages/egg/src/config/plugin.ts |
Updated plugin name from aopModule to teggAop; updated all package references |
packages/egg/package.json |
Updated dependencies to use new package names |
pnpm-workspace.yaml |
Updated oxlint versions in catalog |
site/docs/zh-CN/basics/aop-middleware.md |
Updated documentation example from aopModule to teggAop |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
| [snyk-image]: https://snyk.io/test/npm/@eggjs/ajv-plugin/badge.svg?style-square | ||
| [snyk-url]: https://snyk.io/test/npm/@eggjs/ajv-plugin | ||
| [download-image]: https://img.shields.io/npm/dm/@eggjs/ajv-plugin.svg?style-square |
There was a problem hiding this comment.
Corrected spelling of 'style-flat-square' to 'style=flat-square' and 'style-square' to 'style=flat-square' (missing '=' and 'flat-').
| [snyk-image]: https://snyk.io/test/npm/@eggjs/ajv-plugin/badge.svg?style-square | |
| [snyk-url]: https://snyk.io/test/npm/@eggjs/ajv-plugin | |
| [download-image]: https://img.shields.io/npm/dm/@eggjs/ajv-plugin.svg?style-square | |
| [snyk-image]: https://snyk.io/test/npm/@eggjs/ajv-plugin/badge.svg?style=flat-square | |
| [snyk-url]: https://snyk.io/test/npm/@eggjs/ajv-plugin | |
| [download-image]: https://img.shields.io/npm/dm/@eggjs/ajv-plugin.svg?style=flat-square |
| const pkgFile = path.join(npmRunRoot, 'package.json'); | ||
| const pkgFileExists = await exists(pkgFile); | ||
| debug('pkgFile: %o exists: %o', pkgFile, pkgFileExists); | ||
| debug('pkgFile: %s exists: %s', pkgFile, !!pkgFileExists); |
There was a problem hiding this comment.
The double negation !!pkgFileExists is unnecessary when formatting with %s. The format specifier already converts the value to a string, so the original value can be passed directly. Consider using debug('pkgFile: %s exists: %s', pkgFile, pkgFileExists); for clearer code.
| debug('pkgFile: %s exists: %s', pkgFile, !!pkgFileExists); | |
| debug('pkgFile: %s exists: %s', pkgFile, pkgFileExists); |
| import path from 'node:path'; | ||
| import { mock } from 'node:test'; | ||
|
|
||
| import { describe, beforeEach, afterEach, it } from 'vitest'; |
There was a problem hiding this comment.
[nitpick] Two consecutive blank lines were introduced between imports. The project typically uses a single blank line to separate import groups. Consider using only one blank line for consistency with the existing codebase style.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #5642 +/- ##
=======================================
Coverage 87.51% 87.51%
=======================================
Files 565 565
Lines 11007 11007
Branches 1243 1243
=======================================
Hits 9633 9633
Misses 1292 1292
Partials 82 82 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Deploying egg-v3 with
|
| Latest commit: |
cea39e4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://cb85fa82.egg-v3.pages.dev |
| Branch Preview URL: | https://prepare-release-tegg.egg-v3.pages.dev |
Summary of ChangesHello @fengmk2, 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 undertakes a comprehensive refactoring initiative to standardize the naming conventions within the @eggjs ecosystem. The primary objective is to eliminate redundant "tegg-" and "egg-" prefixes from package names and their internal references, resulting in a cleaner, more intuitive, and consistent module structure. This change affects a wide array of files, including package.json dependencies, plugin configurations, import statements, and documentation, ensuring a unified naming scheme throughout the project. Additionally, several development dependencies have been updated to their latest versions. Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request is a large-scale refactoring that renames many packages within the @eggjs scope by removing the tegg- and egg- prefixes. This change is applied consistently across package.json files, import statements, configuration files, and documentation. The changes also include some minor dependency updates and test file improvements. Overall, the refactoring is well-executed. I have a few minor suggestions for improving consistency in documentation and configuration, and for cleaning up test code.
| [snyk-image]: https://snyk.io/test/npm/@eggjs/ajv-plugin/badge.svg?style-square | ||
| [snyk-url]: https://snyk.io/test/npm/@eggjs/ajv-plugin | ||
| [download-image]: https://img.shields.io/npm/dm/@eggjs/ajv-plugin.svg?style-square | ||
| [download-url]: https://npmjs.org/package/@eggjs/ajv-plugin |
There was a problem hiding this comment.
The badge styles for snyk and download were changed to square, but the npm version badge remains flat-square. This is inconsistent with other README files in this PR which use flat-square for all badges. For consistency, it would be better to use flat-square for all badges.
| [snyk-image]: https://snyk.io/test/npm/@eggjs/ajv-plugin/badge.svg?style-square | |
| [snyk-url]: https://snyk.io/test/npm/@eggjs/ajv-plugin | |
| [download-image]: https://img.shields.io/npm/dm/@eggjs/ajv-plugin.svg?style-square | |
| [download-url]: https://npmjs.org/package/@eggjs/ajv-plugin | |
| [snyk-image]: https://snyk.io/test/npm/@eggjs/ajv-plugin/badge.svg?style=flat-square | |
| [snyk-url]: https://snyk.io/test/npm/@eggjs/ajv-plugin | |
| [download-image]: https://img.shields.io/npm/dm/@eggjs/ajv-plugin.svg?style=flat-square | |
| [download-url]: https://npmjs.org/package/@eggjs/ajv-plugin |
| "name": "teggEventbus", | ||
| "dependencies": [ | ||
| "tegg" | ||
| ] |
There was a problem hiding this comment.
The strict: false property was removed from the eggPlugin configuration. Other tegg plugins like ajv, controller, and dal still have this property. Was this removal intentional? If not, it should be added back for consistency.
"name": "teggEventbus",
"strict": false,
"dependencies": [
"tegg"
]|
Warning Review the following alerts detected in dependencies. According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.
|
plugin names: