sfdx-hardis 5.10.2-beta202412222214.0 → 5.10.2-beta202412280136.0

package/CHANGELOG.md

@@ -7,6 +7,7 @@ Note: Can be used with `sfdx plugins:install sfdx-hardis@beta` and docker image
 - Visual flow management, using MermaidJs
   - [hardis:doc:project2markdown](https://sfdx-hardis.cloudity.com/hardis/doc/project2markdown/): Add a markdown file for each Flow
     - If unable to run mermaid-cli, store markdown with mermaidJs diagram content anyway (can happen from Monitoring Backup Command)
+    - When called from Monitoring ([hardis:org:monitor:backup](https://sfdx-hardis.cloudity.com/hardis/org/monitor/backup/)), generate Flow documentation only if it has been updated
   - [hardis:doc:flow2markdown](https://sfdx-hardis.cloudity.com/hardis/doc/flow2markdown/): Generate the markdown documentation of a single flow (available from VsCode extension)
   - [hardis:project:generate:flow-git-diff](https://sfdx-hardis.cloudity.com/hardis/project/generate/flow-git-diff/): Generate the visual git diff for a single flow (available from VsCode extension)
   - [hardis:project:deploy:smart](https://sfdx-hardis.cloudity.com/hardis/project/deploy/smart/): Add visual git diff for flows updated by a Pull Request
@@ -27,6 +28,10 @@ Note: Can be used with `sfdx plugins:install sfdx-hardis@beta` and docker image
   - Display warning message in case package.xml has wrong format
   - Allow to override package-no-overwrite from a branch .sfdx-hardis.yml config file
 
+- Doc
+  - Update Microsoft Teams notifications integration User Guide
+  - Add troubleshooting section in Email integration User Guide
+
 ## [5.10.1] 2024-12-12
 
 - Fix sfdx-hardis docker image build by adding coreutils in dependencies

package/defaults/mkdocs/docs/stylesheets/extra.css

@@ -6,3 +6,28 @@
 .md-typeset table:not([class]) {
   display: table;
 }
+
+/* light mode table header bgcolor */
+.md-typeset__table th {
+  background-color: #f2edfe;
+}
+
+/* dark mode table header bgcolor */
+[data-md-color-scheme="slate"] .md-typeset__table th {
+  background-color: hsla(var(--md-hue), 25%, 25%, 1)
+}
+
+/* light mode alternating table bg colors */
+.md-typeset__table tr:nth-child(2n) {
+  background-color: #f8f8f8;
+}
+
+/* dark mode alternating table bg colors */
+[data-md-color-scheme="slate"] .md-typeset__table tr:nth-child(2n) {
+  background-color: hsla(var(--md-hue), 25%, 25%, 1)
+}
+
+:root>* {
+  --md-primary-fg-color: #1B1464;
+  --md-footer-bg-color: #1B1464;
+}

package/defaults/mkdocs/mkdocs.yml

@@ -9,9 +9,11 @@ theme:
   name: material
   custom_dir: docs/overrides
   features:
+    - content.code.copy
     - navigation.instant
-#  logo: assets/images/salesforce-logo.png
-#  favicon: assets/images/salesforce-icon.png
+    - navigation.footer
+  #  logo: assets/images/salesforce-logo.png
+  #  favicon: assets/images/salesforce-icon.png
   palette:
     primary: "light blue"
 markdown_extensions:

package/defaults/mkdocs-project-doc/docs/javascripts/gtag.js

@@ -0,0 +1,27 @@
+/*
+location$.subscribe(function(url) {
+    window.dataLayer = window.dataLayer || [];
+    function gtag() {
+        dataLayer.push(arguments);
+    }
+    gtag("js", new Date());
+
+    gtag("config", "G-3DM50255LC");
+});
+*/
+var gtag_id = "G-XXXXXXXXXX";
+
+var script = document.createElement("script");
+script.src = "https://www.googletagmanager.com/gtag/js?id=" + gtag_id;
+document.head.appendChild(script);
+
+location$.subscribe(function (url) {
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+
+  gtag("js", new Date());
+  gtag("config", gtag_id);
+});

package/defaults/mkdocs-project-doc/docs/javascripts/tables.js

@@ -0,0 +1,6 @@
+document$.subscribe(function () {
+    var tables = document.querySelectorAll("article table")
+    tables.forEach(function (table) {
+        new Tablesort(table)
+    })
+})

package/defaults/mkdocs-project-doc/docs/overrides/main.html

@@ -0,0 +1,4 @@
+{% extends "base.html" %}
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<!-- <script async src="https://www.googletagmanager.com/gtag/js?id=G-3DM50255LC"></script> MOVED TO gtag.js -->

package/defaults/mkdocs-project-doc/docs/stylesheets/extra.css

@@ -0,0 +1,33 @@
+/* stylelint-disable SelectorFormat */
+.md-typeset__table {
+  min-width: 100%;
+}
+
+.md-typeset table:not([class]) {
+  display: table;
+}
+
+/* light mode table header bgcolor */
+.md-typeset__table th {
+  background-color: #f2edfe;
+}
+
+/* dark mode table header bgcolor */
+[data-md-color-scheme="slate"] .md-typeset__table th {
+  background-color: hsla(var(--md-hue), 25%, 25%, 1)
+}
+
+/* light mode alternating table bg colors */
+.md-typeset__table tr:nth-child(2n) {
+  background-color: #f8f8f8;
+}
+
+/* dark mode alternating table bg colors */
+[data-md-color-scheme="slate"] .md-typeset__table tr:nth-child(2n) {
+  background-color: hsla(var(--md-hue), 25%, 25%, 1)
+}
+
+:root>* {
+  --md-primary-fg-color: #1B1464;
+  --md-footer-bg-color: #1B1464;
+}

package/defaults/mkdocs-project-doc/mkdocs.yml

@@ -0,0 +1,46 @@
+site_name: Salesforce Project Documentation
+site_url: https://sfdx-hardis.cloudity.com
+repo_url: https://github.com/hardisgroupco/sfdx-hardis
+edit_uri: tree/master/docs
+site_author: Nicolas Vuillamy
+site_description: Salesforce project documentation generated by sfdx-hardis
+copyright: Doc generated by <a href="https://sfdx-hardis.cloudity.com/hardis/doc/plugin/generate/" target="_blank">sfdx-hardis</a>
+theme:
+  name: material
+  custom_dir: docs/overrides
+  features:
+    - navigation.instant
+    - navigation.footer
+  # logo: assets/images/cloudity-text-logo.svg
+  # favicon: assets/images/cloudity-logo.svg
+  palette:
+    primary: indigo
+markdown_extensions:
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.snippets:
+      base_path: docs
+      check_paths: true
+  - mdx_truly_sane_lists
+  - attr_list
+extra_javascript:
+  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
+  - javascripts/tables.js
+  - javascripts/gtag.js
+extra_css:
+  - stylesheets/extra.css
+extra:
+  social:
+    - icon: fontawesome/regular/circle-question
+      link: https://github.com/hardisgroupcom/sfdx-hardis/issues
+      title: Need help ? Post an issue :)
+    - icon: fontawesome/brands/github
+      link: https://github.com/hardisgroupcom/sfdx-hardis
+    - icon: fontawesome/brands/docker
+      link: https://hub.docker.com/r/oxsecurity/megalinter
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/NicolasVuillamy
+  generator: false
+nav:
+  - "Home": "index.md"

package/lib/commands/hardis/doc/flow2markdown.js

@@ -26,6 +26,11 @@ export default class Flow2Markdown extends SfCommand {
             char: 'f',
             description: 'Force the path and name of output markdown file. Must end with .md',
         }),
+        "with-history": Flags.boolean({
+            char: 'd',
+            default: false,
+            description: messages.getMessage('debugMode'),
+        }),
         debug: Flags.boolean({
             char: 'd',
             default: false,
@@ -58,7 +63,7 @@ export default class Flow2Markdown extends SfCommand {
         }
         uxLog(this, c.grey(`Generating markdown for Flow ${this.inputFile}...`));
         const flowXml = (await fs.readFile(this.inputFile, "utf8")).toString();
-        const genRes = await generateFlowMarkdownFile(this.inputFile, flowXml, this.outputFile);
+        const genRes = await generateFlowMarkdownFile(this.inputFile, flowXml, this.outputFile, { collapsedDetails: false });
         if (!genRes) {
             throw new Error("Error generating markdown file");
         }

package/lib/commands/hardis/doc/flow2markdown.js.map

@@ -1 +1 @@
-{"version":3,"file":"flow2markdown.js","sourceRoot":"","sources":["../../../../src/commands/hardis/doc/flow2markdown.ts"],"names":[],"mappings":"AAAA,wBAAwB;AACxB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,CAAC,MAAM,OAAO,CAAC;AACtB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACxE,OAAO,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AAElH,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;AAE7D,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,SAAc;IAChD,MAAM,CAAC,KAAK,GAAG,kBAAkB,CAAC;IAElC,MAAM,CAAC,WAAW,GAAG,qDAAqD,CAAC;IAE3E,MAAM,CAAC,QAAQ,GAAG;QACvB,+BAA+B;QAC/B,6FAA6F;KAC9F,CAAC;IAEK,MAAM,CAAC,KAAK,GAAQ;QACzB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;YACtB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,gFAAgF;SAC9F,CAAC;QACF,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,oEAAoE;SAClF,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;SAC9C,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;YACtB,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;SAC9C,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC;YACtB,WAAW,EAAE,+DAA+D;SAC7E,CAAC;KACH,CAAC;IAEF,uGAAuG;IAChG,MAAM,CAAC,eAAe,GAAG,KAAK,CAAC;IAE5B,SAAS,CAAC;IACV,UAAU,CAAC;IACX,SAAS,GAAG,KAAK,CAAC;IAC5B,sBAAsB;IAEf,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC;QAEtC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,MAAM,aAAa,CAAC,UAAU,EAAE,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;YAC/C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/G,CAAC;QAED,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,gCAAgC,IAAI,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACvE,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxF,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,+BAA+B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,6CAA6C;QAC7C,eAAe,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjD,+CAA+C;QAC/C,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;IACzC,CAAC"}
+{"version":3,"file":"flow2markdown.js","sourceRoot":"","sources":["../../../../src/commands/hardis/doc/flow2markdown.ts"],"names":[],"mappings":"AAAA,wBAAwB;AACxB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,CAAC,MAAM,OAAO,CAAC;AACtB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACxE,OAAO,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AAElH,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;AAE7D,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,SAAc;IAChD,MAAM,CAAC,KAAK,GAAG,kBAAkB,CAAC;IAElC,MAAM,CAAC,WAAW,GAAG,qDAAqD,CAAC;IAE3E,MAAM,CAAC,QAAQ,GAAG;QACvB,+BAA+B;QAC/B,6FAA6F;KAC9F,CAAC;IAEK,MAAM,CAAC,KAAK,GAAQ;QACzB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;YACtB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,gFAAgF;SAC9F,CAAC;QACF,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,oEAAoE;SAClF,CAAC;QACF,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC;YAC5B,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;SAC9C,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;SAC9C,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;YACtB,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;SAC9C,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC;YACtB,WAAW,EAAE,+DAA+D;SAC7E,CAAC;KACH,CAAC;IAEF,uGAAuG;IAChG,MAAM,CAAC,eAAe,GAAG,KAAK,CAAC;IAE5B,SAAS,CAAC;IACV,UAAU,CAAC;IACX,SAAS,GAAG,KAAK,CAAC;IAC5B,sBAAsB;IAEf,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC;QAEtC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,MAAM,aAAa,CAAC,UAAU,EAAE,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;YAC/C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/G,CAAC;QAED,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,gCAAgC,IAAI,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACvE,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAC;QACrH,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,+BAA+B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,6CAA6C;QAC7C,eAAe,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjD,+CAA+C;QAC/C,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;IACzC,CAAC"}

package/lib/commands/hardis/doc/project2markdown.d.ts

@@ -2,25 +2,31 @@ import { SfCommand } from '@salesforce/sf-plugins-core';
 import { AnyJson } from '@salesforce/ts-types';
 export default class Project2Markdown extends SfCommand<any> {
     static title: string;
+    static htmlInstructions: string;
     static description: string;
     static examples: string[];
     static flags: any;
     static requiresProject: boolean;
+    protected diffOnly: boolean;
     protected packageXmlCandidates: any[];
     protected outputMarkdownRoot: string;
     protected outputMarkdownIndexFile: string;
     protected mdLines: string[];
     protected sfdxHardisConfig: any;
     protected outputPackageXmlMarkdownFiles: any[];
+    protected mkDocsNavNodes: any;
     protected debugMode: boolean;
+    protected footer: string;
     run(): Promise<AnyJson>;
+    private buildMkDocsYml;
     private generateFlowsDocumentation;
+    private humanDisplay;
     private buildFlowsTable;
-    private writeInstalledPackages;
+    private buildInstalledPackages;
     private buildSfdxHardisParams;
     private buildMajorBranchesAndOrgs;
     private manageLocalPackages;
-    private writePackagesInIndex;
+    private buildPackagesIndex;
     private generatePackageXmlMarkdown;
     private listPackageXmlCandidates;
 }

package/lib/commands/hardis/doc/project2markdown.js

@@ -14,10 +14,24 @@ import { listMajorOrgs } from '../../../common/utils/orgConfigUtils.js';
 import { glob } from 'glob';
 import { listFlowFiles } from '../../../common/utils/projectUtils.js';
 import { generateFlowMarkdownFile, generateMarkdownFileWithMermaid } from '../../../common/utils/mermaidUtils.js';
+import { MetadataUtils } from '../../../common/metadata-utils/index.js';
+import { PACKAGE_ROOT_DIR } from '../../../settings.js';
+import yaml from 'js-yaml';
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('sfdx-hardis', 'org');
 export default class Project2Markdown extends SfCommand {
     static title = 'SFDX Project to Markdown';
+    static htmlInstructions = `## Doc HTML Pages
+
+To read the documentation as HTML pages, run the following code (you need python on your computer)
+
+\`\`\`python
+pip install mkdocs-material mdx_truly_sane_lists
+mkdocs serve
+\`\`\`
+
+To just generate HTML pages that you can host anywhere, run \`mkdocs build\`
+`;
     static description = `Generates a markdown documentation from a SFDX project
 
 - Package.xml files
@@ -43,11 +57,17 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
 ![Screenshot project documentation](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-project-doc.jpg)
 
 ![Screenshot project documentation](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-project-doc-2.jpg)
+
+${this.htmlInstructions}
 `;
     static examples = [
         '$ sf hardis:doc:project2markdown',
     ];
     static flags = {
+        "diff-only": Flags.boolean({
+            default: false,
+            description: "Generate documentation only for changed files (used for monitoring)",
+        }),
         debug: Flags.boolean({
             char: 'd',
             default: false,
@@ -62,26 +82,36 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
     };
     // Set this to true if your command requires a project workspace; 'requiresProject' is false by default
     static requiresProject = true;
+    diffOnly = false;
     packageXmlCandidates;
     outputMarkdownRoot = "docs";
     outputMarkdownIndexFile = path.join(this.outputMarkdownRoot, "index.md");
     mdLines = [];
     sfdxHardisConfig = {};
     outputPackageXmlMarkdownFiles = [];
+    mkDocsNavNodes = { "Home": "index.md" };
     debugMode = false;
+    footer;
     /* jscpd:ignore-end */
     async run() {
         const { flags } = await this.parse(Project2Markdown);
+        this.diffOnly = flags["diff-only"] === true ? true : false;
         this.debugMode = flags.debug || false;
-        this.packageXmlCandidates = this.listPackageXmlCandidates();
+        await fs.ensureDir(this.outputMarkdownRoot);
+        const currentBranch = await getCurrentGitBranch();
+        this.footer = `_Documentation generated from branch ${currentBranch} with [sfdx-hardis](${CONSTANTS.DOC_URL_ROOT}) command [\`sf hardis:doc:project2markdown\`](https://sfdx-hardis.cloudity.com/hardis/doc/project2markdown/)_`;
         if (fs.existsSync("config/.sfdx-hardis.yml")) {
             this.sfdxHardisConfig = await getConfig("project");
-            this.mdLines.push(...[
-                `## ${this.sfdxHardisConfig?.projectName?.toUpperCase() || "SFDX Project"} CI/CD configuration`,
-                ""
-            ]);
-            this.buildSfdxHardisParams();
-            await this.buildMajorBranchesAndOrgs();
+            // General sfdx-hardis config
+            const sfdxHardisParamsLines = this.buildSfdxHardisParams();
+            this.mdLines.push(...sfdxHardisParamsLines);
+            await fs.writeFile(path.join(this.outputMarkdownRoot, "sfdx-hardis-params.md"), sfdxHardisParamsLines.join("\n") + `\n${this.footer}\n`);
+            this.mkDocsNavNodes["SFDX-Hardis Config"] = "sfdx-hardis-params.md";
+            // Branches & orgs
+            const branchesAndOrgsLines = await this.buildMajorBranchesAndOrgs();
+            this.mdLines.push(...branchesAndOrgsLines);
+            await fs.writeFile(path.join(this.outputMarkdownRoot, "sfdx-hardis-branches-and-orgs.md"), branchesAndOrgsLines.join("\n") + `\n${this.footer}\n`);
+            this.mkDocsNavNodes["Branches & Orgs"] = "sfdx-hardis-branches-and-orgs.md";
         }
         else {
             const repoName = (await getGitRepoName() || "").replace(".git", "");
@@ -92,55 +122,123 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
             ]);
         }
         // List SFDX packages and generate a manifest for each of them, except if there is only force-app with a package.xml
+        this.packageXmlCandidates = this.listPackageXmlCandidates();
         await this.manageLocalPackages();
-        // List all packageXml files and generate related markdown
         await this.generatePackageXmlMarkdown(this.packageXmlCandidates);
-        await this.writePackagesInIndex();
+        const packageLines = await this.buildPackagesIndex();
+        this.mdLines.push(...packageLines);
+        await fs.writeFile(path.join(this.outputMarkdownRoot, "manifests.md"), packageLines.join("\n") + `\n${this.footer}\n`);
         // List managed packages
-        await this.writeInstalledPackages();
+        const installedPackages = await this.buildInstalledPackages();
+        this.mdLines.push(...installedPackages);
+        await fs.writeFile(path.join(this.outputMarkdownRoot, "installed-packages.md"), installedPackages.join("\n") + `\n${this.footer}\n`);
+        this.mkDocsNavNodes["Installed Packages"] = "installed-packages.md";
         // List flows & generate doc
         if (!(process?.env?.GENERATE_FLOW_DOC === 'false')) {
             await this.generateFlowsDocumentation();
         }
-        // Footer
-        this.mdLines.push(`_Documentation generated with [sfdx-hardis](${CONSTANTS.DOC_URL_ROOT}) command [\`sf hardis:doc:project2markdown\`](https://sfdx-hardis.cloudity.com/hardis/doc/project2markdown/)_`);
         // Write output index file
         await fs.ensureDir(path.dirname(this.outputMarkdownIndexFile));
-        await fs.writeFile(this.outputMarkdownIndexFile, this.mdLines.join("\n") + "\n");
+        await fs.writeFile(this.outputMarkdownIndexFile, this.mdLines.join("\n") + "\n\n" + Project2Markdown.htmlInstructions + `\n\n${this.footer}\n`);
         uxLog(this, c.green(`Successfully generated doc index at ${this.outputMarkdownIndexFile}`));
         const readmeFile = path.join(process.cwd(), "README.md");
         if (fs.existsSync(readmeFile)) {
             let readme = await fs.readFile(readmeFile, "utf8");
             if (!readme.includes("docs/index.md")) {
-                readme += "\n\n## Documentation\n\n[Read auto-generated documentation of the SFDX project](docs/index.md)\n";
+                readme += `
+        
+## Documentation
+
+[Read auto-generated documentation of the SFDX project](docs/index.md)
+
+${Project2Markdown.htmlInstructions}
+`;
                 await fs.writeFile(readmeFile, readme);
                 uxLog(this, c.green(`Updated README.md to add link to docs/index.md`));
             }
         }
+        await this.buildMkDocsYml();
         // Open file in a new VsCode tab if available
         WebSocketClient.requestOpenFile(this.outputMarkdownIndexFile);
         return { outputPackageXmlMarkdownFiles: this.outputPackageXmlMarkdownFiles };
     }
+    async buildMkDocsYml() {
+        // Copy default files (mkdocs.yml and other files can be updated by the SF Cli plugin developer later)
+        const mkdocsYmlFile = path.join(process.cwd(), 'mkdocs.yml');
+        const mkdocsYmlFileExists = fs.existsSync(mkdocsYmlFile);
+        await fs.copy(path.join(PACKAGE_ROOT_DIR, 'defaults/mkdocs-project-doc', '.'), process.cwd(), { overwrite: false });
+        if (!mkdocsYmlFileExists) {
+            uxLog(this, c.blue('Base mkdocs files copied in your Salesforce project repo'));
+            uxLog(this, c.yellow('You should probably manually update mkdocs.yml to add your own configuration, like theme, site_name, etc.'));
+        }
+        // Update mkdocs nav items
+        const mkdocsYml = yaml.load(fs
+            .readFileSync(mkdocsYmlFile, 'utf-8')
+            .replace('!!python/name:materialx.emoji.twemoji', "'!!python/name:materialx.emoji.twemoji'")
+            .replace('!!python/name:materialx.emoji.to_svg', "'!!python/name:materialx.emoji.to_svg'"));
+        if (!mkdocsYml.nav) {
+            mkdocsYml.nav = {};
+        }
+        for (const menuName of Object.keys(this.mkDocsNavNodes)) {
+            let pos = 0;
+            let found = false;
+            for (const navItem of mkdocsYml.nav) {
+                if (navItem[menuName]) {
+                    found = true;
+                    break;
+                }
+                pos++;
+            }
+            const navMenu = {};
+            navMenu[menuName] = this.mkDocsNavNodes[menuName];
+            if (found) {
+                mkdocsYml.nav[pos] = navMenu;
+            }
+            else {
+                mkdocsYml.nav.push(navMenu);
+            }
+        }
+        /* jscpd:ignore-start */
+        const mkdocsYmlStr = yaml
+            .dump(mkdocsYml)
+            .replace("'!!python/name:materialx.emoji.twemoji'", '!!python/name:materialx.emoji.twemoji')
+            .replace("'!!python/name:materialx.emoji.to_svg'", '!!python/name:materialx.emoji.to_svg');
+        await fs.writeFile(mkdocsYmlFile, mkdocsYmlStr);
+        uxLog(this, c.cyan(`Updated ${c.green(mkdocsYmlFile)}`));
+        uxLog(this, c.cyan(`To generate a HTML WebSite with this documentation with a single command, see instructions at ${CONSTANTS.DOC_URL_ROOT}/hardis/doc/project2markdown/`));
+        /* jscpd:ignore-end */
+    }
     async generateFlowsDocumentation() {
         uxLog(this, c.cyan("Generating Flows Visual documentation... (if you don't want it, define GENERATE_FLOW_DOC=false in your environment variables)"));
+        const flowsForMenu = { "All flows": "flows/index.md" };
         await fs.ensureDir(path.join(this.outputMarkdownRoot, "flows"));
         const packageDirs = this.project?.getPackageDirectories();
+        const updatedFlowNames = !this.diffOnly ?
+            [] :
+            (await MetadataUtils.listChangedFiles()).filter(f => f?.path?.endsWith(".flow-meta.xml")).map(f => path.basename(f.path, ".flow-meta.xml"));
         const flowFiles = await listFlowFiles(packageDirs);
         const flowErrors = [];
         const flowWarnings = [];
+        const flowSkips = [];
         const flowDescriptions = [];
         for (const flowFile of flowFiles) {
+            const flowName = path.basename(flowFile, ".flow-meta.xml");
             uxLog(this, c.grey(`Generating markdown for Flow ${flowFile}...`));
             const flowXml = (await fs.readFile(flowFile, "utf8")).toString();
             const flowContent = await parseXmlFile(flowFile);
             flowDescriptions.push({
-                name: path.basename(flowFile).replace(".flow-meta.xml", ""),
+                name: flowName,
                 description: flowContent?.Flow?.description?.[0] || "",
                 type: flowContent?.Flow?.processType?.[0] === "Flow" ? "ScreenFlow" : flowContent?.Flow?.start?.[0]?.triggerType?.[0] ?? (flowContent?.Flow?.processType?.[0] || "ERROR (Unknown)"),
                 object: flowContent?.Flow?.start?.[0]?.object?.[0] || flowContent?.Flow?.processMetadataValues?.filter(pmv => pmv.name[0] === "ObjectType")?.[0]?.value?.[0]?.stringValue?.[0] || ""
             });
-            const outputFlowMdFile = path.join(this.outputMarkdownRoot, "flows", path.basename(flowFile).replace(".flow-meta.xml", ".md"));
-            const genRes = await generateFlowMarkdownFile(flowFile, flowXml, outputFlowMdFile);
+            flowsForMenu[flowName] = "flows/" + flowName + ".md";
+            if (this.diffOnly && !updatedFlowNames.includes(flowName)) {
+                flowSkips.push(flowFile);
+                continue;
+            }
+            const outputFlowMdFile = path.join(this.outputMarkdownRoot, "flows", flowName + ".md");
+            const genRes = await generateFlowMarkdownFile(flowFile, flowXml, outputFlowMdFile, { collapsedDetails: false });
             if (!genRes) {
                 flowErrors.push(flowFile);
                 continue;
@@ -154,12 +252,15 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
                 continue;
             }
         }
-        uxLog(this, c.green(`Successfully generated ${flowFiles.length - flowWarnings.length - flowErrors.length} Flows documentation`));
+        if (flowSkips.length > 0) {
+            uxLog(this, c.yellow(`Skipped generation for ${flowSkips.length} Flows that have not been updated: ${this.humanDisplay(flowSkips)}`));
+        }
+        uxLog(this, c.green(`Successfully generated ${flowFiles.length - flowSkips.length - flowWarnings.length - flowErrors.length} Flows documentation`));
         if (flowWarnings.length > 0) {
-            uxLog(this, c.yellow(`Partially generated documentation (Markdown with mermaidJs but without SVG) for ${flowWarnings.length} Flows: ${flowWarnings.join(", ")}`));
+            uxLog(this, c.yellow(`Partially generated documentation (Markdown with mermaidJs but without SVG) for ${flowWarnings.length} Flows: ${this.humanDisplay(flowWarnings)}`));
         }
         if (flowErrors.length > 0) {
-            uxLog(this, c.yellow(`Error generating documentation for ${flowErrors.length} Flows: ${flowErrors.join(", ")}`));
+            uxLog(this, c.yellow(`Error generating documentation for ${flowErrors.length} Flows: ${this.humanDisplay(flowErrors)}`));
         }
         // Write table on doc index
         const flowTableLines = await this.buildFlowsTable(flowDescriptions, 'flows/');
@@ -169,9 +270,13 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
         await fs.ensureDir(path.join(this.outputMarkdownRoot, "flows"));
         const flowTableLinesForIndex = await this.buildFlowsTable(flowDescriptions, '');
         const flowIndexFile = path.join(this.outputMarkdownRoot, "flows", "index.md");
-        await fs.writeFile(flowIndexFile, flowTableLinesForIndex.join("\n") + "\n");
+        await fs.writeFile(flowIndexFile, flowTableLinesForIndex.join("\n") + `\n${this.footer}\n`);
+        this.mkDocsNavNodes["Flows"] = flowsForMenu;
         uxLog(this, c.green(`Successfully generated doc index for Flows at ${flowIndexFile}`));
     }
+    humanDisplay(flows) {
+        return flows.map(flow => path.basename(flow, ".flow-meta.xml")).join(", ");
+    }
     async buildFlowsTable(flowDescriptions, prefix) {
         const lines = [];
         lines.push(...[
@@ -188,10 +293,11 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
         lines.push("");
         return lines;
     }
-    async writeInstalledPackages() {
+    async buildInstalledPackages() {
         // CI/CD context
         const packages = this.sfdxHardisConfig.installedPackages || [];
         // Monitoring context
+        const installedPackagesLines = [];
         const packageFolder = path.join(process.cwd(), 'installedPackages');
         if (packages.length === 0 && fs.existsSync(packageFolder)) {
             const findManagedPattern = "**/*.json";
@@ -207,41 +313,49 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
         }
         // Write packages table
         if (packages && packages.length > 0) {
-            this.mdLines.push(...[
+            installedPackagesLines.push(...[
                 "## Installed packages",
                 "",
                 "| Name  | Namespace | Version | Version Name |",
                 "| :---- | :-------- | :------ | :----------: | "
             ]);
             for (const pckg of sortArray(packages, { by: ['SubscriberPackageNamespace', 'SubscriberPackageName'], order: ['asc', 'asc'] })) {
-                this.mdLines.push(...[
+                installedPackagesLines.push(...[
                     `| ${pckg.SubscriberPackageName} | ${pckg.SubscriberPackageNamespace || ""} | [${pckg.SubscriberPackageVersionNumber}](https://test.salesforce.com/packaging/installPackage.apexp?p0=${pckg.SubscriberPackageVersionId}) | ${pckg.SubscriberPackageVersionName} |`
                 ]);
             }
-            this.mdLines.push("");
-            this.mdLines.push("___");
-            this.mdLines.push("");
+            installedPackagesLines.push("");
+            installedPackagesLines.push("___");
+            installedPackagesLines.push("");
         }
+        return installedPackagesLines;
     }
     buildSfdxHardisParams() {
-        this.mdLines.push(...[
+        const sfdxParamsTableLines = [];
+        sfdxParamsTableLines.push(...[
+            `## ${this.sfdxHardisConfig?.projectName?.toUpperCase() || "SFDX Project"} CI/CD configuration`,
+            ""
+        ]);
+        sfdxParamsTableLines.push(...[
             "| Sfdx-hardis Parameter | Value | Description & doc link |",
             "| :--------- | :---- | :---------- |"
         ]);
         const installPackagesDuringCheckDeploy = this.sfdxHardisConfig?.installPackagesDuringCheckDeploy ?? false;
-        this.mdLines.push(`| installPackagesDuringCheckDeploy | ${bool2emoji(installPackagesDuringCheckDeploy)} ${installPackagesDuringCheckDeploy} | [Install 1GP & 2GP packages during deployment check CI/CD job](https://sfdx-hardis.cloudity.com/hardis/project/deploy/smart/#packages-installation) |`);
+        sfdxParamsTableLines.push(`| installPackagesDuringCheckDeploy | ${bool2emoji(installPackagesDuringCheckDeploy)} | [Install 1GP & 2GP packages during deployment check CI/CD job](https://sfdx-hardis.cloudity.com/hardis/project/deploy/smart/#packages-installation) |`);
         const useDeltaDeployment = this.sfdxHardisConfig?.useDeltaDeployment ?? false;
-        this.mdLines.push(`| useDeltaDeployment | ${bool2emoji(useDeltaDeployment)} ${useDeltaDeployment} | [Deploys only updated metadatas , only when a MR/PR is from a minor branch to a major branch](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-config-delta-deployment/#delta-mode) |`);
+        sfdxParamsTableLines.push(`| useDeltaDeployment | ${bool2emoji(useDeltaDeployment)} | [Deploys only updated metadatas , only when a MR/PR is from a minor branch to a major branch](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-config-delta-deployment/#delta-mode) |`);
         const useSmartDeploymentTests = this.sfdxHardisConfig?.useSmartDeploymentTests ?? false;
-        this.mdLines.push(`| useSmartDeploymentTests | ${bool2emoji(useSmartDeploymentTests)} ${useSmartDeploymentTests} | [Skip Apex test cases if delta metadatas can not impact them, only when a MR/PR is from a minor branch to a major branch](https://sfdx-hardis.cloudity.com/hardis/project/deploy/smart/#smart-deployments-tests) |`);
-        this.mdLines.push("");
-        this.mdLines.push("___");
-        this.mdLines.push("");
+        sfdxParamsTableLines.push(`| useSmartDeploymentTests | ${bool2emoji(useSmartDeploymentTests)} | [Skip Apex test cases if delta metadatas can not impact them, only when a MR/PR is from a minor branch to a major branch](https://sfdx-hardis.cloudity.com/hardis/project/deploy/smart/#smart-deployments-tests) |`);
+        sfdxParamsTableLines.push("");
+        sfdxParamsTableLines.push("___");
+        sfdxParamsTableLines.push("");
+        return sfdxParamsTableLines;
     }
     async buildMajorBranchesAndOrgs() {
+        const branchesOrgsLines = [];
         const majorOrgs = await listMajorOrgs();
         if (majorOrgs.length > 0) {
-            this.mdLines.push(...[
+            branchesOrgsLines.push(...[
                 "## Major branches and orgs",
                 "",
                 "| Git branch | Salesforce Org | Deployment Username |",
@@ -249,12 +363,13 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
             ]);
             for (const majorOrg of majorOrgs) {
                 const majorOrgLine = `| ${majorOrg.branchName} | ${majorOrg.instanceUrl} | ${majorOrg.targetUsername} |`;
-                this.mdLines.push(majorOrgLine);
+                branchesOrgsLines.push(majorOrgLine);
             }
-            this.mdLines.push("");
-            this.mdLines.push("___");
-            this.mdLines.push("");
+            branchesOrgsLines.push("");
+            branchesOrgsLines.push("___");
+            branchesOrgsLines.push("");
         }
+        return branchesOrgsLines;
     }
     async manageLocalPackages() {
         const packageDirs = this.project?.getPackageDirectories();
@@ -279,8 +394,10 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
             }
         }
     }
-    async writePackagesInIndex() {
-        this.mdLines.push(...[
+    async buildPackagesIndex() {
+        const packageLines = [];
+        const packagesForMenu = { "All manifests": "manifests.md" };
+        packageLines.push(...[
             "## Package XML files",
             "",
             "| Package name | Description |",
@@ -291,11 +408,14 @@ _sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/pu
             const packageMdFile = path.basename(outputPackageXmlDef.path) + ".md";
             const label = outputPackageXmlDef.name ? `Package folder: ${outputPackageXmlDef.name}` : path.basename(outputPackageXmlDef.path);
             const packageTableLine = `| [${label}](${packageMdFile}) (${metadataNb}) | ${outputPackageXmlDef.description} |`;
-            this.mdLines.push(packageTableLine);
+            packageLines.push(packageTableLine);
+            packagesForMenu[label] = packageMdFile;
         }
-        this.mdLines.push("");
-        this.mdLines.push("___");
-        this.mdLines.push("");
+        packageLines.push("");
+        packageLines.push("___");
+        packageLines.push("");
+        this.mkDocsNavNodes["Manifests"] = packagesForMenu;
+        return packageLines;
     }
     async generatePackageXmlMarkdown(packageXmlCandidates) {
         // Generate packageXml doc when found