Current section

42 Versions

Jump to

Compare versions

4 files changed
+27 additions
-7 deletions
  @@ -5,6 +5,21 @@ See [Conventional Commits](Https://conventionalcommits.org) for commit guideline
5 5
6 6 <!-- changelog -->
7 7
8 + ## v0.1.22 (2025-07-19)
9 +
10 +
11 +
12 +
13 + ### Bug Fixes:
14 +
15 + * make igniter not an optional dependency, but a normal one by Zach Daniel
16 +
17 + ### Improvements:
18 +
19 + * show `mix help test` in testing usage rules by Zach Daniel
20 +
21 + * add a debugging header to elixir usage rules by Zach Daniel
22 +
8 23 ## v0.1.21 (2025-07-17)
  @@ -6,7 +6,7 @@
6 6 {<<"GitHub">>,<<"https://github.com/ash-project/usage_rules">>},
7 7 {<<"Website">>,<<"https://ash-hq.org">>}]}.
8 8 {<<"name">>,<<"usage_rules">>}.
9 - {<<"version">>,<<"0.1.21">>}.
9 + {<<"version">>,<<"0.1.22">>}.
10 10 {<<"description">>,
11 11 <<"A dev tool for Elixir projects to gather LLM usage rules from dependencies">>}.
12 12 {<<"elixir">>,<<"~> 1.18">>}.
  @@ -34,7 +34,7 @@
34 34 {<<"repository">>,<<"hexpm">>}],
35 35 [{<<"name">>,<<"igniter">>},
36 36 {<<"app">>,<<"igniter">>},
37 - {<<"optional">>,true},
37 + {<<"optional">>,false},
38 38 {<<"requirement">>,<<"~> 0.6 and >= 0.6.6">>},
39 39 {<<"repository">>,<<"hexpm">>}]]}.
40 40 {<<"build_tools">>,[<<"mix">>]}.
  @@ -1,7 +1,7 @@
1 1 defmodule UsageRules.MixProject do
2 2 use Mix.Project
3 3
4 - @version "0.1.21"
4 + @version "0.1.22"
5 5 @description """
6 6 A dev tool for Elixir projects to gather LLM usage rules from dependencies
7 7 """
  @@ -15,7 +15,7 @@ defmodule UsageRules.MixProject do
15 15 elixir: "~> 1.18",
16 16 package: package(),
17 17 aliases: aliases(),
18 - dialyzer: [plt_add_apps: [:mix]],
18 + dialyzer: [plt_add_apps: [:mix, :iex]],
19 19 docs: &docs/0,
20 20 description: @description,
21 21 source_url: @source_url,
  @@ -86,7 +86,8 @@ defmodule UsageRules.MixProject do
86 86 [
87 87 {:req, "~> 0.5"},
88 88 {:jason, "~> 1.0"},
89 - {:igniter, "~> 0.6 and >= 0.6.6", optional: true},
89 + # not an optional dependency, because *this package* is itself a dev dependency
90 + {:igniter, "~> 0.6 and >= 0.6.6"},
90 91 # dev dependencies
91 92 {:ex_doc, "~> 0.37-rc", only: [:dev, :test], runtime: false},
92 93 {:ex_check, "~> 0.12", only: [:dev, :test]},
  @@ -41,8 +41,12 @@
41 41 - Read the docs and options fully before using tasks
42 42
43 43 ## Testing
44 - - Run tests in a specific file with `mix test test/my_test.exs` and a specific test
45 - with the line number `mix test path/to/test.exs:123`
44 + - Run tests in a specific file with `mix test test/my_test.exs` and a specific test with the line number `mix test path/to/test.exs:123`
46 45 - Limit the number of failed tests with `mix test --max-failures n`
47 46 - Use `@tag` to tag specific tests, and `mix test --only tag` to run only those tests
48 47 - Use `assert_raise` for testing expected exceptions: `assert_raise ArgumentError, fn -> invalid_function() end`
48 + - Use `mix help test` to for full documentation on running tests
49 +
50 + ## Debugging
51 +
52 + - Use `dbg/1` to print values while debugging. This will display the formatted value and other relevant information in the console.