Remove highlight.js typings

[WilsonGramer]

highlight.js provides its own types: https://github.com/highlightjs/highlight.js/blob/master/types/index.d.ts

Because the markdown-it and remarkable type definitions depend on these typings, this pull request cannot be merged until microsoft/DefinitelyTyped-tools#151 has been merged.

---

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. (Run with npm test YOUR_PACKAGE_NAME.)
• Follow the advice from the readme.
• Avoid common mistakes.
• Run npm run lint package-name (or tsc if no tslint.json is present).

If removing a declaration:

• Delete the package's directory.
• Add it to notNeededPackages.json.

[typescript-bot]

@WilsonGramer Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

This PR touches some part of DefinitelyTyped infrastructure, so a DT maintainer will need to review it. This is rare — did you mean to do this?

4 packages in this PR

• highlight.js on npm, on unpkg
• highlightjs on npm, on unpkg
• markdown-it on npm, on unpkg
• remarkable on npm, on unpkg

Code Reviews

Because this PR edits multiple packages, it can be merged once it's reviewed by a DT maintainer.

Status

• ✅ No merge conflicts
• ✅ Continuous integration tests have passed
• ❌ A DT maintainer needs to approve changes which affect DT infrastructure (notNeededPackages.json)

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.

---

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 49293,
  "author": "WilsonGramer",
  "headCommitAbbrOid": "ddbed2b",
  "headCommitOid": "ddbed2ba1624fedc367756e343cd2bb5b9386593",
  "mergeIsRequested": false,
  "stalenessInDays": 0,
  "lastPushDate": "2020-11-08T17:08:58.000Z",
  "reopenedDate": "2020-11-01T04:40:26.000Z",
  "lastCommentDate": "2020-11-06T01:09:01.000Z",
  "maintainerBlessed": false,
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": null,
      "files": [
        {
          "path": "notNeededPackages.json",
          "kind": "infrastructure"
        }
      ],
      "owners": null,
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    },
    {
      "name": "highlight.js",
      "files": [
        {
          "path": "types/highlight.js/highlight.js-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/highlight.js/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/highlight.js/tsconfig.json",
          "kind": "package-meta",
          "suspect": "couldn't fetch contents"
        },
        {
          "path": "types/highlight.js/tslint.json",
          "kind": "package-meta",
          "suspect": "couldn't fetch contents"
        },
        {
          "path": "types/highlight.js/v7/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/highlight.js/v7/tsconfig.json",
          "kind": "package-meta",
          "suspect": "couldn't fetch contents"
        },
        {
          "path": "types/highlight.js/v7/tslint.json",
          "kind": "package-meta",
          "suspect": "couldn't fetch contents"
        }
      ],
      "owners": [
        "nikeee",
        "sourrust",
        "joshuakgoldberg"
      ],
      "addedOwners": [],
      "deletedOwners": [
        "nikeee",
        "sourrust",
        "joshuakgoldberg"
      ],
      "popularityLevel": "Popular"
    },
    {
      "name": "highlightjs",
      "files": [
        {
          "path": "types/highlightjs/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/highlightjs/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/highlightjs/tslint.json",
          "kind": "package-meta",
          "suspect": "not the required form and not moving towards it"
        }
      ],
      "owners": [
        "ffflorian"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "markdown-it",
      "files": [
        {
          "path": "types/markdown-it/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "plantain-00",
        "rapropos",
        "duduluu"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    },
    {
      "name": "remarkable",
      "files": [
        {
          "path": "types/remarkable/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "makepost",
        "chigix",
        "bios21"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "ffflorian",
      "date": "2020-11-08T22:17:11.000Z",
      "isMaintainer": false
    },
    {
      "type": "approved",
      "reviewer": "peterblazejewicz",
      "date": "2020-11-08T20:56:37.000Z",
      "isMaintainer": false
    }
  ],
  "ciResult": "pass"
}

[typescript-bot]

🔔 @nikeee @sourrust @JoshuaKGoldberg @ffflorian @plantain-00 @rapropos @duduluu @makepost @chigix @bios21 — 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.

[typescript-bot]

@WilsonGramer The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

[ffflorian]

Okay but do the official types also support importing highlightjs (which leads to the same package)? If not, please leave the types for highlightjs where they are and edit them instead to import highlight.js. Thanks!

[WilsonGramer]

@ffflorian Sure, I just added them back. Thanks for pointing that out!

[typescript-bot]

@WilsonGramer The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

[nikeee]

There may still be issues with the types that ship with hljs itself.

highlightjs/highlight.js#2603

Don't know the status of that.

[typescript-bot]

@WilsonGramer The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

[typescript-bot]

👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings.

Let’s review the numbers, shall we?

These typings are for a version of highlightjs that doesn’t yet exist on master, so I’ve compared them with v9.12.

	9.12@master	10.1 in #49293	diff
Batch compilation
Memory usage (MiB)	39.4	70.4	+78.6%
Type count	2154	10568	+391%
Assignability cache size	104	3501	+3266% 🚨
Language service
Samples taken	17	17	0%
Identifiers in tests	17	17	0%
getCompletionsAtPosition
Mean duration (ms)	89.4	83.4	-6.7%
Mean CV	25.1%	21.8%
Worst duration (ms)	117.0	105.0	-10.3%
Worst identifier	code	code
getQuickInfoAtPosition
Mean duration (ms)	82.1	80.1	-2.3%
Mean CV	18.5%	16.9%	-8.8%
Worst duration (ms)	101.9	91.0	-10.7%
Worst identifier	value	code

Looks like there were a couple significant differences—take a look at assignability cache size to make sure everything looks ok.

[typescript-bot]

@WilsonGramer The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

[WilsonGramer]

I just updated the dependencies using old versions of highlight.js and I'm not getting type errors anymore. Since remarkable uses the typings for highlight.js@^9.7.0, I added @typings/highlight.js to the list of dependencies under types/remarkable/package.json. Now I get this error:

Error: In package.json: Dependency @types/highlight.js not in the allowed dependencies list.
Don't use a 'package.json' for @types dependencies unless this package relies on
an old version of types that have since been moved to the source repo.
For example, if package *P* used to have types on Definitely Typed at @types/P,
but now has its own types, a dependent package *D* will need to use package.json
to refer to @types/P if it relies on old versions of P's types.
In this case, please make a pull request to microsoft/DefinitelyTyped-tools adding @types/P to `packages/definitions-parser/allowedPackageJsonDependencies.txt`.

I just submitted microsoft/DefinitelyTyped-tools#158, so I'll wait for that to be merged and then run the tests again!

[typescript-bot]

@peterblazejewicz Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

[typescript-bot]

Updated numbers for you here from c4734a5.

highlightjs/v10.1

These typings are for a version of highlightjs that doesn’t yet exist on master, so I’ve compared them with v9.12.

Comparison details for highlightjs/10.1 📊

	9.12@master	10.1 in #49293	diff
Batch compilation
Memory usage (MiB)	39.2	74.5	+90.0%
Type count	2154	10568	+391%
Assignability cache size	104	3501	+3266% 🚨
Language service
Samples taken	17	17	0%
Identifiers in tests	17	17	0%
getCompletionsAtPosition
Mean duration (ms)	87.4	83.6	-4.3%
Mean CV	23.2%	21.7%
Worst duration (ms)	116.5	109.5	-6.0%
Worst identifier	code	value
getQuickInfoAtPosition
Mean duration (ms)	78.7	79.8	+1.5%
Mean CV	15.8%	16.8%	+6.5%
Worst duration (ms)	90.2	85.8	-4.9%
Worst identifier	value	value

Looks like there were a couple significant differences—take a look at assignability cache size to make sure everything looks ok.

markdown-it/v10.0

Comparison details for markdown-it/10.0 📊

	master	#49293	diff
Batch compilation
Memory usage (MiB)	79.4	81.5	+2.6%
Type count	10779	10779	0%
Assignability cache size	3516	3516	0%
Language service
Samples taken	1008	1008	0%
Identifiers in tests	1008	1008	0%
getCompletionsAtPosition
Mean duration (ms)	364.4	365.9	+0.4%
Mean CV	9.0%	8.9%
Worst duration (ms)	513.8	503.7	-2.0%
Worst identifier	pos	match
getQuickInfoAtPosition
Mean duration (ms)	372.0	374.2	+0.6%
Mean CV	8.9%	8.9%	+0.8%
Worst duration (ms)	541.1	498.2	-7.9%
Worst identifier	length	length

It looks like nothing changed too much. I won’t post performance data again unless it gets worse.

[peterblazejewicz]

LGTM!
@WilsonGramer thx!

[typescript-bot]

I just published @types/highlightjs@10.1.0 to npm.

[typescript-bot]

I just published @types/markdown-it@10.0.3 to npm.

[typescript-bot]

I just published @types/remarkable@1.7.6 to npm.

[joshgoebel]

Is this strange namespace + export function and export var the only way to include both type exports AND a default export in the same file? I see how it's kind of mixing everything into one huge blob (which also seems a bit strange to me).

highlightjs/highlight.js#2945

Is there some better way for us to do this? I find the whole ambient module thing very confusing. If anyone can assist we'd be grateful.