Merge pull request #1718 from Accenture/bug/1717-skipvalidation-does-…

…not-work-for-retrieve Bug/1717 --skipValidation does not work for retrieve
Accenture · Sep 17, 2024 · 5406566 · 5406566
2 parents 152a939 + bd863a3
commit 5406566
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 5 deletions.
diff --git a/@types/lib/util/validations.d.ts b/@types/lib/util/validations.d.ts
diff --git a/@types/lib/util/validations.d.ts.map b/@types/lib/util/validations.d.ts.map
diff --git a/@types/types/mcdev.d.d.ts b/@types/types/mcdev.d.d.ts
diff --git a/@types/types/mcdev.d.d.ts.map b/@types/types/mcdev.d.d.ts.map
diff --git a/lib/cli.js b/lib/cli.js
@@ -50,6 +50,12 @@ yargs(hideBin(process.argv))
                     group: 'Options for retrieve:',
                     describe:
                         'filter metadata components (can include % as wildcard or _ for a single character)',
+                })
+                .option('skipValidation', {
+                    alias: 'sv',
+                    group: 'Options for retrieve:',
+                    describe:
+                        'allows reducing validation rules from error to warn to handle edge cases',
                 }),
         (argv) => {
             Mcdev.setOptions(argv);
@@ -594,7 +600,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('skipValidation', {
                     alias: 'sv',
-                    group: 'Options for deploy:',
+                    group: 'Options for buildDefinitionBulk:',
                     describe:
                         'allows reducing validation rules from error to warn to handle edge cases',
                 }),

diff --git a/lib/util/validations.js b/lib/util/validations.js
@@ -2,6 +2,12 @@
 import path from 'node:path';
 import { Util } from './util.js';
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').validationRuleList} validationRuleList
+ * @typedef {import('../../types/mcdev.d.js').validationRuleTest} validationRuleTest
+ */
+
+/** @type {validationRuleList} */
 let customRules = {};
 let customRuleImport;
 try {
@@ -28,11 +34,12 @@ export default async function validation(definition, item, targetDir) {
             'Could not load custom validation rules from .mcdev-validations.js: ' + ex.message
         );
     }
+    /** @type {validationRuleList} */
     const defaultRules = {
         noGuidKeys: {
             failedMsg: 'Please update the key to a readable value. Currently still in GUID format.',
             /**
-             * @returns {boolean} true=test passed
+             * @type {validationRuleTest}
              */
             passed: function () {
                 const key = item[definition.keyField];
@@ -48,7 +55,7 @@ export default async function validation(definition, item, targetDir) {
         noRootFolder: {
             failedMsg: 'Root folder not allowed. Current folder: ' + item.r__folder_Path,
             /**
-             * @returns {boolean} true=test passed
+             * @type {validationRuleTest}
              */
             passed: function () {
                 /** @type {string} */

diff --git a/types/mcdev.d.js b/types/mcdev.d.js
@@ -625,5 +625,18 @@ complex
  * @property {number} scale ?
  * @property {string} text seems to be equal to name-attribute?; "Email"
  */
+/**
+ *
+ * @callback validationRuleTest
+ * @returns {boolean} true = test passed; false = test failed
+ */
+/**
+ * @typedef {object} validationRule
+ * @property {string} failedMsg error message to display in case of a failed test
+ * @property {validationRuleTest} passed test to run
+ */
+/**
+ * @typedef {Object.<string, validationRule>} validationRuleList key=rule name
+ */
 
 export default {};