Update tests, readme, and simplify install

Author: josevalim

README.md

@@ -24,26 +24,17 @@ def deps do
 end
 ```
 
-However, if your assets are precompiled during development,
-then it only needs to be a dev dependency:
-
-```elixir
-def deps do
-  [
-    {:tailwind, "~> 0.3", only: :dev}
-  ]
-end
-```
-
 Once installed, change your `config/config.exs` to pick your
 Tailwind version of choice:
 
 ```elixir
-config :tailwind, version: "4.0.9"
+config :tailwind, version: "4.1.12"
 ```
 
-Note that `:tailwind` 0.3+ assumes Tailwind v4+ by default. It still supports Tailwind v3, but some configuration options when setting up a new
-project might be different. If you use Tailwind v3, also have a look at [the README in the 0.2 branch](https://github.com/phoenixframework/tailwind/blob/v0.2/README.md).
+Note that `:tailwind` 0.3+ assumes Tailwind v4+ by default.
+It still supports Tailwind v3, but some configuration options
+when setting up a new project might be different. If you use
+Tailwind v3, also have a look at [the README in the 0.2 branch](https://github.com/phoenixframework/tailwind/blob/v0.2/README.md).
 
 Now you can install Tailwind by running:
 
@@ -73,11 +64,11 @@ Where `TARGET` is your system target architecture.
 The first argument to `tailwind` is the execution profile.
 You can define multiple execution profiles with the current
 directory, the OS environment, and default arguments to the
-`tailwind` task:
+`tailwind` task in your `config/config.exs`:
 
 ```elixir
 config :tailwind,
-  version: "4.0.9",
+  version: "4.1.12",
   default: [
     args: ~w(
       --input=assets/css/app.css
@@ -88,22 +79,7 @@ config :tailwind,
 ```
 
 When `mix tailwind default` is invoked, the task arguments will be appended
-to the ones configured above. Note profiles must be configured in your
-`config/config.exs`, as `tailwind` runs without starting your application
-(and therefore it won't pick settings in `config/runtime.exs`).
-
-We also strongly recommend setting up the `@source` paths in your in `app.css`
-file, for example:
-
-```css
-@source "../css";
-@source "../js";
-@source "../../lib/YOUR_APP_web";
-```
-
-This will make Tailwind watch `assets/css`, `assets/js` and `lib/YOUR_APP_web`.
-Without those, too many files (including build artifacts) may be watched,
-leading to frequent recompilations.
+to the ones configured above.
 
 ## Adding to Phoenix
 
@@ -117,7 +93,7 @@ as a dependency in your `mix.exs`:
 ```elixir
 def deps do
   [
-    {:phoenix, "~> 1.7"},
+    {:phoenix, "~> 1.8"},
     {:tailwind, "~> 0.3", runtime: Mix.env() == :dev}
   ]
 end
@@ -136,7 +112,7 @@ We'll also give it our `assets/css/app.css` as our css entry point:
 
 ```elixir
 config :tailwind,
-  version: "4.0.9",
+  version: "4.1.12",
   default: [
     args: ~w(
       --input=assets/css/app.css
@@ -147,14 +123,14 @@ config :tailwind,
 ```
 
 > Make sure the "assets" directory from priv/static is listed in the
-> :only option for Plug.Static in your lib/my_app_web/endpoint.ex
+> `:only` option for Plug.Static in your `lib/my_app_web/endpoint.ex`
 
 If your Phoenix application is using an umbrella structure, you should specify
 the web application's asset directory in the configuration:
 
 ```elixir
 config :tailwind,
-  version: "4.0.9",
+  version: "4.1.12",
   default: [
     args: ...,
     cd: Path.expand("../apps/<folder_ending_with_web>", __DIR__)
@@ -170,15 +146,23 @@ configuration in your `config/dev.exs` and add:
 
 Note we are enabling the file system watcher.
 
-Finally, run the command:
+Finally, create the relevant `assets/css/app.css` file:
 
-```bash
-$ mix tailwind.install
+```css
+@import "tailwindcss" source(none);
+@source "../css";
+@source "../js";
+@source "../../lib/YOUR_APP_web";
+
+@custom-variant phx-click-loading (.phx-click-loading&, .phx-click-loading &);
+@custom-variant phx-submit-loading (.phx-submit-loading&, .phx-submit-loading &);
+@custom-variant phx-change-loading (.phx-change-loading&, .phx-change-loading &);
 ```
 
-This command installs Tailwind and  updates your `assets/css/app.css`
-and `assets/js/app.js` with the necessary changes to start using Tailwind
-right away. See `mix help tailwind.install` to learn more.
+We also strongly recommend setting up the `@source` paths in your in `app.css`
+file to watch `assets/css`, `assets/js` and `lib/YOUR_APP_web`, as above.
+Without those, too many files (including build artifacts) may be watched,
+leading to frequent recompilations.
 
 ## Updating from Tailwind v3 to v4
 
@@ -200,7 +184,7 @@ For a typical Phoenix application, updating from Tailwind v3 to v4 requires the
     ```diff
      config :tailwind,
     -   version: "3.4.13",
-    +   version: "4.0.9",
+    +   version: "4.1.12",
         default: [
           args: ~w(
     -       --config=tailwind.config.js

config/config.exs

@@ -1,7 +1,7 @@
 import Config
 
 config :tailwind,
-  version: "4.0.9",
+  version: "4.1.12",
   another: [
     args: ["--help"]
   ]

lib/mix/tasks/tailwind.install.ex

@@ -21,41 +21,22 @@ defmodule Mix.Tasks.Tailwind.Install do
 
   ## Options
 
-      * `--runtime-config` - load the runtime configuration
-        before executing command
+    * `--runtime-config` - load the runtime configuration
+      before executing command
 
-      * `--if-missing` - install only if the given version
-        does not exist
+    * `--if-missing` - install only if the given version
+      does not exist
 
-      * `--no-assets` - does not install Tailwind assets
-
-  ## Assets
-
-  Whenever Tailwind is installed, a default tailwind configuration
-  will be placed in a new `assets/tailwind.config.js` file. See
-  the [tailwind documentation](https://tailwindcss.com/docs/configuration)
-  on configuration options.
-
-  The default tailwind configuration includes Tailwind variants for Phoenix
-  LiveView specific lifecycle classes:
-
-    * phx-click-loading - applied when an event is sent to the server on click
-      while the client awaits the server response
-    * phx-submit-loading - applied when a form is submitted while the client awaits the server response
-    * phx-change-loading - applied when a form input is changed while the client awaits the server response
-
-  Therefore, you may apply a variant, such as `phx-click-loading:animate-pulse`
-  to customize tailwind classes when Phoenix LiveView classes are applied.
   """
 
-  @shortdoc "Installs Tailwind executable and assets"
+  @shortdoc "Installs Tailwind executable"
   @compile {:no_warn_undefined, Mix}
 
   use Mix.Task
 
   @impl true
   def run(args) do
-    valid_options = [runtime_config: :boolean, if_missing: :boolean, assets: :boolean]
+    valid_options = [runtime_config: :boolean, if_missing: :boolean]
 
     {opts, base_url} =
       case OptionParser.parse_head!(args, strict: valid_options) do
@@ -81,13 +62,6 @@ defmodule Mix.Tasks.Tailwind.Install do
     if opts[:if_missing] && latest_version?() do
       :ok
     else
-      if Keyword.get(opts, :assets, true) do
-        File.mkdir_p!("assets/css")
-
-        prepare_app_css()
-        prepare_app_js()
-      end
-
       if function_exported?(Mix, :ensure_application!, 1) do
         Mix.ensure_application!(:inets)
         Mix.ensure_application!(:ssl)
@@ -102,34 +76,4 @@ defmodule Mix.Tasks.Tailwind.Install do
     version = Tailwind.configured_version()
     match?({:ok, ^version}, Tailwind.bin_version())
   end
-
-  defp prepare_app_css do
-    app_css =
-      case File.read("assets/css/app.css") do
-        {:ok, str} -> str
-        {:error, _} -> ""
-      end
-
-    unless app_css =~ "tailwind" do
-      File.write!("assets/css/app.css", """
-      @import "tailwindcss";
-      @plugin "@tailwindcss/forms";
-      @variant phx-click-loading ([".phx-click-loading&", ".phx-click-loading &"]);
-      @variant phx-submit-loading ([".phx-submit-loading&", ".phx-submit-loading &"]);
-      @variant phx-change-loading ([".phx-change-loading&", ".phx-change-loading &"]);
-
-      #{String.replace(app_css, ~s|@import "./phoenix.css";\n|, "")}\
-      """)
-    end
-  end
-
-  defp prepare_app_js do
-    case File.read("assets/js/app.js") do
-      {:ok, app_js} ->
-        File.write!("assets/js/app.js", String.replace(app_js, ~s|import "../css/app.css"\n|, ""))
-
-      {:error, _} ->
-        :ok
-    end
-  end
 end

lib/tailwind.ex

@@ -1,6 +1,6 @@
 defmodule Tailwind do
   # https://github.com/tailwindlabs/tailwindcss/releases
-  @latest_version "4.1.11"
+  @latest_version "4.1.12"
 
   @moduledoc """
   Tailwind is an installer and runner for [tailwind](https://tailwindcss.com/).
@@ -15,10 +15,10 @@ defmodule Tailwind do
         version: "#{@latest_version}",
         default: [
           args: ~w(
-            --input=css/app.css
-            --output=../priv/static/assets/app.css
+            --input=assets/css/app.css
+            --output=priv/static/assets/app.css
           ),
-          cd: Path.expand("../assets", __DIR__),
+          cd: Path.expand("..", __DIR__),
         ]
 
   ## Tailwind configuration
@@ -57,10 +57,10 @@ defmodule Tailwind do
         version: "#{@latest_version}",
         default: [
           args: ~w(
-            --input=css/app.css
-            --output=../priv/static/assets/app.css
+            --input=assets/css/app.css
+            --output=priv/static/assets/app.css
           ),
-          cd: Path.expand("../assets", __DIR__),
+          cd: Path.expand("..", __DIR__),
         ],
         # skip executable check/download
         version_check: false,

test/tailwind_test.exs

@@ -5,13 +5,10 @@ defmodule TailwindTest do
 
   setup do
     Application.put_env(:tailwind, :version, @version)
-    File.mkdir_p!("assets/js")
-    File.mkdir_p!("assets/css")
-    File.rm("assets/css/app.css")
     :ok
   end
 
-  test "run on default" do
+  test "--help" do
     assert ExUnit.CaptureIO.capture_io(fn ->
              assert Tailwind.run(:default, ["--help"]) == 0
            end) =~ @version
@@ -23,75 +20,21 @@ defmodule TailwindTest do
            end) =~ @version
   end
 
-  test "run with pre-existing app.css" do
+  test "run on default" do
     assert ExUnit.CaptureIO.capture_io(fn ->
              assert Tailwind.run(:default, []) == 0
            end) =~ @version
   end
 
-  test "updates on install" do
+  test "installs and updates with custom config and path" do
     Application.put_env(:tailwind, :version, "3.4.17")
-    Mix.Task.rerun("tailwind.install", ["--if-missing"])
-
-    assert ExUnit.CaptureIO.capture_io(fn ->
-             assert Tailwind.run(:default, ["--help"]) == 0
-           end) =~ "3.4.17"
 
-    Application.delete_env(:tailwind, :version)
-
-    Mix.Task.rerun("tailwind.install", ["--if-missing"])
-    assert File.read!("assets/css/app.css") =~ "tailwind"
+    Mix.Task.rerun("tailwind.install", [
+      "https://github.com/tailwindlabs/tailwindcss/releases/download/v$version/tailwindcss-$target"
+    ])
 
     assert ExUnit.CaptureIO.capture_io(fn ->
              assert Tailwind.run(:default, ["--help"]) == 0
-           end) =~ @version
-  end
-
-  test "install on existing app.css and app.js" do
-    File.write!("assets/css/app.css", """
-    @import "./phoenix.css";
-    body {
-    }
-    """)
-
-    File.write!("assets/js/app.js", """
-    import "../css/app.css"
-
-    let Hooks = {}
-    """)
-
-    Mix.Task.rerun("tailwind.install")
-
-    expected_css =
-      String.trim("""
-      @import "tailwindcss";
-      @plugin "@tailwindcss/forms";
-      @variant phx-click-loading ([".phx-click-loading&", ".phx-click-loading &"]);
-      @variant phx-submit-loading ([".phx-submit-loading&", ".phx-submit-loading &"]);
-      @variant phx-change-loading ([".phx-change-loading&", ".phx-change-loading &"]);
-
-      body {
-      }
-      """)
-
-    expected_js =
-      String.trim("""
-
-      let Hooks = {}
-      """)
-
-    assert String.trim(File.read!("assets/css/app.css")) == expected_css
-    assert String.trim(File.read!("assets/js/app.js")) == expected_js
-
-    Mix.Task.rerun("tailwind.install")
-
-    assert String.trim(File.read!("assets/js/app.js")) == expected_js
-  end
-
-  test "installs with custom URL" do
-    assert :ok =
-             Mix.Task.rerun("tailwind.install", [
-               "https://github.com/tailwindlabs/tailwindcss/releases/download/v$version/tailwindcss-$target"
-             ])
+           end) =~ "3.4.17"
   end
 end

test/test_helper.exs

@@ -1 +1 @@
-ExUnit.start()
+ExUnit.start(timeout: 180_000)