Prefix and scope the internal 'core' envio platform specific packages#937
Prefix and scope the internal 'core' envio platform specific packages#937
Conversation
📝 WalkthroughWalkthroughThe changes rename the core package from "envio" to "@envio-dev/core" in the NPM release workflow, package templates, and binary resolution logic, affecting platform-specific package naming and node_modules path resolution. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@codegenerator/cli/npm/envio/bin.js`:
- Around line 11-15: Update the JSDoc to match the actual package naming used in
the code: replace references to "@envio-dev/envio-${os}-${arch}" with
"@envio-dev/core-${os}-${arch}" and adjust the example accordingly so it aligns
with the string passed to require.resolve in bin.js (the require.resolve call
that constructs the platform-specific package name). Ensure the note about
Windows `.exe` behavior and the os/arch `@see` links remain accurate.
| * The naming convention is @envio-dev/envio-${os}-${arch} | ||
| * If the platform is `win32` or `cygwin`, executable will include a `.exe` extension | ||
| * @see https://nodejs.org/api/os.html#osarch | ||
| * @see https://nodejs.org/api/os.html#osplatform | ||
| * @example "x/xx/node_modules/envio-darwin-arm64" | ||
| * @example "x/xx/node_modules/@envio-dev/envio-darwin-arm64" |
There was a problem hiding this comment.
JSDoc comments are inconsistent with the actual code.
Lines 11 and 15 still reference @envio-dev/envio-${os}-${arch}, but the actual require.resolve on line 31 uses @envio-dev/core-${os}-${arch}. These comments should be updated to match.
📝 Proposed fix
- * The naming convention is `@envio-dev/envio-`${os}-${arch}
+ * The naming convention is `@envio-dev/core-`${os}-${arch}
* If the platform is `win32` or `cygwin`, executable will include a `.exe` extension
* `@see` https://nodejs.org/api/os.html#osarch
* `@see` https://nodejs.org/api/os.html#osplatform
- * `@example` "x/xx/node_modules/@envio-dev/envio-darwin-arm64"
+ * `@example` "x/xx/node_modules/@envio-dev/core-darwin-arm64"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * The naming convention is @envio-dev/envio-${os}-${arch} | |
| * If the platform is `win32` or `cygwin`, executable will include a `.exe` extension | |
| * @see https://nodejs.org/api/os.html#osarch | |
| * @see https://nodejs.org/api/os.html#osplatform | |
| * @example "x/xx/node_modules/envio-darwin-arm64" | |
| * @example "x/xx/node_modules/@envio-dev/envio-darwin-arm64" | |
| * The naming convention is `@envio-dev/core-`${os}-${arch} | |
| * If the platform is `win32` or `cygwin`, executable will include a `.exe` extension | |
| * `@see` https://nodejs.org/api/os.html#osarch | |
| * `@see` https://nodejs.org/api/os.html#osplatform | |
| * `@example` "x/xx/node_modules/@envio-dev/core-darwin-arm64" |
🤖 Prompt for AI Agents
In `@codegenerator/cli/npm/envio/bin.js` around lines 11 - 15, Update the JSDoc to
match the actual package naming used in the code: replace references to
"@envio-dev/envio-${os}-${arch}" with "@envio-dev/core-${os}-${arch}" and adjust
the example accordingly so it aligns with the string passed to require.resolve
in bin.js (the require.resolve call that constructs the platform-specific
package name). Ensure the note about Windows `.exe` behavior and the os/arch
`@see` links remain accurate.
|
Sorry for the hustle, but I'd like to postpone it a little bit. I want to start using napi for the envio-cli package, so I'm not sure how it'll require changing the package name. I don't want to pollute npm with too many packages like this |
Changes looked good (AI helped me with a command to review it):
Summary by CodeRabbit
Release Notes