@nest-yalc-2/jest-config 2.2.0 → 2.2.2

package/src/jest-def.config.ts

@@ -0,0 +1,220 @@
+/* istanbul ignore file */
+
+import * as path from 'path';
+import * as readTsConfig from 'get-tsconfig';
+import { pathsToModuleNameMapper } from 'ts-jest';
+import { defaults } from 'jest-config';
+import type { JestConfigWithTsJest } from 'ts-jest';
+
+export const coveragePathIgnorePatterns = [
+  '/env/dist/',
+  '/node_modules/',
+  '/database/seeds/',
+  '/database/migrations/',
+  '/test/feature/',
+];
+
+export const globals = () => {
+  return {
+    __JEST_DISABLE_DB: true,
+  };
+};
+
+export const tsJestConfigE2E = (
+  tsConfPath = '',
+  withGqlPlugin = true,
+  overrideTsJestConfig?: any,
+) => {
+  const tsConfigFile = readTsConfig.getTsconfig(path.resolve(tsConfPath));
+  const { tsconfig, ...restTsJest } = overrideTsJestConfig ?? {};
+
+  const conf: any = {
+    diagnostics: false,
+    tsconfig: {
+      ...(tsConfigFile?.config.compilerOptions ?? {}),
+      ...(tsconfig ?? {}),
+    },
+    ...restTsJest,
+  };
+
+  if (withGqlPlugin) {
+    conf.astTransformers = {
+      before: [path.join(__dirname, 'gql-plugin.js')],
+    };
+  }
+
+  return conf;
+};
+
+export const tsJestConfig = (tsConfPath = '', overrideTsJestConfig?: any) => {
+  const tsConfigFile = readTsConfig.getTsconfig(
+    path.resolve(path.dirname(tsConfPath)),
+    path.basename(tsConfPath),
+  );
+
+  if (tsConfigFile?.path && path.resolve(tsConfigFile.path) !== path.resolve(tsConfPath)) {
+    throw new Error(`Cannot find ${tsConfPath}`);
+  }
+
+  const { tsconfig, ...restTsJest } = overrideTsJestConfig ?? {};
+
+  const config = {
+    tsconfig: {
+      ...(tsConfigFile?.config.compilerOptions ?? {}),
+      ...(tsconfig ?? {}),
+      importHelpers: true,
+    },
+    diagnostics: false,
+    ...restTsJest,
+  };
+
+  return config;
+};
+
+export const coverageThreshold = (
+  projects: any[] = [],
+  defaultCoverageThreshold = {
+    branches: 100,
+    functions: 100,
+    lines: 100,
+    statements: 100,
+  },
+) => {
+  const coverage: Record<string, any> = {
+    global: {
+      ...defaultCoverageThreshold,
+    },
+  };
+
+  projects.map((project) => {
+    // /**
+    //  * @todo  should be removed and be set to 100% asap
+    //  */
+    // switch (project.name) {
+    //   case 'unit/common/crud-gen':
+    //     branches = 92.27;
+    //     functions = 98.92;
+    //     lines = 98.75;
+    //     statements = 98.5;
+    //     break;
+    //   default:
+    //     branches = 100;
+    //     break;
+    // }
+
+    coverage[project.rootDir] = {
+      ...defaultCoverageThreshold,
+    };
+
+    if (project?.coverageThreshold) {
+      coverage[project.rootDir] = {
+        ...coverage[project.rootDir],
+        ...project?.coverageThreshold,
+      };
+    }
+  });
+
+  return coverage;
+};
+
+export interface IDefaultConfOptions {
+  /** node modules to transform
+   * string array -> add extra esmodule to transform
+   * true -> transform esmodule only using the default array
+   * false -> disable esmodule transformation (default)
+   */
+  transformEsModules?: string[] | boolean;
+  tsJestConf?: any;
+  jestConf?: any;
+}
+
+/**
+ * for both unit and e2e
+ * @param dirname
+ * @returns
+ */
+const defaultConf = (
+  dirname: string,
+  options: IDefaultConfOptions = {},
+  _tsJestConfig: any = {},
+): JestConfigWithTsJest => {
+  const tsConfigFile = readTsConfig.getTsconfig(
+    path.join(dirname, 'tsconfig.json'),
+  );
+  const compilerOptions = tsConfigFile?.config.compilerOptions ?? {};
+
+  // We need this to make sure that some esm modules are transformed
+  // ref: https://github.com/nrwl/nx/issues/812
+  // ref: https://github.com/jaredpalmer/tsdx/issues/187#issuecomment-825536863
+
+  const config: JestConfigWithTsJest = {
+    rootDir: dirname,
+    modulePathIgnorePatterns: [
+      '<rootDir>/var/',
+      '<rootDir>/env/',
+      '<rootDir>/docs/',
+      '<rootDir>/dist/',
+      '<rootDir>/../dist/',
+      '<rootDir>/node_modules/',
+      '.*/dist/',
+    ],
+    preset: 'ts-jest/presets/default-esm',
+    testEnvironment: 'node',
+    moduleFileExtensions: [...defaults.moduleFileExtensions, 'ts'], // add typescript to the default options
+    testRegex: '.*\\.spec\\.ts$',
+    transform: {
+      '^.+\\.(t|j)sx?$': [
+        'ts-jest',
+        {
+          useESM: true,
+          tsconfig: {
+            ...compilerOptions,
+            importHelpers: true,
+          },
+          ..._tsJestConfig,
+        },
+      ],
+    },
+    moduleNameMapper: {
+      // this fixes the issue with wrong line numbers in stack traces,
+      /** @see https://github.com/kulshekhar/ts-jest/issues/727 */
+      'source-map-support/register': 'identity-obj-proxy',
+      '^(@nest-yalc-2/.*|@node-yalc/.*|\\.{1,2}/.*)\\.js$': [
+        '$1.ts',
+        '$1/index.ts',
+        '$1.js',
+        '$1',
+      ],
+      ...pathsToModuleNameMapper(compilerOptions.paths ?? {}, {
+        prefix: `${dirname}/`,
+        useESM: true,
+      }),
+    },
+    errorOnDeprecated: true,
+    extensionsToTreatAsEsm: ['.ts'],
+    // injectGlobals: false,
+    ...options?.jestConf,
+  };
+
+  if (options.transformEsModules) {
+    const esModules = [
+      ...(Array.isArray(options.transformEsModules)
+        ? options.transformEsModules
+        : []),
+      'aggregate-error',
+      'clean-stack',
+      'escape-string-regexp',
+      'indent-string',
+      'p-map',
+      'lodash-es',
+    ].join('|');
+
+    config.transformIgnorePatterns = [
+      `[/\\\\]node_modules[/\\\\](?!${esModules}).+\\.(js|jsx|ts|tsx)$`,
+    ];
+  }
+
+  return config;
+};
+
+export default defaultConf;

package/src/jest.setup.d.ts

@@ -0,0 +1 @@
+export {};

package/src/jest.setup.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+process.env.NODE_ENV = 'test';
+if (!process.env.LISTENING_TO_UNHANDLED_REJECTION) {
+    process.on('unhandledRejection', (err) => {
+        throw err;
+    });
+    process.env.LISTENING_TO_UNHANDLED_REJECTION = 'true';
+}
+jest.mock('@nestjs/graphql', () => {
+    const actual = jest.requireActual('@nestjs/graphql');
+    const mockedModule = Object.assign({}, actual);
+    const decorators = [
+        'Args', 'Field', 'Query', 'Mutation', 'Resolver', 'InputType', 'ObjectType',
+        'InterfaceType', 'ResolveField', 'HideField', 'Directive', 'registerEnumType', 'IntersectionType'
+    ];
+    for (const name of decorators) {
+        if (actual[name]) {
+            mockedModule[name] = jest.fn().mockImplementation((...args) => {
+                return actual[name](...args);
+            });
+        }
+    }
+    return mockedModule;
+});
+//# sourceMappingURL=jest.setup.js.map

package/src/jest.setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.setup.js","sourceRoot":"","sources":["jest.setup.ts"],"names":[],"mappings":";;AAGA,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC;AAI9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,CAAC;IAClD,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,GAAG,EAAE,EAAE;QACvC,MAAM,GAAG,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,gCAAgC,GAAG,MAAM,CAAC;AACxD,CAAC;AA6BD,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAChC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC;IACrD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAC/C,MAAM,UAAU,GAAG;QACjB,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY;QAC3E,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,kBAAkB,EAAE,kBAAkB;KAClG,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACjB,YAAY,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE;gBAC5D,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC,CAAC"}

package/src/jest.setup.ts

@@ -0,0 +1,58 @@
+/// <reference types="jest" />
+/* istanbul ignore file */
+
+process.env.NODE_ENV = 'test';
+
+// without this, jest won't fail with unhandled promises
+// (e.g. missing awaits)
+if (!process.env.LISTENING_TO_UNHANDLED_REJECTION) {
+  process.on('unhandledRejection', (err) => {
+    throw err;
+  });
+  // Avoid memory leak by adding too many listeners
+  process.env.LISTENING_TO_UNHANDLED_REJECTION = 'true';
+}
+
+// try {
+//   jest.unstable_mockModule('@nestjs/graphql', () => {
+//     class Fake {}
+//     return {
+//       ...jest.requireActual<any>('@nestjs/graphql'),
+//       InputType: () => jest.fn(),
+//       OmitType: () => Fake,
+//       PickType: () => Fake,
+//       PartialType: () => Fake,
+//       IntersectionType: () => Fake,
+//     };
+//   });
+//   // eslint-disable-next-line no-console
+//   console.debug('Mocked @nestjs/graphql');
+// } catch (e) {
+//   // eslint-disable-next-line no-console
+//   console.debug("Can't mock @nestjs/graphql. Not installed?");
+// }
+
+// jest.mock('@nestjs/common', () => {
+//   return {
+//     ...jest.requireActual<any>('@nestjs/common'),
+//     Injectable: () => jest.fn(),
+//   };
+// });
+
+
+jest.mock('@nestjs/graphql', () => {
+  const actual = jest.requireActual('@nestjs/graphql');
+  const mockedModule = Object.assign({}, actual);
+  const decorators = [
+    'Args', 'Field', 'Query', 'Mutation', 'Resolver', 'InputType', 'ObjectType',
+    'InterfaceType', 'ResolveField', 'HideField', 'Directive', 'registerEnumType', 'IntersectionType'
+  ];
+  for (const name of decorators) {
+    if (actual[name]) {
+      mockedModule[name] = jest.fn().mockImplementation((...args) => {
+        return actual[name](...args);
+      });
+    }
+  }
+  return mockedModule;
+});

package/src/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@nest-yalc-2/jest-config",
+  "version": "2.2.2",
+  "description": "",
+  "main": "./index.ts",
+  "exports": {
+    ".": "./dist/src/index.js",
+    "./*": "./dist/src/*"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Autistic_Intelligence",
+  "license": "MIT",
+  "types": "./index.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "tslib": "^2.6.3"
+  },
+  "keywords": [
+    "nestjs",
+    "yalc",
+    "framework",
+    "jest config"
+  ]
+}

package/src/src/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @nest-yalc-2/jest-config
+
+## 1.3.3
+
+### Patch Changes
+
+- Publish npm-safe README files for every package and prevent Jekyll landing-page
+  markup from being copied into npm tarballs.

package/src/src/README.md

@@ -0,0 +1,31 @@
+# @nest-yalc-2/jest-config
+
+Reusable Jest configuration generators for YALC-style TypeScript and NestJS
+projects.
+
+Use this package when a consuming workspace wants the same ts-jest defaults,
+coverage threshold handling, GraphQL AST transformer, and project generation
+used by the YALC monorepo.
+
+## Installation
+
+```bash
+npm install --save-dev @nest-yalc-2/jest-config
+```
+
+## Main Exports
+
+- `jestConfGenerator` for creating multi-project Jest configs.
+- `createE2EConfig` for e2e Jest configuration.
+- `tsJestConfig` and `tsJestConfigE2E` for ts-jest setup.
+- `coverageThreshold`, `coveragePathIgnorePatterns`, and default globals.
+
+## Example
+
+```ts
+import { jestConfGenerator } from '@nest-yalc-2/jest-config';
+
+export default jestConfGenerator(rootPath, projects, appProjects, {
+  skipProjects: ['types'],
+});
+```

package/src/src/config/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @nest-yalc-2/jest-config
+
+## 1.3.3
+
+### Patch Changes
+
+- Publish npm-safe README files for every package and prevent Jekyll landing-page
+  markup from being copied into npm tarballs.

package/src/src/config/README.md

@@ -0,0 +1,31 @@
+# @nest-yalc-2/jest-config
+
+Reusable Jest configuration generators for YALC-style TypeScript and NestJS
+projects.
+
+Use this package when a consuming workspace wants the same ts-jest defaults,
+coverage threshold handling, GraphQL AST transformer, and project generation
+used by the YALC monorepo.
+
+## Installation
+
+```bash
+npm install --save-dev @nest-yalc-2/jest-config
+```
+
+## Main Exports
+
+- `jestConfGenerator` for creating multi-project Jest configs.
+- `createE2EConfig` for e2e Jest configuration.
+- `tsJestConfig` and `tsJestConfigE2E` for ts-jest setup.
+- `coverageThreshold`, `coveragePathIgnorePatterns`, and default globals.
+
+## Example
+
+```ts
+import { jestConfGenerator } from '@nest-yalc-2/jest-config';
+
+export default jestConfGenerator(rootPath, projects, appProjects, {
+  skipProjects: ['types'],
+});
+```

package/src/src/config/gql-plugin.js

@@ -0,0 +1,25 @@
+/* istanbul ignore file */
+
+/* eslint-disable @typescript-eslint/no-var-requires */
+const transformer = require('@nestjs/graphql/plugin');
+
+module.exports.name = 'nestjs-graphql-transformer';
+// you should change the version number anytime you change the configuration below - otherwise, jest will not detect changes
+module.exports.version = 4;
+
+module.exports.factory = (cs) => {
+  return transformer.before(
+    {
+      typeFileNameSuffix: [
+        '.input.ts',
+        '.args.ts',
+        '.arg.ts',
+        '.entity.ts',
+        '.type.ts',
+        '.dto.ts',
+      ],
+      introspectComments: true,
+    },
+    cs.program, // "cs.tsCompiler.program" for older versions of Jest (<= v27)
+  );
+};

package/src/src/config/index.d.ts

@@ -0,0 +1,2 @@
+export * from './jest-conf.generator.js';
+export * from './jest-def.config.js';

package/src/src/config/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./jest-conf.generator.js"), exports);
+tslib_1.__exportStar(require("./jest-def.config.js"), exports);
+//# sourceMappingURL=index.js.map

package/src/src/config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,+DAAqC"}

package/src/src/config/index.ts

@@ -0,0 +1,2 @@
+export * from './jest-conf.generator.js';
+export * from './jest-def.config.js';

package/src/src/config/jest-conf.generator.d.ts

@@ -0,0 +1,53 @@
+import type { JestConfigWithTsJest } from 'ts-jest';
+import { IDefaultConfOptions } from './jest-def.config.js';
+interface IAppDep {
+    name: string;
+    path: string;
+}
+export interface IAppProjSetting {
+    confOverride?: any;
+    deps: IAppDep[];
+}
+export interface IProjectInfo {
+    path: string;
+    sourcePath: string;
+    type: 'library' | 'application' | string;
+}
+export interface IOptions {
+    skipProjects?: string[];
+    confOverrides?: {
+        [key: string]: any;
+    };
+    defaultCoverageThreshold?: {
+        branches: number;
+        functions: number;
+        lines: number;
+        statements: number;
+    };
+    tsConfigPath?: {
+        (proj: IProjectInfo): string;
+    };
+    coverageOutputPath?: {
+        (subProjectPath: string): string;
+    };
+    defaultConfOptions?: IDefaultConfOptions;
+    tsJestConfig?: any;
+    extraSetupFiles?: string[];
+    setupFilesAfterEnv?: string[];
+}
+export declare function jestConfGenerator(rootPath: string, projectList: {
+    [key: string]: IProjectInfo;
+}, appProjectsSettings: {
+    [key: string]: IAppProjSetting;
+}, options: IOptions): JestConfigWithTsJest;
+export interface E2EOptions {
+    alias?: string;
+    e2eDirname: string;
+    rootDirname: string;
+    defaultConfOptions?: IDefaultConfOptions;
+    confOverride?: JestConfigWithTsJest;
+    withGqlPlugins?: boolean;
+    tsJestConfig?: any;
+}
+export declare const createE2EConfig: (options: E2EOptions) => JestConfigWithTsJest;
+export {};