@equisoft/jest-utils 0.0.1-snapshot.20230613025310

package/README.md

@@ -0,0 +1,55 @@
+# @equisoft/jest-utils
+
+This package regroup utils to help write tests with Jest and create a standard config.
+
+## How to install
+
+```
+yarn add -DE @equisoft/jest-utils
+```
+
+## How to use
+### Create a jest config
+Create your `jest.config.js` file and import the `createJestConfig` function. The `createJestConfig` uses a deep merge that allow you to extend from the base Equisoft's config. 
+
+```javascript
+// jest.config.js
+
+const { createJestConfig } = require('@equisoft/jest-utils');
+const { pathsToModuleNameMapper } = require('ts-jest');
+const { compilerOptions } = require('./tsconfig.json');
+
+const config = {
+    moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths || [], { prefix: '<rootDir>/src/test' }),
+
+    roots: [
+        '<rootDir>/src/browser',
+        '<rootDir>/src/test',
+    ],
+    setupFilesAfterEnv: [
+        'jest-extended',
+        './src/test/setup-tests.ts',
+    ],
+
+    collectCoverageFrom: ['<rootDir>/src/browser/**/*.{js,jsx,ts,tsx}'],
+
+    transform: {
+        '^.+.m?[t]sx?$': ['ts-jest', {
+            tsconfig: 'src/test/tsconfig.json',
+            babelConfig: {
+                presets: [
+                    ['@babel/preset-env', { targets: { node: 'current' } }],
+                    '@babel/preset-react',
+                ],
+                plugins: [
+                    '@babel/plugin-transform-react-display-name',
+                    ['babel-plugin-styled-components', { fileName: false }],
+                ],
+            },
+        },
+        ],
+    },
+};
+
+module.exports = createJestConfig(config);
+```

package/dist/TsMockitoSerializer.d.ts

@@ -0,0 +1,2 @@
+import { NewPlugin } from 'pretty-format';
+export declare const tsMockitoSerializer: NewPlugin;

package/dist/TsMockitoSerializer.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tsMockitoSerializer = void 0;
+exports.tsMockitoSerializer = {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    test(arg) {
+        // eslint-disable-next-line no-underscore-dangle
+        return !!(arg && arg._isMockFunction && !('_isMockFunction' in arg));
+    },
+    serialize() {
+        return 'MockedInstance';
+    },
+};

package/dist/config/createJestConfig.d.ts

@@ -0,0 +1,2 @@
+import type { Config } from '@jest/types';
+export declare function createJestConfig(config: Partial<Config.InitialOptions>): Config.InitialOptions;

package/dist/config/createJestConfig.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createJestConfig = void 0;
+function isObject(obj) {
+    return obj !== null && obj !== undefined && typeof obj === 'object';
+}
+/* eslint-disable no-param-reassign */
+function mergeDeep(...objects) {
+    return objects.reduce((prev, obj) => {
+        Object.keys(obj).forEach((key) => {
+            const previousValue = prev[key];
+            const otherValue = obj[key];
+            if (Array.isArray(previousValue) && Array.isArray(otherValue)) {
+                prev[key] = previousValue.concat(...otherValue);
+            }
+            else if (isObject(previousValue) && isObject(otherValue)) {
+                prev[key] = mergeDeep(previousValue, otherValue);
+            }
+            else {
+                prev[key] = otherValue;
+            }
+        });
+        return prev;
+    }, {});
+}
+function createJestConfig(config) {
+    return Object.assign({}, mergeDeep({
+        clearMocks: true,
+        errorOnDeprecated: true,
+        collectCoverage: true,
+        coverageDirectory: '<rootDir>/build/jest/coverage',
+        coveragePathIgnorePatterns: [
+            '/index\\.[jt]sx?$',
+            '.+\\.d\\.ts$',
+        ],
+        coverageProvider: 'v8',
+        coverageReporters: [
+            // Supported reporters: https://istanbul.js.org/docs/advanced/alternative-reporters/
+            'text',
+            'html',
+            'clover', // ADR-05
+        ],
+        extensionsToTreatAsEsm: ['.jsx', '.ts', '.tsx'],
+        reporters: [
+            'default',
+            [
+                'jest-junit',
+                {
+                    outputDirectory: 'build/jest/',
+                    outputName: 'junit.xml',
+                    suiteNameTemplate: '{filepath}',
+                    classNameTemplate: '{classname}',
+                    titleTemplate: '{title}',
+                },
+            ],
+        ],
+        resetMocks: true,
+        snapshotSerializers: [require.resolve('@equisoft/jest-utils/serializer')],
+        testEnvironment: 'jsdom',
+        transformIgnorePatterns: [],
+    }, config));
+}
+exports.createJestConfig = createJestConfig;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { createJestConfig } from './config/createJestConfig';
+declare const _default: {
+    createJestConfig: typeof createJestConfig;
+};
+export = _default;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+const createJestConfig_1 = require("./config/createJestConfig");
+module.exports = {
+    createJestConfig: createJestConfig_1.createJestConfig,
+};

package/dist/serializer.d.ts

@@ -0,0 +1,2 @@
+import { tsMockitoSerializer } from './TsMockitoSerializer';
+export = tsMockitoSerializer;

package/dist/serializer.js

@@ -0,0 +1,3 @@
+"use strict";
+const TsMockitoSerializer_1 = require("./TsMockitoSerializer");
+module.exports = TsMockitoSerializer_1.tsMockitoSerializer;

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@equisoft/jest-utils",
+  "version": "0.0.1-snapshot.20230613025310",
+  "dependencies": {
+    "pretty-format": "29.5.0"
+  },
+  "devDependencies": {
+    "@equisoft/eslint-config-typescript": "3.0.3",
+    "@equisoft/typescript-config": "2.0.0",
+    "@jest/types": "29.5.0",
+    "@microsoft/eslint-formatter-sarif": "3.0.0",
+    "@types/node": "18.11.9",
+    "@typescript-eslint/eslint-plugin": "5.59.11",
+    "@typescript-eslint/parser": "5.59.11",
+    "eslint": "8.40.0",
+    "eslint-import-resolver-node": "0.3.7",
+    "eslint-import-resolver-typescript": "3.5.5",
+    "eslint-plugin-import": "2.27.5",
+    "globby": "13.1.4",
+    "ts-jest": "29.1.0",
+    "typescript": "5.0.4",
+    "yargs": "17.7.2"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./serializer": "./dist/serializer.js",
+    "./serializer.js": "./dist/serializer.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "jest-junit": "*",
+    "ts-jest": "*"
+  },
+  "scripts": {
+    "build": "tsc",
+    "eslint": "eslint src",
+    "eslint:ci": "yarn eslint"
+  }
+}