DA-1354: Added test for the H1 content

[VirajAgarwal1]

• Added cheerio and marked dependencies
• Implemented H1 validation against frontmatter title in markdown files
• Created utility functions for frontmatter extraction and H1 detection

[gemini-code-assist]

Summary of Changes

Hello @VirajAgarwal1, 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 enhances content quality checks by implementing a new validation process for markdown files. It ensures that the primary heading (H1) within a markdown document, if present, accurately reflects the title defined in its frontmatter. This consistency check is crucial for maintaining structured and semantically correct documentation, improving readability and searchability. The changes involve adding external parsing libraries and creating modular utility functions, which are then integrated into the existing testing framework to automatically enforce these new content standards.

Highlights

• New H1 Content Validation: Introduced a new test to ensure that markdown files either have no H1 tags or exactly one H1 tag that matches the 'title' specified in their frontmatter.
• Dependency Additions: Integrated 'cheerio' and 'marked' libraries to facilitate parsing markdown content and extracting H1 tags.
• Frontmatter and H1 Utility Functions: Developed new utility functions to programmatically extract frontmatter from markdown content, remove it, and identify H1 headings within the content.
• Enhanced Markdown Testing: The existing markdown frontmatter validation script ('test-markdown-frontmatter.js') has been updated to incorporate this new H1 validation, providing a more comprehensive check for content consistency.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 introduces a new validation test to ensure that the H1 heading in markdown files matches the title specified in the frontmatter, a valuable addition for maintaining content consistency. However, a high-severity insecure deserialization vulnerability was identified in the extract_frontmatter_from_tutorial.js utility file due to the use of the unsafe yaml.load function; it is recommended to replace it with yaml.safeLoad to prevent potential remote code execution. Additionally, my review includes suggestions to improve error handling consistency in the main test script, enhance code portability by using standard regex patterns, and refactor some of the new functions for better maintainability and style.