sfdx-hardis 5.20.0 → 5.21.0

package/oclif.manifest.json

@@ -57,13 +57,12 @@
         "world:hello"
       ]
     },
-    "hardis:auth:login": {
+    "hardis:cache:clear": {
       "aliases": [],
       "args": {},
-      "description": "Login to salesforce org",
+      "description": "Clear cache generated by sfdx-hardis",
       "examples": [
-        "$ sf hardis:auth:login",
-        "CI=true sf hardis:auth:login"
+        "$ sf hardis:cache:clear"
       ],
       "flags": {
         "json": {
@@ -81,28 +80,6 @@
           "multiple": false,
           "type": "option"
         },
-        "instanceurl": {
-          "char": "r",
-          "description": "URL of org instance",
-          "name": "instanceurl",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "devhub": {
-          "char": "h",
-          "description": "Also connect associated DevHub",
-          "name": "devhub",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "scratchorg": {
-          "char": "s",
-          "description": "Scratch org",
-          "name": "scratchorg",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "debug": {
           "char": "d",
           "description": "Activate debug mode (more logs)",
@@ -126,38 +103,38 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "hardis:auth:login",
+      "id": "hardis:cache:clear",
       "pluginAlias": "sfdx-hardis",
       "pluginName": "sfdx-hardis",
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": true,
-      "title": "Login",
+      "title": "Clear sfdx-hardis cache",
       "requiresProject": false,
       "isESM": true,
       "relativePath": [
         "lib",
         "commands",
         "hardis",
-        "auth",
-        "login.js"
+        "cache",
+        "clear.js"
       ],
       "aliasPermutations": [],
       "permutations": [
-        "hardis:auth:login",
-        "auth:hardis:login",
-        "auth:login:hardis",
-        "hardis:login:auth",
-        "login:hardis:auth",
-        "login:auth:hardis"
+        "hardis:cache:clear",
+        "cache:hardis:clear",
+        "cache:clear:hardis",
+        "hardis:clear:cache",
+        "clear:hardis:cache",
+        "clear:cache:hardis"
       ]
     },
-    "hardis:cache:clear": {
+    "hardis:config:get": {
       "aliases": [],
       "args": {},
-      "description": "Clear cache generated by sfdx-hardis",
+      "description": "Returns sfdx-hardis project config for a given level",
       "examples": [
-        "$ sf hardis:cache:clear"
+        "$ sf hardis:project:deploy:sources:metadata"
       ],
       "flags": {
         "json": {
@@ -175,6 +152,20 @@
           "multiple": false,
           "type": "option"
         },
+        "level": {
+          "char": "l",
+          "description": "project,branch or user",
+          "name": "level",
+          "default": "project",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "project",
+            "branch",
+            "user"
+          ],
+          "type": "option"
+        },
         "debug": {
           "char": "d",
           "description": "Activate debug mode (more logs)",
@@ -198,38 +189,39 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "hardis:cache:clear",
+      "id": "hardis:config:get",
       "pluginAlias": "sfdx-hardis",
       "pluginName": "sfdx-hardis",
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": true,
-      "title": "Clear sfdx-hardis cache",
+      "title": "Deploy metadata sources to org",
       "requiresProject": false,
       "isESM": true,
       "relativePath": [
         "lib",
         "commands",
         "hardis",
-        "cache",
-        "clear.js"
+        "config",
+        "get.js"
       ],
       "aliasPermutations": [],
       "permutations": [
-        "hardis:cache:clear",
-        "cache:hardis:clear",
-        "cache:clear:hardis",
-        "hardis:clear:cache",
-        "clear:hardis:cache",
-        "clear:cache:hardis"
+        "hardis:config:get",
+        "config:hardis:get",
+        "config:get:hardis",
+        "hardis:get:config",
+        "get:hardis:config",
+        "get:config:hardis"
       ]
     },
-    "hardis:config:get": {
+    "hardis:auth:login": {
       "aliases": [],
       "args": {},
-      "description": "Returns sfdx-hardis project config for a given level",
+      "description": "Login to salesforce org",
       "examples": [
-        "$ sf hardis:project:deploy:sources:metadata"
+        "$ sf hardis:auth:login",
+        "CI=true sf hardis:auth:login"
       ],
       "flags": {
         "json": {
@@ -247,20 +239,28 @@
           "multiple": false,
           "type": "option"
         },
-        "level": {
-          "char": "l",
-          "description": "project,branch or user",
-          "name": "level",
-          "default": "project",
+        "instanceurl": {
+          "char": "r",
+          "description": "URL of org instance",
+          "name": "instanceurl",
           "hasDynamicHelp": false,
           "multiple": false,
-          "options": [
-            "project",
-            "branch",
-            "user"
-          ],
           "type": "option"
         },
+        "devhub": {
+          "char": "h",
+          "description": "Also connect associated DevHub",
+          "name": "devhub",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "scratchorg": {
+          "char": "s",
+          "description": "Scratch org",
+          "name": "scratchorg",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Activate debug mode (more logs)",
@@ -284,30 +284,30 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "hardis:config:get",
+      "id": "hardis:auth:login",
       "pluginAlias": "sfdx-hardis",
       "pluginName": "sfdx-hardis",
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": true,
-      "title": "Deploy metadata sources to org",
+      "title": "Login",
       "requiresProject": false,
       "isESM": true,
       "relativePath": [
         "lib",
         "commands",
         "hardis",
-        "config",
-        "get.js"
+        "auth",
+        "login.js"
       ],
       "aliasPermutations": [],
       "permutations": [
-        "hardis:config:get",
-        "config:hardis:get",
-        "config:get:hardis",
-        "hardis:get:config",
-        "get:hardis:config",
-        "get:config:hardis"
+        "hardis:auth:login",
+        "auth:hardis:login",
+        "auth:login:hardis",
+        "hardis:login:auth",
+        "login:hardis:auth",
+        "login:auth:hardis"
       ]
     },
     "hardis:doc:fieldusage": {
@@ -392,7 +392,9 @@
       "description": "Generates a markdown documentation from a Flow file\n  \nIf [AI integration](https://sfdx-hardis.cloudity.com/salesforce-ai-setup/) is configured, documentation will contain a summary of the Flow.  \n  ",
       "examples": [
         "$ sf hardis:doc:flow2markdown",
-        "$ sf hardis:doc:flow2markdown --inputfile force-app/main/default/flows/MyFlow.flow-meta.xml"
+        "$ sf hardis:doc:flow2markdown --inputfile force-app/main/default/flows/MyFlow.flow-meta.xml",
+        "$ sf hardis:doc:flow2markdown --pdf",
+        "$ sf hardis:doc:flow2markdown --inputfile force-app/main/default/flows/MyFlow.flow-meta.xml --pdf"
       ],
       "flags": {
         "json": {
@@ -432,6 +434,12 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "pdf": {
+          "description": "Also generate the documentation in PDF format",
+          "name": "pdf",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Activate debug mode (more logs)",
@@ -762,7 +770,8 @@
       "description": "Generates a markdown documentation from a SFDX project\n\n- Objects\n- Flows\n- Apex\n- Lightning Pages\n- SFDX-Hardis Config\n- Branches & Orgs\n- Installed Packages\n- Manifests\n\nCan work on any sfdx project, no need for it to be a sfdx-hardis flavored one.\n\nGenerates markdown files will be written in **docs** folder (except README.md where a link to doc index is added)\n\n- You can customize the pages following [mkdocs-material setup documentation](https://squidfunk.github.io/mkdocs-material/setup/)\n- You can manually add new markdown files in the \"docs\" folder to extend this documentation and add references to them in \"mkdocs.yml\"\n- You can also add images in folder \"docs/assets\" and embed them in markdown files.\n\nTo read Flow documentations if your markdown reader doesn't handle MermaidJS syntax, this command could require @mermaid-js/mermaid-cli\n\n- Run `npm install @mermaid-js/mermaid-cli --global` if puppeteer works in your environment\n- It can also be run as a docker image\n\nBoth modes will be tried by default, but you can also force one of them by defining environment variable `MERMAID_MODES=docker` or `MERMAID_MODES=cli`\n\n_sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/puppeteer: if you can help, please submit a PR !_\n\nIf Flow history doc always display a single state, you probably need to update your workflow configuration:\n\n- on Gitlab: Env variable [`GIT_FETCH_EXTRA_FLAGS: --depth 10000`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.gitlab-ci.yml#L11)\n- on GitHub: [`fetch-depth: 0`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.github/workflows/org-monitoring.yml#L58)\n- on Azure: [`fetchDepth: \"0\"`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/azure-pipelines.yml#L39)\n- on Bitbucket: [`step: clone: depth: full`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/bitbucket-pipelines.yml#L18)\n\n![Screenshot flow doc](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-flow-doc.jpg)\n\n![Screenshot project documentation](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-project-doc.jpg)\n\n![Screenshot project documentation](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-project-doc-2.jpg)\n\n![Screenshot project documentation](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-object-diagram.jpg)\n\n\nIf it is a sfdx-hardis CI/CD project, a diagram of the branches and orgs strategy will be generated.\n\n![](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-doc-branches-strategy.jpg)\n\nIf [AI integration](https://sfdx-hardis.cloudity.com/salesforce-ai-setup/) is configured, documentation will contain a summary of the Flow.\n\nIf you have a complex strategy, you might need to input property **mergeTargets** in branch-scoped sfdx-hardis.yml file to have a correct diagram.\n\n## Doc HTML Pages\n\nTo read the documentation as HTML pages, run the following code (you need [**Python**](https://www.python.org/downloads/) on your computer)\n\n```python\npip install mkdocs-material mkdocs-exclude-search mdx_truly_sane_lists || python -m pip install mkdocs-material mkdocs-exclude-search mdx_truly_sane_lists || py -m pip install mkdocs-material mkdocs-exclude-search mdx_truly_sane_lists\nmkdocs serve -v || python -m mkdocs serve -v || py -m mkdocs serve -v\n```\n\nTo just generate HTML pages that you can host anywhere, run `mkdocs build -v || python -m mkdocs build -v || py -m mkdocs build -v`\n\n",
       "examples": [
         "$ sf hardis:doc:project2markdown",
-        "$ sf hardis:doc:project2markdown --with-history"
+        "$ sf hardis:doc:project2markdown --with-history",
+        "$ sf hardis:doc:project2markdown --with-history --pdf"
       ],
       "flags": {
         "json": {
@@ -792,6 +801,12 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "pdf": {
+          "description": "Also generate the documentation in PDF format",
+          "name": "pdf",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Activate debug mode (more logs)",
@@ -14488,5 +14503,5 @@
       ]
     }
   },
-  "version": "5.20.0"
+  "version": "5.21.0"
 }

package/package.json

@@ -3,7 +3,7 @@
   "description": "Swiss-army-knife Toolbox for Salesforce.\n Allows you to define a complete CD/CD Pipeline.\n Orchestrate base commands and assist users with interactive wizards",
   "author": "NicolasVuillamy @nvuillam",
   "bugs": "https://github.com/hardisgroupcom/sfdx-hardis/issues",
-  "version": "5.20.0",
+  "version": "5.21.0",
   "dependencies": {
     "@actions/github": "^6.0.0",
     "@cparra/apexdocs": "^3.9.0",
@@ -45,6 +45,7 @@
     "make-fetch-happen": "^14.0.3",
     "markdown-toc": "^1.2.0",
     "marked": "^14.1.4",
+    "md-to-pdf": "^5.2.4",
     "mega-linter-runner": "^8.4.2",
     "moment": "^2.30.1",
     "open": "^10.1.0",