merge dev to main (better-auth README)

[ymc9]

• chore: add README for better-auth adapter

• typo

[claude]

Claude finished @ymc9's task —— View job

---

PR Review: Better Auth Adapter README

Todo List

• Read and analyze the new README file
• Review documentation quality and best practices
• Check for potential issues or improvements
• Provide comprehensive review feedback

Review Feedback

The README file provides a solid foundation for the Better Auth adapter documentation. Here's my detailed review:

✅ Strengths:

• Clear, concise structure with appropriate sections
• Good basic installation and configuration examples
• Mentions the schema generation feature
• Uses proper code formatting and syntax highlighting

⚠️ Issues Found:

1. Incorrect Installation Command (line 8)

   npm install @zenstackhq/better-auth@next

   • Should be @zenstackhq/better-auth without @next tag based on package.json
   • Package version is 3.0.0-beta.24, so consider mentioning the beta status

2. Missing Import Statement (line 19)

   const auth = new BetterAuth({

   • Missing import { BetterAuth } from 'better-auth'; at the top

3. Incomplete Documentation

   • Missing documentation for AdapterConfig options found in adapter.ts:16-35:
     • debugLogs?: DBAdapterDebugLogOption - for enabling debug logging
     • usePlural?: boolean - for using plural table names
   • No mention of transaction support (which is implemented in adapter.ts:223-230)
   • Missing error handling examples or troubleshooting section

4. Schema Generation Section Lacks Detail (lines 27-33)

   • Doesn't explain what models get generated
   • No mention of ZenStack-specific workflow (zenstack generate command)
   • Missing integration with ZenStack's schema generation process

🔧 Suggestions for Improvement:

1. Add complete configuration example:

   import { BetterAuth } from 'better-auth';
   import { zenstackAdapter } from '@zenstackhq/better-auth';
   import { db } from './db';
   
   const auth = new BetterAuth({
       database: zenstackAdapter(db, {
           provider: 'postgresql',
           debugLogs: true, // Enable debug logging
           usePlural: false, // Use singular table names
       }),
       // other better-auth options...
   });

2. Add workflow section:

   ## Workflow
   1. Install the adapter
   2. Generate Better Auth schema: `npx @better-auth/cli generate`
   3. Generate ZenStack schema: `npx zenstack generate`
   4. Configure the adapter in your Better Auth setup

3. Add troubleshooting section for common issues like missing models

4. Consider adding a peer dependencies section since the package requires better-auth and @better-auth/core

📊 Code Quality Assessment:

• Documentation Structure: Good ✅
• Code Examples: Partially complete ⚠️
• Completeness: Missing key configuration options ⚠️
• Accuracy: Installation command incorrect ❌

🔒 Security Considerations:

• No security concerns in the documentation itself
• Could benefit from mentioning security best practices for auth configuration

🧪 Test Coverage:

• Documentation-only change, no test coverage needed
• Consider adding example tests in future documentation updates

Overall Assessment:

This is a good start for the adapter documentation. The main issues are the incorrect installation command and missing comprehensive configuration examples. The structure is solid and follows documentation best practices.

[coderabbitai]

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 19 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 5a36a7d and 4240ecd.

📒 Files selected for processing (1)

• packages/auth-adapters/better-auth/README.md (1 hunks)

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dev

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[Copilot]

Pull Request Overview

This PR merges the dev branch to main, adding a comprehensive README file for the @zenstackhq/better-auth adapter package. The documentation provides installation instructions, configuration examples, and schema generation guidance for users integrating better-auth with ZenStack ORM.

Key Changes:

• Added README.md with installation, configuration, and usage instructions for the better-auth adapter

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The code example is missing the import statement for BetterAuth. Add the following import:

import { betterAuth } from 'better-auth';

Additionally, based on the better-auth library conventions, the function is typically named betterAuth (lowercase), not BetterAuth (uppercase). The example should use:

const auth = betterAuth({
    database: zenstackAdapter(db, {
        provider: 'postgresql', // or 'sqlite'
    }),
    // other better-auth options...
});