feat(#65): Add rehype configuration namespace. Add missing test

Author: javierbrea

.github/workflows/test-e2e.yml

@@ -7,6 +7,7 @@ on:
   push:
     branches:
       - main
+      - origin/feat/65/rehype-codeblocks
 
 permissions:
   contents: read

components/markdown-confluence-sync/CHANGELOG.md

@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * feat: Add code blocks transformation to Confluence code macro format.
   Code blocks are now converted to Confluence's structured code macro
   with syntax highlighting support. This feature is disabled by default
-  and can be enabled via `codeBlocks` configuration option.
+  and can be enabled via `rehype.codeBlocks` configuration option.
 
 #### Changed
 #### Fixed

components/markdown-confluence-sync/README.md

@@ -301,7 +301,7 @@ The namespace for the configuration of this library is `markdown-confluence-sync
 | `confluence.noticeMessage` | `string` | Notice message to add at the beginning of the Confluence pages. | |
 | `confluence.noticeTemplate` | `string` | Template string to use for the notice message. | |
 | `confluence.dryRun` | `boolean` | Log create, update or delete requests to Confluence instead of really making them | `false` |
-| `codeBlocks` | `boolean` | Enable conversion of code blocks to Confluence code macro format with syntax highlighting. When disabled, code blocks remain as plain HTML pre/code tags. | `false` |
+| `rehype.codeBlocks` | `boolean` | Enable conversion of code blocks to Confluence code macro format with syntax highlighting. When disabled, code blocks remain as plain HTML pre/code tags. | `false` |
 | `dryRun` | `boolean` | Process markdown files without sending them to `confluence-sync`. Useful to early detection of possible errors in configuration, etc. Note that, requests that would be made to Confluence won't be logged, use `confluence.dryRun` for that, which also connects to Confluence to calculate the requests to do | `false` |
 | `config.readArguments` | `boolean` | Read configuration from arguments or not | `false` |
 | `config.readFile` | `boolean` | Read configuration from file or not | `false` |
@@ -497,13 +497,13 @@ Apart of supporting the most common markdown features, the library also supports
 * Code blocks - Markdown fenced code blocks can be converted to
   Confluence code macro format with syntax highlighting support. This
   feature is disabled by default but can be enabled via the
-  `codeBlocks` configuration option.
+  `rehype.codeBlocks` configuration option.
   * The plugin converts fenced code blocks to Confluence's
     `<ac:structured-macro ac:name="code">` format.
   * Language syntax highlighting is preserved when specified in the
     markdown code fence.
   * This feature is disabled by default for compatibility with older
-    Confluence versions. Enable it by setting `codeBlocks: true`.
+    Confluence versions. Enable it by setting `rehype.codeBlocks: true`.
   * For example, the following markdown code block:
     ````markdown
     ```javascript

components/markdown-confluence-sync/markdown-confluence-sync.config.cjs

@@ -41,4 +41,7 @@ module.exports = {
     rootPageName: "Cross",
   },
   logLevel: "debug",
+  rehype: {
+    codeBlocks: true,
+  },
 };

components/markdown-confluence-sync/src/lib/MarkdownConfluenceSync.ts

@@ -41,6 +41,7 @@ import type {
 const MODULE_NAME = "markdown-confluence-sync";
 const MARKDOWN_NAMESPACE = "markdown";
 const CONFLUENCE_NAMESPACE = "confluence";
+const REHYPE_CONFIG_NAMESPACE = "rehype";
 
 const DEFAULT_CONFIG: Configuration["config"] = {
   readArguments: false,
@@ -146,6 +147,9 @@ export const MarkdownConfluenceSync: MarkdownConfluenceSyncConstructor = class M
 
     const confluenceConfig =
       this._configuration.addNamespace(CONFLUENCE_NAMESPACE);
+    const rehypeConfig = this._configuration.addNamespace(
+      REHYPE_CONFIG_NAMESPACE,
+    );
     const confluenceLogger = this._logger.namespace(CONFLUENCE_NAMESPACE);
 
     this._markdownDocuments = new MarkdownDocuments({
@@ -160,6 +164,7 @@ export const MarkdownConfluenceSync: MarkdownConfluenceSyncConstructor = class M
     });
     this._confluenceSync = new ConfluenceSync({
       config: confluenceConfig,
+      rehypeConfig: rehypeConfig,
       logger: confluenceLogger,
       mode: this._modeOption,
     });

components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.ts

@@ -34,6 +34,8 @@ import type {
   NoticeTemplateOption,
   AuthenticationOptionDefinition,
   AuthenticationOption,
+  RehypeCodeBlocksOptionDefinition,
+  RehypeCodeBlocksOption,
 } from "./ConfluenceSync.types.js";
 import { ConfluencePageTransformer } from "./transformer/ConfluencePageTransformer.js";
 import type { ConfluencePageTransformerInterface } from "./transformer/ConfluencePageTransformer.types.js";
@@ -85,6 +87,12 @@ const authenticationOption: AuthenticationOptionDefinition = {
   type: "object",
 };
 
+const rehypeCodeBlocksOption: RehypeCodeBlocksOptionDefinition = {
+  name: "codeBlocks",
+  type: "boolean",
+  default: false,
+};
+
 export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
   implements ConfluenceSyncInterface
 {
@@ -102,8 +110,9 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
   private _initialized = false;
   private _logger: LoggerInterface;
   private _modeOption: ModeOption;
+  private _rehypeCodeBlocksOption: RehypeCodeBlocksOption;
 
-  constructor({ config, logger, mode }: ConfluenceSyncOptions) {
+  constructor({ config, rehypeConfig, logger, mode }: ConfluenceSyncOptions) {
     this._urlOption = config.addOption(urlOption) as UrlOption;
     this._personalAccessTokenOption = config.addOption(
       personalAccessTokenOption,
@@ -125,6 +134,11 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
       authenticationOption,
     ) as AuthenticationOption;
     this._dryRunOption = config.addOption(dryRunOption) as DryRunOption;
+
+    this._rehypeCodeBlocksOption = rehypeConfig.addOption(
+      rehypeCodeBlocksOption,
+    ) as RehypeCodeBlocksOption;
+
     this._modeOption = mode;
     this._logger = logger;
   }
@@ -189,6 +203,9 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
         rootPageName: this._rootPageNameOption.value,
         spaceKey: this._spaceKeyOption.value,
         logger: this._logger.namespace("transformer"),
+        rehype: {
+          codeBlocks: this._rehypeCodeBlocksOption.value,
+        },
       });
 
       this._confluenceSyncPages = new ConfluenceSyncPages({

components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.types.ts

@@ -23,6 +23,8 @@ type NoticeMessageOptionValue = string;
 type NoticeTemplateOptionValue = string;
 type DryRunOptionValue = boolean;
 
+type RehypeCodeBlocksOptionValue = boolean;
+
 declare global {
   //eslint-disable-next-line @typescript-eslint/no-namespace
   namespace MarkdownConfluenceSync {
@@ -50,6 +52,10 @@ declare global {
         /** Confluence dry run */
         dryRun?: DryRunOptionValue;
       };
+      rehype?: {
+        /** Enable code blocks transformation to Confluence code macro */
+        codeBlocks?: RehypeCodeBlocksOptionValue;
+      };
     }
   }
 }
@@ -70,6 +76,8 @@ export type DryRunOptionDefinition = OptionDefinition<
   DryRunOptionValue,
   { hasDefault: true }
 >;
+export type RehypeCodeBlocksOptionDefinition =
+  OptionDefinition<RehypeCodeBlocksOptionValue>;
 
 export type AuthenticationOptionDefinition =
   OptionDefinition<ConfluenceClientAuthenticationConfig>;
@@ -91,13 +99,20 @@ export type DryRunOption = OptionInterfaceOfType<
   { hasDefault: true }
 >;
 
+export type RehypeCodeBlocksOption = OptionInterfaceOfType<
+  RehypeCodeBlocksOptionValue,
+  { hasDefault: true }
+>;
+
 export interface ConfluenceSyncOptions {
   /** Configuration interface */
   config: ConfigNamespaceInterface;
   /** Logger interface */
   logger: LoggerInterface;
   /** Sync mode option */
   mode: ModeOption;
+  /** Rehype configuration namespace */
+  rehypeConfig: ConfigNamespaceInterface;
 }
 
 /** Creates a ConfluenceSyncInterface interface */

components/markdown-confluence-sync/src/lib/confluence/transformer/ConfluencePageTransformer.ts

@@ -59,7 +59,7 @@ export const ConfluencePageTransformer: ConfluencePageTransformerConstructor = c
     rootPageName,
     spaceKey,
     logger,
-    codeBlocks,
+    rehype: { codeBlocks },
   }: ConfluencePageTransformerOptions) {
     this._noticeMessage = noticeMessage;
     this._noticeTemplateRaw = noticeTemplate;

components/markdown-confluence-sync/src/lib/confluence/transformer/ConfluencePageTransformer.types.ts

@@ -6,6 +6,19 @@ import type { ConfluenceInputPage } from "@telefonica/confluence-sync";
 
 import type { ConfluenceSyncPage } from "../ConfluenceSync.types.js";
 
+/**
+ * Options for Rehype plugins used in ConfluencePageTransformer
+ */
+export interface ConfluencePageTransformerRehypeOptions {
+  /**
+   * Enable code blocks transformation to Confluence code macro.
+   * When enabled, markdown code blocks will be converted to Confluence's
+   * structured code macro format with syntax highlighting support.
+   * @default false
+   */
+  codeBlocks?: boolean;
+}
+
 export interface ConfluencePageTransformerOptions {
   /** Confluence page notice message */
   noticeMessage?: string;
@@ -24,13 +37,8 @@ export interface ConfluencePageTransformerOptions {
   spaceKey: string;
   /** Logger */
   logger?: LoggerInterface;
-  /**
-   * Enable code blocks transformation to Confluence code macro.
-   * When enabled, markdown code blocks will be converted to Confluence's
-   * structured code macro format with syntax highlighting support.
-   * @default false
-   */
-  codeBlocks?: boolean;
+  /** Rehype options */
+  rehype: ConfluencePageTransformerRehypeOptions;
 }
 
 /** Creates a ConfluencePageTransformer interface */

components/markdown-confluence-sync/src/lib/confluence/transformer/support/rehype/rehype-replace-code-blocks.ts

@@ -104,7 +104,8 @@ function extractLanguage(codeElement: HastElement): string | undefined {
     return undefined;
   }
 
-  // className can be a string or an array of strings
+  // className is always an array of strings, but we check it for safety
+  // istanbul ignore next
   const classNames = Array.isArray(className) ? className : [className];
 
   // Look for a class that starts with "language-"