feat: add tailwind.config.ts support

[harlan-zw]

🔗 Linked issue

n/a

❓ 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 like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This exists for two reasons:

• Nuxt v3 is fully typescript, .js files are out of place
• Tailwind now ships types

This change introduces a way to define the config in typescript. While technically you could have typescript working if you provided your own configPath, it wasn't intuitive.

The changes are fairly minimal as the requireModule uses jiti already behind the scenes. I've documented the code for other nuances.

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[atinux]

Thank you @harlan-zw

I am not 100% sure about supporting .ts since it is not supported by TailwindCSS officially.

From what I see, when running npx tailwindcss init, they add the types with a comment now:

/** @type {import('tailwindcss').Config} */
module.exports = {
  // ...
}

What do you think of it?

[Tahul]

I would love to see this PR happen, I have the same feeling as @harlan-zw, seeing a .js file with module.exports syntax feels wrong!

Tailwind supports configuration typing via JSDoc type hints, but I think TypeScript looks way more natural in a Nuxt 3 project.

[harlan-zw]

I've removed the decorator from the PR to simplify the changes, swapped the types to use the official tailwind ones and made the doc clearer around the conventions.

Given that the module already supports typescript without this change, I think it's worthwhile documenting it for users and making it slightly easier for them if this is their preference.

I also think it's a matter of time before tailwind has a typescript config.

I'll leave it with you @atinux, happy either way

[atinux]

Much cleaner! Will merge and release thank you @harlan-zw

PS: nice new profile picture BTW!