Skip to content

Release: v0.1.5 #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kraleppa merged 3 commits into from
Apr 18, 2025
Merged

Release: v0.1.5 #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2872b4d
Updated README
kraleppa Apr 18, 2025
fe44ebf
Bumped versions
kraleppa Apr 18, 2025
27860f5
Removed Chrome DevTools mention
kraleppa Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,21 @@ Add `live_debugger` to your list of dependencies in `mix.exs`:
```elixir
defp deps do
[
{:live_debugger, "~> 0.1.4", only: :dev}
{:live_debugger, "~> 0.1.5", only: :dev}
]
end
```

For full experience we recommend adding below line to your application root layout. It attaches `meta` tag and LiveDebugger scripts in dev environment enabling browser features.

```elixir
# lib/my_app_web/components/layouts/root.html.heex

<head>
<%= Application.get_env(:live_debugger, :live_debugger_tags) %>
</head>
```

After you start your application LiveDebugger will be running at a default port `http://localhost:4007`.

> [!WARNING]
Expand All @@ -34,23 +44,16 @@ List of browser features:
- Debug button
- Components highlighting (coming soon!)

Some features require injecting JS into the debugged application. To achieve that you need to turn them on in the config and add LiveDebugger scripts to your application root layout.
Some features require injecting JS into the debugged application. You can disable them in your config.

```elixir
# config/dev.exs

config :live_debugger, browser_features?: true
```
# Disables all browser features and does not inject LiveDebugger JS
config :live_debugger, browser_features?: false

```elixir
# lib/my_app_web/components/layouts/root.html.heex

<head>
<%= if Application.get_env(:live_debugger, :browser_features?) do %>
<script id="live-debugger-scripts" src={Application.get_env(:live_debugger, :assets_url)}>
</script>
<% end %>
</head>
# Disables only debug button
config :live_debugger, debug_button?: false
```

### Content Security Policy
Expand All @@ -67,14 +70,14 @@ In `router.ex` of your Phoenix app, make sure your locally running Phoenix app c

## Igniter

LiveDebugger has [Igniter](https://github.com/ash-project/igniter) support - an alternative for standard mix installation. It'll automatically add LiveDebugger scripts to `root.html.heex` and enable browser features in your `config/dev.exs` after you use the below command.

Make sure that added dependency is `:dev` only.
LiveDebugger has [Igniter](https://github.com/ash-project/igniter) support - an alternative for standard mix installation. It'll automatically add LiveDebugger dependency and modify your `root.html.heex` after you use the below command.

```bash
mix igniter.install live_debugger
```

Make sure that added dependency is `:dev` only.

## Optional configuration

```elixir
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule LiveDebugger.MixProject do
use Mix.Project

@version "0.1.4"
@version "0.1.5"

def project do
[
Expand Down