feat: add def token in tokens and renderer #3745
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @UziTech, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces support for a new 'def' (definition) token type within the markdown parsing and rendering library. It updates the parser to recognize and process this new token, and adds a corresponding renderer method that, for now, outputs an empty string. This lays the groundwork for future definition list or similar markdown features.
Highlights
- New Token Type Support: Integrated a new 'def' token type into the parser's token handling logic.
- Renderer Extension: Added a dedicated def method to the renderer, which currently produces an empty string output for 'def' tokens.
- Lexer Token Collection: Ensured that link tokens are explicitly pushed to the token array in the lexer, potentially improving token collection consistency.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds support for def tokens in the token stream and a renderer for them. The implementation looks correct and follows the existing patterns in the codebase. I've added one critical comment regarding the need to update the test suite to reflect these changes. Once the tests are updated, this should be good to merge.
|
This looks straightforward enough. My one comment is if this would work better using the preprocess hook or something. Defs can occur after the line where the corresponding link is rendered. This currently works fine because Defs sre parsed first as part of the "block" pass, and links later during the "inline" pass. However if this is to support extensions, I could see users wanting to have access to the set of Def tokens as a precursor to everything everything else so they could also be referenced in any block-level extensions. (I actually do this myself for one of my extensions that extends links) That would be a bigger refactor though. |
|
Ya that would be a much bigger refactor. Def tokens are already parsed they just aren't added to the tokens and there is no renderer for them (since they usually aren't rendered anyways) |
# [16.2.0](v16.1.2...v16.2.0) (2025-08-18) ### Features * add def token in tokens and renderer ([#3745](#3745)) ([0769124](0769124))
Marked version: 16.1.2
Description
Add
deftoken and renderer as an empty string.This will allow extensions that need to know where the defs are in the markdown.
Contributor
Committer
In most cases, this should be a different person than the contributor.