🤖 Merge PR DefinitelyTyped#74226 feat(markdown-it-container): retain v2 types, add proper v4 types by @hkleungai

Author: hkleungai

types/markdown-it-container/.npmignore

@@ -3,3 +3,4 @@
 !**/*.d.cts
 !**/*.d.mts
 !**/*.d.*.ts
+/v2/

types/markdown-it-container/index.d.mts

@@ -0,0 +1,5 @@
+import MarkdownItContainer = require("./index.js");
+
+export type ContainerOpts = MarkdownItContainer.ContainerOpts;
+
+export default MarkdownItContainer;

types/markdown-it-container/index.d.ts

@@ -1,11 +1,10 @@
 import MarkdownIt = require("markdown-it");
-import Renderer = require("markdown-it/lib/renderer");
 
 declare namespace MarkdownItContainer {
     interface ContainerOpts {
         marker?: string | undefined;
         validate?(params: string): boolean;
-        render?: Renderer.RenderRule | undefined;
+        render?: MarkdownIt.Renderer.RenderRule | undefined;
     }
 }
 

types/markdown-it-container/package.json

@@ -1,12 +1,22 @@
 {
     "private": true,
     "name": "@types/markdown-it-container",
-    "version": "2.0.9999",
+    "version": "4.0.9999",
     "projects": [
         "https://github.com/markdown-it/markdown-it-container"
     ],
+    "exports": {
+        ".": {
+            "require": "./index.d.ts",
+            "import": "./index.d.mts"
+        },
+        "./*": {
+            "require": "./*",
+            "import": "./*"
+        }
+    },
     "dependencies": {
-        "@types/markdown-it": "<14"
+        "@types/markdown-it": ">=14"
     },
     "devDependencies": {
         "@types/markdown-it-container": "workspace:."

types/markdown-it-container/tsconfig.json

@@ -14,6 +14,7 @@
     },
     "files": [
         "index.d.ts",
+        "index.d.mts",
         "markdown-it-container-tests.ts"
     ]
 }

types/markdown-it-container/v2/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/markdown-it-container/v2/index.d.ts

@@ -0,0 +1,14 @@
+import MarkdownIt = require("markdown-it");
+import Renderer = require("markdown-it/lib/renderer");
+
+declare namespace MarkdownItContainer {
+    interface ContainerOpts {
+        marker?: string | undefined;
+        validate?(params: string): boolean;
+        render?: Renderer.RenderRule | undefined;
+    }
+}
+
+declare function MarkdownItContainer(md: MarkdownIt, name: string, opts: MarkdownItContainer.ContainerOpts): void;
+
+export = MarkdownItContainer;

types/markdown-it-container/v2/markdown-it-container-tests.ts

@@ -0,0 +1,36 @@
+import MarkdownIt = require("markdown-it");
+
+import MarkdownItContainer = require("markdown-it-container");
+
+const md = new MarkdownIt();
+
+md.use(MarkdownItContainer, "spoiler", {
+    validate: (params: string) => params.trim().match(/^spoiler\s+(.*)$/),
+    render: (tokens: MarkdownIt.Token[], index: number) => {
+        const match = tokens[index].info.trim().match(/^spoiler\s+(.*)$/);
+        const onClick = "this.parentNode.classList.toggle('_expanded');" + "event.preventDefault();";
+
+        if (tokens[index].nesting === 1) {
+            return (
+                // tslint:disable-next-line prefer-template
+                "<div class=\"markdown__spoiler\">\n"
+                + "<div class=\"markdown__spoiler-title\" onclick=\""
+                + onClick
+                + "\">\n"
+                + md.utils.escapeHtml((match && match[1]) || "")
+                + "\n"
+                + "</div>\n"
+                + "<div class=\"markdown__spoiler-content\">\n"
+            );
+        } else {
+            return "</div></div>\n";
+        }
+    },
+    marker: "marker",
+});
+
+const src = `:::spoiler This Is Spoiler Title
+Here is spoiler content.
+:::`;
+
+md.render(src);

types/markdown-it-container/v2/package.json

@@ -0,0 +1,20 @@
+{
+    "private": true,
+    "name": "@types/markdown-it-container",
+    "version": "2.0.9999",
+    "projects": [
+        "https://github.com/markdown-it/markdown-it-container"
+    ],
+    "dependencies": {
+        "@types/markdown-it": "<14"
+    },
+    "devDependencies": {
+        "@types/markdown-it-container": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Vyacheslav Demot",
+            "githubUsername": "hronex"
+        }
+    ]
+}

types/markdown-it-container/v2/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "markdown-it-container-tests.ts"
+    ]
+}