-
-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Add HOL (Hashgraph Online) TypeScript SDK cursor rules #161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Michael Kantor <6068672+kantorcodes@users.noreply.github.com>
📝 WalkthroughWalkthroughAdds a new HOL (Hedera TypeScript SDK) cursorrules document and references in the README describing TypeScript HOL development rules, SDK usage examples (RegistryBrokerClient flows), coding standards, testing workflow, validation checklist, and environment configuration. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 133: The README entry for "HOL (Hedera TypeScript SDK)" currently
contains an external link to Hashgraph Online (https://hol.org); update the
README.md entry so the visible link is only the relative path to
./rules/hol-hedera-typescript-cursorrules-prompt-file/.cursorrules and remove
the external https://hol.org URL from the same line (you may instead add that
external reference inside the .cursorrules file if needed), ensuring the entry
follows the project guideline of using relative links.
In `@rules/hol-hedera-typescript-cursorrules-prompt-file/.cursorrules`:
- Around line 36-41: Examples in .cursorrules violate the "No console.log - use
Logger from standards-sdk" rule by showing console.log in multiple example
blocks; replace every console.log example usage with the Logger API from
`@hashgraphonline/standards-sdk`, add a consistent logger instantiation (single
named logger used across examples), and switch calls to the appropriate logger
methods (debug/info/warn/error) and structured key/value logging; update the
example snippets referenced (the blocks currently showing console.log) to
import/instantiate Logger and use logger.info/debug/etc with the same contextual
message structure to match the rule.
- Remove external hol.org link from README (use relative links only)
- Replace all console.log with Logger from standards-sdk
- Fix chat API: use conversation.send({ plaintext }) not sendMessage({ content })
Signed-off-by: Michael Kantor <6068672+kantorcodes@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@rules/hol-hedera-typescript-cursorrules-prompt-file/.cursorrules`:
- Around line 83-95: The examples call client.resolveUaid (and other client.*
methods) but never show how client is created; update each snippet to initialize
a RegistryBrokerClient instance (e.g., create and configure a const client = new
RegistryBrokerClient(...) or equivalent) before using it so the examples are
runnable—specifically add the RegistryBrokerClient instantiation and any minimal
config/credentials required just above usages of client (locations referencing
resolveUaid, resolveAgent, or any other client.method) and ensure the variable
name remains client to match existing calls.
Each code snippet now includes the RegistryBrokerClient instantiation so examples are copy-paste ready. Signed-off-by: Michael Kantor <6068672+kantorcodes@users.noreply.github.com>
Adding cursor rules for Hashgraph Online (HOL) - a TypeScript SDK for building AI agents on the Hedera network.
The
.cursorrulesfile includes:Technology stack (TypeScript, Node.js 20+, pnpm, Jest)
HOL SDK patterns (RegistryBrokerClient, agent search, chat)
Code quality standards
Testing patterns
Website: https://hol.org
GitHub: https://github.com/hashgraph-online/standards-sdk
NPM: @hashgraphonline/standards-sdk