-
-
Notifications
You must be signed in to change notification settings - Fork 0
Import remark definition links #72
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: dev
Are you sure you want to change the base?
Conversation
this is based on https://github.com/remarkjs/remark-reference-links and https://github.com/remarkjs/remark-defsplit in that it converts inline links to a definition list, but unlike https://github.com/remarkjs/remark-defsplit it puts them all at the bottom Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
…ppend numeric if there's a dupe Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
… a link Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: Logan McAnsh <[email protected]>
* chore(deps): bump to latest, add prettier-plugin-organize-imports Signed-off-by: GitHub <[email protected]> * chore: run prettier Signed-off-by: GitHub <[email protected]> * test: update assertions Signed-off-by: GitHub <[email protected]> * test: update workflows Signed-off-by: GitHub <[email protected]> * chore: add .node-version file with version 22 Signed-off-by: GitHub <[email protected]> * chore: add packageManager field to package.json Signed-off-by: GitHub <[email protected]> * chore: update tsconfig.json schema and compiler options Signed-off-by: GitHub <[email protected]> * feat: build with tsdown Signed-off-by: GitHub <[email protected]> * chore: update tsconfig Signed-off-by: GitHub <[email protected]> * chore: remove glob in favor of built in Signed-off-by: GitHub <[email protected]> * feat: rewrite the library Signed-off-by: GitHub <[email protected]> * chore: move fixtures directory to root level, move test file to src directory Signed-off-by: GitHub <[email protected]> * fix: adjust path separators in test assertions for cross-platform compatibility Signed-off-by: GitHub <[email protected]> * feat: add artifact upload for failed tests in CI workflow Signed-off-by: GitHub <[email protected]> * ci Signed-off-by: GitHub <[email protected]> * feat: update test workflow to upload failed fixtures and improve test setup Signed-off-by: GitHub <[email protected]> * x Signed-off-by: GitHub <[email protected]> * x Signed-off-by: GitHub <[email protected]> * test: add windows processed files Signed-off-by: GitHub <[email protected]> * chore: remove shit Signed-off-by: GitHub <[email protected]> * test: pls forgive me for i have lost all sense of humanity Signed-off-by: GitHub <[email protected]> * x Signed-off-by: GitHub <[email protected]> * x Signed-off-by: GitHub <[email protected]> * y Signed-off-by: GitHub <[email protected]> * z Signed-off-by: GitHub <[email protected]> * test: normalize line endings Signed-off-by: GitHub <[email protected]>
…efinition-links Signed-off-by: Logan McAnsh <[email protected]>
|
❌ 1 Tests Failed:
View the top 1 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
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.
Summary of Changes
Hello @mcansh, 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 primarily focuses on integrating and testing a new remark plugin, remark-definition-links, into the project. This plugin is designed to convert inline links in Markdown to a definition list, placing them at the bottom of the document. The extensive addition of Markdown files under packages/remark-definition-links/fixtures/ serves as comprehensive test cases and documentation examples for the new plugin's functionality, covering various aspects of Remix API, guides, and pages. Minor adjustments to project configuration files (package.json and .prettierignore) support the inclusion and proper handling of this new package.
Highlights
- New Remark Plugin Integration: A new
remarkplugin,remark-definition-links, has been integrated. This plugin automatically converts inline Markdown links into a neatly organized definition list at the bottom of the document, improving readability and document structure. - Comprehensive Fixture and Documentation Additions: An extensive collection of Markdown files has been added under
packages/remark-definition-links/fixtures/. These files serve as comprehensive test cases and detailed documentation examples, showcasing the new plugin's functionality across various Remix documentation sections, including API references, guides, and general pages. - Project Configuration Updates: Minor configuration adjustments were made across the project's
package.jsonfiles and.prettierignore. These updates ensure proper build processes, dependency management, and code formatting for the newly introducedremark-definition-linkspackage and its associated fixture files.
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. ↩
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
packages | 246d7db | Commit Preview URL Branch Preview URL |
Aug 20 2025, 09:38 PM |
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.
Code Review
This pull request introduces a new package, @mcansh/remark-definition-links, which is a remark plugin designed to convert inline links into definition links. The PR also includes extensive test fixtures for this new package. Other changes primarily involve reformatting package.json files due to an update in the Prettier plugin for sorting JSON. While the new package is a great addition, I've found a critical issue in its core logic that needs to be addressed.
Signed-off-by: Logan McAnsh <[email protected]>
commit: |
Signed-off-by: Logan McAnsh <[email protected]>
Signed-off-by: GitHub <[email protected]>
…with no alt text Signed-off-by: GitHub <[email protected]>
…essary settings Signed-off-by: GitHub <[email protected]>
Signed-off-by: GitHub <[email protected]>
Signed-off-by: GitHub <[email protected]>
No description provided.