Skip to content

Conversation

ChiragAgg5k
Copy link
Member

@ChiragAgg5k ChiragAgg5k commented Sep 7, 2025

What does this PR do?

check the readme for more details

Test Plan

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

yes.

Copy link

coderabbitai bot commented Sep 7, 2025

Walkthrough

The README was updated to mark the Deno SDK as deprecated and to direct users to the Appwrite Node.js SDK (compatible with Deno). It adds a Migration Notice with stated reasons, a How to migrate section showing npm-based import, and replaces the prior server-version compatibility note with migration-focused content. References to Deno–Node.js compatibility resources and the Node.js SDK were added. The Installation section now recommends the Node.js SDK while retaining a deprecated Deno snippet. Getting Started and License remain, with a minor EOF newline change.

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch deprecate-deno-sdk

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.

Copy link

@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: 0

🧹 Nitpick comments (7)
README.md (7)

3-4: Add deprecation timeline and npm link in the banner.

Include an explicit deprecation date and EOL/support window to set expectations, and link to the npm package directly.

-> ⚠️ **DEPRECATED**: This SDK is deprecated. Please use the [Appwrite Node.js SDK](https://github.com/appwrite/sdk-for-node/) with Deno instead.
+> ⚠️ **DEPRECATED (2025-09-07)**: This SDK is deprecated. Please use the [Appwrite Node.js SDK](https://github.com/appwrite/sdk-for-node/) with Deno instead (npm: [node-appwrite](https://www.npmjs.com/package/node-appwrite)).  
+> Planned EOL for security/bug fixes: 2025-12-31 (please migrate before this date).

11-21: Call out the minimum Deno version required for npm: specifiers.

Deno’s npm: specifier requires newer Deno (v1.28+). Stating this avoids churn for users on older environments.

-This Deno-specific SDK is now deprecated. Thanks to Deno's excellent Node.js compatibility, you can now use the official Appwrite Node.js SDK directly in your Deno applications.
+This Deno-specific SDK is now deprecated. Thanks to Deno's Node.js compatibility, you can use the official Appwrite Node.js SDK directly in Deno (requires Deno ≥ 1.28 for `npm:` imports).

22-31: Tone down “identical API” claim and show a named-import example.

Avoid overpromising; “largely compatible” is safer. Also add a named-import style that mirrors current docs usage.

-```typescript
-import * as sdk from "npm:node-appwrite";
-```
+```typescript
+// Option A
+import * as sdk from "npm:node-appwrite";
+// Option B (recommended)
+import { Client, Users, ID } from "npm:node-appwrite";
+```
@@
-That's it! The API is identical, so your existing code will work with minimal changes.
+That's it! The API is largely compatible; most code should work with minimal changes. Review the Node.js SDK docs for any differences.

34-36: Add npm package link alongside GitHub.

Many Deno users will grab the package name directly.

 - 📦 [Appwrite Node.js SDK](https://github.com/appwrite/sdk-for-node/)
+- 📦 Appwrite Node.js SDK: [GitHub](https://github.com/appwrite/sdk-for-node/) · [npm](https://www.npmjs.com/package/node-appwrite)

39-39: Make the historical section harder to copy by accident.

Wrap legacy content in a collapsible block and reiterate the deprecation date.

-**The information below is kept for historical reference but should not be used for new projects.**
+<details>
+<summary><strong>Historical reference only (deprecated as of 2025-09-07)</strong></summary>
+<br/>
+The information below is kept for historical reference and should not be used for new projects.
+</details>

46-46: Mention Deno ≥1.28 here too.

Small consistency win with the migration note.

-> ⚠️ **Use the Node.js SDK instead**: `import * as sdk from "npm:node-appwrite";`
+> ⚠️ **Use the Node.js SDK instead (Deno ≥ 1.28)**: `import * as sdk from "npm:node-appwrite";`

132-132: Verify the LICENSE link target.

The link points to the main appwrite/appwrite repo. If this SDK repo has its own LICENSE file, prefer linking to it to avoid drift.

-Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.
+Please see the [BSD-3-Clause license](./LICENSE) for more information.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a78e3d2 and ba539ab.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🔇 Additional comments (2)
README.md (2)

37-37: LGTM on the section separator.

Clear break between migration notice and historical content.


48-48: LGTM on clearly marking the old installation as deprecated.

This header plus the banner should reduce accidental copy-paste.

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.

1 participant