Proper daisyUI support.

Author: oliverandrich

CHANGELOG.md

@@ -27,6 +27,8 @@
     * If it is a relative path, this path is considered relative to `settings.BASE_DIR`.
     * The last option is an absolute path.
 
+- Proper daisyUI support using [tailwind-cli-extra](https://github.com/dobicinaitis/tailwind-cli-extra).
+
 ## 4.1.0
 
 - TAILWIND_CLI_VERSION defaults to "latest" now. In case it is set to this value,

docs/settings.md

@@ -65,7 +65,6 @@ your project.
     >    TAILWIND_CLI_ASSET_NAME = "tailwindcss-extra"
     >    ```
 
-
 `TAILWIND_CLI_SRC_CSS`
 **Default**: `None`
 
@@ -82,3 +81,21 @@ your project.
 
     The name of the output file. This file is stored relative to the first element of the
     `STATICFILES_DIRS` array.
+
+`TAILWIND_CLI_USE_DAISY_UI`:
+: **Default**: `False`
+
+    This switch determines what content is written to `TAILWIND_CLI_SRC_CSS` if it is automatically created by the library.
+
+    The default is:
+    ```css
+    @import "tailwindcss";
+    ```
+
+    If `TAILWIND_CLI_USE_DAISY_UI = True` is put into the `settings.py` of your project, this is the output:
+    ```css
+    @import "tailwindcss";
+    @plugin "daisyui";
+    ```
+
+    This switch can also be used as a shortcut to activate daisyUI and change `TAILWIND_CLI_SRC_REPO` and `TAILWIND_CLI_ASSET_NAME` as described above to fetch [tailwind-cli-extra](https://github.com/dobicinaitis/tailwind-cli-extra/releases/latest/).

docs/usage.md

@@ -105,11 +105,32 @@ tailwind-sidecar:
 
 ## Use with daisyUI
 
-If you plan to use the [daisyUI](https://daisyui.com) components in your project, I highly recommend the custom CLI build [tailwind-cli-extra](https://github.com/dobicinaitis/tailwind-cli-extra) by [Andris Dobičinaitis](https://github.com/dobicinaitis).
+If you plan to use [daisyUI](https://daisyui.com), there is an easy way to solve this with this library.
 
-Just add the following settings to your `settings.py`file.
+```python
+TAILWIND_CLI_USE_DAISY_UI = True
+```
+
+Setting this, the library switches from using the default TailwindCSS CLI to the one provided by [Andris Dobičinaitis](https://github.com/dobicinaitis) and his [tailwind-cli-extra](https://github.com/dobicinaitis/tailwind-cli-extra) project. It also causes the library to create a proper default config that activates the daisyUI plugin.
+
+But of course you can do it manually, too. Just configure a repository where the library should pull the CLI from and activate the daisyUI support.
 
 ```python
 TAILWIND_CLI_SRC_REPO = "dobicinaitis/tailwind-cli-extra"
 TAILWIND_CLI_ASSET_NAME = "tailwindcss-extra"
+TAILWIND_CLI_USE_DAISY_UI = True
 ```
+
+Or provide your custom configuration, too.
+
+```python
+TAILWIND_CLI_SRC_REPO = "dobicinaitis/tailwind-cli-extra"
+TAILWIND_CLI_ASSET_NAME = "tailwindcss-extra"
+TAILWIND_CLI_SRC_CSS = "etc/source.css"
+```
+
+## Use with WhiteNoise
+
+If you are using [WhiteNoise](https://whitenoise.readthedocs.io/en/latest/) to serve your static assets, you must not put your custom Tailwind configuration file inside any of the directories for static files. WhiteNoise stumbles across the `@import "tailwindcss";` statement, because it can't resolve it.
+
+If you want to use a custom configuration for Tailwind CSS, put it somewhere else in the project.

pyproject.toml

@@ -122,7 +122,7 @@ known-first-party = ["django_tailwind_cli"]
 ban-relative-imports = "all"
 
 [tool.ruff.lint.per-file-ignores]
-"tests/**/*" = ["PLR2004", "S101", "TID252", "ARG001"]
+"tests/**/*" = ["PLR2004", "S101", "TID252", "ARG001", "FBT001"]
 "tests/snapshots/*" = ["ALL"]
 "**/migrations/*" = ["ALL"]
 

src/django_tailwind_cli/config.py

@@ -22,6 +22,7 @@ class Config:
     dist_css_base: str
     src_css: Optional[Path]
     automatic_download: bool = True
+    use_daisy_ui: bool = False
 
     @property
     def watch_cmd(self) -> list[str]:
@@ -62,14 +63,18 @@ def get_version() -> tuple[str, Version]:
         ValueError: If the TAILWIND_CLI_SRC_REPO setting is None when the version is set to
         "latest".
     """
+    use_daisy_ui = getattr(settings, "TAILWIND_CLI_USE_DAISY_UI", False)
     version_str = getattr(settings, "TAILWIND_CLI_VERSION", "latest")
-    repo_url = getattr(settings, "TAILWIND_CLI_SRC_REPO", "tailwindlabs/tailwindcss")
+    repo_url = getattr(
+        settings,
+        "TAILWIND_CLI_SRC_REPO",
+        "tailwindlabs/tailwindcss" if not use_daisy_ui else "dobicinaitis/tailwind-cli-extra",
+    )
     if not repo_url:
         raise ValueError("TAILWIND_CLI_SRC_REPO must not be None.")
 
     if version_str == "latest":
         r = requests.get(f"https://github.com/{repo_url}/releases/latest/", timeout=2)
-        print(r.headers)
         if r.ok and "location" in r.headers:
             version_str = r.headers["location"].rstrip("/").split("/")[-1].replace("v", "")
             return version_str, Version.parse(version_str)
@@ -90,6 +95,9 @@ def get_config() -> Config:
     if settings.STATICFILES_DIRS is None or len(settings.STATICFILES_DIRS) == 0:
         raise ValueError("STATICFILES_DIRS is empty. Please add a path to your static files.")
 
+    # daisyUI support
+    use_daisy_ui = getattr(settings, "TAILWIND_CLI_USE_DAISY_UI", False)
+
     # Determine the system and machine we are running on
     system = platform.system().lower()
     system = "macos" if system == "darwin" else system
@@ -107,7 +115,11 @@ def get_config() -> Config:
     version_str, version = get_version()
 
     # Determine the asset name
-    if not (asset_name := getattr(settings, "TAILWIND_CLI_ASSET_NAME", "tailwindcss")):
+    if not (
+        asset_name := getattr(
+            settings, "TAILWIND_CLI_ASSET_NAME", "tailwindcss" if not use_daisy_ui else "tailwindcss-extra"
+        )
+    ):
         raise ValueError("TAILWIND_CLI_ASSET_NAME must not be None.")
 
     # Determine the full path to the CLI
@@ -121,7 +133,11 @@ def get_config() -> Config:
         cli_path = cli_path.expanduser() / f"{asset_name}-{system}-{machine}-{version_str}{extension}"
 
     # Determine the download url for the cli
-    repo_url = getattr(settings, "TAILWIND_CLI_SRC_REPO", "tailwindlabs/tailwindcss")
+    repo_url = getattr(
+        settings,
+        "TAILWIND_CLI_SRC_REPO",
+        "tailwindlabs/tailwindcss" if not use_daisy_ui else "dobicinaitis/tailwind-cli-extra",
+    )
     download_url = (
         f"https://github.com/{repo_url}/releases/download/v{version_str}/{asset_name}-{system}-{machine}{extension}"
     )
@@ -154,4 +170,5 @@ def get_config() -> Config:
         dist_css_base=dist_css_base,
         src_css=src_css,
         automatic_download=automatic_download,
+        use_daisy_ui=use_daisy_ui,
     )

src/django_tailwind_cli/management/commands/tailwind.py

@@ -279,6 +279,7 @@ def _download_cli(*, force_download: bool = False) -> None:
 
 
 DEFAULT_SOURCE_CSS = '@import "tailwindcss";\n'
+DAISY_UI_SOURCE_CSS = '@import "tailwindcss";\n@plugin "daisyui";\n'
 
 
 def _create_standard_config() -> None:
@@ -287,7 +288,10 @@ def _create_standard_config() -> None:
 
     if c.src_css and not c.src_css.exists():
         c.src_css.parent.mkdir(parents=True, exist_ok=True)
-        c.src_css.write_text(DEFAULT_SOURCE_CSS)
+        if c.use_daisy_ui:
+            c.src_css.write_text(DAISY_UI_SOURCE_CSS)
+        else:
+            c.src_css.write_text(DEFAULT_SOURCE_CSS)
         typer.secho(
             f"Created Tailwind Source CSS at '{c.src_css}'",
             fg=typer.colors.GREEN,

tests/test_config.py

@@ -227,3 +227,26 @@ def test_watch_cmd():
         str(c.dist_css),
         "--watch",
     ]
+
+
+def test_daisy_ui_support(
+    settings: SettingsWrapper,
+    mocker: MockerFixture,
+):
+    settings.TAILWIND_CLI_USE_DAISY_UI = True
+    request_get = mocker.patch("requests.get")
+    request_get.return_value.headers = {
+        "location": "https://github.com/dobicinaitis/tailwind-cli-extra/releases/tag/v2.1.4"
+    }
+
+    c = get_config()
+
+    assert c.use_daisy_ui
+    assert "tailwindcss-extra" in str(c.cli_path)
+    assert "dobicinaitis/tailwind-cli-extra" in c.download_url
+
+    r_version_str, r_version = get_version()
+    assert r_version_str == "2.1.4"
+    assert r_version.major == 2
+    assert r_version.minor == 1
+    assert r_version.patch == 4

tests/test_management_commands.py

@@ -8,7 +8,7 @@
 from pytest_mock import MockerFixture
 
 from django_tailwind_cli.config import get_config
-from django_tailwind_cli.management.commands.tailwind import DEFAULT_SOURCE_CSS
+from django_tailwind_cli.management.commands.tailwind import DAISY_UI_SOURCE_CSS, DEFAULT_SOURCE_CSS
 
 
 @pytest.fixture(autouse=True, params=["4.0.0"])
@@ -32,13 +32,21 @@ def test_calling_unknown_subcommand():
         call_command("tailwind", "not_a_valid_command")
 
 
-def test_create_src_css_if_non_exists(settings: LazySettings, tmp_path: Path):
+@pytest.mark.parametrize(
+    "use_daisy_ui",
+    [True, False],
+)
+def test_create_src_css_if_non_exists(settings: LazySettings, tmp_path: Path, use_daisy_ui: bool):
+    settings.TAILWIND_CLI_USE_DAISY_UI = use_daisy_ui
     c = get_config()
     assert c.src_css is not None
     assert not c.src_css.exists()
     call_command("tailwind", "build")
     assert c.src_css.exists()
-    assert DEFAULT_SOURCE_CSS == c.src_css.read_text()
+    if use_daisy_ui:
+        assert DAISY_UI_SOURCE_CSS == c.src_css.read_text()
+    else:
+        assert DEFAULT_SOURCE_CSS == c.src_css.read_text()
 
 
 def test_with_existing_src_css(settings: LazySettings, tmp_path: Path):