Merge pull request #92 from better-stack-ai/feat/comments-plugin

Feat: Comments Plugin

Author: olliethedev

.github/workflows/e2e.yml

@@ -9,24 +9,29 @@ on:
 
 jobs:
   e2e:
+    name: E2E (${{ matrix.framework }})
     runs-on: ubuntu-latest
     concurrency:
-      group: e2e-${{ github.ref }}
+      group: e2e-${{ matrix.framework }}-${{ github.ref }}
       cancel-in-progress: true
     permissions:
       contents: read
     env:
       OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
       NODE_OPTIONS: --max-old-space-size=8192
 
+    strategy:
+      fail-fast: false
+      matrix:
+        framework: [nextjs, tanstack, react-router]
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Setup PNPM
         uses: pnpm/action-setup@v4
 
-
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
@@ -42,23 +47,23 @@ jobs:
       - name: Build workspace
         run: pnpm -w build
 
-      - name: Run Playwright smoke tests
-        run: pnpm e2e:smoke
+      - name: Run Playwright smoke tests (${{ matrix.framework }})
+        run: pnpm e2e:smoke:${{ matrix.framework }}
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
 
       - name: Upload Playwright report
         if: always()
         uses: actions/upload-artifact@v4
         with:
-          name: playwright-report
+          name: playwright-report-${{ matrix.framework }}
           path: e2e/playwright-report
           if-no-files-found: ignore
 
       - name: Upload traces
         if: failure()
         uses: actions/upload-artifact@v4
         with:
-          name: traces
+          name: traces-${{ matrix.framework }}
           path: test-results/**/*.zip
           if-no-files-found: ignore

AGENTS.md

@@ -588,6 +588,13 @@ export $(cat ../examples/nextjs/.env | xargs)
 pnpm e2e:smoke
 ```
 
+Run for a single framework only (starts only that framework's server):
+```bash
+pnpm e2e:smoke:nextjs
+pnpm e2e:smoke:tanstack
+pnpm e2e:smoke:react-router
+```
+
 Run specific test file:
 ```bash
 pnpm e2e:smoke -- tests/smoke.chat.spec.ts
@@ -605,7 +612,7 @@ The `playwright.config.ts` defines three projects:
 - `tanstack:memory` - port 3004
 - `react-router:memory` - port 3005
 
-All three web servers start for every test run. Timeout is 300 seconds per server.
+By default (`pnpm e2e:smoke`) all three web servers start. Set `BTST_FRAMEWORK=nextjs|tanstack|react-router` (or use the per-framework scripts above) to start only the matching server and run only its tests. The CI workflow uses a matrix to run each framework in a separate parallel job.
 
 ### API Key Requirements
 

CONTRIBUTING.md

@@ -709,27 +709,35 @@ test.describe("Your Plugin", () => {
 })
 ```
 
-Run the full E2E suite (requires all three example apps to start):
+Run the full E2E suite (starts all three example apps):
 
 ```bash
 cd e2e
 export $(cat ../examples/nextjs/.env | xargs)
 pnpm e2e:smoke
 ```
 
+Run against a single framework only (starts only that framework's server — faster):
+
+```bash
+pnpm e2e:smoke:nextjs
+pnpm e2e:smoke:tanstack
+pnpm e2e:smoke:react-router
+```
+
 Run a single test file:
 
 ```bash
 pnpm e2e:smoke -- tests/smoke.your-plugin.spec.ts
 ```
 
-Run against a specific framework:
+Run against a specific Playwright project:
 
 ```bash
 pnpm e2e:smoke -- --project="nextjs:memory"
 ```
 
-Tests run against three Playwright projects: `nextjs:memory` (port 3003), `tanstack:memory` (3004), `react-router:memory` (3005).
+Tests run against three Playwright projects: `nextjs:memory` (port 3003), `tanstack:memory` (3004), `react-router:memory` (3005). In CI, each framework runs as a separate parallel job via a matrix strategy.
 
 ---
 

README.md

@@ -40,6 +40,7 @@ Enable the features you need and keep building your product.
 | **OpenAPI** | Auto-generated API documentation with interactive Scalar UI |
 | **Route Docs** | Auto-generated client route documentation with interactive navigation |
 | **Better Auth UI** | Beautiful shadcn/ui authentication components for better-auth |
+| **Comments** | Commenting system with moderation, likes, and nested replies |
 
 Each plugin ships **frontend + backend together**:
 routes, APIs, database models, React components, SSR, and SEO — already wired.

docs/content/docs/cli.mdx

@@ -124,3 +124,9 @@ Because the CLI executes your config file to extract the `dbSchema`, there are a
 ```bash
 SOME_VAR=value npx @btst/cli generate --config=lib/stack.ts --orm=prisma --output=schema.prisma
 ```
+
+or using dotenv-cli:
+
+```bash
+npx dotenv-cli -e .env.local -- npx @btst/cli generate --orm drizzle --config lib/stack.ts --output db/btst-schema.ts
+```

docs/content/docs/installation.mdx

@@ -354,6 +354,7 @@ In order to use BTST, your application must meet the following requirements:
         export const GET = handler
         export const POST = handler
         export const PUT = handler
+        export const PATCH = handler
         export const DELETE = handler
         ```
       </Tab>
@@ -390,6 +391,9 @@ In order to use BTST, your application must meet the following requirements:
               PUT: async ({ request }) => {
                 return handler(request)
               },
+              PATCH: async ({ request }) => {
+                return handler(request)
+              },
               DELETE: async ({ request }) => {
                 return handler(request)
               },

docs/content/docs/meta.json

@@ -17,6 +17,7 @@
       "plugins/form-builder",
       "plugins/ui-builder",
       "plugins/kanban",
+      "plugins/comments",
       "plugins/open-api",
       "plugins/route-docs",
       "plugins/better-auth-ui",

docs/content/docs/plugins/blog.mdx

@@ -509,6 +509,32 @@ overrides={{
 }}
 ```
 
+**Slot overrides:**
+
+| Override | Type | Description |
+|----------|------|-------------|
+| `postBottomSlot` | `(post: SerializedPost) => ReactNode` | Render additional content below each blog post — use to embed a `CommentThread` |
+
+```tsx
+import { CommentThread } from "@btst/stack/plugins/comments/client/components"
+
+overrides={{
+  blog: {
+    // ...
+    postBottomSlot: (post) => (
+      <CommentThread
+        resourceId={post.slug}
+        resourceType="blog-post"
+        apiBaseURL={baseURL}
+        apiBasePath="/api/data"
+        currentUserId={session?.user?.id}
+        loginHref="/login"
+      />
+    ),
+  }
+}}
+```
+
 ## React Data Hooks and Types
 You can import the hooks from `"@btst/stack/plugins/blog/client/hooks"` to use in your components.