Unexpected artifacts are being introduced to the build folder by the compiler

Question

Unexpected artifacts are being introduced to the build folder by the compiler

Currently, I am following the steps outlined in this Getting Started guide to set up the installation of tsoa. According to their instructions, I have created a routes.ts folder and placed it under /build:

/build
  /routes.ts

Next, in /src/app.tsx, I make a reference to it:

import { RegisterRoutes } from "/build/routes"

However, when I execute

yarn run tsc --outDir build --experimentalDecorators

, I encounter an unexpected directory structure within /build:

/build
  /build
  /src
    server.js
  routes.ts

This issue seems to be occurring because of the way I am referencing "/build/routes", resulting in both /build and /src being copied into /build. What I actually desire is only the contents of /src to be copied into the build.

/build
  routes.ts
  server.js

Even after adding includes: ["src"] to my tsconfig.json, the problem persists.

I'm curious if there might be something specific I've done locally that could be causing this behavior?

typescript

Answer 1

Answer №1

When TypeScript generates files, it follows the rootDir directory specified in the tsconfig.json. If this is not set, TypeScript will automatically determine the common path among all input files. Given that there are files in both the build and src directories, the common path would be the directory that encompasses both folders as well as contains the tsconfig.json file.

You cannot import files outside of this designated rootDir, so manually setting it to src in the tsconfig.json will not work in this scenario.

Solution:

If you adjust the route files to output to the src directory by modifying tsoa.json and then importing from the route file, the rootDir will be automatically set to your desired location. The modification in tsoa.json should be:

"routes": {
    "routesDir": "src"
  }

Following this change, the corresponding import in your app.ts file (after executing yarn run tsoa routes) would look like:

import { RegisterRoutes } from './routes';

Alternatively:

If you specifically want the routes file in the build directory, another option is creating a symbolic link from the routes.ts file to the src directory. You can still import from ./routes in your app.ts.

Solution:

If you adjust the route files to output to the src directory by modifying tsoa.json and then importing from the route file, the rootDir will be automatically set to your desired location. The modification in tsoa.json should be:

"routes": {
    "routesDir": "src"
  }

Following this change, the corresponding import in your app.ts file (after executing yarn run tsoa routes) would look like:

import { RegisterRoutes } from './routes';

Alternatively:

If you specifically want the routes file in the build directory, another option is creating a symbolic link from the routes.ts file to the src directory. You can still import from ./routes in your app.ts.

Unexpected artifacts are being introduced to the build folder by the compiler

Answer №1

Solution:

Alternatively:

Further reading:

Similar questions

Using Typescript and React to manage controlled components and selecting a single checkbox within a group

Guide to implementing lazy loading and sorting in p-Table with Angular2

Unlock the Power of Angular: Leveraging ViewEncapsulation.Native to Access HTML Elements

Execute --runTestsByPath on two or more distinct paths

Javascript operations for duplicating and altering arrays

The observable HTTP map appears to be more of a representation rather than a concrete entity

Troubleshooting Issue with Mongoose Virtual Field Population

The Angular 2 Router's navigation functionality seems to be malfunctioning within a service

How can we utilize Typescript to check if the intern 4 page has finished loading?

Retrieving an Enum member based on its value in TypeScript

Template specific requirements in Angular

Is there a way to exclusively view references of a method override in a JS/TS derived class without any mentions of the base class method or other overrides in VS Code?

"Enhance your Vue 3 projects with a dynamic library featuring universal components and full

Navigating through Objects in Angular 9

Angular2: Continuous User Authentication Guard

Issue with MIME handling while utilizing Vue-Router in combination with Express

Exploring Node Stream.Writable Extension in Typescript 4.8

Using Typescript generics within a callback function

What is the best way to handle a ReadableStream for a POST request?

TS2688 Error: Type definition file for 'tooltip.js' not found