Merge pull request #22 from Telefonica/feat/CRC-70/cwd-option

feat: Add cwd option

Author: javierbrea

components/markdown-confluence-sync/CHANGELOG.md

@@ -11,6 +11,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 
+## [1.0.0-beta.4] - 2024-11-28
+
+### Added
+
+* feat: Add cwd option, enabling to change the working directory from where to load the configuration file, and resolve the docsDir and filesPattern paths.
+
+
 ## [1.0.0-beta.3] - 2024-11-27
 
 ### Added
@@ -23,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * refactor: Rename first level types and classes to use Markdown instead of Docusaurus.
 * docs: Explain clearer the usage of the `confluence_title` property in frontmatter.
 
+
 ## [1.0.0-beta.2] - 2024-11-26
 
 ### Added

components/markdown-confluence-sync/README.md

@@ -274,6 +274,10 @@ The namespace for the configuration of this library is `markdown-confluence-sync
 | `config.readArguments` | `boolean` | Read configuration from arguments or not | `false` |
 | `config.readFile` | `boolean` | Read configuration from file or not | `false` |
 | `config.readEnvironment` | `boolean` | Read configuration from environment or not | `false` |
+| `cwd`* | `string` | Path from where the library resolve docsDir, filesPattern, and 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.
 
 ### Configuration file
 

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.0.0-beta.3",
+  "version": "1.0.0-beta.4",
   "license": "Apache-2.0",
   "author": "Telefónica Innovación Digital",
   "repository": {

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

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { ConfigInterface as customMarkdownConfluenceSyncClass } from "@mocks-server/config";
+import { resolve } from "path";
 import { Config } from "@mocks-server/config";
 import type { LoggerInterface } from "@mocks-server/logger";
 import { Logger } from "@mocks-server/logger";
@@ -68,14 +69,20 @@ export const MarkdownConfluenceSync: MarkdownConfluenceSyncConstructor = class M
   private _logLevelOption: LogLevelOption;
   private _modeOption: ModeOption;
   private _filesPatternOption: FilesPatternOption;
+  private _cwd: string;
 
   constructor(config: Configuration) {
+    const cwd = config?.cwd || process.env.MARKDOWN_CONFLUENCE_SYNC_CWD;
+    this._cwd = cwd ? resolve(process.cwd(), cwd) : process.cwd();
     this._config = config;
     if (!this._config) {
       throw new Error("Please provide configuration");
     }
 
-    this._configuration = new Config({ moduleName: MODULE_NAME });
+    this._configuration = new Config({
+      moduleName: MODULE_NAME,
+    });
+
     this._logger = new Logger(MODULE_NAME);
     this._logLevelOption = this._configuration.addOption(
       logLevelOption,
@@ -96,6 +103,7 @@ export const MarkdownConfluenceSync: MarkdownConfluenceSyncConstructor = class M
       logger: markdownLogger,
       mode: this._modeOption,
       filesPattern: this._filesPatternOption,
+      cwd: this._cwd,
     });
     this._confluenceSync = new ConfluenceSync({
       config: confluenceConfig,
@@ -114,10 +122,27 @@ export const MarkdownConfluenceSync: MarkdownConfluenceSyncConstructor = class M
 
   private async _init() {
     if (!this._initialized) {
-      await this._configuration.load({
-        config: { ...DEFAULT_CONFIG, ...this._config.config },
+      // NOTE: We delete the cwd property from the configuration because it can be configured only programmatically. It is not a configuration option.
+      const configToLoad = {
         ...this._config,
-      });
+        cwd: undefined,
+        config: {
+          ...DEFAULT_CONFIG,
+          ...{
+            fileSearchFrom: this._cwd,
+            fileSearchStop: this._cwd,
+          },
+          ...this._config.config,
+        },
+      };
+
+      delete configToLoad.cwd;
+
+      this._logger.debug(
+        `Initializing with config: ${JSON.stringify(configToLoad)}`,
+      );
+
+      await this._configuration.load(configToLoad);
       this._logger.setLevel(this._logLevelOption.value);
       this._initialized = true;
     }

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

@@ -25,6 +25,8 @@ declare global {
       };
       /** Log level */
       logLevel?: LogLevel;
+      /** Working Directory */
+      cwd?: string;
       /** Mode to structure pages */
       mode?: SyncModes;
       /**

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

@@ -27,8 +27,8 @@ export const MarkdownFlatDocuments: MarkdownFlatDocumentsConstructor = class Mar
   private _initialized = false;
   private _filesPattern: FilesPattern;
 
-  constructor({ logger, filesPattern }: MarkdownFlatDocumentsOptions) {
-    this._path = process.cwd();
+  constructor({ logger, filesPattern, cwd }: MarkdownFlatDocumentsOptions) {
+    this._path = cwd;
     this._filesPattern = filesPattern as FilesPattern;
     this._logger = logger.namespace("doc-flat");
   }

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

@@ -12,6 +12,8 @@ export interface MarkdownFlatDocumentsOptions
   extends MarkdownDocumentsModeOptions {
   /** Pattern to search files when flat mode is active */
   filesPattern?: FilesPattern;
+  /** Working directory */
+  cwd: string;
 }
 
 /** Creates a MarkdownFlatDocuments interface */

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

@@ -41,14 +41,17 @@ export const MarkdownDocuments: MarkdownDocumentsConstructor = class MarkdownDoc
   private _logger: LoggerInterface;
   private _config: ConfigInterface;
   private _filesPattern?: FilesPatternOption;
+  private _cwd: string;
 
   constructor({
     config,
     logger,
     mode,
     filesPattern,
+    cwd,
   }: MarkdownDocumentsOptions) {
     this._docsDirOption = config.addOption(docsDirOption);
+    this._cwd = cwd;
     this._modeOption = mode;
     this._filesPattern = filesPattern;
     this._config = config;
@@ -64,13 +67,14 @@ export const MarkdownDocuments: MarkdownDocumentsConstructor = class MarkdownDoc
   private _init() {
     this._logger.debug(`mode option is ${this._modeOption.value}`);
     if (!this._initialized) {
-      const path = resolve(process.cwd(), this._docsDirOption.value);
+      const path = resolve(this._cwd, this._docsDirOption.value);
       this._path = path;
       this._pages = MarkdownDocumentsFactory.fromMode(this._modeOption.value, {
         config: this._config,
         logger: this._logger,
         path: this._path,
         filesPattern: this._filesPattern?.value as FilesPattern,
+        cwd: this._cwd,
       });
       this._initialized = true;
     }

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

@@ -46,6 +46,8 @@ export interface MarkdownDocumentsOptions {
   mode: ModeOption;
   /** Pattern to search files when flat mode is active */
   filesPattern?: FilesPatternOption;
+  /** Working directory */
+  cwd: string;
 }
 
 /** Data about one markdown file */

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

@@ -18,6 +18,8 @@ export interface MarkdownDocumentsFactoryOptions {
   path: string;
   /** Pattern to search files when flat mode is active */
   filesPattern?: FilesPattern;
+  /** Working directory */
+  cwd: string;
 }
 
 /**

components/markdown-confluence-sync/test/component/fixtures/working-directory/run.mjs

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+
+// SPDX-FileCopyrightText: 2024 Telefónica Innovación Digital and contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { MarkdownConfluenceSync } from "../../../../dist/index.js";
+
+const markdownToConfluence = new MarkdownConfluenceSync({
+  cwd: "./subfolder",
+  config: {
+    readArguments: false,
+    readEnvironment: true,
+    readFile: true,
+  },
+});
+await markdownToConfluence.sync();

components/markdown-confluence-sync/test/component/fixtures/working-directory/subfolder/docs/parent/child1/grandChild1.md

@@ -0,0 +1,10 @@
+---
+id: foo-grandChild1
+title: foo-grandChild1-title
+sync_to_confluence: true
+confluence_title: Confluence grandChild 1
+---
+
+# Here goes the grandChild1 title
+
+This is the grandChild1 content

components/markdown-confluence-sync/test/component/fixtures/working-directory/subfolder/docs/parent/child1/index.md

@@ -0,0 +1,9 @@
+---
+id: foo-child1
+title: foo-child1-title
+sync_to_confluence: true
+---
+
+# Here goes the child1 title
+
+This is the child1 content

components/markdown-confluence-sync/test/component/fixtures/working-directory/subfolder/docs/parent/index.md

@@ -0,0 +1,8 @@
+---
+id: foo-parent
+title: foo-parent-title
+sync_to_confluence: true
+confluence_title: Confluence title
+---
+
+# Hello World

components/markdown-confluence-sync/test/component/fixtures/working-directory/subfolder/markdown-confluence-sync.config.cjs

@@ -0,0 +1,12 @@
+// SPDX-FileCopyrightText: 2024 Telefónica Innovación Digital and contributors
+// SPDX-License-Identifier: MIT
+
+module.exports = {
+  logLevel: "info",
+  confluence: {
+    url: "http://127.0.0.1:3100",
+    personalAccessToken: "foo-token",
+    spaceKey: "foo-space-id",
+    rootPageId: "foo-root-id",
+  },
+};