Skip to content

Comments

Chore/readmes for blocks and integrations#705

Merged
michnowak merged 36 commits intomainfrom
chore/readmes-for-blocks-and-integrations
Feb 20, 2026
Merged

Chore/readmes for blocks and integrations#705
michnowak merged 36 commits intomainfrom
chore/readmes-for-blocks-and-integrations

Conversation

@marcinkrasowski
Copy link
Collaborator

@marcinkrasowski marcinkrasowski commented Feb 19, 2026

What does this PR do?

  • Added READMEs and descriptions/metadata in package.json files for all existing blocks and integrations
  • Updated generators to also create readme files when creating a new block or integration

Summary by CodeRabbit

  • Documentation

    • Added comprehensive README files across blocks, integrations, configs, modules, utils, CLI, framework, telemetry, and UI packages describing installation, usage, configuration, and API surfaces.
  • Chores

    • Enriched package metadata (keywords, description, repository, homepage, bugs) across many packages.
    • Updated generator templates to produce README and metadata for new blocks and integrations.

- Introduced cart-related modules to Medusa.js integration with support for create, update, and delete operations.
- Included mappings and services for handling carts across integrations.
- Updated relevant configurations, docs, and seed data.
- Added models, services, and mappers for customers, payments, and checkout.
- Enhanced carts and orders to support additional fields like email and payment session.
- Integrated mocked module functionality for new services.
- Refined Medusa.js mappings for customer addresses and shipping options.
- Renamed methods, parameters, and models for clarity and consistency (e.g., `setupAddresses` to `setAddresses`).
- Centralized support for guest email handling using `email` field across carts, orders, and checkout processes.
- Removed redundant calls and optimized order completion workflow.
- Added locale-based grouping for payment providers.
- Introduced utility to retrieve localized payment method display info.
- Updated cart and checkout services to support locale-based operations.
- Enhanced cart item handling with improved product mapping and variant support.
- Addressed stricter authentication for customer cart access and actions.
…d field mappings

- Added documentation for Carts, Customers, and Checkout services, including API methods and data models.
- Updated Products module to reference associated entities (e.g., Carts and Orders).
- Enhanced Tickets API docs with clarified field mapping and integration-specific requirements.
- Improved docs with consistent formatting.
- Replaced hardcoded URLs with dynamic inputs for better flexibility in checkout.
- Enhanced promotion handling with direct API invocation for addition and removal.
- Refactored `carts.mapper` to standardize currency to uppercase.
…module

- Updated models, mappers, and service logic to use `sku` for identifying product variants.
- Adjusted tests and mocked data mappings to align with the new `sku` field.
- Revised documentation to reflect the parameter changes and improve consistency.
- Updated request parameters across cart-related models to include `locale` field.
- Fixed incorrect HTTP method in promotion removal logic.
- Updated checkout service to accept dynamic `returnUrl` and `cancelUrl` values.
- Added stricter validation for payment and shipping methods in the checkout service.
- Refactored currency handling to use default currency when missing.
- Standardized import paths for `handleHttpError` utility across modules.
… type handling across payment and cart modules

- Removed `type` field from `PaymentMethod` and `Cart` entities, mappers, and related services.
- Standardized error handling in payment and customer address services with clearer exception usage.
…price mapping for consistent error handling and field validation
…usajs-integration-for-checkout-process

# Conflicts:
#	packages/integrations/medusajs/src/modules/medusajs/medusajs.service.spec.ts
#	packages/integrations/medusajs/src/modules/medusajs/medusajs.service.ts
#	packages/integrations/medusajs/src/modules/products/products.mapper.ts
#	packages/integrations/medusajs/src/modules/products/products.service.spec.ts
#	packages/integrations/medusajs/src/modules/products/products.service.ts
- add setup and usage guides
- update cart and checkout documentation
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 19, 2026

Warning

Rate limit exceeded

@michnowak has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Walkthrough

Adds README documentation and standardized package.json metadata (keywords, repository, homepage, bugs, and some descriptions/scripts) across many packages (blocks, integrations, configs, utils, framework, ui, telemetry, modules, CLI) and updates turbo generator templates to scaffold READMEs and package metadata.

Changes

Cohort / File(s) Summary
Changeset
​.changeset/silly-socks-hammer.md
Adds a changeset declaring a patch release series covering many @o2s/* packages.
Blocks — READMEs & package metadata
packages/blocks/*/README.md, packages/blocks/*/package.json
Adds README for each block (installation, backend/frontend/SDK usage, config, env, API) and injects standard metadata fields (keywords, repository, homepage, bugs) into block package.json files.
Integrations — READMEs & package metadata
packages/integrations/*/README.md, packages/integrations/*/package.json
Adds READMEs for integrations (Algolia, Contentful, MedusaJS, Mocked, Redis, Strapi, Zendesk) and inserts descriptive/metadata fields into their package.json files.
Configs — READMEs & package metadata
packages/configs/*/README.md, packages/configs/*/package.json
Introduces documentation for shared config packages (eslint, prettier, typescript, vitest, lint-staged, integrations) and updates package.jsons with description/keywords and other metadata.
Utilities & Core — READMEs & package.json
packages/utils/*/README.md, packages/utils/*/package.json, packages/framework/*, packages/ui/*, packages/telemetry/*, packages/modules/*, packages/cli/create-o2s-app/*
Adds documentation and standard metadata; some utils received expanded package.json fields (files, scripts, deps, devDeps, peerDeps). Framework, UI, telemetry, modules, and CLI received READMEs and metadata updates.
Generator templates & config
turbo/generators/config.ts, turbo/generators/templates/block/*, turbo/generators/templates/integration/*
Updates scaffolding to generate README and package metadata for blocks/integrations, adds Handlebars helper(s), and fixes template paths; adds block/integration README and package.json templates.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • marcinkrasowski

Poem

🐰
I hopped through folders, README in paw,
Sprinkled metadata, tidy and sure.
Packages now sing with URLs and keys,
A little rabbit's nudge — docs done with ease. 🥕📚

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive PR description provides brief overview of changes but lacks structured sections and detail required by template (Key Changes, How to test, Media). Expand description to include detailed Key Changes explaining impact, side effects, and testing instructions per the repository template.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed Title clearly summarizes the main change: adding READMEs and metadata for blocks and integrations packages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/readmes-for-blocks-and-integrations

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@marcinkrasowski marcinkrasowski changed the base branch from main to feat/medusajs-integration-for-checkout-process February 19, 2026 11:04
@github-actions
Copy link
Contributor

github-actions bot commented Feb 19, 2026

Coverage Report for packages/configs/vitest-config

Status Category Percentage Covered / Total
🔵 Lines 80.87% 1192 / 1474
🔵 Statements 80.34% 1267 / 1577
🔵 Functions 78.66% 446 / 567
🔵 Branches 72.13% 1017 / 1410
File CoverageNo changed files found.
Generated in workflow #343 for commit 8554f78 by the Vitest Coverage Report Action

Base automatically changed from feat/medusajs-integration-for-checkout-process to main February 19, 2026 13:56
@vercel
Copy link

vercel bot commented Feb 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
o2s-docs Skipped Skipped Feb 20, 2026 11:05am

Request Review

@vercel vercel bot temporarily deployed to Preview – o2s-docs February 19, 2026 13:57 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

Note

Due to the large number of review comments, Critical, Major severity comments were prioritized as inline comments.

@vercel vercel bot temporarily deployed to Preview – o2s-docs February 20, 2026 10:52 Inactive
@vercel vercel bot temporarily deployed to Preview – o2s-docs February 20, 2026 10:55 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 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/integrations/redis/README.md`:
- Around line 49-58: The README currently lists CACHE_REDIS_HOST and
CACHE_REDIS_PORT as "Required" but the code in cache.service.ts only reads them
when CACHE_ENABLED === 'true'; update the README to reflect that
CACHE_REDIS_HOST and CACHE_REDIS_PORT are required only when CACHE_ENABLED is
enabled (or move them to "Optional" with a conditional note). Mention
CACHE_ENABLED, CACHE_REDIS_HOST, CACHE_REDIS_PORT and keep CACHE_TTL as optional
with its default (300) shown, and add a short sentence like "CACHE_REDIS_HOST
and CACHE_REDIS_PORT are required only if CACHE_ENABLED is set to true" so
readers know the variables are conditional.
- Around line 24-33: The first example in README imports an unused symbol
(Cache) and references a nonexistent RedisConfig export from
'@o2s/integrations.redis/integration'; fix by either deleting that entire first
example and leaving the second (which uses Cache.CacheIntegrationConfig), or
update the example to import the actual export (Config) and use Config.cache
instead of RedisConfig; locate references to "import { Cache }", "RedisConfig",
"Config.cache", and "Cache.CacheIntegrationConfig" in the snippet and apply one
of these two fixes so the example compiles and matches the real exports.
- Around line 72-75: The README incorrectly advertises "Connection pooling"
while the integration uses the redis library's createClient()
(single-connection) and not createClientPool(); remove the "Connection pooling"
bullet from the feature list and, if desired, replace it with a note that
pooling can be enabled via createClientPool() in the redis library to avoid
misleading readers; update any related docs or examples that mention pooling to
reference createClient() vs createClientPool() by name.

@michnowak michnowak merged commit 8c01be4 into main Feb 20, 2026
15 checks passed
@michnowak michnowak deleted the chore/readmes-for-blocks-and-integrations branch February 20, 2026 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants