Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(nuxt): Add readme docs for server-side setup (ESM) #13019

Merged
merged 2 commits into from
Jul 24, 2024
Merged

Conversation

s1gr1d
Copy link
Member

@s1gr1d s1gr1d commented Jul 23, 2024

Specify how Nuxt is set up on the server-side. Nuxt v3+ runs with ESM.

@s1gr1d s1gr1d requested review from mydea, Lms24 and andreiborza July 23, 2024 13:56
packages/nuxt/README.md Outdated Show resolved Hide resolved
@@ -140,6 +126,18 @@ Add an import flag to the node options, so the file loads before any other impor
}
```

If you are getting an `import-in-the-middle` error message, add the package with a minimum version of `1.10.0` as a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: I'm curious - Is there a concrete reason in Nuxt apps why users would run into this error? I think this is already rather specific for the SDK readme as it sounds a bit more like troubleshooting.

Generally, I'd tend towards keeping the Readmes in the repo rather short in favour of more detailed docs. They almost inevitably diverge at some point 🥲 But given we don't have docs yet for nuxt we can also leave this in and rethink if we need it once we give the readme a pass before going stable.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem will most likely occur because of iitm-related issues with vue/server-renderer (repro here and other issue comment here). That's why I added it here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can look at this in a follow up, but maybe we can auto-add this package to the exclude config for the users 🤔

@s1gr1d s1gr1d merged commit aaaedbc into develop Jul 24, 2024
29 checks passed
@s1gr1d s1gr1d deleted the sig/nuxt-esm branch July 24, 2024 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants