Merge pull request #1961 from Accenture/task/1960-hide-pretter-error-…

…log-files-behind-config-option task/1960 hide pretter error log behind config option formatErrorLog
Accenture · Jan 7, 2025 · 705279f · 705279f
2 parents 6a6db1b + 2036e78
commit 705279f
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 15 deletions.
diff --git a/@types/lib/util/file.d.ts.map b/@types/lib/util/file.d.ts.map
diff --git a/boilerplate/config.json b/boilerplate/config.json
@@ -7,6 +7,7 @@
     },
     "options": {
         "formatOnSave": true,
+        "formatErrorLog": false,
         "deployment": {
             "commitHistory": 10,
             "sourceTargetMapping": {

diff --git a/lib/util/file.js b/lib/util/file.js
@@ -270,6 +270,7 @@ const File = {
      * @returns {Promise.<string>} original string on error; formatted string on success
      */
     _beautify_prettier: async function (directory, filename, filetype, content) {
+        const properties = await config.getProperties();
         let formatted = '';
         try {
             if (!FileFs.prettierConfig) {
@@ -337,20 +338,22 @@ const File = {
 
             formatted = await prettier.format(content, FileFs.prettierConfig);
         } catch (ex) {
-            // save prettier errror into log file
-            // Note: we have to filter color codes from prettier's error message before saving it to file
-            /* eslint-disable no-control-regex */
-            this.writeToFile(
-                directory,
-                filename + '.error',
-                'log',
-                `Error Log\nParser: ${FileFs.prettierConfig.parser}\n${ex.message.replaceAll(
-                    /[\u001B\u009B][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
-
-                    ''
-                )}`
-            );
-            /* eslint-enable no-control-regex */
+            if (properties.options.formatErrorLog) {
+                // save prettier errror into log file
+                // Note: we have to filter color codes from prettier's error message before saving it to file
+                /* eslint-disable no-control-regex */
+                this.writeToFile(
+                    directory,
+                    filename + '.error',
+                    'log',
+                    `Error Log\nParser: ${FileFs.prettierConfig.parser}\n${ex.message.replaceAll(
+                        /[\u001B\u009B][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
+
+                        ''
+                    )}`
+                );
+                /* eslint-enable no-control-regex */
+            }
 
             formatted = content;
         }

diff --git a/test/mockRoot/.mcdevrc.json b/test/mockRoot/.mcdevrc.json
@@ -10,6 +10,7 @@
     },
     "options": {
         "formatOnSave": true,
+        "formatErrorLog": false,
         "deployment": {
             "commitHistory": 10,
             "sourceTargetMapping": {