feat: support for partials

Author: TorstenDittmann

markdoc.config.json

@@ -1,6 +1,6 @@
 [
     {
-        "id": "my-site",
+        "id": "demo-site",
         "path": "apps/demo",
         "schema": {
             "path": "apps/demo/.svelte-kit/markdoc_schema.js",

packages/process/package.json

@@ -1,6 +1,6 @@
 {
     "name": "svelte-markdoc-preprocess",
-    "version": "0.1.3",
+    "version": "0.1.4",
     "description": "A Svelte preprocessor that allows you to use Markdoc.",
     "type": "commonjs",
     "keywords": [

packages/process/src/config.ts

@@ -13,6 +13,10 @@ export type Config = {
      * Absoulute path to the .svelte file exporting components for tags.
      */
     tags: string | null;
+    /**
+     * Absoulute path to the folder for partials.
+     */
+    partials: string | null;
     /**
      * Generate schema files under `./svelte-kit/markdoc-schema.json` to be used with the official [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=Stripe.markdoc-language-support).
      */

packages/process/src/helpers.ts

@@ -0,0 +1,12 @@
+import { lstatSync, readdirSync } from 'fs';
+
+export function get_all_files(path: string): string[] {
+    const files = [];
+    for (const file of readdirSync(path)) {
+        const fullPath = path + '/' + file;
+        if (lstatSync(fullPath).isDirectory())
+            get_all_files(fullPath).forEach((x) => files.push(file + '/' + x));
+        else files.push(file);
+    }
+    return files;
+}

packages/process/src/processor.ts

@@ -8,13 +8,15 @@ const processor = (
         layouts = null,
         nodes = null,
         tags = null,
+        partials = null,
         config = null,
         generateSchema = true,
     }: Config = {
         extensions: ['.markdoc'],
         layouts: null,
         nodes: null,
         tags: null,
+        partials: null,
         config: null,
         generateSchema: true,
     },
@@ -38,6 +40,7 @@ const processor = (
                 generate_schema: generateSchema,
                 nodes_file: nodes,
                 tags_file: tags,
+                partials_dir: partials,
             });
 
             return {

packages/process/src/transformer.ts

@@ -8,7 +8,13 @@ import {
     Tag,
     ConfigType,
 } from '@markdoc/markdoc';
-import { existsSync, readFileSync, writeFileSync } from 'fs';
+import {
+    existsSync,
+    lstatSync,
+    readFileSync,
+    readdirSync,
+    writeFileSync,
+} from 'fs';
 import { load as loadYaml } from 'js-yaml';
 import { parse as svelteParse, walk } from 'svelte/compiler';
 import { dirname, join } from 'path';
@@ -23,6 +29,7 @@ import {
     getNameOfDeclaration,
     isVariableStatement,
 } from 'typescript';
+import { get_all_files } from './helpers';
 
 type Var = {
     name: string;
@@ -33,13 +40,15 @@ export function transformer({
     content,
     nodes_file,
     tags_file,
+    partials_dir,
     layouts,
     generate_schema,
     config,
 }: {
     content: string;
     nodes_file: Config['nodes'];
     tags_file: Config['tags'];
+    partials_dir: Config['partials'];
     layouts: Config['layouts'];
     generate_schema: Config['generateSchema'];
     config: Config['config'];
@@ -72,6 +81,7 @@ export function transformer({
     const has_tags = Object.keys(tags).length > 0;
     const nodes = prepare_nodes(nodes_file);
     const has_nodes = Object.keys(nodes).length > 0;
+    const partials = prepare_partials(partials_dir);
 
     /**
      * add import for tags
@@ -107,12 +117,15 @@ export function transformer({
             ...config?.nodes,
             ...nodes,
         },
+        partials: {
+            ...config?.partials,
+            ...partials,
+        },
         variables: {
-            frontmatter,
             ...config?.variables,
+            frontmatter,
         },
         functions: config?.functions,
-        partials: config?.partials,
         validation: config?.validation,
     };
 
@@ -348,6 +361,24 @@ function prepare_tags(tags_file: Config['tags']): Record<string, Schema> {
     return tags;
 }
 
+function prepare_partials(
+    folder: Config['partials'],
+): Record<string, ReturnType<typeof markdocParse>> {
+    if (!folder) {
+        return {};
+    }
+
+    return get_all_files(folder).reduce<ReturnType<typeof prepare_partials>>(
+        (carry, file) => {
+            carry[file] = markdocParse(
+                readFileSync(join(folder, file), 'utf8'),
+            );
+            return carry;
+        },
+        {},
+    );
+}
+
 function each_exported_var(filepath: string): Array<[string, string]> {
     const data = readFileSync(filepath, 'utf8');
     const ast = svelteParse(data);
@@ -399,7 +430,7 @@ function create_schema(tags: Record<string, Schema>): void {
                     return;
                 }
             }
-            writeFileSync(target_file, `export default { tags: ${object} };`);
+            writeFileSync(target_file, content);
         } catch (err) {
             console.error(err);
         }