Klerith/pasos-node-ts-jest.md

Created August 19, 2023 18:35

Star () You must be signed in to star a gist
Fork () You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/Klerith/98d7b1bc0f1525e892f260813cad1007.js"></script>
Save Klerith/98d7b1bc0f1525e892f260813cad1007 to your computer and use it in GitHub Desktop.

Download ZIP

Note + TypeScript + Jest = Testing

Raw

pasos-node-ts-jest.md

Pasos para configurar Jest con TypeScript, en Node

Documentación oficial sobre Jest

Instalaciones de desarrollo (super test es útil para probar Express)

npm install -D jest @types/jest ts-jest supertest

Crear archivo de configuración de Jest

npx jest --init

En el archivo jest.config.js configurar

preset: 'ts-jest',
testEnvironment: "jest-environment-node",

// Opcional - The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: ['dotenv/config'],

Crear scripts en el package.json

"test": "jest",
"test:watch": "jest --watch",
"test:coverage": "jest --coverage",

pleivac commented Jun 25, 2024

Workaround para el error:

Error: Jest: Failed to parse the TypeScript config file C:\Users\...\jest.config.ts
Error: Jest: 'ts-node' is required for the TypeScript configuration files. Make sure it is installed
Error: Cannot find package 'ts-node' imported from

Hacer la instalación de ts-node:

npm install -D ts-node

cristianA123 commented Jul 1, 2024

AlejoDev95 commented Aug 13, 2024

Dejo mi configuración para usar path aliases

import type { Config } from "jest";

const config: Config = {
  collectCoverage: true,
  coverageDirectory: "coverage",
  coverageProvider: "v8",
  moduleNameMapper: {
    "^@src/(.*)$": "<rootDir>/src/$1",
  },
  preset: "ts-jest",
  testEnvironment: "jest-environment-node",
  transform: {
    "^.+\\.(ts|tsx)$": "ts-jest",
  },
  moduleFileExtensions: ["ts", "tsx", "js", "json"],
};

export default config;

{
  "compilerOptions": {
    "target": "es2016",
    "module": "commonjs",
    "rootDir": ".",
    "baseUrl": ".",
    "paths": {
      "@src/*": ["src/*"]
    },
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  },
  "include": ["src/**/*", "test/**/*"],
  "exclude": ["node_modules", "dist"]
}

Esto les permitira realizar importaciones como la siguiente

import { emailTemplate } from "@src/foundation/01_template";

describe("01_template", () => {
  it("should ", () => {
    const messageExpected = "Hi, ";
    expect(emailTemplate).toContain(messageExpected);
  });
});