nuxt / module-builder

Complete solution to build and ship Nuxt modules.
MIT License
211 stars 22 forks source link

build command creates symlink from dist to src #288

Closed markbrockhoff closed 1 week ago

markbrockhoff commented 2 weeks ago

Hi, I recently encountered an issue while trying to create a nuxt module within a turborepo project. It seems like the build command only generates a symlink from the dist/runtime folder to src/runtime. This was causing some issues for me when turborepo tried to restore the build cache containing the symlink.

I'm not sure if there's a reason for the symlink within the dist folder but I found it a bit strange so I wanted to report the issue here. The original issue raised for turborepo including a reproduction can be found here: https://github.com/vercel/turbo/issues/8476

danielroe commented 2 weeks ago

The symlink should only be created in stub mode. It's removed and a directory is created when building.

github-actions[bot] commented 1 week ago

We cannot recreate the issue with the provided information. Please add a reproduction in order for us to be able to investigate.

Why was this issue marked with the needs-reproduction label?

To be able to investigate, we need access to a reproduction to identify what triggered the issue. Please provide a link to either :

To make sure the issue is resolved as quickly as possible, please make sure that the reproduction is as minimal as possible. This means that you should remove unnecessary code, files, and dependencies that do not contribute to the issue.

I added a link, why was it still marked?

Ensure the link is pointing to a codebase that is accessible (e.g. not a private repository). "example.com", "n/a", "will add later", etc. are not acceptable links -- we need to see a public codebase. See the above section for accepted links.

What happens if I don't provide a sufficient minimal reproduction?

Issues with the needs-reproduction label that receives no meaningful activity (e.g. new comments with a reproduction link) will be closed by the maintainers and won't be looked at.

I did not open this issue, but it is relevant to me, what can I do to help?

Anyone experiencing the same issue is welcome to provide a minimal reproduction following the above steps. Furthermore, you can upvote the issue using a reaction on the topmost comment.

I think my reproduction is good enough, why aren't you looking into it quicker?

We constantly monitor open issues for new comments.

However, sometimes we might miss one or two. We apologize, and kindly ask you to refrain from tagging core maintainers, as that will usually not result in increased priority.

Upvoting issues to show your interest will help us prioritize and address them as quickly as possible.

I have a minimal reproduction to contribute to a closed issue.

If you have a minimal reproduction for a closed issue, please write a comment on the issue with a link to the reproduction. We will review it and reopen the issue if it is sufficient.

Useful Resources

markbrockhoff commented 1 week ago

I see, then this is not a nuxt related issue and only related to the handling of symlinks inside turborepo. Thanks for clarification @danielroe.