refactor(module): provide tailwind config through template

[ineshbose]

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

1. This change will work with @nuxtjs/tailwindcss@^6.11.1.
2. Configuration, especially with plugins, need to be passed through templates and not inline config. This will be beneficial for IntelliSense support as well.
3. This change also prepares the module for first-class HMR support to @nuxtjs/tailwindcss (planned for 6.12.0); refer refactor: first class HMR support nuxt-modules/tailwindcss#795

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
ui	✅ Ready (Inspect)	Visit Preview	Feb 1, 2024 10:55am

[ineshbose]

If we update @nuxt/ui-pro-edge and @nuxtjs/tailwindcss@6.11.1, it should work.

[ineshbose]

Minor gotcha: nuxi prepare will be required on a fresh project; shouldn't do nuxi dev directly (but a restart can also fix); this may be an upstream @nuxtjs/tailwindcss improvement to wait for templates:generated hook to be completed to start resolving configPath

[benjamincanac]

@ineshbose I'm getting this when trying to run the docs locally:

[ineshbose]

sure, give me a sec - testing it on my end.

[ineshbose]

@benjamincanac seems OK on my end - but the traceback goes to docs/nuxt.config.ts where we have

const { resolve } = createResolver(import.meta.url)

I looked over at our package.json and docs/package.json which don't specify "type": "module" - should that fix?

[benjamincanac]

The traceback goes to src/module.ts line 8 which is the import of installTailwind.

[benjamincanac]

You're able to run the docs propertly on dev branch? 🤔

[ineshbose]

You're able to run the docs propertly on dev branch? 🤔

I am - very odd!

I looked over at our package.json and docs/package.json which don't specify "type": "module" - should that fix?

This should definitely be the case though right, as Nuxt projects as ESM.

[benjamincanac]

Does this mean that everyone using @nuxt/ui will have this error if they don't add "type": "module"?

[benjamincanac]

Are you able to run dev:prepare too?

[ineshbose]

Does this mean that everyone using @nuxt/ui will have this error if they don't add "type": "module"?

No, it is unlikely to hit this error; just referring to Nuxt starter templates, they would/should have it specified.

https://github.com/nuxt/starter/blob/606a503171717391f2aced7439cda4aee6cd6d55/package.json#L4

https://github.com/nuxt/starter/blob/module/package.json#L7

[ineshbose]

Are you able to run dev:prepare too?

Yes - works on both my Ubuntu environment and Windows.

Some local change...?

[benjamincanac]

No I don't have local changes, it's coming from this: https://github.com/nuxt/ui/blob/dev/src/tailwind.ts#L12.

If I checkout the commit right before, everything's fine.

[benjamincanac]

Adding "type": "module" to both package.json didn't change a thing. Can you try with a clean install?

[ineshbose]

trying on my macbook now..

[ineshbose]

it's working 🤔

Can you send the output of npx nuxi info please?

[benjamincanac]

I don't get it. Are you running the docs from the rootDir with pnpm run dev?

[ineshbose]

Are you running the docs from the rootDir with pnpm run dev?

From root, yes, after doing pnpm i and pnpm dev:prepare.

[ineshbose]

We can use something else in tailwind.ts for the resolve function too 👍

[ineshbose]

Was this PR not working before being merged?

[benjamincanac]

Ok, I fixed it by restarting my mac, I'm so confused 😅 Sorry about that!

[ineshbose]

[benjamincanac]

@ineshbose The error comes back after some time everytime I restart, will try to refactor this it's too painful.

[ineshbose]

Okay let me know.

[benjamincanac]

8b08ede