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

package/README.md

@@ -22,16 +22,16 @@ failOnConsoleError();
 
 | Parameter             | Default               | <div style="width:300px">Description</div>    |
 |---                    |---                    |---                                            |
-| `excludeMessages`     | `undefined` | 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. |
+| `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                                     
 
 <br/>
 
 ```js
-import failOnConsoleError, { consoleType } from 'cypress-fail-on-console-error';
+import failOnConsoleError, { consoleType, Config } from 'cypress-fail-on-console-error';
 
-const config = {
+const config: Config = {
     excludeMessages: ['foo', /^some bar-regex.*/],
     includeConsoleTypes: [
         consoleType.ERROR,
@@ -46,7 +46,7 @@ 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
-//debug information will be printed to the cypress runner
+// cypressLog debug information will be printed to the cypress runner
 ```
 
 Using Javascript, consoleType Enum can be parsed as number values
@@ -61,10 +61,33 @@ failOnConsoleError({
 // 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.
+
+```js
+const { getConfig, setConfig } = failOnConsoleError(config);
+
+Cypress.Commands.addAll({
+    getExcludeMessages: () => cy.wrap(getConfig()),
+    setExcludeMessages: (excludeMessages: (string | RegExp)[]) => 
+        setConfig({ ...getConfig(), excludeMessages );
+```
+
+```js
+describe('example test', () => {
+    it('should set excluded messages', () => {
+        cy.setExcludeMessages(['foo', 'bar']).then(() => {
+            cy.visit('./cypress/fixtures/consoleError.html');
+        });
+    });
+});
+```
+
+
 ### 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)
 
 ### 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. Provide a PR with implementation and tests. Command `npm run verify` have to pass locally

package/dist/index.d.ts

@@ -1,14 +1,18 @@
 import * as sinon from 'sinon';
 import { Config } from './types/Config';
 import { ConsoleType } from './types/ConsoleType';
-export default function failOnConsoleError(config?: Config): void;
+export default function failOnConsoleError(_config?: Config): {
+    getConfig: () => Required<Config> | undefined;
+    setConfig: (_config: Config) => void;
+};
 export declare const validateConfig: (config: Config) => void;
-export declare const createConfig: (config: Config) => Config;
-export declare const createSpies: (config: Config, console: Console) => Map<ConsoleType, sinon.SinonSpy>;
+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: Config) => string | undefined;
-export declare const findIncludedCall: (spy: sinon.SinonSpy, config: Config) => string | undefined;
+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 callToString: (calls: any[]) => string;
 export declare const cypressLogger: (name: string, message: any) => void;
-export declare const consoleType: typeof ConsoleType;
+export { Config } from './types/Config';
+export { ConsoleType as consoleType } from './types/ConsoleType';

package/dist/index.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -36,11 +47,18 @@ 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) {
-    if (config === void 0) { config = {}; }
+function failOnConsoleError(_config) {
+    if (_config === void 0) { _config = {}; }
+    var originConfig;
+    var config;
     var spies;
-    (0, exports.validateConfig)(config);
-    config = (0, exports.createConfig)(config);
+    var getConfig = function () { return config; };
+    var setConfig = function (_config) {
+        (0, exports.validateConfig)(_config);
+        config = (0, exports.createConfig)(_config);
+        originConfig = originConfig !== null && originConfig !== void 0 ? originConfig : __assign({}, config);
+    };
+    setConfig(_config);
     Cypress.on('window:before:load', function (window) {
         spies = (0, exports.createSpies)(config, window.console);
     });
@@ -53,11 +71,17 @@ function failOnConsoleError(config) {
             throw new chai_1.AssertionError("cypress-fail-on-console-error: ".concat(os_1.EOL, " ").concat(errorMessage));
         }
     });
+    Cypress.on('test:after:run', function () {
+        setConfig(originConfig);
+    });
+    return {
+        getConfig: getConfig,
+        setConfig: setConfig,
+    };
 }
 exports.default = failOnConsoleError;
 var validateConfig = function (config) {
     if (config.excludeMessages) {
-        chai.expect(config.excludeMessages).not.to.be.empty;
         config.excludeMessages.forEach(function (_excludeMessage) {
             chai.expect((0, type_detect_1.default)(_excludeMessage)).to.be.oneOf([
                 'string',
@@ -75,13 +99,13 @@ var validateConfig = function (config) {
 };
 exports.validateConfig = validateConfig;
 var createConfig = function (config) {
-    var _a, _b;
+    var _a, _b, _c;
     return ({
-        excludeMessages: config.excludeMessages,
-        includeConsoleTypes: ((_a = config.includeConsoleTypes) === null || _a === void 0 ? void 0 : _a.length)
+        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: (_b = config.cypressLog) !== null && _b !== void 0 ? _b : false,
+        cypressLog: (_c = config.cypressLog) !== null && _c !== void 0 ? _c : false,
     });
 };
 exports.createConfig = createConfig;
@@ -165,4 +189,5 @@ var cypressLogger = function (name, message) {
     });
 };
 exports.cypressLogger = cypressLogger;
-exports.consoleType = ConsoleType_1.ConsoleType;
+var ConsoleType_2 = require("./types/ConsoleType");
+Object.defineProperty(exports, "consoleType", { enumerable: true, get: function () { return ConsoleType_2.ConsoleType; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-fail-on-console-error",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "description": "fail cypress test on console error",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,12 +10,11 @@
   "scripts": {
     "build": "npx rimraf dist/ && tsc",
     "prettier": "prettier --write \"**/*\"",
+    "lint": "tsc --noEmit && tsc -p ./test/tsconfig.json && tsc -p ./cypress/tsconfig.json",
     "test": "npm run test:ut && npm run test:it",
     "test:ut": "ts-mocha test/unitTest.ts",
-    "test:ut:debug": "ts-mocha --inspect-brk test/unitTest.ts",
     "test:it": "ts-mocha test/integrationTest.ts --timeout 60000",
-    "test:it:debug": "cypress open",
-    "verify": "npm run build && npm run ci:prettier && npm run test",
+    "verify": "npm run build && npm run lint && npm run ci:prettier && npm run test",
     "ci:prettier": "prettier --check \"**/*\""
   },
   "repository": {
@@ -39,18 +38,18 @@
     "sinon-chai": "^3.7.0"
   },
   "devDependencies": {
-    "@types/chai": "4.3.1",
+    "@types/chai": "4.3.3",
     "@types/expect": "24.3.0",
     "@types/mocha": "9.1.1",
     "@types/sinon": "10.0.13",
     "@types/sinon-chai": "3.2.8",
     "@types/type-detect": "4.0.1",
-    "cypress": "10.3.1",
+    "cypress": "10.8.0",
     "mocha": "10.0.0",
     "prettier": "2.7.1",
-    "prettier-plugin-organize-imports": "3.0.0",
+    "prettier-plugin-organize-imports": "3.1.1",
     "rimraf": "3.0.2",
     "ts-mocha": "10.0.0",
-    "typescript": "4.7.4"
+    "typescript": "4.8.3"
   }
 }