feat: add iconpark lookup for lark slides#1123
Open
ethan-zhx wants to merge 1 commit into
Open
Conversation
📝 WalkthroughWalkthroughThis PR adds a new IconPark icon search and resolution tool for Lark Slides, along with comprehensive developer documentation. The implementation includes a 362-line Python CLI tool with multi-language query tokenization, relevance scoring, and three core commands (search, resolve, list-categories), validated by a 99-line test suite, and documented across process guidelines and reference materials. ChangesIconPark Icon Search and Integration
Sequence Diagram(s)sequenceDiagram
participant Developer
participant CLI as iconpark_tool.py
participant Loader as load_index()
participant Tokenizer as tokenize_query()
participant Scorer as score_icon()
participant Index as Index JSON
Developer->>CLI: search --query "arrow"
CLI->>Loader: load_index()
Loader->>Index: read icons.json
Index-->>Loader: icon entries
Loader-->>CLI: index_data
CLI->>Tokenizer: tokenize_query("arrow")
Tokenizer-->>CLI: tokens: ["arrow"]
CLI->>Scorer: rank candidates by score(token)
loop For each icon in index
Scorer->>Scorer: exact match, field match, substring, boost
end
Scorer-->>CLI: ranked results
CLI-->>Developer: JSON results [{"iconType": "...", ...}]
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1123 +/- ##
==========================================
+ Coverage 68.10% 68.22% +0.11%
==========================================
Files 613 617 +4
Lines 56396 57192 +796
==========================================
+ Hits 38409 39017 +608
- Misses 14809 14945 +136
- Partials 3178 3230 +52 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@9a507b26cef83cdbf5fc65d52c3a7944ba111881🧩 Skill updatenpx skills add larksuite/cli#feat/slide_icon_park -y -g |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
skills/lark-slides/scripts/iconpark_tool.py (2)
50-51: ⚡ Quick winAdd
NoReturntype annotation for proper type checking.The
fail()function always raises but lacks a return type annotation. Type checkers will infer-> None, causing spurious "missing return" warnings in callers likeparse_limit()andload_index().Proposed fix
+from typing import Any, NoReturn -from typing import Any -def fail(message: str) -> None: +def fail(message: str) -> NoReturn: raise IconParkToolError(message)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-slides/scripts/iconpark_tool.py` around lines 50 - 51, The fail() helper currently lacks a NoReturn annotation which causes type-checkers to infer -> None and produce "missing return" warnings in callers like parse_limit() and load_index(); update the fail function signature to def fail(message: str) -> NoReturn: and add the required import from typing (NoReturn), leaving the implementation raise IconParkToolError(message) unchanged so callers are correctly treated as unreachable after calling fail().
214-220: 💤 Low valueConsider precomputing tag tokens to avoid repeated work.
field_tokens(tag)is called inside nested loops, recomputing the same token set for each query token. For a query with 10 tokens and an icon with 5 tags, this results in 50 calls instead of 5.Proposed optimization
name_tokens = field_tokens(name) category_tokens = field_tokens(category) tag_tokens = field_tokens(*tags) icon_type_tokens = field_tokens(icon_type) + tag_token_sets = [field_tokens(tag) for tag in tags] search_text = icon_search_text(entry) ... - for tag in tags: + for i, tag in enumerate(tags): if token == tag: score += 60 - elif token in field_tokens(tag): + elif token in tag_token_sets[i]: score += 45 elif allows_substring_match(token) and token in tag: score += 20🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-slides/scripts/iconpark_tool.py` around lines 214 - 220, The nested scoring loop calls field_tokens(tag) repeatedly for each query token; to fix, compute the token set for each tag once before iterating tokens: inside the outer loop over tags (the block using variables tag and score and calling field_tokens and allows_substring_match), call field_tokens(tag) a single time (e.g., tag_token_set) and reuse it for equality/in-set checks, and use the original tag string only for substring checks (allows_substring_match(token) and token in tag); this eliminates repeated field_tokens calls and preserves the existing scoring logic.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@skills/lark-slides/scripts/iconpark_tool.py`:
- Around line 50-51: The fail() helper currently lacks a NoReturn annotation
which causes type-checkers to infer -> None and produce "missing return"
warnings in callers like parse_limit() and load_index(); update the fail
function signature to def fail(message: str) -> NoReturn: and add the required
import from typing (NoReturn), leaving the implementation raise
IconParkToolError(message) unchanged so callers are correctly treated as
unreachable after calling fail().
- Around line 214-220: The nested scoring loop calls field_tokens(tag)
repeatedly for each query token; to fix, compute the token set for each tag once
before iterating tokens: inside the outer loop over tags (the block using
variables tag and score and calling field_tokens and allows_substring_match),
call field_tokens(tag) a single time (e.g., tag_token_set) and reuse it for
equality/in-set checks, and use the original tag string only for substring
checks (allows_substring_match(token) and token in tag); this eliminates
repeated field_tokens calls and preserves the existing scoring logic.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: b7b48cca-bbfa-4d26-99de-3a5927d18a0f
📒 Files selected for processing (7)
skills/lark-slides/SKILL.mdskills/lark-slides/references/iconpark-index.jsonskills/lark-slides/references/iconpark.mdskills/lark-slides/references/lark-slides-replace-slide.mdskills/lark-slides/references/xml-schema-quick-ref.mdskills/lark-slides/scripts/iconpark_tool.pyskills/lark-slides/scripts/iconpark_tool_test.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add IconPark lookup support for the lark-slides skill, including reference docs, index data, and a helper script for searching and selecting icons.
Changes
iconpark_tool.pywith lookup helpers and tests.Test Plan
lark-cli <domain> <command>flow works as expectedRelated Issues
Summary by CodeRabbit
New Features
Documentation