cypress-fail-on-console-error 5.0.1 → 5.1.0

package/README.md

@@ -1,6 +1,6 @@
 # cypress-fail-on-console-error
 
-This Plugin observes `console.error()` function from [window object](https://developer.mozilla.org/de/docs/Web/API/Window). Cypress test will fail when the error function gets executed. For observing network errors please check out [cypress-fail-on-network-requests](https://www.npmjs.com/package/cypress-fail-on-network-request).
+This Plugin observes `console.error()` function from [window object](https://developer.mozilla.org/de/docs/Web/API/Window). Cypress test will fail when the error conditions are met. For observing network errors please check out [cypress-fail-on-network-errors](https://www.npmjs.com/package/cypress-fail-on-network-errors).
 
 ### Installation
 
@@ -23,7 +23,7 @@ failOnConsoleError();
 | Parameter             | Default               | <div style="width:300px">Description</div>    |
 |---                    |---                    |---                                            |
 | `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.
+| `consoleTypes` | `['error']` | Define console types for observation. `error`, `warn`, `info`, `debug`, `trace , `table` are accepted values.
 | `debug`          | `false`               | Enable debug logs for `consoleMessage_configConsoleMessage_match` and `consoleMessage_excluded` to cypress runner                                     
 
 <br/>
@@ -32,9 +32,12 @@ failOnConsoleError();
 import failOnConsoleError, { Config } from 'cypress-fail-on-console-error';
 
 const config: Config = {
-    consoleMessages: ['foo', /^some bar-regex.*/],
-    consoleTypes: ['error', 'warn', 'info'],
-    debug: false,
+    consoleMessages: [
+        'foo', 
+        /^bar-regex.*/,
+        /^((?!include-console-messages).)*$/ 
+    ],
+    consoleTypes: ['error', 'warn'],
 };
 
 failOnConsoleError(config);
@@ -45,11 +48,11 @@ Use `failOnConsoleError` functions `getConfig()` and `setConfig()` with your own
 
 ```js
 // Simple example implementation
-const { getConfig, setConfig } = failOnConsoleError(config);
+const { getConfig, setConfig, ConsoleMessage } = failOnConsoleError(config);
 
 Cypress.Commands.addAll({
     getConsoleMessages: () => cy.wrap(getConfig().consoleMessages),
-    setConsoleMessages: (consoleMessages: (string | RegExp)[]) => 
+    setConsoleMessages: (consoleMessages: ConsoleMessage[]) => 
         setConfig({ ...getConfig(), consoleMessages });
 ```
 

package/dist/index.d.ts

@@ -1,12 +1,14 @@
 import * as sinon from 'sinon';
-type ConsoleType = 'error' | 'warn' | 'info';
+type ConsoleType = 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'table';
+type ConsoleMessage = string | RegExp;
 interface Config {
-    consoleMessages?: (string | RegExp)[];
+    consoleMessages?: ConsoleMessage[];
     consoleTypes?: ConsoleType[];
     debug?: boolean;
 }
 export { Config };
 export { ConsoleType };
+export { ConsoleMessage };
 export default function failOnConsoleError(_config?: Config): {
     getConfig: () => Required<Config> | undefined;
     setConfig: (_config: Config) => void;
@@ -17,6 +19,6 @@ export declare const createSpies: (config: Required<Config>, console: Console) =
 export declare const resetSpies: (spies: Map<ConsoleType, sinon.SinonSpy>) => Map<ConsoleType, sinon.SinonSpy>;
 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 isConsoleMessageExcluded: (consoleMessage: string, configConsoleMessage: ConsoleMessage, debug: boolean) => boolean;
 export declare const callToString: (calls: any[]) => string;
 export declare const cypressLogger: (name: string, message: any) => void;

package/dist/index.js

@@ -56,7 +56,14 @@ export const validateConfig = (config) => {
     if (config.consoleTypes) {
         chai.expect(config.consoleTypes).not.to.be.empty;
         config.consoleTypes.forEach((consoleType) => {
-            chai.expect(['error', 'warn', 'info']).contains(consoleType);
+            chai.expect([
+                'error',
+                'warn',
+                'info',
+                'debug',
+                'trace',
+                'table',
+            ]).contains(consoleType);
         });
     }
 };
@@ -72,6 +79,7 @@ export const createSpies = (config, console) => {
     var _a;
     let spies = new Map();
     (_a = config.consoleTypes) === null || _a === void 0 ? void 0 : _a.forEach((consoleType) => {
+        //TODO: function table does not exists on node.Console
         spies.set(consoleType, sinon.spy(console, consoleType));
     });
     return spies;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-fail-on-console-error",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "fail cypress test on console error",
   "type": "module",
   "main": "dist/index.js",
@@ -14,8 +14,8 @@
     "lint": "tsc --noEmit && tsc -p ./test/tsconfig.json && tsc -p ./cypress/tsconfig.json",
     "test": "npm run test:ut && npm run test:e2e && npm run test:cmp",
     "test:ut": "vitest run unit.test.ts",
-    "test:e2e": "vitest run e2e.test.ts --test-timeout 60000",
-    "test:cmp": "vitest run component.test.ts --test-timeout 60000",
+    "test:e2e": "vitest run e2e.test.ts --test-timeout 120000",
+    "test:cmp": "vitest run component.test.ts --test-timeout 120000",
     "verify": "npm run build && npm run lint && npm run ci:prettier && npm run test",
     "ci:prettier": "prettier --check \"**/*\""
   },
@@ -38,25 +38,25 @@
   "homepage": "https://github.com/nils-hoyer/cypress-fail-on-console-error#readme",
   "dependencies": {
     "chai": "^4.3.10",
-    "sinon": "^16.0.0",
+    "sinon": "^17.0.0",
     "sinon-chai": "^3.7.0",
     "type-detect": "^4.0.8"
   },
   "devDependencies": {
     "@cypress/mount-utils": "^4.0.0",
-    "@types/chai": "4.3.8",
+    "@types/chai": "4.3.11",
     "@types/expect": "24.3.0",
-    "@types/mocha": "10.0.2",
-    "@types/sinon": "10.0.19",
-    "@types/sinon-chai": "3.2.10",
-    "@types/type-detect": "4.0.1",
-    "cypress": "13.3.1",
+    "@types/mocha": "10.0.6",
+    "@types/sinon": "17.0.2",
+    "@types/sinon-chai": "3.2.12",
+    "@types/type-detect": "4.0.3",
+    "cypress": "13.6.2",
     "mocha": "10.2.0",
     "prettier": "3.0.3",
-    "prettier-plugin-organize-imports": "3.2.3",
+    "prettier-plugin-organize-imports": "3.2.4",
     "rimraf": "5.0.5",
-    "typescript": "5.2.2",
-    "vite": "^4.4.6",
-    "vitest": "^0.34.0"
+    "typescript": "5.3.3",
+    "vite": "^5.0.0",
+    "vitest": "^1.0.0"
   }
 }