Removed Tailwind CSS 3.x support.

Author: oliverandrich

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 4.2.0
+
+> [!WARNING]
+> Version 4.2.x and onward only support Tailwind CSS 4.x. If you are using Tailwind CSS 3.x,
+> please use version 2.21.1 of this library. Version 4.0.x or 4.1.x still support Tailwind CSS 3.x, but
+> it is not recommended to use it for new projects.
+
+- Default fallback version is now 4.1.3.
+- Removed support for Tailwind CSS 3.x. The main reason is that this makes the library easier to maintain and also add better support for custom CLI builds which support DaisyUI and other plugins.
+
 ## 4.1.0
 
 - TAILWIND_CLI_VERSION defaults to "latest" now. In case it is set to this value,

README.md

@@ -10,6 +10,11 @@
 [![Downloads](https://static.pepy.tech/badge/django-tailwind-cli)](https://pepy.tech/project/django-tailwind-cli)
 [![Downloads / Month](https://pepy.tech/badge/django-tailwind-cli/month)](<https://pepy.tech/project/django-tailwind-cli>)
 
+> [!WARNING]
+> Version 4.2.x and onward only support Tailwind CSS 4.x. If you are using Tailwind CSS 3.x,
+> please use version 2.21.1 of this library. Version 4.0.x or 4.1.x still supported Tailwind CSS 3.x, but
+> it is not recommended to use it for new projects.
+
 This library provides an integration of [Tailwind CSS](https://tailwindcss.com) for Django that is using on the precompiled versions of the [Tailwind CSS CLI](https://tailwindcss.com/blog/standalone-cli).
 
 The goal of this library is to provided the simplest possible Tailwind integration for your Django project. It took its inspiration from the [Tailwind integration for Phoenix](https://github.com/phoenixframework/tailwind) which completely skips the neccesity of a node installation.

docs/requirements.txt

@@ -1 +1,2 @@
 mkdocs-material
+markdown-callouts

docs/settings.md

@@ -21,7 +21,7 @@ your project.
 
     For example:
     ```python
-    TAILWIND_CLI_VERSION = "3.4.17"
+    TAILWIND_CLI_VERSION = "4.1.3"
     ```
 
 `TAILWIND_CLI_PATH`
@@ -73,12 +73,7 @@ your project.
     Enable or disable the automatic downloading of the official CLI to your machine.
 
 `TAILWIND_CLI_SRC_CSS`
-: **Default** (for Tailwind 3.x): `None`<br>**Default** (for Tailwind 4.x): `css/source.css`
-
-    !!! warning
-        This setting is optional for Tailwind CSS 3.x. For Tailwind CSS 4.x it must not be empty.
-
-    For **Tailwind CSS 3.x** this optional file is used to define addition CSS rules for your project.
+**Default** (for Tailwind 4.x): `css/source.css`
 
     For **Tailwind CSS 4.x** this required file is used to configure Tailwind CSS and also add
     additional CSS rules for your project. This file is stored relative to the first element of
@@ -89,44 +84,3 @@ your project.
 
     The name of the output file. This file is stored relative to the first element of the
     `STATICFILES_DIRS` array.
-
-`TAILWIND_CLI_CONFIG_FILE`
-: **Default**: `"tailwind.config.js"`
-
-    !!! danger
-
-        Is only required for Tailwind CSS 3.x. If you use it with Tailwind CSS 4.x, it is ignored
-        and also raises an exception to force you to remove it.
-
-    The name of the Tailwind CLI config file. The file is stored relative to the `BASE_DIR` defined
-    in your settings.
-
-## `tailwind.config.js` (Tailwind CSS 3.x only)
-
-If you don't create a `tailwind.config.js` file yourself, the management commands will create a sane default for you inside the `BASE_DIR` of your project. The default activates all the official plugins for Tailwind CSS and adds a minimal plugin to support some variants for [HTMX](https://htmx.org/).
-
-### Default version
-
-```javascript title="tailwind.config.js"
-/** @type {import('tailwindcss').Config} */
-const plugin = require("tailwindcss/plugin");
-
-module.exports = {
-  content: ["./templates/**/*.html", "**/templates/**/*.html", '**/*.py'],
-  theme: {
-    extend: {},
-  },
-  plugins: [
-    require("@tailwindcss/typography"),
-    require("@tailwindcss/forms"),
-    require("@tailwindcss/aspect-ratio"),
-    require("@tailwindcss/container-queries"),
-    plugin(function ({ addVariant }) {
-      addVariant("htmx-settling", ["&.htmx-settling", ".htmx-settling &"]);
-      addVariant("htmx-request", ["&.htmx-request", ".htmx-request &"]);
-      addVariant("htmx-swapping", ["&.htmx-swapping", ".htmx-swapping &"]);
-      addVariant("htmx-added", ["&.htmx-added", ".htmx-added &"]);
-    }),
-  ],
-};
-```

docs/usage.md

@@ -9,10 +9,6 @@ hide:
 
     **No.** The management commands of this library handle the download and installation of the Tailwind CLI. You don't have to deal with this. But you can configure the installation location and the version of the CLI you want to use. Take a look at the [settings](settings.md) section.
 
-!!! question "Do I have to create my own `tailwind.config.js` for Tailwind 3.x?"
-
-    **No.** The management commands also take care of this step. If no `tailwind.config.js` is present in your project, a new one with sane defaults will be created. Afterwards this file will be used and be customized by you. The default location for the file is the `BASE_DIR` of your project, but you can change this. Take a look at the [settings](settings.md) section.
-
 !!! question "Do I have to create my own `css/source.css` for Tailwind 4.x?"
 
     **No.** The management commands also take care of this step. If no `css/source.css` is present in your project, a new one with sane defaults will be created. Afterwards this file will be used and be customized by you. The default location for the file is first folder from the `STATICFILES_DIRS` of your project, but you can change this. Take a look at the [settings](settings.md) section.

justfile

@@ -41,4 +41,4 @@ VENV_DIRNAME := ".venv"
 
 # serve docs during development
 @serve-docs: check_uv
-    uvx --with mkdocs-material mkdocs serve
+    uvx  --with markdown-callouts --with mkdocs-material mkdocs serve

mkdocs.yml

@@ -42,6 +42,7 @@ markdown_extensions:
   - footnotes
   - tables
   - sane_lists
+  - github-callouts
   - pymdownx.snippets:
       check_paths: true
 extra:

src/django_tailwind_cli/config.py

@@ -8,7 +8,7 @@
 from django.conf import settings
 from semver import Version
 
-FALLBACK_VERSION = "4.0.6"
+FALLBACK_VERSION = "4.1.3"
 
 
 @dataclass
@@ -20,7 +20,6 @@ class Config:
     dist_css: Path
     dist_css_base: str
     src_css: Optional[Path]
-    config_file: Optional[Path]
     automatic_download: bool = True
 
     @property
@@ -46,9 +45,6 @@ def build_cmd(self) -> list[str]:
             "--minify",
         ]
 
-        if self.config_file:
-            result.extend(["--config", str(self.config_file)])
-        
         if self.src_css:
             result.extend(["--input", str(self.src_css)])
 
@@ -68,18 +64,27 @@ def get_version() -> tuple[str, Version]:
         "latest".
     """
     version_str = getattr(settings, "TAILWIND_CLI_VERSION", "latest")
+    repo_url = getattr(settings, "TAILWIND_CLI_SRC_REPO", "tailwindlabs/tailwindcss")
+    if not repo_url:
+        raise ValueError("TAILWIND_CLI_SRC_REPO must not be None.")
 
     if version_str == "latest":
-        repo_url = getattr(settings, "TAILWIND_CLI_SRC_REPO", "tailwindlabs/tailwindcss")
-        if not repo_url:
-            raise ValueError("TAILWIND_CLI_SRC_REPO must not be None.")
         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)
         else:
-            version_str = FALLBACK_VERSION
-
-    return version_str, Version.parse(version_str)
+            return FALLBACK_VERSION, Version.parse(FALLBACK_VERSION)
+    elif repo_url == "tailwindlabs/tailwindcss":
+        version = Version.parse(version_str)
+        if version.major < 4:
+            raise ValueError(
+                "Tailwind CSS 3.x is not supported by this version. Use version 2.21.1 if you want to use Tailwind 3."
+            )
+        return version_str, version
+    else:
+        return version_str, Version.parse(version_str)
 
 
 def get_config() -> Config:
@@ -124,27 +129,9 @@ def get_config() -> Config:
     dist_css = Path(settings.STATICFILES_DIRS[0]) / dist_css_base
 
     # Determine the full path to the source css file.
-    # It is optional for Tailwind CSS < 4.0.0, but required for >= 4.0.0.
-    if version >= Version.parse("4.0.0"):
-        if not (src_css := getattr(settings, "TAILWIND_CLI_SRC_CSS", "css/source.css")):
-            raise ValueError("TAILWIND_CLI_SRC_CSS must not be None.")
-        src_css = Path(settings.STATICFILES_DIRS[0]) / src_css
-    else:
-        if not (src_css := getattr(settings, "TAILWIND_CLI_SRC_CSS", None)):
-            src_css = None
-        else:
-            src_css = Path(settings.STATICFILES_DIRS[0]) / src_css
-
-    # Determine the full path to the config file.
-    # It is optional for Tailwind CSS >= 4.0.0, but required for < 4.0.0.
-    if version < Version.parse("4.0.0"):
-        if not (config_file := getattr(settings, "TAILWIND_CLI_CONFIG_FILE", "tailwind.config.js")):
-            raise ValueError("TAILWIND_CLI_CONFIG_FILE must not be None.")
-        config_file = Path(settings.BASE_DIR) / config_file
-    else:
-        if config_file := getattr(settings, "TAILWIND_CLI_CONFIG_FILE", None):
-            raise ValueError("TAILWIND_CLI_CONFIG_FILE is not used by this library with Tailwind CSS >= 4.x.")
-        config_file = None
+    if not (src_css := getattr(settings, "TAILWIND_CLI_SRC_CSS", "css/source.css")):
+        raise ValueError("TAILWIND_CLI_SRC_CSS must not be None.")
+    src_css = Path(settings.STATICFILES_DIRS[0]) / src_css
 
     # Determine if the CLI should be downloaded automatically
     automatic_download = getattr(settings, "TAILWIND_CLI_AUTOMATIC_DOWNLOAD", True)
@@ -158,6 +145,5 @@ def get_config() -> Config:
         dist_css=dist_css,
         dist_css_base=dist_css_base,
         src_css=src_css,
-        config_file=config_file,
         automatic_download=automatic_download,
     )

src/django_tailwind_cli/management/commands/tailwind.py

@@ -29,21 +29,14 @@ def build() -> None:
 
     try:
         subprocess.run(config.build_cmd, cwd=settings.BASE_DIR, check=True, capture_output=True, text=True)
+        typer.secho(f"Built production stylesheet '{config.dist_css}'.", fg=typer.colors.GREEN)
     except KeyboardInterrupt:
         typer.secho("Canceled building production stylesheet.", fg=typer.colors.RED)
-        return
-    except subprocess.CalledProcessError as e:  # pragma: no cover
-        typer.secho(
-            f"Failed to build production stylesheet: {e.stderr}",
-            fg=typer.colors.RED,
-        )
+    except subprocess.CalledProcessError as e:
+        error_message = e.stderr if e.stderr else "An unknown error occurred."
+        typer.secho(f"Failed to build production stylesheet: {error_message}", fg=typer.colors.RED)
         sys.exit(1)
 
-    typer.secho(
-        f"Built production stylesheet '{config.dist_css}'.",
-        fg=typer.colors.GREEN,
-    )
-
 
 @app.command()
 def watch():
@@ -57,10 +50,8 @@ def watch():
     except KeyboardInterrupt:
         typer.secho("Stopped watching for changes.", fg=typer.colors.RED)
     except subprocess.CalledProcessError as e:  # pragma: no cover
-        typer.secho(
-            f"Failed to start in watch mode: {e.stderr.decode()}",
-            fg=typer.colors.RED,
-        )
+        typer.secho(f"Failed to start in watch mode: {e.stderr.decode()}", fg=typer.colors.RED)
+        sys.exit(1)
 
 
 @app.command(name="list_templates")
@@ -287,52 +278,20 @@ def _download_cli(*, force_download: bool = False) -> None:
     typer.secho(f"Downloaded Tailwind CSS CLI to '{c.cli_path}'.", fg=typer.colors.GREEN)
 
 
-DEFAULT_TAILWIND_CONFIG = """/** @type {import('tailwindcss').Config} */
-const plugin = require("tailwindcss/plugin");
-
-module.exports = {
-  content: ["./templates/**/*.html", "**/templates/**/*.html",'**/*.py'],
-  theme: {
-    extend: {},
-  },
-  plugins: [
-    require("@tailwindcss/typography"),
-    require("@tailwindcss/forms"),
-    require("@tailwindcss/aspect-ratio"),
-    require("@tailwindcss/container-queries"),
-    plugin(function ({ addVariant }) {
-      addVariant("htmx-settling", ["&.htmx-settling", ".htmx-settling &"]);
-      addVariant("htmx-request", ["&.htmx-request", ".htmx-request &"]);
-      addVariant("htmx-swapping", ["&.htmx-swapping", ".htmx-swapping &"]);
-      addVariant("htmx-added", ["&.htmx-added", ".htmx-added &"]);
-    }),
-  ],
-};
-"""
-
 DEFAULT_SOURCE_CSS = '@import "tailwindcss";\n'
 
 
 def _create_standard_config() -> None:
     """Create a standard Tailwind CSS config file."""
     c = get_config()
 
-    if c.version.major >= 4:
-        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)
-            typer.secho(
-                f"Created Tailwind Source CSS at '{c.src_css}'",
-                fg=typer.colors.GREEN,
-            )
-    else:
-        if c.config_file and not c.config_file.exists():
-            c.config_file.parent.mkdir(parents=True, exist_ok=True)
-            c.config_file.write_text(DEFAULT_TAILWIND_CONFIG)
-            typer.secho(
-                f"Created Tailwind CSS config at '{c.config_file}'",
-                fg=typer.colors.GREEN,
-            )
+    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)
+        typer.secho(
+            f"Created Tailwind Source CSS at '{c.src_css}'",
+            fg=typer.colors.GREEN,
+        )
 
 
 def get_runserver_options(