Is there a way to exclude certain files from compilation in Typescript, but still include them for testing purposes

Question

Is there a way to exclude certain files from compilation in Typescript, but still include them for testing purposes

Organizing Files

In my project, I have structured my files as follows:
functions/lib/src/...src .ts files
functions/lib/test/...test files
functions/tsconfig.json

Initially, including the test files directory in the tsconfig.json.include property allowed linting to work successfully in the test files. However, when running tsc, the test files were also compiled into js.

Upon removing the test directory from the tsconfig.json include property, errors started appearing in the test files related to Jest methods, with messages like:

Cannot find name 'test'. Do you need to install type definitions for a test runner? Try npm i @types/jest or npm i @types/mocha.

This is how the tsconfig.json appears:

{
  "compilerOptions": {
    "module": "commonjs",
    "noImplicitReturns": true,
    "noUnusedLocals": true,
    "outDir": "lib",
    "sourceMap": true,
    "strict": true,
    "target": "es2017"
  },
  "compileOnSave": true,
  "include": [
    "src",
  ],

}

And here is the jest.config.js file:

module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
};

How can I ensure that Jest methods are recognized without having the test files compiled?

typescript jestjs ts-jest

Answer 1

Answer №1

I found the solution in this helpful article.

To exclude test files from compilation, you need to create a separate tsconfig.build.json file that extends your main tsconfig.json. Here's what the content of the new file should look like:

{
  "extends": "./tsconfig.json",
  // ⬇️ adjust this path based on how you name your test files
  "exclude": [
    "lib/test/*"
  ]
}

After setting up the build configuration, you can use the following command to transpile your code without including test files:

tsc --project tsconfig.build.json

Don't forget to add this command as a script in your package.json for easy access during the build process.

Answer 2

I found the solution in this helpful article.

To exclude test files from compilation, you need to create a separate tsconfig.build.json file that extends your main tsconfig.json. Here's what the content of the new file should look like:

{
  "extends": "./tsconfig.json",
  // ⬇️ adjust this path based on how you name your test files
  "exclude": [
    "lib/test/*"
  ]
}

After setting up the build configuration, you can use the following command to transpile your code without including test files:

tsc --project tsconfig.build.json

Don't forget to add this command as a script in your package.json for easy access during the build process.

Is there a way to exclude certain files from compilation in Typescript, but still include them for testing purposes

Answer №1

Similar questions

The 'ReactNode' binding element is automatically assigned an 'any' type

I attempted to mock a standalone class method using jest.spyOn, but unexpectedly the real method was executed instead of the mock implementation

Utilizing properties in a fresh function with Angular 2

NavigatedRoute and Auth-protect - problem retrieving ID from paramMap

Tips for utilizing PNG images in Next.js beyond the conventional PUBLIC folder

Guide for adjusting icon dimensions in Material-UI breakpoints

Tips for implementing a feature in Angular 6 that enables an input box to accept both negative and positive values within the range of 0 to

Obtaining Input Field Value in Angular Using Code

Tips for efficiently finding and comparing text within the results generated by a for loop in Angular/Javascript

Tips for adjusting the dimensions of a map within the app.component.html

Share a callback function with child components via props

Using TypeScript to deserialize various types from a shared object

Navigating through a multidimensional array in Angular 2 / TypeScript, moving both upwards and downwards

Tips for running batch files prior to debugging in VS Code

What is the reason behind the lack of exported interfaces in the redux-form typings?

Exploring the wonders of using the Async Pipe with Reactive Extensions

Exploring how React dynamically alters class names within snapshots

Exploring the directories: bundles, lib, lib-esm, and iife

Is there a way to simulate Pinia and vue-i18n simultaneously?

What is the proper method for integrating a loader into an observable HTTP request?