[markdown-it,mdurl,linkify-it,markdown-it-emoji] update type definitions by brc-dd · Pull Request #69355 · DefinitelyTyped/DefinitelyTyped

brc-dd · 2024-04-15T07:38:19Z

Please fill in this template.

Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code. (Compile and run.)
Add or edit tests to reflect the change.
Follow the advice from the readme.
Avoid common mistakes.
Run pnpm test <package to test>.

Select one of these and delete the others:

If changing an existing definition:

Provide a URL to documentation or source code which provides context for the suggested changes: https://github.com/markdown-it/linkify-it/blob/master/CHANGELOG.md#500--2023-12-01 (markdown-it/linkify-it@4.0.1...5.0.0), https://github.com/markdown-it/mdurl/blob/master/CHANGELOG.md#200--2023-12-01 (markdown-it/mdurl@1.0.1...2.0.0), https://github.com/markdown-it/markdown-it/blob/master/CHANGELOG.md#1400---2023-12-08 (markdown-it/markdown-it@13.0.2...14.0.0) (basically syncs with the bunch of ESM rewrites done by the markdown-it team)
If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the package.json.

brc-dd · 2024-04-15T07:39:46Z

types/markdown-it/lib/common/entities.d.mts

this file is no longer present in v14 - https://unpkg.com/browse/markdown-it@14.1.0/lib/common/

brc-dd · 2024-04-15T07:40:53Z

types/markdown-it/lib/common/html_re.d.mts

wasn't converted in #68924

types/markdown-it/lib/common/utils.d.mts

brc-dd · 2024-04-15T07:42:44Z

types/markdown-it/lib/helpers/parse_link_destination.d.mts

this was left over from cjs->esm migration (#68924), and the types shouldn't contain lines: number (https://unpkg.com/browse/markdown-it@14.1.0/lib/helpers/parse_link_destination.mjs -- there is no mention of any lines property)

brc-dd · 2024-04-15T07:43:43Z

types/markdown-it/lib/helpers/parse_link_title.d.mts

the types were wrong (or likely old) here. syncs with https://unpkg.com/browse/markdown-it@14.1.0/lib/helpers/parse_link_title.mjs

brc-dd · 2024-04-15T07:47:41Z

types/markdown-it/lib/rules_block/state_block.d.mts

-    /**
-     * renderer
-     */
-    result: string;


this is not mentioned anywhere in https://unpkg.com/browse/markdown-it@14.1.0/lib/rules_block/state_block.mjs

types/markdown-it/lib/token.d.mts

types/markdown-it/tsconfig.json

types/mdurl/build/index.cjs.d.ts

types/uc.micro/package.json

typescript-bot · 2024-04-15T08:44:44Z

@brc-dd Thank you for submitting this PR!

This is a live comment which I will keep updated.

4 packages in this PR

linkify-it — on npm, on unpkg
markdown-it-emoji — on npm, on unpkg
markdown-it — on npm, on unpkg
mdurl — on npm, on unpkg

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

You can test the changes of this PR in the Playground.

Status

✅ No merge conflicts
✅ Continuous integration tests have passed
✅ A DT maintainer needs to approve changes which affect more than one package

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 69355,
  "author": "brc-dd",
  "headCommitOid": "c2f43c9fbcc2fbbdc85d77bea2faef4e9e1c7490",
  "mergeBaseOid": "1bed4c3ae1d8206236b1ffe98f96075046705813",
  "lastPushDate": "2024-04-15T07:38:19.000Z",
  "lastActivityDate": "2024-05-01T17:41:55.000Z",
  "mergeOfferDate": "2024-05-01T17:38:56.000Z",
  "mergeRequestDate": "2024-05-01T17:41:55.000Z",
  "mergeRequestUser": "brc-dd",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "linkify-it",
      "kind": "edit",
      "files": [
        {
          "path": "types/linkify-it/build/index.cjs.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/linkify-it/index.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/linkify-it/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/linkify-it/linkify-it-tests.mts",
          "kind": "test"
        },
        {
          "path": "types/linkify-it/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/linkify-it/tsconfig.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "praxxis",
        "alexplumb",
        "ragafus"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    },
    {
      "name": "markdown-it-emoji",
      "kind": "edit",
      "files": [
        {
          "path": "types/markdown-it-emoji/bare.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/bare.cjs.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/full.cjs.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/index.cjs.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/light.cjs.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/markdown-it-emoji-bare.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/markdown-it-emoji-bare.min.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/markdown-it-emoji-light.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/markdown-it-emoji-light.min.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/markdown-it-emoji.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/dist/markdown-it-emoji.min.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/index.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/lib/bare.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/lib/full.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/lib/light.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/light.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it-emoji/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/markdown-it-emoji/test/markdown-it-emoji-global.ts",
          "kind": "test"
        },
        {
          "path": "types/markdown-it-emoji/test/markdown-it-emoji.mts",
          "kind": "test"
        },
        {
          "path": "types/markdown-it-emoji/test/markdown-it-emoji.ts",
          "kind": "test"
        },
        {
          "path": "types/markdown-it-emoji/tsconfig.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/markdown-it-emoji/tsconfig.non-umd.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/markdown-it-emoji/tsconfig.umd.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "Shinigami92",
        "peterblazejewicz"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "markdown-it",
      "kind": "edit",
      "files": [
        {
          "path": "types/markdown-it/dist/index.cjs.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/dist/markdown-it.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/dist/markdown-it.min.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/common/entities.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/common/html_blocks.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/common/html_re.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/common/utils.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/helpers/parse_link_destination.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/helpers/parse_link_label.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/helpers/parse_link_title.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/index.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/parser_block.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/parser_core.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/parser_inline.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/renderer.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/ruler.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/rules_block/state_block.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/rules_inline/state_inline.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/lib/token.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/markdown-it/markdown-it-tests.mts",
          "kind": "test"
        },
        {
          "path": "types/markdown-it/markdown-it-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/markdown-it/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/markdown-it/test/common/utils.mts",
          "kind": "test"
        },
        {
          "path": "types/markdown-it/test/index.mts",
          "kind": "test"
        },
        {
          "path": "types/markdown-it/test/rules_block/state_block.mts",
          "kind": "test"
        },
        {
          "path": "types/markdown-it/tsconfig.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "plantain-00",
        "rapropos",
        "duduluu",
        "peterblazejewicz"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    },
    {
      "name": "mdurl",
      "kind": "edit",
      "files": [
        {
          "path": "types/mdurl/build/index.cjs.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/decode.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/encode.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/format.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/index.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/lib/decode.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/lib/encode.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/lib/format.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/lib/parse.d.mts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/mdurl-tests.mts",
          "kind": "test"
        },
        {
          "path": "types/mdurl/mdurl-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/mdurl/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/mdurl/parse.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/mdurl/tsconfig.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "rokt33r"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "rbuckton",
      "date": "2024-05-01T17:38:08.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "peterblazejewicz",
      "date": "2024-04-15T19:42:52.000Z",
      "abbrOid": "ba4c53d"
    }
  ],
  "mainBotCommentID": 2056235611,
  "ciResult": "pass"
}

typescript-bot · 2024-04-15T08:44:46Z

🔔 @praxxis @alexplumb @ragafus @Shinigami92 @peterblazejewicz @plantain-00 @rapropos @duduluu @Rokt33r — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

yoitsro · 2024-05-01T19:41:39Z

To be clear, I'm not even using markdown-it or linkify-it directly in my project - it's a transitive dependency of jsdoc, I think.

…safe version See DefinitelyTyped/DefinitelyTyped#69355 (comment)

brc-dd · 2024-05-01T19:47:23Z

Ah, I see. I'm not sure what's the proper way to handle this because the v13 of @types/markdown-it specifies those deps as *. Even if we update now the older versions won't have any effect. We did do a major version bump here and in #68924, but that * is pulling the latest deps.

/cc @jakebailey

yoitsro · 2024-05-01T19:49:11Z

Is it worth doing a patch release of v13 to fix the version of linkify-it it targets?

brc-dd · 2024-05-01T19:50:49Z

Is it worth doing a patch release of v13 to fix the version of linkify-it it targets?

As contributors, I don't think there is any flow in DT bot for that. Maintainers will probably have to do that manually 👀

Or maybe we can do this - https://github.com/DefinitelyTyped/DefinitelyTyped/blob/HEAD/README.md#if-a-library-is-updated-to-a-new-major-version-with-breaking-changes-how-should-i-update-its-type-declaration-package - create types/markdown-it/v13 with v13 code and updated package.json 👀

yoitsro · 2024-05-01T19:56:27Z

Ouch! Is it something the @DefinitelyTyped team could look at @rbuckton?

If not, and sorry to drag you in here, but @hegemonic, you might need to manually set the version of linkify-it which is used in jsdoc sooner rather than later.

jakebailey · 2024-05-01T19:56:51Z

The first thing to do is to revert this PR. If you want to resurrect and old version of a DT package, you'll have to pull it out of git history and make a subdir.

jakebailey · 2024-05-01T19:59:26Z

@brc-dd Are you sending the revert? Or should I?

brc-dd · 2024-05-01T20:00:13Z

Ah do it. I'm creating the subdir PR in meanwhile.

@brc-dd

…t,markdown-it-emoji] update type definitions by @brc-dd" This reverts commit d152bf8.

jakebailey · 2024-05-01T20:12:13Z

Actually, I didn't realize this PR bumped the major versions of linkify-it, markdown-it-emoji, and mdurl. Reverting isn't going to unpublish those changes.

brc-dd · 2024-05-01T20:33:58Z

It'll still break for people on markdown-it v12. Apparently the usage of v12 is 16 times v13 🥲

v13.0.8 should fix this for v13 users.

jakebailey · 2024-05-01T21:28:07Z

It'll still break for people on markdown-it v12. Apparently the usage of v12 is 16 times v13 🥲

Yeah, that would also need to be pulled back into the repo for a release, if you want those to be fixed without package manager locking or resolution overrides.

rajsite · 2024-05-01T21:31:21Z

Verified @types/markdown-it@13.0.8 prevented build issues for me, thanks! 👍

Hopefully this fixes the [TypeScript compilation issues](DefinitelyTyped/DefinitelyTyped#69355 (comment)) reported in DefinitelyTyped/DefinitelyTyped#69355. To my surprise, all of these updated packages appear to be compatible with Node.js 12.0.0, which is what JSDoc 4.x claims to support.

hegemonic · 2024-05-02T03:19:31Z

@yoitsro and other JSDoc users: I just published JSDoc 4.0.3, which should fix the build issue. If you're still seeing issues after you upgrade, please file a bug. Thanks for the heads up!

Typing update (DefinitelyTyped/DefinitelyTyped#69355).

brc-dd added 3 commits April 15, 2024 12:21

update mdit definitions

eabd224

minor bump

01f910e

regenerate

ba4c53d

brc-dd commented Apr 15, 2024

View reviewed changes

split adding defs to separate pr

6707f20

brc-dd changed the title ~~[markdown-it,mdurl] Fix broken definitions and add types for uc.micro~~ [markdown-it,mdurl] Fix broken definitions and sync doc comments Apr 15, 2024

restore tsconfig.files

52fefd1

brc-dd changed the title ~~[markdown-it,mdurl] Fix broken definitions and sync doc comments~~ [markdown-it,mdurl] Update type definitions and sync doc comments Apr 15, 2024

brc-dd added 4 commits April 15, 2024 13:35

format

09f8d85

fix exports

d9d610e

update tests

28950b3

another try

2dce2a1

brc-dd marked this pull request as ready for review April 15, 2024 08:43

brc-dd requested a review from peterblazejewicz as a code owner April 15, 2024 08:43

typescript-bot added Critical package Edits multiple packages labels Apr 15, 2024

brc-dd added 2 commits April 15, 2024 14:16

fix import

0d2a355

fix types

b7ac4bc

brc-dd marked this pull request as draft April 15, 2024 08:55

brc-dd closed this Apr 15, 2024

brc-dd added 6 commits April 15, 2024 19:19

update linkify-it definitions

a1ec145

update mdurl types

ce18f27

update mdit esm types

531a3e8

update mdit esm types

8976d0a

update cjs types

1e4af17

align class defs and dont export as namespace for non-umd files

e85ce1d

brc-dd reopened this Apr 15, 2024

brc-dd marked this pull request as ready for review April 15, 2024 16:15

rajsite added a commit to ni/nimble that referenced this pull request May 1, 2024

Add explicit peerDep on @types/linkify-it so hopefully resolves to a …

e51d06d

…safe version See DefinitelyTyped/DefinitelyTyped#69355 (comment)

rajsite mentioned this pull request May 1, 2024

Update npm dependencies update to latest ni/nimble#2056

Merged

1 task

rajsite mentioned this pull request May 1, 2024

Create spright-components package ni/nimble#1986

Merged

1 task

rajsite mentioned this pull request May 1, 2024

Remove peerDependency on @types/linkify-it ni/nimble#2061

Closed

jakebailey added a commit to jakebailey/DefinitelyTyped that referenced this pull request May 1, 2024

Revert "🤖 Merge PR DefinitelyTyped#69355 [markdown-it,mdurl,linkify-i…

fef0b3e

…t,markdown-it-emoji] update type definitions by @brc-dd" This reverts commit d152bf8.

jakebailey mentioned this pull request May 1, 2024

Revert "🤖 Merge PR #69355 [markdown-it,mdurl,linkify-it,markdown-it-emoji] update type definitions by @brc-dd" #69491

Closed

brc-dd mentioned this pull request May 1, 2024

[markdown-it]: specify dependency versions on markdown-it v13 #69492

Merged

16 tasks

Balearica mentioned this pull request May 8, 2024

Request: add package-lock.json file (npm run build broken) konvajs/konva#1757

Closed

marmitar added a commit to marmitar/thelounge that referenced this pull request Nov 17, 2025

chore(deps): update linkify-it to v5

1142c14

Typing update (DefinitelyTyped/DefinitelyTyped#69355).

marmitar added a commit to marmitar/thelounge that referenced this pull request Jan 31, 2026

chore(deps): update linkify-it to v5

ba3e102

Typing update (DefinitelyTyped/DefinitelyTyped#69355).

marmitar added a commit to marmitar/thelounge that referenced this pull request Feb 11, 2026

chore(deps): update linkify-it to v5

a5bc9bc

Typing update (DefinitelyTyped/DefinitelyTyped#69355).

Conversation

brc-dd commented Apr 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brc-dd Apr 15, 2024

Choose a reason for hiding this comment

Uh oh!

brc-dd Apr 15, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

brc-dd Apr 15, 2024

Choose a reason for hiding this comment

Uh oh!

brc-dd Apr 15, 2024

Choose a reason for hiding this comment

Uh oh!

brc-dd Apr 15, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

typescript-bot commented Apr 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

4 packages in this PR

Code Reviews

Status

Uh oh!

typescript-bot commented Apr 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yoitsro commented May 1, 2024

Uh oh!

brc-dd commented May 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yoitsro commented May 1, 2024

Uh oh!

brc-dd commented May 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yoitsro commented May 1, 2024

Uh oh!

jakebailey commented May 1, 2024

Uh oh!

jakebailey commented May 1, 2024

Uh oh!

brc-dd commented May 1, 2024

Uh oh!

jakebailey commented May 1, 2024

Uh oh!

brc-dd commented May 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jakebailey commented May 1, 2024

Uh oh!

rajsite commented May 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hegemonic commented May 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

brc-dd commented Apr 15, 2024 •

edited

Loading

typescript-bot commented Apr 15, 2024 •

edited

Loading

typescript-bot commented Apr 15, 2024 •

edited

Loading

brc-dd commented May 1, 2024 •

edited

Loading

brc-dd commented May 1, 2024 •

edited

Loading

brc-dd commented May 1, 2024 •

edited

Loading

rajsite commented May 1, 2024 •

edited

Loading