Migrate Core Patches to TypeScript by yihao03 · Pull Request #2853 · MarkBind/markbind

yihao03 · 2026-03-04T10:28:27Z

What is the purpose of this pull request?

Overview of changes:
Migrated nunjucks, htmlparser2 and markdown-it patches to TypeScript and ESM.

Anything you'd like to highlight/discuss:
As these patches are modifying the internals of the npm packages, the types
we worked on are not exposed in the @types packages. We have to do module augmentation
to add the types that we are patching. Considering that the packages haven't been updated
in a while and will likely not be updated in the near future, we are fine with this approach.

Testing instructions:
Pull this branch and run npm run setup to make sure exisitng .js files are cleaned
and .ts files are compiled. Then run npm test to make sure all tests are passing.

Proposed commit message: (wrap lines at 72 characters)
Migrated nunjucks, htmlparser2 and markdown-it patches to TypeScript and ESM.

Checklist: ☑️

Updated the documentation for feature additions and enhancements
Added tests for bug fixes or features
Linked all related issues
No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

Major (when you make incompatible API changes)
Minor (when you add functionality in a backward compatible manner)
Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

what was the old feature that was made obsolete

any replacement feature (if any), and

how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

created module augmentation in .d.ts files for components patches, with types inferred by studying the usage in the node_modules src files. added tsc compiled .js files to .gitignore and prevent .d.ts files from being ignored Ignore compiled js and patched ts from linting

codecov · 2026-03-04T10:31:57Z

Codecov Report

❌ Patch coverage is 76.14679% with 26 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.89%. Comparing base (5a90880) to head (2834c80).
⚠️ Report is 6 commits behind head on master.

Files with missing lines	Patch %	Lines
...re/src/patches/nunjucks/context-overrides-frame.ts	57.14%	24 Missing ⚠️
packages/core/src/patches/nunjucks/load-event.ts	81.81%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2853      +/-   ##
==========================================
- Coverage   71.92%   71.89%   -0.03%     
==========================================
  Files         132      132              
  Lines        7358     7359       +1     
  Branches     1516     1542      +26     
==========================================
- Hits         5292     5291       -1     
+ Misses       2021     1967      -54     
- Partials       45      101      +56

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot

Pull request overview

This PR migrates MarkBind’s internal “core patches” (monkey-patches applied to nunjucks, htmlparser2, and a markdown-it custom-component patch set) from CommonJS .js files to TypeScript sources, and adds local .d.ts files to type internal/unstable APIs that aren’t covered by upstream @types/* packages.

Changes:

Converted patch entrypoints from *.js to *.ts and updated exports/imports accordingly.
Added manual TypeScript declaration files for patched/hidden internals (nunjucks submodules + internals, htmlparser2 internals).
Updated ignore lists to avoid committing compiled patch outputs while still tracking the “manual” declaration files.

Reviewed changes

Copilot reviewed 13 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/core/src/patches/nunjucks/nunjucks-submodules.d.ts	Adds ambient module declarations for untyped nunjucks internal submodules.
packages/core/src/patches/nunjucks/nunjucks-internals.d.ts	Adds module augmentations for nunjucks internals used by MarkBind patches.
packages/core/src/patches/nunjucks/load-event.ts	Migrates the nunjucks “load event” patch to TS + ES imports.
packages/core/src/patches/nunjucks/index.ts	TS patch entrypoint (side-effect imports).
packages/core/src/patches/nunjucks/index.js	Removes old CommonJS entrypoint.
packages/core/src/patches/nunjucks/context-overrides-frame.ts	Migrates and types the MarkBind context/frame priority patch.
packages/core/src/patches/index.ts	Migrates patch aggregator to TS and wires ignore-tag injections.
packages/core/src/patches/index.js	Removes old CommonJS patch aggregator.
packages/core/src/patches/htmlparser2.ts	Migrates htmlparser2 patch to TS + ES imports and exports.
packages/core/src/patches/htmlparser2-internal.d.ts	Adds declaration augmentation for htmlparser2 internals used by the patch.
packages/core/src/lib/markdown-it/patches/custom-component/inlineTags.ts	Converts export style to TS-friendly `export =`.
packages/core/src/lib/markdown-it/patches/custom-component/htmlRe.ts	Converts to named ESM exports.
packages/core/src/lib/markdown-it/patches/custom-component/htmlInlineRule.ts	Migrates to TS imports/exports and adds types.
packages/core/src/lib/markdown-it/patches/custom-component/htmlBlockRule.ts	Migrates to TS imports/exports and adds types.
packages/core/src/lib/markdown-it/patches/custom-component/customComponentPlugin.ts	Migrates plugin wiring to TS imports/exports and adds types.
.gitignore	Ignores compiled patch JS outputs; attempts to unignore manual `.d.ts` files.
.eslintignore	Ignores compiled patch JS outputs for linting.

Comments suppressed due to low confidence (3)

packages/core/src/patches/htmlparser2.ts:465

injectIgnoreTags is typed as string[], but the caller path (PluginManager -> patches.ignoreTags) passes a Set of tags. Since the implementation only spreads the input, it can support any iterable; consider changing the parameter type to Iterable<string> (or readonly string[]) and converting to an array before spreading if needed.
packages/core/src/lib/markdown-it/patches/custom-component/customComponentPlugin.ts:41
injectTags is typed as tagsToIgnore: string[], but the upstream call path (PluginManager -> patches.ignoreTags) passes a Set of tags. Consider widening this (and the customComponentPlugin parameter) to Iterable<string> / ReadonlySet<string> | readonly string[] so the existing call-site type-checks without forcing an array conversion.
packages/core/src/lib/markdown-it/patches/custom-component/htmlBlockRule.ts:6
initCustomComponentHtmlBlockRule is typed to take string[], but the surrounding logic (Array.from(tagsToIgnore)) works with any iterable and the upstream caller provides a Set of tags. Widening this parameter to Iterable<string> (or accepting Set<string> | string[]) would align with actual usage and avoid type errors once the caller is updated.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/core/src/patches/index.ts

gerteck

Highlighted some parts of the code that needs a further look and update, but generally looks good

packages/core/src/lib/markdown-it/patches/custom-component/customComponentPlugin.ts

packages/core/src/lib/markdown-it/patches/custom-component/htmlInlineRule.ts

packages/core/src/patches/nunjucks/context-overrides-frame.ts

gerteck · 2026-03-05T08:23:07Z

packages/core/src/patches/nunjucks/nunjucks-internals.d.ts

+// ---------------------------------------------------------------------------
+// Sub-module: nunjucks/src/runtime
+// ---------------------------------------------------------------------------
+declare module 'nunjucks/src/runtime' {


Duplicated nunjucks/src/runtime and nunjucks/src/object declarations in

internals.d.ts and

submodule.d.ts

Any reason why it was duplicated? Should it be removed from internals.d.ts?

nunjucks-submodules.d.ts exists solely to create the sub-modules (nunjucks/src/runtime, nunjucks/src/object) as ambient declarations.

nunjucks-internals.d.ts exists to augment the main nunjucks module, big declare module 'nunjucks' block at the bottom is its unique, non-duplicated work.

The sub-module blocks in it are dead weight that snuck in.
So the rule is: whoever creates something owns it. nunjucks-submodules.d.ts created the sub-modules, so it should keep the duplicated code. Delete the duplicate sub-module blocks from nunjucks-internals.d.ts.

packages/core/src/patches/index.ts

gerteck · 2026-03-08T06:53:32Z

Todos:

Update imports to type imports where applicable
Update duplicated type declaration
Update string[] type to iterable type or as appropriate according to current usage

👍

gerteck

lgtm

yihao03 added 3 commits March 4, 2026 15:05

Rename nunjucks patches to ts

b8ef944

Rename core/src/patches to ts

1214b28

yihao03 requested a review from Copilot March 4, 2026 10:28

Copilot started reviewing on behalf of yihao03 March 4, 2026 10:29 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

packages/core/src/patches/index.ts Outdated Show resolved Hide resolved

yihao03 requested review from Harjun751, MoshiMoshiMochi and gerteck March 4, 2026 13:37

yihao03 force-pushed the feat/migrate-core-patch branch from 0aa1499 to ea62ea3 Compare March 4, 2026 13:51

yihao03 added this to 2026 MarkBind Roadmap Mar 5, 2026

gerteck reviewed Mar 5, 2026

View reviewed changes

gerteck requested changes Mar 8, 2026

View reviewed changes

yihao03 added 3 commits March 8, 2026 17:33

Migrate core/src/patches to ts

11dc0ce

Rename core/src/lib/markdown-it/patches to TypeScript

9d91445

Adapt core/src/lib/markdown-it/patches to TypeScript

2834c80

yihao03 force-pushed the feat/migrate-core-patch branch from ea62ea3 to 2834c80 Compare March 8, 2026 09:34

gerteck approved these changes Mar 8, 2026

View reviewed changes

gerteck merged commit 6b37843 into MarkBind:master Mar 8, 2026
10 checks passed

github-actions bot added the r.Patch Version resolver: increment by 0.0.1 label Mar 8, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate Core Patches to TypeScript#2853

Migrate Core Patches to TypeScript#2853
gerteck merged 6 commits intoMarkBind:masterfrom
yihao03:feat/migrate-core-patch

yihao03 commented Mar 4, 2026 •

edited by gerteck

Loading

Uh oh!

codecov bot commented Mar 4, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

gerteck left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gerteck Mar 5, 2026

Uh oh!

gerteck Mar 5, 2026

Uh oh!

Uh oh!

gerteck commented Mar 8, 2026

Uh oh!

gerteck left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

yihao03 commented Mar 4, 2026 • edited by gerteck Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

gerteck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gerteck Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

gerteck Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gerteck commented Mar 8, 2026

Uh oh!

gerteck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

yihao03 commented Mar 4, 2026 •

edited by gerteck

Loading

codecov bot commented Mar 4, 2026 •

edited

Loading