@core / reviews

1.0.1 ▾

1.0.1

已验证MIT

GitHub

基于 @core/comments 的商品评价：已验证购买、图片、标注来源的导入评价、评分和邀评邮件

代码5 个文件上下文约 540 个 token扫描通过

约 540 个 token→ src/lib/reviews/AGENTS.md→ .cursor/rules/genpm-core-reviews.mdc

这正是你的 AI 在 src/lib/reviews 中工作时读取的内容。不会向其上下文添加其他任何内容。

@core/reviews — rules for AI agents

Purpose

Product reviews built on @core/comments (no duplicate comment system): a review is a comment on product/<id> with a 1–5 rating, plus review_meta (verified purchase, photos from @core/media, source) and review_stats per product. "Verified" means the signed-in author has a paid and shipped order with that product (by user id or their account's verified email); guest reviews are never verified, so the response never reveals whether an email bought. Imported reviews are always labeled with their source and never verified. Asks customers for a review N days after delivery.

Map

index.ts — public API: postReview, listReviews, productRating, moderateReview, importReviews, verifiedOrder.
reviews.ts — logic, stats and the reviews.request job (scheduled from the order delivered event on import).

Integration

Requires @core/comments (moderation, anti-spam) and @core/orders. Env: optional REVIEW_REQUEST_DELAY_DAYS (default 7, -1 disables), SITE_URL, EMAIL_FROM.
Migrations as in src/lib/db/AGENTS.md; import this module at startup.
Product page: productRating(id) for stars and JSON-LD (jsonLd.product({ rating }) from @core/seo), listReviews(id, { page, rating, sort }) for the list; show a "Verified purchase" badge and, for imported ones, "Imported from <source>".
Review form → postReview({ productId, rating, body, user | guest, photos }, { headers, fields }) with @core/antispam fields.
Moderate in the comments admin (filter entityType=product) and call moderateReview so stats update.
Verify: a buyer's review shows as verified after approval and the product rating changes.

Conventions

Explain on the page how reviews are checked (EU Omnibus Directive): verified = confirmed order.
Show all approved reviews, including negative ones; sort options must not hide them by default.

Don't

Don't write, generate or buy fake reviews, and don't mark imported reviews as verified.
Don't put aggregateRating in JSON-LD when there are no approved reviews.
Don't offer rewards conditioned on a positive review.

# @core/reviews — rules for AI agents

## Purpose
Product reviews built on @core/comments (no duplicate comment system): a review is a comment on `product/<id>` with a
1–5 rating, plus `review_meta` (verified purchase, photos from @core/media, source) and `review_stats` per product.
"Verified" means the signed-in author has a paid and shipped order with that product (by user id or their account's
verified email); guest reviews are never verified, so the response never reveals whether an email bought. Imported reviews are always labeled with
their source and never verified. Asks customers for a review N days after delivery.

## Map
- `index.ts` — public API: `postReview`, `listReviews`, `productRating`, `moderateReview`, `importReviews`, `verifiedOrder`.
- `reviews.ts` — logic, stats and the `reviews.request` job (scheduled from the order `delivered` event on import).

## Integration
1. Requires @core/comments (moderation, anti-spam) and @core/orders. Env: optional `REVIEW_REQUEST_DELAY_DAYS` (default 7, `-1` disables), `SITE_URL`, `EMAIL_FROM`.
2. Migrations as in `src/lib/db/AGENTS.md`; import this module at startup.
3. Product page: `productRating(id)` for stars and JSON-LD (`jsonLd.product({ rating })` from @core/seo), `listReviews(id, { page, rating, sort })`
   for the list; show a "Verified purchase" badge and, for imported ones, "Imported from <source>".
4. Review form → `postReview({ productId, rating, body, user | guest, photos }, { headers, fields })` with @core/antispam fields.
5. Moderate in the comments admin (filter `entityType=product`) and call `moderateReview` so stats update.
6. Verify: a buyer's review shows as verified after approval and the product rating changes.

## Conventions
- Explain on the page how reviews are checked (EU Omnibus Directive): verified = confirmed order.
- Show all approved reviews, including negative ones; sort options must not hide them by default.

## Don't
- Don't write, generate or buy fake reviews, and don't mark imported reviews as verified.
- Don't put `aggregateRating` in JSON-LD when there are no approved reviews.
- Don't offer rewards conditioned on a positive review.

应用 .genpmignore 后将被注入的确切目录树。固定于

src/lib/reviews/LICENSE只读 · 9c40b7a

MIT License

Copyright (c) 2026 GenPM

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.