[BUG] transform entry emptied in markdown-magic configuration file

[ioncakephper]

Fixes #20

[gemini-code-assist]

Summary of Changes

Hello @ioncakephper, I'm Gemini Code Assist¹! 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 addresses a critical bug where the transformDefaults entry in the markdown-magic configuration file (md.config.js) was being inadvertently emptied or corrupted during updates. The core of the fix involves a substantial refactoring of the configuration update logic to ensure that only the relevant sections are modified, thereby preserving the file's integrity and preventing data loss. Concurrently, file descriptions for the fileTreeExtended transform have been externalized into a new JSON file, streamlining the configuration and documentation generation process and improving maintainability.

Highlights

• Refactored Configuration Update Logic: The mechanism for updating the markdown-magic configuration file (md.config.js) has been significantly improved. Instead of completely overwriting the file, the src/describe.js utility now uses a more robust regex-based approach to selectively update only the transformDefaults section, preserving comments and the overall file structure.
• Externalized File Descriptions: File descriptions for the fileTreeExtended transform, previously embedded directly within md.config.js, have been moved to a new dedicated file named _descriptions.json. This centralizes and simplifies the management of file descriptions.
• Updated Build and Documentation Generation Process: The prep script in package.json has been updated to include the generation of file descriptions (npm run describe:file) as an initial step before other documentation and linting tasks. This ensures that the documentation always reflects the latest file descriptions.
• Documentation and Debugging Enhancements: The README.md has been updated to reflect the new _descriptions.json file and the revised prep script. Additionally, a new VS Code launch configuration has been added to .vscode/launch.json to facilitate debugging the CLI with specific markdown-magic arguments.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request successfully fixes a critical bug where updating the markdown-magic configuration file would corrupt it by removing non-JSON elements. The new approach of reading the file, replacing only the relevant section, and writing it back is a great improvement. However, the changes also introduce a significant regression in the project's documentation. By moving file descriptions from md.config.js to a new _descriptions.json file, the previously detailed, human-written descriptions have been lost and replaced with 'Description unavailable.' in the README. My review includes high-severity comments urging the restoration of these descriptions before merging. I've also included a medium-severity suggestion to make the configuration update logic even more robust in the future by using an AST parser instead of regular expressions.