Skip to content

fix: use typescript#9

Merged
UziTech merged 7 commits into
mainfrom
typescript
Jul 17, 2025
Merged

fix: use typescript#9
UziTech merged 7 commits into
mainfrom
typescript

Conversation

@UziTech
Copy link
Copy Markdown
Owner

@UziTech UziTech commented Jul 4, 2025

This requires some changes to marked types to make Parser and Renderer outputs generic.

markedjs/marked#3722 should fix it

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a 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 @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 significantly refactors the project's build system and codebase by migrating to TypeScript. The primary goal is to enhance maintainability, improve developer experience through type safety, and modernize the bundling process with esbuild. This change also ensures that type declarations are automatically generated for seamless integration into other TypeScript projects.

Highlights

  • TypeScript Migration: The project has been migrated from JavaScript to TypeScript, with all source files (.js) converted to .ts and a new tsconfig.json added to define the TypeScript compilation settings.
  • Build Tooling Change: The build process has transitioned from rollup to esbuild for faster bundling. A new esbuild.config.js file now handles the creation of ESM and UMD bundles.
  • Type Declaration Generation: Introduced dts-bundle-generator to automatically generate a single lib/index.d.ts declaration file, ensuring proper type definitions are available for consumers of the library.
  • Dependency Updates: Updated package.json and package-lock.json to reflect the new build dependencies (esbuild, dts-bundle-generator, esbuild-plugin-umd-wrapper) and removed the old rollup and globals dependencies.
  • Codebase Refinements: Added explicit type annotations, type assertions (as HTMLElement, as unknown as MarkedParser), and non-null assertions (tokens!, renderer!) across the src files to leverage TypeScript's type safety and improve code clarity.
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 is currently in preview and 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 to provide feedback.

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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a 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 successfully migrates the project to TypeScript, significantly enhancing code quality, maintainability, and developer experience. The changes involve updating the build system from Rollup to esbuild, configuring TypeScript compilation, and refactoring the source code with comprehensive type annotations and assertions. Several improvements to parsing logic, HTML rendering robustness, and type safety have been introduced, making the codebase more reliable.

Comment thread spec/test.config.js
Comment thread src/extensions.ts
Comment thread src/extensions.ts Outdated
Comment thread src/parser.ts
Comment thread src/parser.ts
Comment thread src/renderer.ts
Comment thread src/renderer.ts
Comment thread src/renderer.ts
Comment thread src/renderer.ts
Comment thread src/renderer.ts
@UziTech UziTech merged commit f3066cb into main Jul 17, 2025
6 checks passed
@UziTech UziTech deleted the typescript branch July 17, 2025 15:37
github-actions Bot pushed a commit that referenced this pull request Jul 17, 2025
## [1.0.2](v1.0.1...v1.0.2) (2025-07-17)

### Bug Fixes

* use typescript ([#9](#9)) ([f3066cb](f3066cb))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant