From b17aeb793e14a076d7cf9d82cf22a181759f75c3 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sun, 18 Apr 2021 08:56:18 +0200 Subject: [PATCH 1/3] refactor(logging): aligned error messages with reporting criticality If we call it an error in the message, we should even also mark it as an error instead of an info or a warning --- packages/core/src/lib/buildFooter.js | 4 ++-- packages/core/src/lib/compose.js | 4 ++-- packages/core/src/lib/loadPattern.js | 8 ++++---- packages/core/src/lib/parameter_hunter.js | 4 ++-- packages/core/src/lib/parseLink.js | 4 ++-- packages/core/src/lib/pseudopattern_hunter.js | 4 ++-- packages/core/src/lib/readDocumentation.js | 4 ++-- packages/plugin-tab/src/tab-loader.js | 8 ++++---- 8 files changed, 20 insertions(+), 20 deletions(-) diff --git a/packages/core/src/lib/buildFooter.js b/packages/core/src/lib/buildFooter.js index 6d0c4351c..c70cfe249 100644 --- a/packages/core/src/lib/buildFooter.js +++ b/packages/core/src/lib/buildFooter.js @@ -29,8 +29,8 @@ module.exports = function (patternlab, patternPartial, uikit) { 'config.paths.source.data plus patterns data' ); } catch (err) { - logger.warning('There was an error parsing JSON for patternlab.data'); - logger.warning(err); + logger.error('There was an error parsing JSON for patternlab.data'); + logger.error(err); } allFooterData.patternLabFoot = footerPartial; diff --git a/packages/core/src/lib/compose.js b/packages/core/src/lib/compose.js index 6eeeb50fd..cc981f8e2 100644 --- a/packages/core/src/lib/compose.js +++ b/packages/core/src/lib/compose.js @@ -168,10 +168,10 @@ module.exports = async function (pattern, patternlab) { 'config.paths.source.data global data' ); } catch (err) { - logger.info( + logger.error( 'There was an error parsing JSON for ' + pattern.relPath ); - logger.info(err); + logger.error(err); } allFooterData = _.merge(allFooterData, pattern.jsonFileData); allFooterData.cacheBuster = patternlab.cacheBuster; diff --git a/packages/core/src/lib/loadPattern.js b/packages/core/src/lib/loadPattern.js index 7753d5bd4..8c8d276f3 100644 --- a/packages/core/src/lib/loadPattern.js +++ b/packages/core/src/lib/loadPattern.js @@ -94,10 +94,10 @@ module.exports = function (relPath, patternlab) { ); } } catch (err) { - logger.warning( + logger.error( `There was an error parsing sibling JSON for ${currentPattern.relPath}` ); - logger.warning(err); + logger.error(err); } //look for a listitems.json file for this template @@ -118,10 +118,10 @@ module.exports = function (relPath, patternlab) { buildListItems(currentPattern); } } catch (err) { - logger.warning( + logger.error( `There was an error parsing sibling listitem JSON for ${currentPattern.relPath}` ); - logger.warning(err); + logger.error(err); } //look for a markdown file for this template diff --git a/packages/core/src/lib/parameter_hunter.js b/packages/core/src/lib/parameter_hunter.js index 748c113d4..b6455f377 100644 --- a/packages/core/src/lib/parameter_hunter.js +++ b/packages/core/src/lib/parameter_hunter.js @@ -288,10 +288,10 @@ const parameter_hunter = function () { try { paramData = JSON.parse(paramStringWellFormed); } catch (err) { - logger.warning( + logger.error( `There was an error parsing JSON for ${pattern.relPath}` ); - logger.warning(err); + logger.error(err); } // resolve any pattern links that might be present diff --git a/packages/core/src/lib/parseLink.js b/packages/core/src/lib/parseLink.js index 5b383b45e..0251ffada 100644 --- a/packages/core/src/lib/parseLink.js +++ b/packages/core/src/lib/parseLink.js @@ -84,8 +84,8 @@ module.exports = function (patternlab, obj, key) { try { dataObj = JSON.parse(dataObjAsString); } catch (err) { - logger.warning(`There was an error parsing JSON for ${key}`); - logger.warning(err); + logger.error(`There was an error parsing JSON for ${key}`); + logger.error(err); } return dataObj; diff --git a/packages/core/src/lib/pseudopattern_hunter.js b/packages/core/src/lib/pseudopattern_hunter.js index 1f3a9f530..5e510de66 100644 --- a/packages/core/src/lib/pseudopattern_hunter.js +++ b/packages/core/src/lib/pseudopattern_hunter.js @@ -54,10 +54,10 @@ pseudopattern_hunter.prototype.find_pseudopatterns = function ( fs.readFileSync(variantFileFullPath, 'utf8') ); } catch (err) { - logger.warning( + logger.error( `There was an error parsing pseudopattern JSON for ${currentPattern.relPath}` ); - logger.warning(err); + logger.error(err); } //extend any existing data with variant data diff --git a/packages/core/src/lib/readDocumentation.js b/packages/core/src/lib/readDocumentation.js index efb6f6cd9..1159a0347 100644 --- a/packages/core/src/lib/readDocumentation.js +++ b/packages/core/src/lib/readDocumentation.js @@ -73,10 +73,10 @@ module.exports = function (pattern, patternlab, isVariant) { } catch (err) { // do nothing when file not found if (err.code !== 'ENOENT') { - logger.warning( + logger.error( `There was an error setting pattern keys after markdown parsing of the companion file for pattern ${pattern.patternPartial}${FILE_EXTENSION}` ); - logger.warning(err); + logger.error(err); } } diff --git a/packages/plugin-tab/src/tab-loader.js b/packages/plugin-tab/src/tab-loader.js index ff0981b45..55beddc8a 100644 --- a/packages/plugin-tab/src/tab-loader.js +++ b/packages/plugin-tab/src/tab-loader.js @@ -64,7 +64,7 @@ async function findTab(patternlab, pattern) { } //copy the file to our output target if found - _.each(patternlab.uikits, uikit => { + _.each(patternlab.uikits, (uikit) => { fs.copySync( tabFileName, path.join(process.cwd(), uikit.outputDir, customFileTypeOutputPath) @@ -72,7 +72,7 @@ async function findTab(patternlab, pattern) { }); } else { //otherwise write nothing to the same location - this prevents GET errors on the tab. - _.each(patternlab.uikits, uikit => { + _.each(patternlab.uikits, (uikit) => { fs.outputFileSync( path.join(process.cwd(), uikit.outputDir, customFileTypeOutputPath), '' @@ -80,11 +80,11 @@ async function findTab(patternlab, pattern) { }); } } catch (err) { - console.log( + console.error( 'plugin-tab: There was an error parsing sibling JSON for ' + pattern.relPath ); - console.log(err); + console.error(err); } } } From 1f518c8c7876ab40fe48b9887ea3ffa9b5764301 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sun, 18 Apr 2021 11:03:29 +0200 Subject: [PATCH 2/3] refactor(logging): parameters are actually allowed to fail so we'll use a warning here --- packages/core/src/lib/parameter_hunter.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/core/src/lib/parameter_hunter.js b/packages/core/src/lib/parameter_hunter.js index b6455f377..748c113d4 100644 --- a/packages/core/src/lib/parameter_hunter.js +++ b/packages/core/src/lib/parameter_hunter.js @@ -288,10 +288,10 @@ const parameter_hunter = function () { try { paramData = JSON.parse(paramStringWellFormed); } catch (err) { - logger.error( + logger.warning( `There was an error parsing JSON for ${pattern.relPath}` ); - logger.error(err); + logger.warning(err); } // resolve any pattern links that might be present From c1a99522e09fa8dbac0b74430c4bfecf203cebf8 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Sun, 18 Apr 2021 11:21:55 +0200 Subject: [PATCH 3/3] chore(logging): optimized the wording --- packages/core/src/lib/parameter_hunter.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/src/lib/parameter_hunter.js b/packages/core/src/lib/parameter_hunter.js index 748c113d4..3a6d018e5 100644 --- a/packages/core/src/lib/parameter_hunter.js +++ b/packages/core/src/lib/parameter_hunter.js @@ -289,7 +289,7 @@ const parameter_hunter = function () { paramData = JSON.parse(paramStringWellFormed); } catch (err) { logger.warning( - `There was an error parsing JSON for ${pattern.relPath}` + `There was a problem parsing JSON parameters for ${pattern.relPath}` ); logger.warning(err); }