Version Packages#1475
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughRemoved a changeset file and finalized release metadata: bumped Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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 |
95f82e5 to
266dacf
Compare
266dacf to
b6cd5b3
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
packages/instant-meilisearch/CHANGELOG.md (1)
17-17: Polish migration markdown/style for readability.Line [17] has redundant wording, and Lines [23-24] use malformed ordered-list syntax (
1. - ...), which renders awkwardly in some viewers.🧹 Suggested cleanup
- - Remove any fields regarding exports outside of `"exports"` field, all supported Node.js versions support "exports" field, as do all modern bundlers and CDNs + - Remove any export-related fields outside the `"exports"` field; all supported Node.js versions, modern bundlers, and CDNs support `"exports"`. ## Migration - 1. - CommonJS and UMD bundles aren't available anymore - - `package.json` `"main"` and `"types"` fields aren't available anymore + 1. CommonJS and UMD bundles aren't available anymore. + 2. `package.json` `"main"` and `"types"` fields aren't available anymore.Also applies to: 23-24
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/instant-meilisearch/CHANGELOG.md` at line 17, Reword the redundant sentence "Remove any fields regarding exports outside of \"exports\" field, all supported Node.js versions support \"exports\" field, as do all modern bundlers and CDNs" to a concise, clear line (e.g., "Remove any export-related fields outside the \"exports\" field; modern Node.js versions and bundlers support \"exports\".") and fix the malformed list entries that use "1. - ..." by converting them to proper ordered list items or bullets (e.g., "1. Do X" or "- Do X") so the markdown renders cleanly; update occurrences matching the exact phrase and the malformed "1. -" list pattern in the CHANGELOG.md content.packages/autocomplete-client/CHANGELOG.md (1)
17-17: Clean up wording and ordered-list markdown.Line [17] is a bit redundant, and Lines [23-24] use invalid/awkward ordered-list formatting (
1. - ...).🧹 Suggested cleanup
- - Remove any fields regarding exports outside of `"exports"` field, all supported Node.js versions support "exports" field, as do all modern bundlers and CDNs + - Remove any export-related fields outside the `"exports"` field; all supported Node.js versions, modern bundlers, and CDNs support `"exports"`. ## Migration - 1. - CommonJS and UMD bundles aren't available anymore - - `package.json` `"main"` and `"types"` fields aren't available anymore + 1. CommonJS and UMD bundles aren't available anymore. + 2. `package.json` `"main"` and `"types"` fields aren't available anymore.Also applies to: 23-24
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/autocomplete-client/CHANGELOG.md` at line 17, Reword the redundant sentence "- Remove any fields regarding exports outside of \"exports\" field, all supported Node.js versions support \"exports\" field, as do all modern bundlers and CDNs" to a concise line such as "Remove fields outside the \"exports\" field; modern Node.js versions and bundlers support the \"exports\" field." and fix the malformed ordered-list entries that currently read like "1. - ..." by converting them to proper ordered-list lines (e.g., "1. Remove X" and "2. Remove Y" or a single numbered line with sub-bullets) so the markdown is valid and not awkward.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/autocomplete-client/CHANGELOG.md`:
- Line 20: Clarify the CHANGELOG sentence to state that adding "./package.json"
applies to the package's published exports (publishConfig.exports) not the
workspace-level exports; explicitly mention that "./package.json" is
intentionally omitted from workspace exports and is only added under
publishConfig.exports so readers understand this is a publish-time change rather
than a workspace requirement.
In `@packages/instant-meilisearch/CHANGELOG.md`:
- Line 20: Update the changelog line so it clarifies that `package.json` is
added to the published package exports rather than workspace exports: replace
the phrase referencing `exports` with explicit wording like
"publishConfig.exports" or "published package exports (`publishConfig.exports`)"
and mention that workspace `exports` intentionally omit "./package.json" to
avoid contributors modifying workspace `exports` incorrectly; refer to the
symbols `package.json`, `exports`, `publishConfig.exports`, and workspace
`exports` when making the edit.
---
Nitpick comments:
In `@packages/autocomplete-client/CHANGELOG.md`:
- Line 17: Reword the redundant sentence "- Remove any fields regarding exports
outside of \"exports\" field, all supported Node.js versions support \"exports\"
field, as do all modern bundlers and CDNs" to a concise line such as "Remove
fields outside the \"exports\" field; modern Node.js versions and bundlers
support the \"exports\" field." and fix the malformed ordered-list entries that
currently read like "1. - ..." by converting them to proper ordered-list lines
(e.g., "1. Remove X" and "2. Remove Y" or a single numbered line with
sub-bullets) so the markdown is valid and not awkward.
In `@packages/instant-meilisearch/CHANGELOG.md`:
- Line 17: Reword the redundant sentence "Remove any fields regarding exports
outside of \"exports\" field, all supported Node.js versions support \"exports\"
field, as do all modern bundlers and CDNs" to a concise, clear line (e.g.,
"Remove any export-related fields outside the \"exports\" field; modern Node.js
versions and bundlers support \"exports\".") and fix the malformed list entries
that use "1. - ..." by converting them to proper ordered list items or bullets
(e.g., "1. Do X" or "- Do X") so the markdown renders cleanly; update
occurrences matching the exact phrase and the malformed "1. -" list pattern in
the CHANGELOG.md content.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0cab29ee-3db7-4c03-a5a1-f989a9ffff38
📒 Files selected for processing (5)
.changeset/crisp-wasps-flow.mdpackages/autocomplete-client/CHANGELOG.mdpackages/autocomplete-client/package.jsonpackages/instant-meilisearch/CHANGELOG.mdpackages/instant-meilisearch/package.json
💤 Files with no reviewable changes (1)
- .changeset/crisp-wasps-flow.md
✅ Files skipped from review due to trivial changes (2)
- packages/autocomplete-client/package.json
- packages/instant-meilisearch/package.json
This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.
Releases
@meilisearch/autocomplete-client@0.8.0
Minor Changes
9642256: # Rework exports and bundling
MeiliSearchto lower caseMeilisearchto eliminate some possible issues arising from JSPM and maybe other CDNs/package resolvers (instant-meilisearch@0.30.0 broken against meilisearch@0.57.0 — MeiliSearch named export removed #1472, Compatibility broken with meilisearch due to renaming of exported name 'MeiliSearch' #1468)meilisearchis marked as a peer dependencyimportmap*.tsfiles directly; for now executing them withtsxrequire(esm), so there's no point in bundling to commonjs anymoretype="module"scripts for almost a decade now, even Node.js supports requiring ESM as stated above"exports"field, all supported Node.js versions support "exports" field, as do all modern bundlers and CDNspublishConfig, so we can export to other workspace packages the TypeScript source filespackage.jsoninto exports, mainly so bundlers can read it via directly importing it, and it seems to be the industry normMigration
package.json"main"and"types"fields aren't available anymoreIf you relied on any of these outdated features, you will have to bundle for any target environment that requires them, or update the environment if that's possible.
meilisearchis a peer dependency (if the package manager used doesn't automatically install it, add it to the list of dependencies manually):Patch Changes
@meilisearch/instant-meilisearch@0.31.0
Minor Changes
9642256: # Rework exports and bundling
MeiliSearchto lower caseMeilisearchto eliminate some possible issues arising from JSPM and maybe other CDNs/package resolvers (instant-meilisearch@0.30.0 broken against meilisearch@0.57.0 — MeiliSearch named export removed #1472, Compatibility broken with meilisearch due to renaming of exported name 'MeiliSearch' #1468)meilisearchis marked as a peer dependencyimportmap*.tsfiles directly; for now executing them withtsxrequire(esm), so there's no point in bundling to commonjs anymoretype="module"scripts for almost a decade now, even Node.js supports requiring ESM as stated above"exports"field, all supported Node.js versions support "exports" field, as do all modern bundlers and CDNspublishConfig, so we can export to other workspace packages the TypeScript source filespackage.jsoninto exports, mainly so bundlers can read it via directly importing it, and it seems to be the industry normMigration
package.json"main"and"types"fields aren't available anymoreIf you relied on any of these outdated features, you will have to bundle for any target environment that requires them, or update the environment if that's possible.
meilisearchis a peer dependency (if the package manager used doesn't automatically install it, add it to the list of dependencies manually):Summary by CodeRabbit
Refactor
Chores