Update skills for more accuracy + to satisfy audit#1377
Update skills for more accuracy + to satisfy audit#1377atharvadeosthale merged 2 commits intomasterfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation templates updated to migrate CLI commands and real-time channel namespace references from the Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@templates/agent-skills/cli.md.twig`:
- Around line 273-275: The doc lists non-existent CLI commands (`appwrite
tables-db list-column-indexes`, `create-column-index`, `delete-column-index`) —
remove these three rows from the CLI documentation in
templates/agent-skills/cli.md.twig unless you intend to expose them; if you do
intend to expose them, implement CLI handlers that map to the service methods
(`listIndexes`, `createIndex`, `deleteIndex`) and wire them into the CLI
dispatch so the commands actually exist before documenting them.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 34a1e5d0-2581-4800-a283-d50435ec5ea9
📒 Files selected for processing (5)
templates/agent-skills/cli.md.twigtemplates/agent-skills/dart.md.twigtemplates/agent-skills/kotlin.md.twigtemplates/agent-skills/swift.md.twigtemplates/agent-skills/typescript.md.twig
| | `appwrite tables-db list-column-indexes --database-id <ID> --table-id <ID>` | List indexes | | ||
| | `appwrite tables-db create-column-index --database-id <ID> --table-id <ID>` | Create index | | ||
| | `appwrite tables-db delete-column-index --database-id <ID> --table-id <ID> --key <KEY>` | Delete index | |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Template mentions:\n'
rg -n -C2 'appwrite tables-db (list-column-indexes|create-column-index|delete-column-index|list-indexes|create-index|delete-index|get-index)' templates
printf '\nGenerator / spec symbols:\n'
rg -n -C2 '\b(listIndexes|getIndex|createIndex|deleteIndex|listColumnIndexes|createColumnIndex|deleteColumnIndex)\b'Repository: appwrite/sdk-generator
Length of output: 2678
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Search for tables-db command definitions:\n'
rg -n 'tables-db|tablesDb|tables-db' --type ts --type js | grep -i 'list.*index\|create.*index\|delete.*index' | head -20
printf '\nSearch for column-index command definitions:\n'
rg -n 'column-index|columnIndex|column-indexes|columnIndexes' --type ts --type js | head -20
printf '\nSearch for tables-db in command files:\n'
fd -e ts -e js | xargs grep -l 'tables-db' 2>/dev/null | head -10Repository: appwrite/sdk-generator
Length of output: 107
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Look for spec or schema files:\n'
find . -type f \( -name '*.json' -o -name '*.yaml' -o -name '*.yml' \) | grep -E '(spec|schema|command)' | head -20
printf '\nSearch for any mention of column-index in the entire repo:\n'
rg -n 'column.index|columnIndex' --type-list | head -20
printf '\nLook in templates/cli for how commands are generated:\n'
find templates/cli -type f -name '*.ts' -o -name '*.js' | head -10
printf '\nCheck for existing tables/database commands in the codebase:\n'
rg -n 'tables-db|database.*index' templates/cli --type ts --type js | head -20Repository: appwrite/sdk-generator
Length of output: 591
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Check spec.json for tables-db service definitions:\n'
jq '.services[] | select(.name | contains("tables")) | {name, methods: [.methods[] | select(.name | contains("Index")) | {name, sdk: .sdk}]}' tests/resources/spec.json 2>/dev/null | head -50
printf '\nIf above is empty, search raw for index-related methods:\n'
rg -n 'listColumnIndexes|list.*Index|createColumnIndex|create.*Index|deleteColumnIndex|delete.*Index' tests/resources/spec.jsonRepository: appwrite/sdk-generator
Length of output: 116
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'File size and first lines of spec.json:\n'
wc -l tests/resources/spec.json
head -100 tests/resources/spec.json
printf '\n\nSearch for tables in spec.json:\n'
grep -n '"tables"' tests/resources/spec.json | head -10
printf '\nSearch for columnIndex or column-index:\n'
grep -n -i 'columnindex\|column.index' tests/resources/spec.jsonRepository: appwrite/sdk-generator
Length of output: 2820
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Look for command generation or mapping in templates/cli:\n'
find templates/cli -type f | head -20
printf '\nSearch for how method names become command names (camelCase to kebab-case):\n'
rg -n 'listIndexes|createIndex|deleteIndex' templates/cli --type ts --type js -A 2 | head -40
printf '\nLook for "column" and "index" together in templates:\n'
rg -n 'column.*index|index.*column' templates/cli --type ts --type js -i | head -20Repository: appwrite/sdk-generator
Length of output: 3898
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Search for CLI command generation or spec-to-command mapping:\n'
rg -n 'tables.db|tablesDb|tables-db' --type ts --type js templates/cli | head -20
printf '\nSearch for where commands are registered/generated:\n'
fd -e ts -path '*/templates/cli/*' | xargs grep -l 'command.*register\|addCommand\|register.*command' 2>/dev/null | head -5
printf '\nLook for swagger/spec parsing to command generation:\n'
rg -n 'listIndexes\|createIndex\|deleteIndex' templates/cli/cli.ts.twig -A 3 -B 3 2>/dev/null | head -30Repository: appwrite/sdk-generator
Length of output: 526
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Read parser.ts around tables-db definition:\n'
sed -n '280,350p' templates/cli/lib/parser.ts
printf '\nSearch for list-column-indexes or similar index commands in parser:\n'
rg -n 'list-column|create-column|delete-column|list-index|create-index|delete-index' templates/cli/lib/parser.ts -A 2 | head -50Repository: appwrite/sdk-generator
Length of output: 3201
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Search for ALL tables-db command definitions:\n'
rg -n '"tables-db' templates/cli --type ts --type js -A 5 -B 2 | head -60
printf '\nSearch for any index-related commands in the CLI:\n'
rg -n 'index' templates/cli/lib/parser.ts -A 1 -B 1
printf '\nCheck if tables-db has any sub-commands defined:\n'
rg -n 'databases\.|tables-db' templates/cli/cli.ts.twig -A 2 -B 2 2>/dev/null || echo "Not in cli.ts.twig"Repository: appwrite/sdk-generator
Length of output: 1455
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Look for how databases service commands are generated:\n'
rg -n '"databases' templates/cli/lib/parser.ts -A 10 -B 2
printf '\nSearch for actual command definitions in CLI that show sub-commands:\n'
rg -n 'command\s*=' templates/cli/lib/commands -l | head -10
printf '\nCheck if cli.md.twig is generated or manually maintained:\n'
head -20 templates/agent-skills/cli.md.twigRepository: appwrite/sdk-generator
Length of output: 120
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Read the cli.md.twig file around the tables-db section:\n'
sed -n '260,290p' templates/agent-skills/cli.md.twig
printf '\n\nCheck if this template is auto-generated or manually edited:\n'
head -30 templates/agent-skills/cli.md.twig
printf '\n\nLook at database commands for comparison:\n'
sed -n '200,260p' templates/agent-skills/cli.md.twig | tail -50Repository: appwrite/sdk-generator
Length of output: 4044
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Search for any appwrite SDK or spec that documents these commands:\n'
rg -n 'list.*[Ii]ndex|create.*[Ii]ndex|delete.*[Ii]ndex' --type ts --type js --type json | grep -E '(tables|index)' -i | head -30
printf '\nSearch for the actual list of tables-db commands in a spec or command list:\n'
rg -n 'appwrite tables-db' templates/ --type ts --type js --type json | head -20
printf '\nLook for command name generation patterns:\n'
rg -n 'list-|create-|delete-' templates/cli/lib/commands -l | head -5Repository: appwrite/sdk-generator
Length of output: 1550
These tables-db index commands do not appear to be exposed as direct CLI commands and should not be documented.
The documented commands (list-column-indexes, create-column-index, delete-column-index) do not exist as user-facing CLI commands. The corresponding service methods (listIndexes, createIndex, deleteIndex) are used only internally during table configuration workflows in push and init operations, not as standalone commands users can run. Either remove these rows from the table or verify whether these commands should actually be exposed to users before documenting them.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@templates/agent-skills/cli.md.twig` around lines 273 - 275, The doc lists
non-existent CLI commands (`appwrite tables-db list-column-indexes`,
`create-column-index`, `delete-column-index`) — remove these three rows from the
CLI documentation in templates/agent-skills/cli.md.twig unless you intend to
expose them; if you do intend to expose them, implement CLI handlers that map to
the service methods (`listIndexes`, `createIndex`, `deleteIndex`) and wire them
into the CLI dispatch so the commands actually exist before documenting them.
Summary by CodeRabbit
Documentation
Breaking Changes