Merge branch 'develop' into feature/js-bundle

Author: Flo0807

.github/workflows/ci.yml

@@ -46,7 +46,7 @@ jobs:
           cache-dependency-path: yarn.lock
 
       - name: Restore the deps and _build cache
-        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
         id: restore-cache
         env:
           MIX_LOCK_HASH: ${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
@@ -165,7 +165,7 @@ jobs:
           cache-dependency-path: demo/yarn.lock
 
       - name: Restore the deps and _build cache
-        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
         id: restore-cache
         env:
           OTP_VERSION: ${{ steps.beam.outputs.otp-version }}
@@ -272,15 +272,15 @@ jobs:
 
       - name: Log in to the container registry
         if: env.PUSH_IMAGE == 'true'
-        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
+        uses: docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1 # v3.5.0
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0
+        uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME_RUNTIME }}
 

demo/mix.exs

@@ -43,7 +43,6 @@ defmodule Demo.MixProject do
       {:smokestack, "~> 0.9.2"},
       {:faker, "~> 0.18"},
       {:phoenix_test, "~> 0.7.0", only: :test, runtime: false},
-      {:sourceror, "~> 1.7", only: [:dev, :test]},
       {:phoenix_test_playwright, "~> 0.7.0", only: :test, runtime: false},
       {:a11y_audit, "~> 0.2.3", only: :test},
       {:live_debugger, "~> 0.3", only: :dev},

demo/mix.lock

@@ -20,12 +20,12 @@
     "gettext": "mix gettext.extract --merge"
   },
   "devDependencies": {
-    "@sentry/browser": "9.44.0",
+    "@sentry/browser": "9.44.2",
     "npm-run-all2": "8.0.4",
     "playwright": "1.54.2",
     "postcss": "8.5.6",
     "standard": "17.1.2",
-    "stylelint": "16.23.0",
+    "stylelint": "16.23.1",
     "stylelint-config-standard": "39.0.0",
     "topbar": "3.0.0"
   },

demo/package.json

@@ -123,51 +123,51 @@
   resolved "https://registry.yarnpkg.com/@rtsao/scc/-/scc-1.1.0.tgz#927dd2fae9bc3361403ac2c7a00c32ddce9ad7e8"
   integrity sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g==
 
-"@sentry-internal/[email protected].0":
-  version "9.44.0"
-  resolved "https://registry.yarnpkg.com/@sentry-internal/browser-utils/-/browser-utils-9.44.0.tgz#1bb9cfe7bcc0e5f87c060133e2e3f0b9d7ab6e06"
-  integrity sha512-ySIXxq3xq2lhY/XPMLUtaUd6HghJUsz+S5GksuRCxv6exY6mRMjsbm7VhcAEPmY4IrhsXjnEzCONP+M7pzAc3A==
+"@sentry-internal/[email protected].2":
+  version "9.44.2"
+  resolved "https://registry.yarnpkg.com/@sentry-internal/browser-utils/-/browser-utils-9.44.2.tgz#9d6be15ee170b8aae5045a0eacd9dfe5d70e93ad"
+  integrity sha512-VvaSk8DDV8fsUZf+bnbjziyu4RJgSNAxZ4jFo5Jq7Z/SXc7uciOGElpEzgALcY0uMbFA/0IsXQKpB1s01ZsoZQ==
   dependencies:
-    "@sentry/core" "9.44.0"
+    "@sentry/core" "9.44.2"
 
-"@sentry-internal/[email protected].0":
-  version "9.44.0"
-  resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-9.44.0.tgz#1fe4fe83e42122b4bba31ac8882b0a15371a347a"
-  integrity sha512-ptA74gXPU7qV9eBuz2UUyFv+BroMrVMZD58eIG3IkRu93mAH0dhJiKmd1rhlWheXfhFhiw82WdNH9sTQj7++GA==
+"@sentry-internal/[email protected].2":
+  version "9.44.2"
+  resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-9.44.2.tgz#ab97736219e3dcd4d055e8b09701a4cb5a219402"
+  integrity sha512-EVyTIc/V2p3aK2GwMk1/r192C8uxLipJXYB+nQCIqYTduuvdg9jCUFsK90FbRCbIqQtglcvVYmyNZwY4IaMxoQ==
   dependencies:
-    "@sentry/core" "9.44.0"
+    "@sentry/core" "9.44.2"
 
-"@sentry-internal/[email protected].0":
-  version "9.44.0"
-  resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-9.44.0.tgz#9a580a53eb7721eec6a5b4b0d233150378de3b71"
-  integrity sha512-JTRBlKsd46tz/bE6FE8bRsapteWwBt+4eviYZlE6Wn/QSirYOqEniibhJ8GIUIpUmHpkrvNAfIRaKJ4tXYaqGQ==
+"@sentry-internal/[email protected].2":
+  version "9.44.2"
+  resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-9.44.2.tgz#e751089af0fd6efaf4f90292a51d86142c34b00b"
+  integrity sha512-49wOCuXz5qf507BW6UuGOFGSxCGke84rreglLRr+N/8n3Ag2GQC7zcxn25SwidVsWYQo70GxSqzAwZVrOCe6Vw==
   dependencies:
-    "@sentry-internal/replay" "9.44.0"
-    "@sentry/core" "9.44.0"
+    "@sentry-internal/replay" "9.44.2"
+    "@sentry/core" "9.44.2"
 
-"@sentry-internal/[email protected].0":
-  version "9.44.0"
-  resolved "https://registry.yarnpkg.com/@sentry-internal/replay/-/replay-9.44.0.tgz#0fd0b1f5c682113c97584cca0094879751953064"
-  integrity sha512-IVRbONKaoxcDItpcXV9wpNCL+T5iMnTLJv2glMULMnqU4nplhBynxjSyng1s/rpTU4PwwYYIgwkb4Z0GMIYPlg==
+"@sentry-internal/[email protected].2":
+  version "9.44.2"
+  resolved "https://registry.yarnpkg.com/@sentry-internal/replay/-/replay-9.44.2.tgz#c727d766249787bd2c9840c13ba63b47f8372dc8"
+  integrity sha512-LALsZg8n0F5OsOUELByXnCxPdovwl7eJja903fjamzC1MoWtTB06RXiZHqv/E1+HuTsseR2EggS0dLXfptximg==
   dependencies:
-    "@sentry-internal/browser-utils" "9.44.0"
-    "@sentry/core" "9.44.0"
+    "@sentry-internal/browser-utils" "9.44.2"
+    "@sentry/core" "9.44.2"
 
-"@sentry/[email protected].0":
-  version "9.44.0"
-  resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-9.44.0.tgz#e5db81fd0508b24dc71335b443c31efc15422098"
-  integrity sha512-QhZds04ta8m1SGN8jpF22kFu2SyM2FcHM2tFBaFuYTK6b7ouBII6YpYLhXulZvF+xl/pxnYsXHgyeTJ5JseITg==
+"@sentry/[email protected].2":
+  version "9.44.2"
+  resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-9.44.2.tgz#c7a61ac6c79a409e1cf21096d32afbb515c73b55"
+  integrity sha512-m5oMprtmPTeZB9PFrQfWmRQglSgzozAUFUFiQdL0g2QJkmyNL4LzEE2L88dxGSbnABLRu0MI1ySiEQTFa7ZSbw==
   dependencies:
-    "@sentry-internal/browser-utils" "9.44.0"
-    "@sentry-internal/feedback" "9.44.0"
-    "@sentry-internal/replay" "9.44.0"
-    "@sentry-internal/replay-canvas" "9.44.0"
-    "@sentry/core" "9.44.0"
+    "@sentry-internal/browser-utils" "9.44.2"
+    "@sentry-internal/feedback" "9.44.2"
+    "@sentry-internal/replay" "9.44.2"
+    "@sentry-internal/replay-canvas" "9.44.2"
+    "@sentry/core" "9.44.2"
 
-"@sentry/[email protected].0":
-  version "9.44.0"
-  resolved "https://registry.yarnpkg.com/@sentry/core/-/core-9.44.0.tgz#99be002aada90d70afb4f0293b1a8e186294cdca"
-  integrity sha512-U+KBNGgq/eXIj226CPtRk+n5dx0q1xGVvbLbyfAyeek9C/wxQ3f+mvqeVqF9cx8FfrWIOeDM1F8ISH5uRkjjQg==
+"@sentry/[email protected].2":
+  version "9.44.2"
+  resolved "https://registry.yarnpkg.com/@sentry/core/-/core-9.44.2.tgz#a2d55a6b108702925dfa7d97eb423cbc671fd2cc"
+  integrity sha512-4wduCY9vz+VRMZXTT1dzk08L2nReeR+lzpY8hCcc+Wu100BoJR+TNlrSn1rG5iIo98NDW860JsRA7SVDUDOiNQ==
 
 "@types/json5@^0.0.29":
   version "0.0.29"
@@ -2443,10 +2443,10 @@ [email protected]:
   dependencies:
     stylelint-config-recommended "^17.0.0"
 
-[email protected].0:
-  version "16.23.0"
-  resolved "https://registry.yarnpkg.com/stylelint/-/stylelint-16.23.0.tgz#a50c3340b5ba3ed4e05f7e89d8ec5e3350092dd0"
-  integrity sha512-69T5aS2LUY306ekt1Q1oaSPwz/jaG9HjyMix3UMrai1iEbuOafBe2Dh8xlyczrxFAy89qcKyZWWtc42XLx3Bbw==
+[email protected].1:
+  version "16.23.1"
+  resolved "https://registry.yarnpkg.com/stylelint/-/stylelint-16.23.1.tgz#e5f5ee173adf989db0855b825e66f9ccdde3c78a"
+  integrity sha512-dNvDTsKV1U2YtiUDfe9d2gp902veFeo3ecCWdGlmLm2WFrAV0+L5LoOj/qHSBABQwMsZPJwfC4bf39mQm1S5zw==
   dependencies:
     "@csstools/css-parser-algorithms" "^3.0.5"
     "@csstools/css-tokenizer" "^3.0.4"

demo/yarn.lock

@@ -1,6 +1,6 @@
 # Installation
 
-The following guide will help you to install Backpex in your Phoenix application. We will guide you through the installation process and show you how to create a simple resource.
+The following guide will help you to install Backpex in your Phoenix application. We will guide you through the installation process and show you how to create a simple resource. 
 
 ## Prerequisites
 
@@ -10,6 +10,10 @@ Backpex integrates seamlessly with your existing Phoenix LiveView application, b
 
 Backpex is built on top of Phoenix LiveView, so you need to have Phoenix LiveView installed in your application. If you generate a new Phoenix application using the latest version of the `mix phx.new` generator, Phoenix LiveView is included by default.
 
+> #### Info {: .info}
+>
+> We have created an initial version of the [Backpex installer task](Mix.Tasks.Backpex.Install.html), which runs with the help of the [Igniter](https://github.com/ash-project/igniter) framework. This installer automates the upcoming steps up to the "[Create an example resource](installation.html#create-an-example-resource)" step. Feedback is welcome!
+
 ### Tailwind CSS
 
 Backpex uses Tailwind CSS for styling. Make sure you have Tailwind CSS installed in your application. You can install Tailwind CSS by following the [official installation guide](https://tailwindcss.com/docs/installation/framework-guides/phoenix). If you generate a new Phoenix application using the latest version of the `mix phx.new` generator, Tailwind CSS is included by default.

guides/get_started/installation.md

@@ -0,0 +1,91 @@
+defmodule Backpex.Mix.Helpers do
+  @moduledoc """
+  Helper functions for the Backpex mix tasks.
+  """
+
+  alias Igniter.Libs.Phoenix
+  alias Igniter.Project.Application, as: IgniterApp
+  alias Igniter.Project.Module, as: IgniterModule
+  alias Igniter.Util.Warning
+
+  @doc """
+  Gets the Phoenix PubSub module from the application configuration.
+  """
+  def pubsub_module(igniter) do
+    web_module = Phoenix.web_module(igniter)
+    endpoint_module = Module.safe_concat(web_module, Endpoint)
+    app_name = IgniterApp.app_name(igniter)
+
+    Application.get_env(app_name, endpoint_module)[:pubsub_server]
+  end
+
+  @doc """
+  Checks if a specific string exists within a module's source code.
+  """
+  def exists_in_module?(igniter, module, line) do
+    case IgniterModule.find_module(igniter, module) do
+      {:ok, {igniter, source, _zipper}} ->
+        {:ok, {igniter, string_in_source?(source, line)}}
+
+      {:error, igniter} ->
+        Mix.shell().warning("Could not find module #{inspect(module)}")
+        {:error, igniter}
+    end
+  end
+
+  @doc """
+  Checks if a specific string exists within a source's content.
+  """
+  def string_in_source?(source, string) do
+    source
+    |> Rewrite.Source.get(:content)
+    |> String.contains?(string)
+  end
+
+  @doc """
+  Updates a file by adding a line if it doesn't already exist.
+  """
+  def add_line_to_file(igniter, file_path, new_line) do
+    if Igniter.exists?(igniter, file_path) do
+      Igniter.update_file(igniter, file_path, &add_line(&1, file_path, new_line))
+    else
+      Warning.warn_with_code_sample(
+        igniter,
+        "File not found at #{file_path}. Please manually add the following line:",
+        new_line
+      )
+    end
+  end
+
+  defp add_line(source, file_path, line) do
+    content = Rewrite.Source.get(source, :content)
+
+    if String.contains?(content, line) do
+      Mix.shell().info("'#{line}' already exists in #{file_path}.")
+      source
+    else
+      Rewrite.Source.update(source, :content, content <> "\n#{line}")
+    end
+  end
+
+  @doc """
+  Gets the web folder path for the Phoenix application.
+  """
+  def web_folder_path(igniter) do
+    igniter
+    |> IgniterApp.app_name()
+    |> Mix.Phoenix.web_path()
+  end
+
+  @doc """
+  Checks if an npm package is already installed in the project.
+  """
+  def npm_package_installed?(package_name) do
+    env = [{"PATH", System.get_env("PATH")}]
+
+    case System.cmd("npm", ["list", "--depth=0", package_name], stderr_to_stdout: true, env: env) do
+      {_output, 0} -> true
+      {_output, _int} -> false
+    end
+  end
+end