cloud/music_library
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync usage rules

Browse Source
This commit is contained in:
Claudio Ortolina
2025-07-20 08:33:40 +01:00
parent 89b91e0798
commit 512404ffad
1 changed files with 12 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+12 -25
View File
@@ -241,26 +241,21 @@ usage rules to understand the correct patterns, conventions, and best practices.
<!-- usage-rules-header-end --> <!-- usage-rules-header-end -->
<!-- igniter-start --> <!-- igniter-start -->
## igniter usage ## igniter usage
_A code generation and project patching framework _A code generation and project patching framework
_ _
[igniter usage rules](deps/igniter/usage-rules.md) [igniter usage rules](deps/igniter/usage-rules.md)
<!-- igniter-end --> <!-- igniter-end -->
<!-- usage_rules-start --> <!-- usage_rules-start -->
## usage_rules usage ## usage_rules usage
_A dev tool for Elixir projects to gather LLM usage rules from dependencies _A dev tool for Elixir projects to gather LLM usage rules from dependencies
_ _
## Using Usage Rules ## Using Usage Rules
Many packages have usage rules, which you should _thoroughly_ consult before taking any Many packages have usage rules, which you should *thoroughly* consult before taking any
action. These usage rules contain guidelines and rules _directly from the package authors_. action. These usage rules contain guidelines and rules *directly from the package authors*.
They are your best source of knowledge for making decisions. They are your best source of knowledge for making decisions.
## Modules & functions in the current app and dependencies ## Modules & functions in the current app and dependencies
@@ -279,9 +274,10 @@ mix usage_rules.docs Enum.zip
mix usage_rules.docs Enum.zip/1 mix usage_rules.docs Enum.zip/1
``` ```
## Searching Documentation ## Searching Documentation
You should also consult the documentation of any tools you are using, early and often. The best You should also consult the documentation of any tools you are using, early and often. The best
way to accomplish this is to use the `usage_rules.search_docs` mix task. Once you have way to accomplish this is to use the `usage_rules.search_docs` mix task. Once you have
found what you are looking for, use the links in the search results to get more detail. For example: found what you are looking for, use the links in the search results to get more detail. For example:
@@ -299,26 +295,22 @@ mix usage_rules.search_docs "making requests" -p req
mix usage_rules.search_docs "Enum.zip" --query-by title mix usage_rules.search_docs "Enum.zip" --query-by title
``` ```
<!-- usage_rules-end --> <!-- usage_rules-end -->
<!-- usage_rules:elixir-start --> <!-- usage_rules:elixir-start -->
## usage_rules:elixir usage ## usage_rules:elixir usage
# Elixir Core Usage Rules # Elixir Core Usage Rules
## Pattern Matching ## Pattern Matching
- Use pattern matching over conditional logic when possible - Use pattern matching over conditional logic when possible
- Prefer to match on function heads instead of using `if`/`else` or `case` in function bodies - Prefer to match on function heads instead of using `if`/`else` or `case` in function bodies
## Error Handling ## Error Handling
- Use `{:ok, result}` and `{:error, reason}` tuples for operations that can fail - Use `{:ok, result}` and `{:error, reason}` tuples for operations that can fail
- Avoid raising exceptions for control flow - Avoid raising exceptions for control flow
- Use `with` for chaining operations that return `{:ok, _}` or `{:error, _}` - Use `with` for chaining operations that return `{:ok, _}` or `{:error, _}`
## Common Mistakes to Avoid ## Common Mistakes to Avoid
- Elixir has no `return` statement, nor early returns. The last expression in a block is always returned. - Elixir has no `return` statement, nor early returns. The last expression in a block is always returned.
- Don't use `Enum` functions on large collections when `Stream` is more appropriate - Don't use `Enum` functions on large collections when `Stream` is more appropriate
- Avoid nested `case` statements - refactor to a single `case`, `with` or separate functions - Avoid nested `case` statements - refactor to a single `case`, `with` or separate functions
@@ -331,15 +323,13 @@ mix usage_rules.search_docs "Enum.zip" --query-by title
- There are many useful standard library functions, prefer to use them where possible - There are many useful standard library functions, prefer to use them where possible
## Function Design ## Function Design
- Use guard clauses: `when is_binary(name) and byte_size(name) > 0` - Use guard clauses: `when is_binary(name) and byte_size(name) > 0`
- Prefer multiple function clauses over complex conditional logic - Prefer multiple function clauses over complex conditional logic
- Name functions descriptively: `calculate_total_price/2` not `calc/2` - Name functions descriptively: `calculate_total_price/2` not `calc/2`
- Predicate function names should not start with `is` and should end in a question mark. - Predicate function names should not start with `is` and should end in a question mark.
- Names like `is_thing` should be reserved for guards - Names like `is_thing` should be reserved for guards
## Data Structures ## Data Structures
- Use structs over maps when the shape is known: `defstruct [:name, :age]` - Use structs over maps when the shape is known: `defstruct [:name, :age]`
- Prefer keyword lists for options: `[timeout: 5000, retries: 3]` - Prefer keyword lists for options: `[timeout: 5000, retries: 3]`
- Use maps for dynamic key-value data - Use maps for dynamic key-value data
@@ -352,41 +342,38 @@ mix usage_rules.search_docs "Enum.zip" --query-by title
- Read the docs and options fully before using tasks - Read the docs and options fully before using tasks
## Testing ## Testing
- 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`
- 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`
- Limit the number of failed tests with `mix test --max-failures n` - Limit the number of failed tests with `mix test --max-failures n`
- Use `@tag` to tag specific tests, and `mix test --only tag` to run only those tests - Use `@tag` to tag specific tests, and `mix test --only tag` to run only those tests
- Use `assert_raise` for testing expected exceptions: `assert_raise ArgumentError, fn -> invalid_function() end` - Use `assert_raise` for testing expected exceptions: `assert_raise ArgumentError, fn -> invalid_function() end`
- Use `mix help test` to for full documentation on running tests
## Debugging
- Use `dbg/1` to print values while debugging. This will display the formatted value and other relevant information in the console.
<!-- usage_rules:elixir-end --> <!-- usage_rules:elixir-end -->
<!-- usage_rules:otp-start --> <!-- usage_rules:otp-start -->
## usage_rules:otp usage ## usage_rules:otp usage
# OTP Usage Rules # OTP Usage Rules
## GenServer Best Practices ## GenServer Best Practices
- Keep state simple and serializable - Keep state simple and serializable
- Handle all expected messages explicitly - Handle all expected messages explicitly
- Use `handle_continue/2` for post-init work - Use `handle_continue/2` for post-init work
- Implement proper cleanup in `terminate/2` when necessary - Implement proper cleanup in `terminate/2` when necessary
## Process Communication ## Process Communication
- Use `GenServer.call/3` for synchronous requests expecting replies - Use `GenServer.call/3` for synchronous requests expecting replies
- Use `GenServer.cast/2` for fire-and-forget messages. - Use `GenServer.cast/2` for fire-and-forget messages.
- When in doubt, us `call` over `cast`, to ensure back-pressure - When in doubt, us `call` over `cast`, to ensure back-pressure
- Set appropriate timeouts for `call/3` operations - Set appropriate timeouts for `call/3` operations
## Fault Tolerance ## Fault Tolerance
- Set up processes such that they can handle crashing and being restarted by supervisors - Set up processes such that they can handle crashing and being restarted by supervisors
- Use `:max_restarts` and `:max_seconds` to prevent restart loops - Use `:max_restarts` and `:max_seconds` to prevent restart loops
## Task and Async ## Task and Async
- Use `Task.Supervisor` for better fault tolerance - Use `Task.Supervisor` for better fault tolerance
- Handle task failures with `Task.yield/2` or `Task.shutdown/2` - Handle task failures with `Task.yield/2` or `Task.shutdown/2`
- Set appropriate task timeouts - Set appropriate task timeouts