Moved default storage location BASE_DIR/.django_tailwind_cli

Author: oliverandrich

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.2.3
+
+- Reverted the decision to store the CLI and the default config file in proper platform dirs.
+
+  * Windows has issues with the paths or sometimes it is not possible to create them.
+  * VSCode Tailwind Plugin relies on the the existance of the config within the current project.
+  * Decision: Create a folder named `.django_tailwind_cli` within the project and store the files there.
+
 ## 4.2.2
 
 - Default configuration stored in the user cache directory is overwritten on every start of the debug server or other management command.

docs/settings.md

@@ -25,11 +25,11 @@ your project.
     ```
 
 `TAILWIND_CLI_PATH`
-: **Default**: `None`
+: **Default**: `.django_tailwind_cli`
 
     This allows you to override the default of the library where to store the CLI binary.
 
-    The default behaviour is to store the CLI binary in the directory returned by this call `platformdirs.user_data_dir("django-tailwind-cli", "django-commons")`. Checkout [platformdirs](https://pypi.org/project/platformdirs/) for details.
+    The default behaviour is to store the CLI binary in the hidden directory `.django_tailwind_cli` within the project.
 
     But if you want to store it elsewhere or plan to use a custom build binary stored locally, change this setting either to a path to a directory or the full path to the binary. If it points to a directory, this is the download destination otherwise it directly tries to use the referenced binary.
 
@@ -66,11 +66,9 @@ your project.
     >    ```
 
 `TAILWIND_CLI_SRC_CSS`
-**Default**: `None`
+**Default**: `.django_tailwind_cli/source.css`
 
-    This variable can be set to `None`, a relative path and an absolute path.
-
-    If it is set to `None`, the library creates file with the name `source.css` in the directory returned by this call `platformdirs.user_cache_dir("django-tailwind-cli", "django-commons")`. Checkout [platformdirs](https://pypi.org/project/platformdirs/) for details.
+    This variable can be set to a relative path and an absolute path.
 
     If it is a relative path it is assumed to be relative to `settings.BASE_DIR`. If `settings.BASE_DIR` is not defined or the file doesn't exist a `ValueError` is raised.
 

pyproject.toml

@@ -30,7 +30,6 @@ requires-python = ">=3.9"
 dependencies = [
     "django>=4.0",
     "django-typer>=2.1.2",
-    "platformdirs>=4.3.7",
     "requests>=2.32.3",
     "semver>=3.0.4",
 ]

src/django_tailwind_cli/config.py

@@ -3,7 +3,6 @@
 from dataclasses import dataclass
 from pathlib import Path
 
-import platformdirs
 import requests
 from django.conf import settings
 from semver import Version
@@ -123,10 +122,14 @@ def get_config() -> Config:
         raise ValueError("TAILWIND_CLI_ASSET_NAME must not be None.")
 
     # Determine the full path to the CLI
-    cli_path = Path(
-        getattr(settings, "TAILWIND_CLI_PATH", None)
-        or platformdirs.user_data_dir("django-tailwind-cli", "django-commons")
-    )
+    cli_path = getattr(settings, "TAILWIND_CLI_PATH", None)
+    if not cli_path:
+        cli_path = ".django_tailwind_cli"
+
+    cli_path = Path(cli_path)
+    if not cli_path.is_absolute():
+        cli_path = Path(settings.BASE_DIR) / cli_path
+
     if cli_path.exists() and cli_path.is_file() and os.access(cli_path, os.X_OK):
         cli_path = cli_path.expanduser().resolve()
     else:
@@ -150,15 +153,15 @@ def get_config() -> Config:
     # Determine the full path to the source css file.
     src_css = getattr(settings, "TAILWIND_CLI_SRC_CSS", None)
     if not src_css:
-        user_cache_dir = platformdirs.user_cache_dir("django-tailwind-cli", "django-commons")
-        src_css = Path(user_cache_dir) / "source.css"
+        src_css = ".django_tailwind_cli/source.css"
         overwrite_default_config = True
     else:
-        src_css = Path(src_css)
-        if not src_css.is_absolute():
-            src_css = Path(settings.BASE_DIR) / src_css
         overwrite_default_config = False
 
+    src_css = Path(src_css)
+    if not src_css.is_absolute():
+        src_css = Path(settings.BASE_DIR) / src_css
+
     # Determine if the CLI should be downloaded automatically
     automatic_download = getattr(settings, "TAILWIND_CLI_AUTOMATIC_DOWNLOAD", True)
 

tests/test_config.py

@@ -78,14 +78,14 @@ def test_get_version_with_unofficial_repo_and_version_3(settings: SettingsWrappe
 def test_default_config():
     c = get_config()
     assert c.version.major >= 4
-    assert "django-tailwind-cli/tailwindcss" in str(c.cli_path)
+    assert ".django_tailwind_cli/tailwindcss" in str(c.cli_path)
     assert c.version_str in str(c.cli_path)
     assert c.download_url.startswith(
         f"https://github.com/tailwindlabs/tailwindcss/releases/download/v{c.version_str}/tailwindcss-"
     )
     assert str(c.dist_css) == "/home/user/project/assets/css/tailwind.css"
     assert c.src_css is not None
-    assert str(c.src_css).endswith("django-tailwind-cli/source.css")
+    assert str(c.src_css).endswith(".django_tailwind_cli/source.css")
     assert c.overwrite_default_config