Skip to content

Commit

Permalink
update warnm() to use console.warn(), update tests
Browse files Browse the repository at this point in the history
  • Loading branch information
nickesc committed Aug 26, 2023
1 parent b9482a4 commit 4c5c06e
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 16 deletions.
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
### Default text for undefined messages
### (leave commented to use the default text)
#LOG_MESSAGE = "a new message was logged"
#WARN_MESSAGE = "a new warning was logged"
#ERROR_MESSAGE = "a new error has occurred"

### Time message locale
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@

### Changed:
- changed `infom` to use `console.info()` instead of `console.log()`
- changed `warnm` to use `console.warn()` instead of `console.log()`

## Fixed
- updated `error` to `Error` in `README.md`
19 changes: 14 additions & 5 deletions loggedmessage.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ const defaultSeparator = dotenvConfig.MESSAGE_SEPARATOR || ":"; // separator st

const defaultLogMessage = dotenvConfig.LOG_MESSAGE || "a message was logged"; // default message text for a regular message
const defaultErrMessage = dotenvConfig.ERROR_MESSAGE || "an error occurred"; // default message text for an error
const defaultWarnMessage = dotenvConfig.WARN_MESSAGE || "a warning was logged"; // default message text for a regular message

const defaultErr = null; // default non-error for the error parameter

Expand Down Expand Up @@ -144,7 +145,16 @@ function errm(message = null, err = null, prefix = null, separator = null){
* ```
*/
function warnm(message = null, err = null, separator = null){
return errm(message, err, defaultWarnmPrefix, separator); // send and return an error as a warning
let warnmMessage = message || defaultWarnMessage; // set message content
let warnmPrefix = defaultWarnmPrefix;
let warnmSeparator = separator || defaultSeparator;
if (err){
return errm(warnmMessage, err, warnmPrefix, warnmSeparator); // send and return an error as a warning
} else {
let warnmString = toString(warnmPrefix, warnmSeparator); // format string
console.info(warnmString, warnmMessage); // log and return warning
return `${warnmString} ${checkObject(warnmMessage)}`;
}
}

/**
Expand Down Expand Up @@ -172,12 +182,11 @@ function infom(message = null, err = null, separator = null){
let infomMessage = message || defaultLogMessage; // set message content
let infomPrefix = defaultInfomPrefix;
let infomSeparator = separator || defaultSeparator;
if (err){ // send an and return error/message as info
return errm(message, err, infomPrefix, separator);
if (err){ // send and return error/message as info
return errm(infomMessage, err, infomPrefix, infomSeparator);
} else {
let infomString = toString(infomPrefix, infomSeparator); // format string
console.info(infomString, infomMessage); // log and return message

console.info(infomString, infomMessage); // log and return info message
return `${infomString} ${checkObject(infomMessage)}`;
}
}
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 10 additions & 9 deletions tests/tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const testSeparator = process.env.MESSAGE_SEPARATOR || ":";

const testLogMessage = process.env.LOG_MESSAGE || "a message was logged";
const testErrMessage = process.env.ERROR_MESSAGE || "an error occurred";
const testWarnMessage = process.env.WARN_MESSAGE || "a warning was logged";

const testerMessage = "test message"
const testerPrefix = "test prefix"
Expand Down Expand Up @@ -196,7 +197,7 @@ function testLogm(){

testMessage(
lm.warnm(),
`${testWarnmPrefix}${testSeparator} ${testErrMessage}`);
`${testWarnmPrefix}${testSeparator} ${testWarnMessage}`);
testMessage(
lm.warnm(testerMessage),
`${testWarnmPrefix}${testSeparator} ${testerMessage}`);
Expand All @@ -211,16 +212,16 @@ function testLogm(){
`${testWarnmPrefix}${testerSeparator} ${testerMessage}\n`);
testMessage(
lm.warnm(undefined, testerError, undefined),
`${testWarnmPrefix}${testSeparator} ${testErrMessage}\n`);
`${testWarnmPrefix}${testSeparator} ${testWarnMessage}\n`);
testMessage(
lm.warnm(undefined, new SyntaxError(), undefined),
`${testWarnmPrefix}${testSeparator} ${testErrMessage}\n`);
`${testWarnmPrefix}${testSeparator} ${testWarnMessage}\n`);
testMessage(
lm.warnm(undefined, new SyntaxError(), testerSeparator),
`${testWarnmPrefix}${testerSeparator} ${testErrMessage}\n`);
`${testWarnmPrefix}${testerSeparator} ${testWarnMessage}\n`);
testMessage(
lm.warnm(undefined, testerError, testerSeparator),
`${testWarnmPrefix}${testerSeparator} ${testErrMessage}\n`);
`${testWarnmPrefix}${testerSeparator} ${testWarnMessage}\n`);
testMessage(
lm.warnm(testerObject),
`${testWarnmPrefix}${testSeparator} ${JSON.stringify(testerObject)}`);
Expand Down Expand Up @@ -259,16 +260,16 @@ function testLogm(){
`${testInfomPrefix}${testerSeparator} ${testerMessage}\n`);
testMessage(
lm.infom(undefined, testerError, undefined),
`${testInfomPrefix}${testSeparator} ${testErrMessage}\n`);
`${testInfomPrefix}${testSeparator} ${testLogMessage}\n`);
testMessage(
lm.infom(undefined, new TypeError(), undefined),
`${testInfomPrefix}${testSeparator} ${testErrMessage}\n`);
`${testInfomPrefix}${testSeparator} ${testLogMessage}\n`);
testMessage(
lm.infom(undefined, new TypeError(), testerSeparator),
`${testInfomPrefix}${testerSeparator} ${testErrMessage}\n`);
`${testInfomPrefix}${testerSeparator} ${testLogMessage}\n`);
testMessage(
lm.infom(undefined, testerError, testerSeparator),
`${testInfomPrefix}${testerSeparator} ${testErrMessage}\n`);
`${testInfomPrefix}${testerSeparator} ${testLogMessage}\n`);
testMessage(
lm.infom(testerObject),
`${testInfomPrefix}${testSeparator} ${JSON.stringify(testerObject)}`);
Expand Down

0 comments on commit 4c5c06e

Please sign in to comment.