tailwhip 0.9a2__tar.gz

tailwhip-0.9a2/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2025, Martin Mahner <https://elephant.house/>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name django-markup nor the names of its contributors
+      may be used to endorse or promote products derived from this software without
+      specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

tailwhip-0.9a2/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: tailwhip
+Version: 0.9a2
+Summary: A pure Python Tailwind CSS class sorter that works with any HTML or CSS file, including Django templates and other template languages.
+Author-email: Martin Mahner <martin@mahner.org>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/bartTC/tailwhip/
+Project-URL: Repository, https://github.com/bartTC/tailwhip/
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich
+Requires-Dist: typer
+Dynamic: license-file
+
+# Tailwhip — Tailwind CSS class sorter
+
+Tailwhip is a pure Python Tailwind CSS class sorter that works with any HTML or CSS 
+file — including Django templates and other templating languages.
+
+![Screenshot of Tailwhip](./screenshot.png)
+
+## Why Tailwhip?
+
+The [official Prettier plugin][1] for sorting Tailwind classes doesn’t play well 
+with many template languages, such as Django. While there are Prettier plugins that 
+add limited support for [Jinja templates][2], they often require configuration 
+workarounds or restrict what you can do with Prettier.
+
+Tailwhip takes a more pragmatic approach. Instead of trying to parse and understand 
+every possible template syntax, it focuses on sorting Tailwind classes reliably.
+
+[1]: https://github.com/tailwindlabs/prettier-plugin-tailwindcss
+[2]: https://github.com/davidodenwald/prettier-plugin-jinja-template
+
+How it works:
+
+1.	It finds all `class=""` attributes and `@apply` directives in the given files.
+2.	It sorts the contained classes according to the official Tailwind CSS class order.
+3.	If a class attribute contains template syntax (e.g., `{{ ... }}` or `{% ... %}`), 
+    Tailwhip leaves it untouched.
+
+This approach ensures Tailwhip works across diverse environments — Django, Flask, 
+Jinja2, or even custom templating engines — without breaking your templates or 
+requiring complicated setup.
+
+
+## Usage
+
+```bash
+$ uvx tailwhip [options] [filepath...]
+
+# Find all .html and .css files in the templates directory
+$ uvx tailwhip templates/ 
+
+# Preview changes 
+$ uvx tailwhip templates/ -vv
+
+# Actually apply changes
+$ uvx tailwhip templates/ --write
+
+# Sort classes in .scss files
+$ uvx tailwhip templates/**/*.scss
+
+# Standard glob patterns are supported
+$ uvx tailwhip templates/**/*.html templates/**/*.css myapp/**/*.xhtml 
+```
+
+You can also install it with pip or use it as a Python library:
+
+```bash
+$ pip install tailwhip
+
+$ tailwhip templates/
+$ python -m tailwhip templates/
+```
+
+See `--help` for all options and features.

tailwhip-0.9a2/README.md

@@ -0,0 +1,63 @@
+# Tailwhip — Tailwind CSS class sorter
+
+Tailwhip is a pure Python Tailwind CSS class sorter that works with any HTML or CSS 
+file — including Django templates and other templating languages.
+
+![Screenshot of Tailwhip](./screenshot.png)
+
+## Why Tailwhip?
+
+The [official Prettier plugin][1] for sorting Tailwind classes doesn’t play well 
+with many template languages, such as Django. While there are Prettier plugins that 
+add limited support for [Jinja templates][2], they often require configuration 
+workarounds or restrict what you can do with Prettier.
+
+Tailwhip takes a more pragmatic approach. Instead of trying to parse and understand 
+every possible template syntax, it focuses on sorting Tailwind classes reliably.
+
+[1]: https://github.com/tailwindlabs/prettier-plugin-tailwindcss
+[2]: https://github.com/davidodenwald/prettier-plugin-jinja-template
+
+How it works:
+
+1.	It finds all `class=""` attributes and `@apply` directives in the given files.
+2.	It sorts the contained classes according to the official Tailwind CSS class order.
+3.	If a class attribute contains template syntax (e.g., `{{ ... }}` or `{% ... %}`), 
+    Tailwhip leaves it untouched.
+
+This approach ensures Tailwhip works across diverse environments — Django, Flask, 
+Jinja2, or even custom templating engines — without breaking your templates or 
+requiring complicated setup.
+
+
+## Usage
+
+```bash
+$ uvx tailwhip [options] [filepath...]
+
+# Find all .html and .css files in the templates directory
+$ uvx tailwhip templates/ 
+
+# Preview changes 
+$ uvx tailwhip templates/ -vv
+
+# Actually apply changes
+$ uvx tailwhip templates/ --write
+
+# Sort classes in .scss files
+$ uvx tailwhip templates/**/*.scss
+
+# Standard glob patterns are supported
+$ uvx tailwhip templates/**/*.html templates/**/*.css myapp/**/*.xhtml 
+```
+
+You can also install it with pip or use it as a Python library:
+
+```bash
+$ pip install tailwhip
+
+$ tailwhip templates/
+$ python -m tailwhip templates/
+```
+
+See `--help` for all options and features.

tailwhip-0.9a2/pyproject.toml

@@ -0,0 +1,69 @@
+[project]
+name = "tailwhip"
+version = "0.9a2"
+description = "A pure Python Tailwind CSS class sorter that works with any HTML or CSS file, including Django templates and other template languages."
+readme = "README.md"
+authors = [
+    { name = "Martin Mahner", email = "martin@mahner.org" }
+]
+license = "MIT"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3 :: Only",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "rich",
+    "typer",
+]
+
+[project.urls]
+Homepage = "https://github.com/bartTC/tailwhip/"
+Repository = "https://github.com/bartTC/tailwhip/"
+
+[dependency-groups]
+dev = [
+    "pytest",
+    "pytest-cov",
+]
+
+[project.scripts]
+tailwhip = "tailwhip:main"
+
+[tool.uv]
+package = true
+
+[tool.ruff]
+target-version = "py39"
+lint.select = ["ALL"]
+lint.ignore = [
+    # Valid exclusions.
+    "COM812", # Conflicts with ruff format
+    "E501", # Line too long (>88)
+    "D203", # incorrect-blank-line-before-class (conflicts with D211)
+    "D213", # multi-line-summary-second-line (conflicts with D212)
+    "ERA001", # Found commented-out code
+    "FBT", # Flake Boolean Trap (don't use arg=True in functions)
+    "FIX", # Line contains TODO/FIXME. Consider resolving.
+]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"test*.py" = [
+    "S101", # Use of `assert` detected
+    "PLR2004", # Magic value used in comparison, consider replacing <int> with a constant variable
+]
+
+[tool.pytest.ini_options]
+python_files = ["*.py"]

tailwhip-0.9a2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tailwhip-0.9a2/tailwhip/__init__.py

@@ -0,0 +1,11 @@
+"""Tailwhip - Sort Tailwind CSS classes in HTML and CSS files."""
+
+from __future__ import annotations
+
+from importlib import metadata
+
+from tailwhip.cli import main
+
+__all__ = ["main"]
+__version__ = metadata.version("tailwhip")
+__author__ = "Martin Mahner"

tailwhip-0.9a2/tailwhip/__main__.py

@@ -0,0 +1,8 @@
+"""Entry point for python -m tailwhip."""
+
+from __future__ import annotations
+
+from tailwhip.cli import main
+
+if __name__ == "__main__":
+    main()

tailwhip-0.9a2/tailwhip/cli.py

@@ -0,0 +1,148 @@
+"""CLI entrypoint."""
+
+from __future__ import annotations
+
+import sys
+import time
+from importlib import metadata
+from pathlib import Path  # noqa: TC003
+from typing import Annotated
+
+import typer
+from rich.console import Console
+
+from tailwhip.constants import CONSOLE_THEME, GLOBS, SKIP_EXPRESSIONS, VERBOSITY_LOUD
+from tailwhip.datatypes import Config
+from tailwhip.files import apply_changes, find_files
+
+
+def version_callback(value: bool) -> None:
+    """Print version and exit."""
+    if value:
+        version = metadata.version("tailwhip")
+        typer.echo(f"tailwhip {version}")
+        raise typer.Exit
+
+
+app = typer.Typer(
+    help="Sort Tailwind CSS classes in HTML and CSS files",
+    add_completion=False,
+)
+
+
+def main() -> None:
+    """Entrypoint for the CLI."""
+    app()
+
+
+@app.command()
+def run(  # noqa: PLR0913
+    paths: Annotated[
+        list[Path],
+        typer.Argument(
+            help=(
+                f"File or directory paths to process. Plain directories "
+                f"(e.g., 'templates/') use default patterns ({', '.join(GLOBS)}). "
+                f"Glob patterns (e.g., 'templates/**/*.postcss') are matched as-is."
+            )
+        ),
+    ],
+    version: Annotated[  # noqa: ARG001
+        bool,
+        typer.Option(
+            "--version",
+            callback=version_callback,
+            is_eager=True,
+            help="Show version and exit.",
+        ),
+    ] = False,
+    write_mode: Annotated[
+        bool,
+        typer.Option(
+            "--write",
+            help="Apply sorting changes to files. Without this flag, runs in check-only mode to preview changes.",
+        ),
+    ] = False,
+    skip_expressions: Annotated[
+        str,
+        typer.Option(
+            "--skip-expressions",
+            help="Template syntax markers that indicate code blocks to skip sorting. Comma-separated list (e.g., '{{,{%,<%'). Prevents sorting dynamic template expressions.",
+        ),
+    ] = ",".join(SKIP_EXPRESSIONS),
+    quiet: Annotated[
+        bool,
+        typer.Option(
+            "--quiet",
+            "-q",
+            help="Minimal output mode. Only displays errors and warnings.",
+        ),
+    ] = False,
+    verbosity: Annotated[
+        int,
+        typer.Option(
+            "--verbose",
+            "-v",
+            count=True,
+            help="Increase output detail level. Use -v for changes, -vv for file processing, -vvv for debug info.",
+        ),
+    ] = 0,
+    custom_colors: Annotated[
+        str,
+        typer.Option(
+            "--custom-colors",
+            help=(
+                "Comma-separated list of custom color names from your Tailwind config "
+                "(e.g., 'brand,company,accent'). These colors will be recognized and sorted "
+                "alongside standard Tailwind colors. WARNING: Classes using these custom colors "
+                "will sort differently if you run tailwhip again without providing the same "
+                "--custom-colors values. Omitting previously-used custom colors will cause those "
+                "utilities to be treated as non-color classes and sorted into different positions."
+            ),
+        ),
+    ] = "",
+) -> None:
+    """Sort Tailwind CSS classes in HTML and CSS files."""
+    console = Console(quiet=quiet, theme=CONSOLE_THEME)
+    skip_expressions = [
+        expr.strip() for expr in skip_expressions.split(",") if expr.strip()
+    ]
+    custom_colors_list = {
+        color.strip() for color in custom_colors.split(",") if color.strip()
+    }
+
+    config = Config(
+        console=console,
+        paths=paths,
+        write=write_mode,
+        skip_expressions=skip_expressions,
+        verbosity=verbosity + 1,
+        custom_colors=custom_colors_list,
+    )
+
+    console.print("")
+
+    start_time = time.time()
+    targets = find_files(config=config)
+    found_any, skipped, changed = apply_changes(targets=targets, config=config)
+    duration = time.time() - start_time
+
+    if not found_any:
+        config.console.print("[red]Error: No files found[/red]")
+        sys.exit(1)
+
+    if config.verbosity < VERBOSITY_LOUD:
+        console.print(
+            "\nUse [important] -v [/important] (show unchanged files) or [important] -vv [/important] (show diff preview) for more detail."
+        )
+
+    if not config.write:
+        console.print(
+            "\n:warning: Dry Run. No files were actually written. "
+            "Use [important] --write [/important] to write changes."
+        )
+
+    console.print(
+        f"⏱ Completed in [bold]{duration:.3f}s[/bold] for {changed} files. [dim]({skipped} skipped)[/dim]",
+        highlight=False,
+    )