feat: change typedef output location for dist-custom-elements

[minecrawler]

Prerequisites

• I have read the Contributing Guidelines.
• I agree to follow the Code of Conduct.
• I have searched for existing issues that already include this feature request, without success.

Describe the Feature Request

Stencil currently does not allow you to specify a destination for type declarations that are generated by the dist-custom-elements output target when generateTypeDeclarations: true is set.

Users should be able to configure the target to write type declarations to a different destination (or at least alongside the output target's dir location).

Describe the Use Case

no response

Describe Preferred Solution

{
  type: 'dist-custom-elements',
  dir: 'my/out/dir',
  typesDir: 'my/out/dir/types'
}

OR

{
  type: 'dist-custom-elements',
  dir: 'my/out/dir',
  adjacentTypeDefs: true
}

[minecrawler]

I also just tried to disbale types generation (generateTypeDeclarations: false), which leads to the paths being nearly correct... however they now start with a ., but the slash for the directory is missing :(

For example:

import type { Components, JSX } from ".types/components";

instead of

import type { Components, JSX } from "./types/components";

[tanner-reits]

Hi @minecrawler 👋

So, I think there's two things in your report. First off, Stencil currently doesn't allow you to change where type declaration are generated via the dist-custom-elements output target. That is called out in the Stencil documentation:

Type declaration files will be placed in the dist/types directory in the root of a Stencil project. At this time, this output destination is not able to be configured.

However, we are open to enabling this behavior. That being said, I'm going to convert this issue into a feature request to gauge interest and help us prioritize that work.

Secondly, your comment does appear to be a valid issue. That being said, I'll create a separate issue (#4630) to track that work.

So, keep an eye on both threads for future updates and changes! Thanks again for reporting!

[minecrawler]

Hi @tanner-reits ,
Thank you for clearing it up and sorting it out. I was upgrading from a v2 and the typegen changes weren't immediately clear to me, but as you pointed out the docs address the issue.

I was confused about the location of the types, but even more so that the output references them which makes the build unusable for me. I wrote a script to fix the problem for me as a workaround, but I'll also add my use case and hope that the feature will land at some point.