fix(remark): resolve local plugins from process.cwd()

Author: tgreyuk

.changeset/bright-sloths-raise.md

@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-remark': patch
+---
+
+- Resolve local plugins from `process.cwd()`.

packages/typedoc-plugin-remark/src/index.ts

@@ -8,6 +8,7 @@ import { Application, DeclarationOption, RendererEvent } from 'typedoc';
 import { MarkdownPageEvent } from 'typedoc-plugin-markdown';
 import * as options from './options/declarations.js';
 import { addTableOfContents } from './options/helpers.js';
+import { parseContents } from './remark.js';
 
 export function load(app: Application) {
   Object.entries(options).forEach(([name, option]) => {
@@ -33,7 +34,6 @@ export function load(app: Application) {
     if (output.urls?.length) {
       await Promise.all(
         output.urls?.map(async (urlMapping) => {
-          const { parseContents } = await import('./remark.js');
           const filePath = `${output.outputDirectory}/${urlMapping.url}`;
           const remarkStringifyOptions = app.options.getValue(
             'remarkStringifyOptions',

packages/typedoc-plugin-remark/src/remark.ts

@@ -1,11 +1,7 @@
+import * as path from 'path';
 import { remark } from 'remark';
 import { read, writeSync } from 'to-vfile';
 
-/**
- * Parses contents with Remark
- * - The remark eco-system is esm only, therefore we have to import its modules synchronously.
- * - In addition we don't want Typescript to transpile this file.
- */
 export async function parseContents(
   filePath: string,
   remarkStringifyOptions = {},
@@ -23,8 +19,14 @@ export async function parseContents(
   const promises = plugins.map(async (plugin) => {
     return new Promise((resolve) => {
       const name = Array.isArray(plugin) ? plugin[0] : plugin;
+      const isLocalPath =
+        name !== './normalize-tables.mjs' &&
+        /^\.{1,2}\/|^\//.test(name as string);
+      const fullPath = isLocalPath
+        ? path.resolve(process.cwd(), name as string)
+        : name;
       const options = Array.isArray(plugin) ? plugin[1] : {};
-      import(name as string).then(({ default: pluginFn }) => {
+      import(fullPath as string).then(({ default: pluginFn }) => {
         resolve({
           pluginFn,
           options,

packages/typedoc-plugin-remark/test/frontmatter-plugin.cjs renamed to packages/typedoc-plugin-remark/test/frontmatter-plugin.mjs

@@ -1,7 +1,6 @@
-function load(app) {
+export function load(app) {
   app.renderer.markdownHooks.on(
     'page.begin',
     () => `---\ntitle: "test"\n---\n`,
   );
 }
-exports.load = load;

packages/typedoc-plugin-remark/test/local-plugin.mjs

@@ -0,0 +1,9 @@
+import { visit } from 'unist-util-visit';
+
+export default function remarkAddKeyword() {
+  return (tree) => {
+    visit(tree, 'code', (node) => {
+      node.meta = `playground`;
+    });
+  };
+}

packages/typedoc-plugin-remark/test/specs/__snapshots__/remark.spec.ts.snap

@@ -183,6 +183,10 @@ Comments form module comments
 
 Thanks [**@tgrey**](https://github.com/tgrey) please see issue [#1](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/1).
 
+\`\`\`js
+const x = 1
+\`\`\`
+
 ## Index
 
 ### Classes
@@ -220,6 +224,10 @@ Comments form module comments
 
 Thanks [**@tgrey**](https://github.com/tgrey) please see issue [#1](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/1).
 
+~~~js playground
+const x = 1
+~~~
+
 ## Contents
 
 + [Classes](#classes)

packages/typedoc-plugin-remark/test/stubs/module-1.ts

@@ -3,6 +3,10 @@
  *
  * Thanks \@tgrey please see issue #1.
  *
+ * ```js
+ * const x = 1
+ * ```
+ *
  * @module
  */
 

packages/typedoc-plugin-remark/test/typedoc.base.json

@@ -5,7 +5,7 @@
   "plugin": [
     "typedoc-plugin-markdown",
     "typedoc-plugin-remark",
-    "./frontmatter-plugin.cjs"
+    "./frontmatter-plugin.mjs"
   ],
   "readme": "none",
   "parametersFormat": "htmlTable",

packages/typedoc-plugin-remark/test/typedoc.modules.json

@@ -3,5 +3,9 @@
   "entryPoints": ["./stubs/*.ts"],
   "outputFileStrategy": "modules",
   "remarkStringifyOptions": { "bullet": "+", "fence": "~" },
-  "remarkPlugins": ["remark-github", ["remark-toc", { "maxDepth": 3 }]]
+  "remarkPlugins": [
+    "remark-github",
+    ["remark-toc", { "maxDepth": 3 }],
+    "./test/local-plugin.mjs"
+  ]
 }