feat: migrated from jasmine/karma to jest (#DS-2192) (koobiq#154)

Author: artembelik

.github/workflows/actions/setup-yarn/action.yml

@@ -5,7 +5,7 @@ runs:
   steps:
     - uses: actions/setup-node@v4
       with:
-        node-version-file: .node-version
+        node-version-file: .nvmrc
 
     - uses: actions/setup-node@v4
       with:

.node-version renamed to .nvmrc

@@ -1,14 +1,7 @@
-# Add files here to ignore them from prettier formatting
 .angular/
 .nx/
 node_modules/
-
 .yarn/
-yarn.lock
-
-*.api.md
-api-report.md
-
 /dist
 /tmp
 /temp
@@ -19,8 +12,11 @@ CHANGELOG.md
 /apps/docs/src/styles/koobiq/default-theme/
 /apps/docs/src/assets/versions.json
 
+# ignore public-api-guard
+/tools/public_api_guard/**/*.md
+
 # ignore auto-generated module
 /packages/docs-examples/example-module.ts
 
 # ignore nunjuck templates
-tools/api-gen/rendering/templates
+/tools/api-gen/rendering/templates

.prettierignore

@@ -200,21 +200,11 @@
                     }
                 },
                 "test": {
-                    "builder": "@angular-devkit/build-angular:karma",
-                    "options": {
-                        "karmaConfig": "packages/cdk/karma.conf.js",
-                        "main": "packages/cdk/test.ts",
-                        "tsConfig": "packages/cdk/tsconfig.spec.json",
-                        "codeCoverage": true
-                    }
-                },
-                "lint": {
-                    "builder": "@angular-eslint/builder:lint",
+                    "builder": "@angular-builders/jest:run",
                     "options": {
-                        "lintFilePatterns": [
-                            "packages/cdk/**/*.ts",
-                            "packages/cdk/**/*.html"
-                        ]
+                        "roots": ["packages/cdk"],
+                        "configPath": "../../jest.config.js",
+                        "tsConfig": "../../tsconfig.spec.json"
                     }
                 }
             }
@@ -247,15 +237,6 @@
                         "tsConfig": "packages/components/tsconfig.spec.json",
                         "codeCoverage": true
                     }
-                },
-                "lint": {
-                    "builder": "@angular-eslint/builder:lint",
-                    "options": {
-                        "lintFilePatterns": [
-                            "packages/components/**/*.ts",
-                            "packages/components/**/*.html"
-                        ]
-                    }
                 }
             }
         },
@@ -280,21 +261,11 @@
                     }
                 },
                 "test": {
-                    "builder": "@angular-devkit/build-angular:karma",
+                    "builder": "@angular-builders/jest:run",
                     "options": {
-                        "karmaConfig": "packages/angular-moment-adapter/karma.conf.js",
-                        "main": "packages/angular-moment-adapter/test.ts",
-                        "tsConfig": "packages/angular-moment-adapter/tsconfig.spec.json",
-                        "codeCoverage": true
-                    }
-                },
-                "lint": {
-                    "builder": "@angular-eslint/builder:lint",
-                    "options": {
-                        "lintFilePatterns": [
-                            "packages/angular-moment-adapter/**/*.ts",
-                            "packages/angular-moment-adapter/**/*.html"
-                        ]
+                        "roots": ["packages/angular-moment-adapter"],
+                        "configPath": "../../jest.config.js",
+                        "tsConfig": "../../tsconfig.spec.json"
                     }
                 }
             }
@@ -320,21 +291,11 @@
                     }
                 },
                 "test": {
-                    "builder": "@angular-devkit/build-angular:karma",
+                    "builder": "@angular-builders/jest:run",
                     "options": {
-                        "karmaConfig": "packages/angular-luxon-adapter/karma.conf.js",
-                        "main": "packages/angular-luxon-adapter/test.ts",
-                        "tsConfig": "packages/angular-luxon-adapter/tsconfig.spec.json",
-                        "codeCoverage": true
-                    }
-                },
-                "lint": {
-                    "builder": "@angular-eslint/builder:lint",
-                    "options": {
-                        "lintFilePatterns": [
-                            "packages/angular-luxon-adapter/**/*.ts",
-                            "packages/angular-luxon-adapter/**/*.html"
-                        ]
+                        "roots": ["packages/angular-luxon-adapter"],
+                        "configPath": "../../jest.config.js",
+                        "tsConfig": "../../tsconfig.spec.json"
                     }
                 }
             }

angular.json

@@ -8,7 +8,6 @@ The top-level directory structure:
 ├─ tools ···················· infrastructure/build scripts
 ├─ commitlint.config.js ····· scope-enum declaration
 ├─ gulpfile.js ·············· Gulp tasks config
-├─ wallaby.js ··············· Wallaby/Webpack config
 └─ package.json ············· Project config
 ```
 

docs/guides/directory-structure.en.md

@@ -0,0 +1,20 @@
+// @ts-check
+
+const { pathsToModuleNameMapper } = require('ts-jest');
+const { compilerOptions } = require('./tsconfig.json');
+
+/** @type {import('jest').Config} */
+const config = {
+    rootDir: __dirname,
+    bail: 1,
+    verbose: true,
+    resetModules: true,
+    clearMocks: true,
+    cacheDirectory: '<rootDir>/node_modules/.cache/jest',
+    preset: 'jest-preset-angular',
+    setupFilesAfterEnv: ['<rootDir>/tools/jest/setup.js'],
+    moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/' }),
+    testMatch: ['<rootDir>/**/*.spec.ts']
+};
+
+module.exports = config;

jest.config.js

@@ -12,9 +12,6 @@
         "type": "git",
         "url": "https://github.com/koobiq/angular-components.git"
     },
-    "engines": {
-        "node": ">= 18"
-    },
     "packageManager": "[email protected]",
     "requiredAngularVersion": "^17.0.0",
     "dependencies": {
@@ -38,6 +35,7 @@
         "zone.js": "^0.14.4"
     },
     "devDependencies": {
+        "@angular-builders/jest": "17.0.3",
         "@angular-devkit/architect-cli": "0.1702.0",
         "@angular-devkit/build-angular": "17.2.0",
         "@angular-devkit/core": "17.2.0",
@@ -80,6 +78,7 @@
         "@types/glob": "^7.1.4",
         "@types/inquirer": "^7.3.3",
         "@types/jasmine": "^4.6.4",
+        "@types/jest": "^29.5.12",
         "@types/license-checker": "^25.0.6",
         "@types/luxon": "^3.4.2",
         "@types/merge2": "^0.3.30",
@@ -109,6 +108,8 @@
         "inquirer": "^7.3.3",
         "jasmine": "^4.6.0",
         "jasmine-core": "^3.99.1",
+        "jest": "^29.7.0",
+        "jest-preset-angular": "^14.1.1",
         "karma": "^6.4.3",
         "karma-chrome-launcher": "^3.2.0",
         "karma-coverage": "^2.2.1",
@@ -141,11 +142,11 @@
         "stylelint": "^16.6.1",
         "stylelint-config-recommended-scss": "^14.0.0",
         "stylelint-prettier": "^5.0.0",
+        "ts-jest": "^29.2.2",
         "ts-node": "^10.9.1",
         "tsconfig-paths": "^3.9.0",
         "tsickle": "^0.39.1",
-        "typescript": "5.3.3",
-        "wallaby-webpack": "^3.9.16"
+        "typescript": "5.3.3"
     },
     "scripts": {
         "ng": "ng",
@@ -166,7 +167,7 @@
         "unit:components": "ng test components",
         "unit:angular-moment-adapter": "ng test angular-moment-adapter",
         "unit:angular-luxon-adapter": "ng test angular-luxon-adapter",
-        "unit:schematics": "ts-node --project packages/schematics/tsconfig.json node_modules/jasmine/bin/jasmine packages/schematics/**/*.spec.ts",
+        "unit:schematics": "jest --roots packages/schematics",
         "docs": "yarn run build:cdk && yarn run build:components && yarn run styles:built-all && yarn run build:angular-luxon-adapter && yarn run build:angular-moment-adapter && yarn run build:docs-content && yarn run build:package-docs-content && yarn run build:docs-examples-module && yarn run build:docs-examples && yarn run docs:start:dev",
         "docs:start:dev": "ng serve --configuration=development koobiq-docs",
         "docs:start:prod": "ng serve --configuration=production koobiq-docs",
@@ -175,7 +176,6 @@
         "docs:update-versions": "ts-node --project tools/update-doc-versions/tsconfig.json tools/update-doc-versions/update-doc-versions.ts",
         "docs:api-gen": "BASE_PATH=packages node --no-warnings=ExperimentalWarning --loader ts-node/esm/transpile-only tools/api-gen/generate-api-docs.mts",
         "preinstall": "node tools/npm/check-npm.js",
-        "prepare": "husky",
         "postinstall": "tsc -p tools/builders/tsconfig.json",
         "linter:angular-luxon-adapter": "eslint -c ./packages/angular-luxon-adapter/.eslintrc.json .",
         "linter:angular-moment-adapter": "eslint -c ./packages/angular-moment-adapter/.eslintrc.json .",

package.json

@@ -1,18 +1,13 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
-        "types": [
-            "node",
-            "jasmine"
-        ],
+        "types": ["node", "jest"],
         "paths": {
             "@koobiq/cdk/*": ["./dist/cdk/*"],
             "@koobiq/components/*": ["./dist/components/*"]
         }
     },
-    "include": [
-        "./**/*.ts"
-    ],
+    "include": ["./**/*.ts"],
     "angularCompilerOptions": {
         "annotateForClosureCompiler": true,
         "allowSyntheticDefaultImports": true,