Skip to content

Commit 0945d64

Browse files
authored
refactor(logging): aligned error messages with reporting criticality (#1317)
* 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 * refactor(logging): parameters are actually allowed to fail so we'll use a warning here * chore(logging): optimized the wording
1 parent a16f8f1 commit 0945d64

File tree

8 files changed

+17
-17
lines changed

8 files changed

+17
-17
lines changed

packages/core/src/lib/buildFooter.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ module.exports = function (patternlab, patternPartial, uikit) {
2929
'config.paths.source.data plus patterns data'
3030
);
3131
} catch (err) {
32-
logger.warning('There was an error parsing JSON for patternlab.data');
33-
logger.warning(err);
32+
logger.error('There was an error parsing JSON for patternlab.data');
33+
logger.error(err);
3434
}
3535
allFooterData.patternLabFoot = footerPartial;
3636

packages/core/src/lib/compose.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,10 @@ module.exports = async function (pattern, patternlab) {
168168
'config.paths.source.data global data'
169169
);
170170
} catch (err) {
171-
logger.info(
171+
logger.error(
172172
'There was an error parsing JSON for ' + pattern.relPath
173173
);
174-
logger.info(err);
174+
logger.error(err);
175175
}
176176
allFooterData = _.merge(allFooterData, pattern.jsonFileData);
177177
allFooterData.cacheBuster = patternlab.cacheBuster;

packages/core/src/lib/loadPattern.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,10 @@ module.exports = function (relPath, patternlab) {
9494
);
9595
}
9696
} catch (err) {
97-
logger.warning(
97+
logger.error(
9898
`There was an error parsing sibling JSON for ${currentPattern.relPath}`
9999
);
100-
logger.warning(err);
100+
logger.error(err);
101101
}
102102

103103
//look for a listitems.json file for this template
@@ -118,10 +118,10 @@ module.exports = function (relPath, patternlab) {
118118
buildListItems(currentPattern);
119119
}
120120
} catch (err) {
121-
logger.warning(
121+
logger.error(
122122
`There was an error parsing sibling listitem JSON for ${currentPattern.relPath}`
123123
);
124-
logger.warning(err);
124+
logger.error(err);
125125
}
126126

127127
//look for a markdown file for this template

packages/core/src/lib/parameter_hunter.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ const parameter_hunter = function () {
289289
paramData = JSON.parse(paramStringWellFormed);
290290
} catch (err) {
291291
logger.warning(
292-
`There was an error parsing JSON for ${pattern.relPath}`
292+
`There was a problem parsing JSON parameters for ${pattern.relPath}`
293293
);
294294
logger.warning(err);
295295
}

packages/core/src/lib/parseLink.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ module.exports = function (patternlab, obj, key) {
8484
try {
8585
dataObj = JSON.parse(dataObjAsString);
8686
} catch (err) {
87-
logger.warning(`There was an error parsing JSON for ${key}`);
88-
logger.warning(err);
87+
logger.error(`There was an error parsing JSON for ${key}`);
88+
logger.error(err);
8989
}
9090

9191
return dataObj;

packages/core/src/lib/pseudopattern_hunter.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ pseudopattern_hunter.prototype.find_pseudopatterns = function (
5454
fs.readFileSync(variantFileFullPath, 'utf8')
5555
);
5656
} catch (err) {
57-
logger.warning(
57+
logger.error(
5858
`There was an error parsing pseudopattern JSON for ${currentPattern.relPath}`
5959
);
60-
logger.warning(err);
60+
logger.error(err);
6161
}
6262

6363
//extend any existing data with variant data

packages/core/src/lib/readDocumentation.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,10 @@ module.exports = function (pattern, patternlab, isVariant) {
7373
} catch (err) {
7474
// do nothing when file not found
7575
if (err.code !== 'ENOENT') {
76-
logger.warning(
76+
logger.error(
7777
`There was an error setting pattern keys after markdown parsing of the companion file for pattern ${pattern.patternPartial}${FILE_EXTENSION}`
7878
);
79-
logger.warning(err);
79+
logger.error(err);
8080
}
8181
}
8282

packages/plugin-tab/src/tab-loader.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,11 @@ async function findTab(patternlab, pattern) {
8080
});
8181
}
8282
} catch (err) {
83-
console.log(
83+
console.error(
8484
'plugin-tab: There was an error parsing sibling JSON for ' +
8585
pattern.relPath
8686
);
87-
console.log(err);
87+
console.error(err);
8888
}
8989
}
9090
}

0 commit comments

Comments
 (0)