feat(CRC-220): Ignore option

Author: javierbrea

components/markdown-confluence-sync/CHANGELOG.md

@@ -11,6 +11,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 
+## [1.2.0] - 2025-03-20
+
+### Added
+
+* feat: Add `ignore` option, enabling to define an array of globule patterns to ignore files when syncing them to Confluence. It is applied in any sync mode.
+
+### Fixed
+
+* fix: Images with absolute URLs were producing an error when syncing to Confluence.
+
 ## [1.1.1] - 2025-03-18
 
 ### Fixed

components/markdown-confluence-sync/README.md

@@ -270,7 +270,8 @@ The namespace for the configuration of this library is `markdown-confluence-sync
 | --- | --- | --- | --- |
 | `logLevel` | `string` | Log level. One of `silly`, `debug`, `info`, `warn`, `error`, `silent` | `info` |
 | `mode` | `string` | Mode to read the pages to send to Confluence. One of `tree`, `flat` or `id`.  | `tree` |
-| `filesPattern` | `string` | Pattern to read the pages to send to Confluence. This option is mandatory when using `flat` or `id` sync modes.  |  |
+| `filesPattern` | `string` | Pattern to read the pages to send to Confluence. This option is mandatory when using `flat` or `id` sync modes. It has no effect in `tree` mode  |  |
+| `ignore` | `array` | Array of [globule](https://github.com/cowboy/node-globule) patterns to ignore files. Matches are calculated from the `cwd` |  |
 | `filesMetadata` | `array` | Array of objects with the metadata of the files to sync. Each object must have the `path` property with the path of the file. For the rest of properties read the [Configuration per page](#configuration-per-page) section |  |
 | `docsDir` | `string` | Path to the docs directory. | `./docs` |
 | `confluence.url` | `string` | URL of the Confluence instance. | |
@@ -285,7 +286,7 @@ The namespace for the configuration of this library is `markdown-confluence-sync
 | `config.readFile` | `boolean` | Read configuration from file or not | `false` |
 | `config.readEnvironment` | `boolean` | Read configuration from environment or not | `false` |
 | `preprocessor` | `function` | Hook enabling to change the content of files before processing the markdown content to send it to Confluence. It receives the content as first argument and the file path as second argument, and must return the new file content | |
-| `cwd`* | `string` | Path from where the library resolve docsDir, filesPattern, and searches for configuration files | `process.cwd()` |
+| `cwd`* | `string` | Path from where the library resolve options `docsDir`, `filesPattern` and `ignore`, and it searches for configuration files | `process.cwd()` |
 
 > [!NOTE]
 > The `cwd` is a special property that is only settable through the `MARKDOWN_CONFLUENCE_SYNC_CWD` environment variable, or when using the library programmatically.
@@ -306,6 +307,7 @@ Just take into account that the namespace for the configuration is `markdown-con
 ```js title="markdown-confluence-sync.config.js"
 module.exports = {
   docsDir: "docs",
+  ignore: ["docs/no-sync/**"],
   confluence: {
     url: "https://my-confluence.es",
     personalAccessToken: "*******",
@@ -320,7 +322,7 @@ module.exports = {
 Configuration properties can be provided through CLI arguments. The name of the argument is the property name prefixed with `--`. For example, to set the `docsDir` property, you have to set the `--docsDir` argument. For boolean properties with a default value of `true`, you can set the `--no-` prefix to set the property to `false`. For example, to set the `config.readArguments` property to `false`, you have to set the `--no-config.readArguments` argument.
 
 ```sh
-npx markdown-confluence-sync --docsDir ./docs --logLevel debug
+npx markdown-confluence-sync --docsDir ./docs --logLevel debug --ignore "docs/no-sync/**" "docs/ignore-file.md"
 ```
 
 ### Environment variables

components/markdown-confluence-sync/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tid-xcut/markdown-confluence-sync",
   "description": "Creates/updates/deletes Confluence pages based on markdown files in a directory. Supports Mermaid diagrams and per-page configuration using frontmatter metadata. Works great with Docusaurus",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "license": "Apache-2.0",
   "author": "Telefónica Innovación Digital",
   "repository": {
@@ -76,6 +76,7 @@
     "@tid-xcut/confluence-sync": "workspace:*",
     "fs-extra": "11.2.0",
     "glob": "10.3.10",
+    "globule": "1.3.4",
     "handlebars": "4.7.8",
     "hast": "1.0.0",
     "hast-util-to-string": "2.0.0",
@@ -116,6 +117,7 @@
     "@tid-xcut/child-process-manager": "workspace:*",
     "@types/fs-extra": "11.0.4",
     "@types/glob": "8.1.0",
+    "@types/globule": "1.1.9",
     "@types/hast": "2.3.10",
     "@types/mdast": "3.0.15",
     "@types/tmp": "0.2.6",

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

@@ -29,6 +29,8 @@ import type {
   ModeOption,
   FilesPatternOption,
   FilesMetadataOptionDefinition,
+  FilesIgnoreOptionDefinition,
+  FilesIgnoreOption,
   FilesMetadataOption,
   ContentPreprocessorOptionDefinition,
   ContentPreprocessorOption,
@@ -61,6 +63,11 @@ const filesPatternOption: FilesPatternOptionDefinition = {
   type: "string",
 };
 
+const filesIgnoreOption: FilesIgnoreOptionDefinition = {
+  name: "ignore",
+  type: "array",
+};
+
 const filesMetadataOption: FilesMetadataOptionDefinition = {
   name: "filesMetadata",
   type: "array",
@@ -84,6 +91,7 @@ export const MarkdownConfluenceSync: MarkdownConfluenceSyncConstructor = class M
   private _modeOption: ModeOption;
   private _filesPatternOption: FilesPatternOption;
   private _filesMetadataOption: FilesMetadataOption;
+  private _filesIgnoreOption: FilesIgnoreOption;
   private _contentPreprocessorOption: ContentPreprocessorOption;
   private _cwd: string;
 
@@ -112,6 +120,10 @@ export const MarkdownConfluenceSync: MarkdownConfluenceSyncConstructor = class M
       filesMetadataOption,
     ) as FilesMetadataOption;
 
+    this._filesIgnoreOption = this._configuration.addOption(
+      filesIgnoreOption,
+    ) as FilesIgnoreOption;
+
     this._contentPreprocessorOption = this._configuration.addOption(
       contentPreprocessorOption as ContentPreprocessorOptionDefinition,
     ) as unknown as ContentPreprocessorOption;
@@ -127,6 +139,7 @@ export const MarkdownConfluenceSync: MarkdownConfluenceSyncConstructor = class M
       logger: markdownLogger,
       mode: this._modeOption,
       filesPattern: this._filesPatternOption,
+      filesIgnore: this._filesIgnoreOption,
       filesMetadata: this._filesMetadataOption,
       contentPreprocessor: this._contentPreprocessorOption,
       cwd: this._cwd,

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

@@ -85,6 +85,10 @@ export type FilesPatternOptionDefinition = OptionDefinition<FilesPattern>;
 
 export type FilesPatternOption = OptionInterfaceOfType<FilesPattern>;
 
+export type FilesIgnoreOptionDefinition = OptionDefinition<FilesPattern>;
+
+export type FilesIgnoreOption = OptionInterfaceOfType<FilesPattern>;
+
 export type FilesMetadataOptionDefinition = OptionDefinition<FilesMetadata>;
 
 export type FilesMetadataOption = OptionInterfaceOfType<FilesMetadata>;

components/markdown-confluence-sync/src/lib/confluence/transformer/support/rehype/rehype-replace-img-tags.ts

@@ -29,14 +29,11 @@ const rehypeReplaceImgTags: UnifiedPlugin<[], Root> =
   function rehypeReplaceImgTags() {
     return function transformer(tree) {
       replace(tree, { type: "element", tagName: "img" }, (node) => {
-        console.log("Image node", JSON.stringify(node));
         const src = node.properties?.src;
         if (typeof src !== "string" || src.toString().length === 0) {
           return node;
         }
         if (src.startsWith("http")) {
-          // eslint-disable-next-line no-console
-          console.log("Image source is a URL!", src);
           return {
             type: "element" as const,
             tagName: "ac:image",

components/markdown-confluence-sync/src/lib/docusaurus/DocusaurusFlatPages.ts

@@ -5,6 +5,7 @@ import { relative } from "node:path";
 
 import type { LoggerInterface } from "@mocks-server/logger";
 import { glob } from "glob";
+import globule from "globule";
 
 import type {
   ContentPreprocessor,
@@ -27,25 +28,28 @@ import { SyncModes } from "@tid-xcut/confluence-sync";
 export const MarkdownFlatDocuments: MarkdownFlatDocumentsConstructor = class MarkdownFlatDocuments
   implements MarkdownDocumentsInterface
 {
-  private _path: string;
+  private _cwd: string;
   private _logger: LoggerInterface;
   private _initialized = false;
   private _filesPattern: FilesPattern;
+  private _filesIgnore?: FilesPattern;
   private _filesMetadata?: FilesMetadata;
   private _mode: SyncModes.FLAT | SyncModes.ID;
   private _contentPreprocessor?: ContentPreprocessor;
 
   constructor({
     logger,
     filesPattern,
+    filesIgnore,
     filesMetadata,
     cwd,
     mode,
     contentPreprocessor,
   }: MarkdownFlatDocumentsOptions) {
     this._mode = mode;
-    this._path = cwd;
+    this._cwd = cwd;
     this._filesPattern = filesPattern as FilesPattern;
+    this._filesIgnore = filesIgnore;
     this._filesMetadata = filesMetadata;
     this._contentPreprocessor = contentPreprocessor;
     this._logger = logger.namespace("doc-flat");
@@ -55,17 +59,28 @@ export const MarkdownFlatDocuments: MarkdownFlatDocumentsConstructor = class Mar
     await this._init();
     const filesPaths = await this._obtainedFilesPaths();
     this._logger.debug(
-      `Found ${filesPaths.length} files in ${this._path} matching the pattern '${this._filesPattern}'`,
+      `Found ${filesPaths.length} files in ${this._cwd} matching the pattern '${this._filesPattern}'`,
     );
     return await this._transformFilePathsToMarkdownDocuments(filesPaths);
   }
 
   private async _obtainedFilesPaths(): Promise<string[]> {
     return await glob(this._filesPattern, {
-      cwd: this._path,
+      cwd: this._cwd,
       absolute: true,
+      // @ts-expect-error The globule types are not compatible with the glob types
       ignore: {
-        ignored: (p) => !/\.mdx?$/.test(p.name),
+        ignored: (p) => {
+          return (
+            !/\.mdx?$/.test(p.name) ||
+            (this._filesIgnore &&
+              globule.isMatch(
+                this._filesIgnore,
+                // cspell:disable-next-line
+                relative(this._cwd, p.fullpath()),
+              ))
+          );
+        },
       },
     });
   }
@@ -84,12 +99,12 @@ export const MarkdownFlatDocuments: MarkdownFlatDocumentsConstructor = class Mar
       title: item.meta.confluenceTitle || item.meta.title,
       id: item.meta.confluencePageId,
       path: item.path,
-      relativePath: relative(this._path, item.path),
+      relativePath: relative(this._cwd, item.path),
       content: item.content,
       ancestors: [],
       name: item.meta.confluenceShortName,
     }));
-    this._logger.debug(`Found ${pages.length} pages in ${this._path}`);
+    this._logger.debug(`Found ${pages.length} pages in ${this._cwd}`);
     return pages;
   }
 

components/markdown-confluence-sync/src/lib/docusaurus/DocusaurusFlatPages.types.ts

@@ -13,6 +13,8 @@ export interface MarkdownFlatDocumentsOptions
   extends MarkdownDocumentsModeOptions {
   /** Pattern to search files when flat mode is active */
   filesPattern?: FilesPattern;
+  /** Pattern with files to be ignored */
+  filesIgnore?: FilesPattern;
   /** Working directory */
   cwd: string;
   /** Mode */

components/markdown-confluence-sync/src/lib/docusaurus/DocusaurusPages.ts

@@ -14,6 +14,7 @@ import type {
   ModeOption,
   ContentPreprocessorOption,
   ContentPreprocessor,
+  FilesIgnoreOption,
 } from "../MarkdownConfluenceSync.types.js";
 
 import type {
@@ -46,6 +47,7 @@ export const MarkdownDocuments: MarkdownDocumentsConstructor = class MarkdownDoc
   private _config: ConfigInterface;
   private _filesPattern?: FilesPatternOption;
   private _filesMetadata?: FilesMetadataOption;
+  private _filesIgnore?: FilesIgnoreOption;
   private _contentPreprocessorOption: ContentPreprocessorOption;
   private _contentPreprocessor?: ContentPreprocessor;
   private _cwd: string;
@@ -56,6 +58,7 @@ export const MarkdownDocuments: MarkdownDocumentsConstructor = class MarkdownDoc
     mode,
     filesPattern,
     filesMetadata,
+    filesIgnore,
     contentPreprocessor,
     cwd,
   }: MarkdownDocumentsOptions) {
@@ -64,6 +67,7 @@ export const MarkdownDocuments: MarkdownDocumentsConstructor = class MarkdownDoc
     this._modeOption = mode;
     this._filesPattern = filesPattern;
     this._filesMetadata = filesMetadata;
+    this._filesIgnore = filesIgnore;
     this._contentPreprocessorOption = contentPreprocessor;
     this._config = config;
     this._logger = logger;
@@ -95,6 +99,7 @@ export const MarkdownDocuments: MarkdownDocumentsConstructor = class MarkdownDoc
         logger: this._logger,
         path: this._path,
         filesPattern: this._filesPattern?.value as FilesPattern,
+        filesIgnore: this._filesIgnore?.value,
         filesMetadata,
         cwd: this._cwd,
       });

components/markdown-confluence-sync/src/lib/docusaurus/DocusaurusPages.types.ts

@@ -11,6 +11,8 @@ import type { LoggerInterface } from "@mocks-server/logger";
 import type {
   FilesMetadataOption,
   FilesPatternOption,
+  FilesIgnoreOption,
+  FilesPattern,
   FilesMetadata,
   ModeOption,
   ContentPreprocessorOption,
@@ -50,6 +52,8 @@ export interface MarkdownDocumentsOptions {
   mode: ModeOption;
   /** Pattern to search files when flat mode is active */
   filesPattern?: FilesPatternOption;
+  /** Pattern with files to be ignored */
+  filesIgnore?: FilesIgnoreOption;
   /** Metadata for specific files */
   filesMetadata?: FilesMetadataOption;
   /** Preprocessor for content */
@@ -96,6 +100,8 @@ export interface MarkdownDocumentsModeOptions {
   contentPreprocessor?: ContentPreprocessor;
   /** Metadata for specific files */
   filesMetadata?: FilesMetadata;
+  /** Files to be ignored */
+  filesIgnore?: FilesPattern;
   /** Configuration interface */
   config: ConfigInterface;
   /** Logger */