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.

Sign up for GitHub

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

Jump to bottom

feat: enable c12 for loading config and provide defineConfig #913

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

feat: enable c12 for loading config and provide defineConfig #913

wants to merge 15 commits into from

Conversation

ineshbose
Copy link
Collaborator

@ineshbose ineshbose commented Nov 18, 2024 •
edited
Loading

🔗 Linked issue

resolves #808 and partly #842

should also resolve #902

❓ 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

Play: https://stackblitz.com/github/nuxt-modules/tailwindcss/tree/c12-refactor

@netlify Netlify
Copy link

netlify bot commented Nov 18, 2024 •
edited
Loading

✅ Deploy Preview for nuxt-tailwindcss ready!

Name Link
🔨 Latest commit 0818970
🔍 Latest deploy log https://app.netlify.com/sites/nuxt-tailwindcss/deploys/6740b647e8cc030009053dac
😎 Deploy Preview https://deploy-preview-913--nuxt-tailwindcss.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@what-the-diff What The Diff
Copy link

what-the-diff bot commented Nov 18, 2024

PR Summary

  • Package Configuration Adjustments

    • Updated the routing path for TypeScript types to ensure accuracy.
    • Added new export capabilities for the configuration module, along with the appropriate type and import pathways.
    • Included a new dependency named c12.

  • New Configuration File Addition

    • Added a new file designed to handle configuration functionality. This configures the Tailwind CSS utility based on the pre-defined protocols in c12.

  • Context File Modifications

    • Renamed and updated a key function for configuration checking purposes.
    • Enhanced the error handling process for warning messages related to Tailwind configurations.

  • Module File Updates

    • Removed previous warning notifications related to module options and adjusted the default setup for the Tailwind configuration.
    • Updated the process for providing editor support with updated checks for module options.

  • Merger File Enhancements

    • Adjusted the structure inside the merging function, particularly around function definitions, to enhance readability while keeping the functionality intact.

  • Type File Changes

    • Introduced a new feature that allows for either single or multiple values in configuration.
    • Updated several configuration fields to make use of this feature and marked some fields as outdated with corresponding documentation for updates.

  • Viewer File Updates

    • Integrated a feature into the Tailwind CSS viewer to add a custom tab in the Nuxt developer tools.
    • Removed previous code that was meant to prevent the watcher from scanning prerendering options.

ineshbose
ineshbose commented Nov 19, 2024
View reviewed changes
src/internal-context/load.ts Outdated Show resolved Hide resolved
src/types.ts
@@ -72,21 +76,22 @@ export interface ModuleOptions {
/**
* The path of the Tailwind configuration file. The extension can be omitted, in which case it will try to find a `.js`, `.cjs`, `.mjs`, or `.ts` file.
*
* @default 'tailwind.config'
* @default []
* @deprecated provide string in `config`
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

check with atinux on this

src/module.ts Outdated Show resolved Hide resolved
ineshbose
ineshbose commented Nov 19, 2024
View reviewed changes
src/module.ts Outdated Show resolved Hide resolved
@ineshbose ineshbose mentioned this pull request Nov 19, 2024
Open
2 tasks
ineshbose
ineshbose commented Nov 19, 2024
View reviewed changes
src/types.ts Show resolved Hide resolved
@ineshbose
Copy link
Collaborator Author

ineshbose commented Nov 19, 2024 •
edited
Loading

  • tests

@ineshbose
Copy link
Collaborator Author

ineshbose commented Nov 20, 2024 •
edited
Loading

docs and deprecation tests

these will be in a separate PR

@ineshbose ineshbose marked this pull request as ready for review November 22, 2024 17:05
ineshbose
ineshbose commented Nov 22, 2024
View reviewed changes
src/expose.ts
const populateMap = (obj: any, path: string[] = [], level = 1) => {
const getTWConfig = (
objPath: string[] = [],
twConfig = twCtx.use().config,
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

HMR with new configs is likely not working. investigate

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this is working here, but its the loadConfig in builder:watch hook

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@ineshbose