Support passing config with registration of the plugin

.changeset/tidy-houses-agree.md

@@ -0,0 +1,5 @@
+---
+"markdownlayer": minor
+---
+
+Support passing config with registration of the plugin which ignores markdownlayer.config.ts

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
     "cSpell.words": [
         "copyfiles",
+        "esast",
         "estree",
         "frontmatter",
         "headlessui",

examples/starter/next.config.js

@@ -5,4 +5,18 @@ const nextConfig = {
   reactStrictMode: true,
 };
 
-export default withMarkdownlayer(nextConfig);
+export default withMarkdownlayer(nextConfig); // requires markdownlayer.config.ts
+
+// You can also pass the config object to the `withMarkdownlayer` function (markdownlayer.config.ts will be ignored)
+// export default withMarkdownlayer(nextConfig, {
+//   contentDirPath: './src/content',
+//   definitions: [
+//     { type: 'LegalDoc', patterns: 'legal/*.{md,mdoc,mdx}' },
+
+//     // blog
+//     { type: 'BlogPost', patterns: 'blog/posts/*.{md,mdoc,mdx}' },
+//     { type: 'Changelog', patterns: 'blog/changelog/*.{md,mdoc,mdx}' },
+//   ],
+//   remarkPlugins: [],
+//   rehypePlugins: [rehypeSlug, rehypeAutolinkHeadings, rehypePrettyCode],
+// });

packages/markdownlayer/package.json

@@ -58,6 +58,7 @@
     "gray-matter": "4.0.3",
     "inflection": "3.0.0",
     "mdast-util-to-string": "4.0.0",
+    "object-hash": "3.0.0",
     "reading-time": "1.5.0",
     "rehype-raw": "7.0.0",
     "remark-directive": "3.0.0",
@@ -72,6 +73,7 @@
     "@types/inflection": "1.13.2",
     "@types/mdast": "4.0.3",
     "@types/mdx": "2.0.11",
+    "@types/object-hash": "3.0.6",
     "@types/shelljs": "0.8.15",
     "@types/source-map-support": "0.5.10",
     "@types/unist": "3.0.2",

packages/markdownlayer/src/core/generation/bundle.ts

@@ -144,7 +144,7 @@ function getCompileOptions({ mode, format, plugins }: GetCompileOptionsProps): C
       format: format,
 
       // configure recma plugins
-      recmaPlugins: recmaPlugins,
+      recmaPlugins: recmaPlugins ?? [],
 
       // configure remark plugins
       remarkPlugins: [
@@ -162,7 +162,7 @@ function getCompileOptions({ mode, format, plugins }: GetCompileOptionsProps): C
       ],
 
       // configure rehype plugins
-      rehypePlugins: rehypePlugins,
+      rehypePlugins: rehypePlugins ?? [],
 
       remarkRehypeOptions: remarkRehypeOptions,
     };

packages/markdownlayer/src/core/generation/config-file.ts

@@ -1,23 +1,49 @@
 import * as esbuild from 'esbuild';
 import fs from 'fs';
+import hash from 'object-hash';
 import path from 'path';
 
 import type { MarkdownlayerConfig } from '../types';
 import { ConfigNoDefaultExportError, ConfigReadError, NoConfigFoundError } from './errors';
 
 const possibleConfigFileNames = ['markdownlayer.config.ts', 'markdownlayer.config.js'];
 
+/** Represents the options for getting the configuration. */
 export type GetConfigOptions = {
+  /** The current working directory. */
   cwd: string;
+
+  /**
+   * The output folder for the compiled file.
+   *
+   * @example /Users/mike/Documents/markdownlayer/examples/starter/.markdownlayer
+   */
   outputFolder: string;
+
+  /** The configuration, if any, that is passed via the NextJS plugin. */
+  pluginConfig: MarkdownlayerConfig | undefined | null;
 };
 
+/** Represents the result of getting the configuration. */
 export type GetConfigResult = {
+  /**
+   * The hash of the configuration.
+   * This is used to determine if the configuration has changed.
+   */
   configHash: string;
+
+  /** The configuration. */
   config: MarkdownlayerConfig;
 };
 
-export async function getConfig({ cwd, outputFolder }: GetConfigOptions): Promise<GetConfigResult> {
+export async function getConfig({ cwd, outputFolder, pluginConfig }: GetConfigOptions): Promise<GetConfigResult> {
+  if (pluginConfig !== null && pluginConfig !== undefined) {
+    return {
+      configHash: hash(pluginConfig, {}),
+      config: pluginConfig,
+    };
+  }
+
   let configPath: string | null = null;
   for (const name of possibleConfigFileNames) {
     configPath = path.join(cwd, name);

packages/markdownlayer/src/core/generation/errors.ts

@@ -3,7 +3,7 @@ export class NoConfigFoundError extends Error {
     super(
       configPath
         ? `Couldn't find ${configPath}`
-        : `Could not find markdownlayer.config.ts or markdownlayer.config.js in ${cwd}`,
+        : `Could not find markdownlayer.config.ts or markdownlayer.config.js in ${cwd}. Create one or pass the config in the 'withMarkdownlayer' function.`,
     );
   }
 }

packages/markdownlayer/src/core/generation/index.ts

@@ -39,20 +39,23 @@ export type GenerateOptions = {
 
   /** Current working directory. */
   cwd?: string;
+
+  /** Plugin configuration. */
+  pluginConfig: MarkdownlayerConfig | undefined | null;
 };
 
 export async function generate(options: GenerateOptions) {
-  const { mode, cwd = process.cwd() } = options;
+  const { mode, cwd = process.cwd(), pluginConfig } = options;
 
   // close the watcher if it exists
   if (contentWatcher) {
     contentWatcher.close();
     contentWatcher = null;
   }
 
-  // get the config (compiled from the config file)
+  // get the config (provided in the plugin or compiled from the config file)
   let outputFolder = path.join(cwd, '.markdownlayer');
-  const { config, configHash } = await getConfig({ cwd, outputFolder });
+  const { config, configHash } = await getConfig({ cwd, outputFolder, pluginConfig });
 
   // generate the documents (initial)
   await generateInner({ mode, cwd, outputFolder, config, configHash });

packages/markdownlayer/src/index.ts

@@ -1,6 +1,7 @@
 import type { NextConfig } from 'next';
 import webpack from 'webpack';
 
+import { type MarkdownlayerConfig } from './core';
 import { runBeforeWebpackCompile } from './plugin';
 
 const devServerStartedRef = { current: false };
@@ -20,6 +21,12 @@ interface WebpackConfigContext {
 
 /**
  * Next.js plugin for markdownlayer.
+ * @argument nextConfig - The Next.js configuration, if any.
+ * @argument pluginConfig
+ * The markdownlayer configuration, if any.
+ * When provided, markdownlayer.config.ts will be ignored.
+ * This will become the only supported configuration method
+ * once next.config.ts is supported in https://github.com/vercel/next.js/pull/57656.
  *
  * @example
  * ```js
@@ -30,8 +37,23 @@ interface WebpackConfigContext {
  *   // My Next.js config
  * })
  * ```
+ *
+ * @example
+ * ```js
+ * // next.config.mjs
+ * import { withMarkdownlayer } from 'markdownlayer'
+ *
+ * export default withMarkdownlayer({
+ *   // My Next.js config
+ * }, {
+ *  // My markdownlayer config (will ignore markdownlayer.config.js)
+ * })
+ * ```
  */
-export function withMarkdownlayer(nextConfig?: Partial<NextConfig>): Partial<NextConfig> {
+export function withMarkdownlayer(
+  nextConfig?: Partial<NextConfig>,
+  pluginConfig?: MarkdownlayerConfig,
+): Partial<NextConfig> {
   return {
     ...nextConfig,
     onDemandEntries: {
@@ -47,7 +69,7 @@ export function withMarkdownlayer(nextConfig?: Partial<NextConfig>): Partial<Nex
         ignored: ['**/node_modules/!(.markdownlayer)/**/*'],
       };
 
-      config.plugins!.push(new MarkdownWebpackPlugin());
+      config.plugins!.push(new MarkdownWebpackPlugin(pluginConfig));
 
       if (typeof nextConfig?.webpack === 'function') {
         return nextConfig.webpack(config, options);
@@ -59,11 +81,14 @@ export function withMarkdownlayer(nextConfig?: Partial<NextConfig>): Partial<Nex
 }
 
 class MarkdownWebpackPlugin {
+  constructor(private readonly pluginConfig: MarkdownlayerConfig | undefined | null) {}
+
   apply(compiler: webpack.Compiler) {
     compiler.hooks.beforeCompile.tapPromise('MarkdownlayerWebpackPlugin', async () => {
       await runBeforeWebpackCompile({
         devServerStartedRef,
         mode: compiler.options.mode,
+        pluginConfig: this.pluginConfig,
       });
     });
   }

packages/markdownlayer/src/plugin.ts

@@ -1,16 +1,18 @@
 import type { WebpackOptionsNormalized } from 'webpack';
 
-import { generate, type GenerateOptions } from '@/core';
+import { generate, type GenerateOptions, type MarkdownlayerConfig } from '@/core';
 
 /** Seems like the next.config.js export function might be executed multiple times, so we need to make sure we only run it once */
 let markdownInitialized = false;
 
 export async function runBeforeWebpackCompile({
   mode,
   devServerStartedRef,
+  pluginConfig,
 }: {
   mode: WebpackOptionsNormalized['mode'];
   devServerStartedRef: { current: boolean };
+  pluginConfig: MarkdownlayerConfig | undefined | null;
 }) {
   if (markdownInitialized) return;
   markdownInitialized = true;
@@ -19,7 +21,7 @@ export async function runBeforeWebpackCompile({
   const prod = mode === 'production';
   if (!dev && !prod) throw new Error(`Unexpected mode: ${mode}`);
 
-  const options: GenerateOptions = { mode };
+  const options: GenerateOptions = { mode, pluginConfig };
 
   if (prod) {
     await generate(options);