cypress-fail-on-console-error 3.3.0 → 4.0.0

package/README.md

@@ -22,72 +22,52 @@ failOnConsoleError();
 
 | Parameter             | Default               | <div style="width:300px">Description</div>    |
 |---                    |---                    |---                                            |
-| `excludeMessages`     | `[]` | Exclude console messages from throwing `AssertionError`. Regular expression parameters are acceptable. String parameters will be interpreted as regular expression. [String.match()](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/String/match) will be used for evaluation. Be sure to [escape the string regular expression](https://javascript.info/regexp-escaping) for special characters. When console message property `stacktrace` exists, then the whole stacktrace can be matched. |
-| `includeConsoleTypes` | `[consoleType.ERROR]` | Define console types for observation
-| `cypressLog`          | `false`               | Enable debug logs for errorMessage_excludeMessage_match and errorMessage_excluded to cypress runner                                     
+| `consoleMessages`     | `[]` | Exclude console messages from throwing `AssertionError`. Types `RegExp` and `string` are accepted. Strings will be converted to regular expression. [RegExp.test()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/test?retiredLocale=de) will be used for console message matching. Make sure to [escape special characters](https://javascript.info/regexp-escaping). When console message property `stacktrace` exists, then the whole stacktrace can be matched. |
+| `consoleTypes` | `['error']` | Define console types for observation. `error`, `warn` and `info` are accepted values.
+| `debug`          | `false`               | Enable debug logs for `consoleMessage_configConsoleMessage_match` and `consoleMessage_excluded` to cypress runner                                     
 
 <br/>
 
 ```js
-import failOnConsoleError, { consoleType, Config } from 'cypress-fail-on-console-error';
+import failOnConsoleError, { Config } from 'cypress-fail-on-console-error';
 
 const config: Config = {
-    excludeMessages: ['foo', /^some bar-regex.*/],
-    includeConsoleTypes: [
-        consoleType.ERROR,
-        consoleType.WARN,
-        consoleType.INFO,
-    ],
-    cypressLog: true,
+    consoleMessages: ['foo', /^some bar-regex.*/],
+    consoleTypes: ['error', 'warn', 'info'],
+    debug: false,
 };
 
 failOnConsoleError(config);
-
-// excludeMessages[0] matches example console message 'this is a foo message'
-// excludeMessages[1] matches example console message 'some bar-regex message'
-// includeConsoleTypes observe console types ERROR, WARN and INFO
-// cypressLog debug information will be printed to the cypress runner
-```
-
-Using Javascript, consoleType Enum can be parsed as number values
-
-```js
-failOnConsoleError({
-    includeConsoleTypes: [0, 1, 2],
-});
-
-// 0 = INFO
-// 1 = WARN
-// 2 = ERROR
 ```
 
 ### Set config from cypress test 
-Use `failOnConsoleError` functions `getConfig()` and `setConfig()` with your own requirements. Detailed example implementation [cypress comands](https://github.com/nils-hoyer/cypress-fail-on-console-error/blob/56753cf3ff9222bb2c452304589ae0cfd5f85b46/cypress/support/e2e.ts#L14-L64) & [cypress test](https://github.com/nils-hoyer/cypress-fail-on-console-error/blob/123e251510045f2eb30c9ec2f6f247b77427d464/cypress/e2e/shouldFailOnConsoleErrorFromSetConfig.cy.ts#L1-L25). Note that the config will be resetted to initial config between tests.
+Use `failOnConsoleError` functions `getConfig()` and `setConfig()` with your own requirements. Detailed example implementation [cypress comands](https://github.com/nils-hoyer/cypress-fail-on-console-error/blob/main/cypress/support/e2e.ts#L14-L64) & [cypress test](https://github.com/nils-hoyer/cypress-fail-on-console-error/blob/main/cypress/e2e/shouldFailOnConsoleErrorFromSetConfig.cy.ts#L1-L25). Note that the config will be resetted to initial config between tests.
 
 ```js
+// Simple example implementation
 const { getConfig, setConfig } = failOnConsoleError(config);
 
 Cypress.Commands.addAll({
-    getExcludeMessages: () => cy.wrap(getConfig()),
-    setExcludeMessages: (excludeMessages: (string | RegExp)[]) => 
-        setConfig({ ...getConfig(), excludeMessages );
+    getConsoleMessages: () => cy.wrap(getConfig().consoleMessages),
+    setConsoleMessages: (consoleMessages: (string | RegExp)[]) => 
+        setConfig({ ...getConfig(), consoleMessages });
 ```
 
 ```js
 describe('example test', () => {
-    it('should set excluded messages', () => {
-        cy.setExcludeMessages(['foo', 'bar']).then(() => {
-            cy.visit('./cypress/fixtures/consoleError.html');
-        });
+    it('should set console messages', () => {
+        cy.setConsoleMessages(['foo', 'bar']);
+        cy.visit('...');
     });
 });
 ```
 
 
 ### Debugging 
-When Cypress log is activated, debug information about the matching and exclude process are available from the cypress runner. As a plus, the generated error message string can be verified.
-![image info](./docs/cypressLogTrue.png)
+When Cypress log is activated, debug information about the console messages / config console messages matching and excluding process are available from the cypress runner. As a plus, the generated error message string can be verified.
+![debugTrue.png](./docs/debugTrue.png)
 
 ### Contributing
 1. Create an project issue with proper description and expected behaviour
-2. Provide a PR with implementation and tests. Command `npm run verify` have to pass locally
+2. NPM command `npm run verify` have to pass locally
+3. Provide a PR with implementation and tests 

package/dist/index.d.ts

@@ -9,10 +9,10 @@ export declare const validateConfig: (config: Config) => void;
 export declare const createConfig: (config: Config) => Required<Config>;
 export declare const createSpies: (config: Required<Config>, console: Console) => Map<ConsoleType, sinon.SinonSpy>;
 export declare const resetSpies: (spies: Map<ConsoleType, sinon.SinonSpy>) => Map<ConsoleType, sinon.SinonSpy>;
-export declare const getIncludedCall: (spies: Map<ConsoleType, sinon.SinonSpy>, config: Required<Config>) => string | undefined;
-export declare const findIncludedCall: (spy: sinon.SinonSpy, config: Required<Config>) => string | undefined;
-export declare const isErrorMessageExcluded: (errorMessage: string, excludeMessage: string, cypressLog: boolean) => boolean;
+export declare const getConsoleMessageIncluded: (spies: Map<ConsoleType, sinon.SinonSpy>, config: Required<Config>) => string | undefined;
+export declare const findConsoleMessageIncluded: (spy: sinon.SinonSpy, config: Required<Config>) => string | undefined;
+export declare const isConsoleMessageExcluded: (consoleMessage: string, configConsoleMessage: string | RegExp, debug: boolean) => boolean;
 export declare const callToString: (calls: any[]) => string;
 export declare const cypressLogger: (name: string, message: any) => void;
 export { Config } from './types/Config';
-export { ConsoleType as consoleType } from './types/ConsoleType';
+export { ConsoleType } from './types/ConsoleType';

package/dist/index.js

@@ -37,14 +37,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.consoleType = exports.cypressLogger = exports.callToString = exports.isErrorMessageExcluded = exports.findIncludedCall = exports.getIncludedCall = exports.resetSpies = exports.createSpies = exports.createConfig = exports.validateConfig = void 0;
+exports.cypressLogger = exports.callToString = exports.isConsoleMessageExcluded = exports.findConsoleMessageIncluded = exports.getConsoleMessageIncluded = exports.resetSpies = exports.createSpies = exports.createConfig = exports.validateConfig = void 0;
 var chai = __importStar(require("chai"));
 var chai_1 = require("chai");
 var os_1 = require("os");
 var sinon = __importStar(require("sinon"));
 var sinon_chai_1 = __importDefault(require("sinon-chai"));
 var type_detect_1 = __importDefault(require("type-detect"));
-var ConsoleType_1 = require("./types/ConsoleType");
 chai.should();
 chai.use(sinon_chai_1.default);
 function failOnConsoleError(_config) {
@@ -65,11 +64,11 @@ function failOnConsoleError(_config) {
     Cypress.on('command:end', function () {
         if (!spies)
             return;
-        var errorMessage = (0, exports.getIncludedCall)(spies, config);
+        var consoleMessage = (0, exports.getConsoleMessageIncluded)(spies, config);
         spies = (0, exports.resetSpies)(spies);
-        if (errorMessage) {
-            throw new chai_1.AssertionError("cypress-fail-on-console-error: ".concat(os_1.EOL, " ").concat(errorMessage));
-        }
+        if (!consoleMessage)
+            return;
+        throw new chai_1.AssertionError("cypress-fail-on-console-error: ".concat(os_1.EOL, " ").concat(consoleMessage));
     });
     Cypress.on('test:after:run', function () {
         setConfig(originConfig);
@@ -81,19 +80,19 @@ function failOnConsoleError(_config) {
 }
 exports.default = failOnConsoleError;
 var validateConfig = function (config) {
-    if (config.excludeMessages) {
-        config.excludeMessages.forEach(function (_excludeMessage) {
-            chai.expect((0, type_detect_1.default)(_excludeMessage)).to.be.oneOf([
+    if (config.consoleMessages) {
+        config.consoleMessages.forEach(function (consoleMessage) {
+            chai.expect((0, type_detect_1.default)(consoleMessage)).to.be.oneOf([
                 'string',
                 'RegExp',
             ]);
-            chai.expect(_excludeMessage.toString()).to.have.length.above(0);
+            chai.expect(consoleMessage.toString()).to.have.length.above(0);
         });
     }
-    if (config.includeConsoleTypes) {
-        chai.expect(config.includeConsoleTypes).not.to.be.empty;
-        config.includeConsoleTypes.forEach(function (_includeConsoleType) {
-            chai.expect((0, ConsoleType_1.someConsoleType)(_includeConsoleType), "includeConsoleTypes '".concat(_includeConsoleType, "' is an unknown ConsoleType")).to.be.true;
+    if (config.consoleTypes) {
+        chai.expect(config.consoleTypes).not.to.be.empty;
+        config.consoleTypes.forEach(function (consoleType) {
+            chai.expect(['error', 'warn', 'info']).contains(consoleType);
         });
     }
 };
@@ -101,74 +100,71 @@ exports.validateConfig = validateConfig;
 var createConfig = function (config) {
     var _a, _b, _c;
     return ({
-        excludeMessages: (_a = config.excludeMessages) !== null && _a !== void 0 ? _a : [],
-        includeConsoleTypes: ((_b = config.includeConsoleTypes) === null || _b === void 0 ? void 0 : _b.length)
-            ? config.includeConsoleTypes
-            : [ConsoleType_1.ConsoleType.ERROR],
-        cypressLog: (_c = config.cypressLog) !== null && _c !== void 0 ? _c : false,
+        consoleMessages: (_a = config.consoleMessages) !== null && _a !== void 0 ? _a : [],
+        consoleTypes: ((_b = config.consoleTypes) === null || _b === void 0 ? void 0 : _b.length) ? config.consoleTypes : ['error'],
+        debug: (_c = config.debug) !== null && _c !== void 0 ? _c : false,
     });
 };
 exports.createConfig = createConfig;
 var createSpies = function (config, console) {
     var _a;
     var spies = new Map();
-    (_a = config.includeConsoleTypes) === null || _a === void 0 ? void 0 : _a.forEach(function (_consoleType) {
-        var functionName = ConsoleType_1.ConsoleType[_consoleType].toLowerCase();
-        spies.set(_consoleType, sinon.spy(console, functionName));
+    (_a = config.consoleTypes) === null || _a === void 0 ? void 0 : _a.forEach(function (consoleType) {
+        spies.set(consoleType, sinon.spy(console, consoleType));
     });
     return spies;
 };
 exports.createSpies = createSpies;
 var resetSpies = function (spies) {
-    spies.forEach(function (_spy) { return _spy.resetHistory(); });
+    spies.forEach(function (spy) { return spy.resetHistory(); });
     return spies;
 };
 exports.resetSpies = resetSpies;
-var getIncludedCall = function (spies, config) {
-    var errorMessage;
-    Array.from(spies.values()).forEach(function (spy) {
+var getConsoleMessageIncluded = function (spies, config) {
+    var includedConsoleMessage;
+    Array.from(spies.values()).find(function (spy) {
         if (!spy.called)
-            return;
-        var includedCall = (0, exports.findIncludedCall)(spy, config);
-        if (includedCall !== undefined) {
-            errorMessage = includedCall;
-        }
+            return false;
+        includedConsoleMessage = (0, exports.findConsoleMessageIncluded)(spy, config);
+        return includedConsoleMessage !== undefined;
     });
-    return errorMessage;
+    return includedConsoleMessage;
 };
-exports.getIncludedCall = getIncludedCall;
-var findIncludedCall = function (spy, config) {
-    var errorMessages = spy.args.map(function (call) { return (0, exports.callToString)(call); });
-    if (config.excludeMessages === undefined) {
-        return errorMessages[0];
+exports.getConsoleMessageIncluded = getConsoleMessageIncluded;
+var findConsoleMessageIncluded = function (spy, config) {
+    var consoleMessages = spy.args.map(function (call) { return (0, exports.callToString)(call); });
+    if (config.consoleMessages.length === 0) {
+        return consoleMessages[0];
     }
-    return errorMessages.find(function (_errorMessage) {
-        var _isErrorMessageExcluded = config.excludeMessages.some(function (_excludeMessage) {
-            return (0, exports.isErrorMessageExcluded)(_errorMessage, _excludeMessage, config.cypressLog);
+    return consoleMessages.find(function (consoleMessage) {
+        var someConsoleMessagesExcluded = config.consoleMessages.some(function (configConsoleMessage) {
+            return (0, exports.isConsoleMessageExcluded)(consoleMessage, configConsoleMessage, config.debug);
         });
-        if (config.cypressLog === true) {
-            (0, exports.cypressLogger)('errorMessage_excluded', {
-                _errorMessage: _errorMessage,
-                _isErrorMessageExcluded: _isErrorMessageExcluded,
+        if (config.debug) {
+            (0, exports.cypressLogger)('consoleMessage_excluded', {
+                consoleMessage: consoleMessage,
+                someConsoleMessagesExcluded: someConsoleMessagesExcluded,
             });
         }
-        return !_isErrorMessageExcluded;
+        return !someConsoleMessagesExcluded;
     });
 };
-exports.findIncludedCall = findIncludedCall;
-var isErrorMessageExcluded = function (errorMessage, excludeMessage, cypressLog) {
-    var _a;
-    var match = (((_a = errorMessage.match(excludeMessage)) === null || _a === void 0 ? void 0 : _a.length) || 0) > 0;
-    if (cypressLog) {
-        (0, exports.cypressLogger)('errorMessage_excludeMessage_match', {
-            errorMessage: errorMessage,
-            excludeMessage: excludeMessage,
-            match: match,
+exports.findConsoleMessageIncluded = findConsoleMessageIncluded;
+var isConsoleMessageExcluded = function (consoleMessage, configConsoleMessage, debug) {
+    var configConsoleMessageRegExp = configConsoleMessage instanceof RegExp
+        ? configConsoleMessage
+        : new RegExp(configConsoleMessage);
+    var consoleMessageExcluded = configConsoleMessageRegExp.test(consoleMessage);
+    if (debug) {
+        (0, exports.cypressLogger)('consoleMessage_configConsoleMessage_match', {
+            consoleMessage: consoleMessage,
+            configConsoleMessage: configConsoleMessage,
+            consoleMessageExcluded: consoleMessageExcluded,
         });
     }
-    return match;
+    return consoleMessageExcluded;
 };
-exports.isErrorMessageExcluded = isErrorMessageExcluded;
+exports.isConsoleMessageExcluded = isConsoleMessageExcluded;
 var callToString = function (calls) {
     return calls
         .reduce(function (previousValue, currentValue) {
@@ -189,5 +185,3 @@ var cypressLogger = function (name, message) {
     });
 };
 exports.cypressLogger = cypressLogger;
-var ConsoleType_2 = require("./types/ConsoleType");
-Object.defineProperty(exports, "consoleType", { enumerable: true, get: function () { return ConsoleType_2.ConsoleType; } });

package/dist/types/Config.d.ts

@@ -1,6 +1,6 @@
 import { ConsoleType } from "./ConsoleType";
 export interface Config {
-    excludeMessages?: (string | RegExp)[];
-    includeConsoleTypes?: ConsoleType[];
-    cypressLog?: boolean;
+    consoleMessages?: (string | RegExp)[];
+    consoleTypes?: (ConsoleType)[];
+    debug?: boolean;
 }

package/dist/types/ConsoleType.d.ts

@@ -1,6 +1 @@
-export declare enum ConsoleType {
-    INFO = 0,
-    WARN = 1,
-    ERROR = 2
-}
-export declare const someConsoleType: (consoleType: ConsoleType) => boolean;
+export declare type ConsoleType = 'error' | 'warn' | 'info';

package/dist/types/ConsoleType.js

@@ -1,15 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.someConsoleType = exports.ConsoleType = void 0;
-var ConsoleType;
-(function (ConsoleType) {
-    ConsoleType[ConsoleType["INFO"] = 0] = "INFO";
-    ConsoleType[ConsoleType["WARN"] = 1] = "WARN";
-    ConsoleType[ConsoleType["ERROR"] = 2] = "ERROR";
-})(ConsoleType = exports.ConsoleType || (exports.ConsoleType = {}));
-var someConsoleType = function (consoleType) {
-    return consoleType === ConsoleType.INFO ||
-        consoleType === ConsoleType.WARN ||
-        consoleType === ConsoleType.ERROR;
-};
-exports.someConsoleType = someConsoleType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-fail-on-console-error",
-  "version": "3.3.0",
+  "version": "4.0.0",
   "description": "fail cypress test on console error",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -40,16 +40,16 @@
   "devDependencies": {
     "@types/chai": "4.3.3",
     "@types/expect": "24.3.0",
-    "@types/mocha": "9.1.1",
+    "@types/mocha": "10.0.0",
     "@types/sinon": "10.0.13",
     "@types/sinon-chai": "3.2.8",
     "@types/type-detect": "4.0.1",
-    "cypress": "10.8.0",
+    "cypress": "10.9.0",
     "mocha": "10.0.0",
     "prettier": "2.7.1",
     "prettier-plugin-organize-imports": "3.1.1",
     "rimraf": "3.0.2",
     "ts-mocha": "10.0.0",
-    "typescript": "4.8.3"
+    "typescript": "4.8.4"
   }
 }