credo-custom-checks
Use when creating custom Credo checks for project-specific code quality rules and standards in Elixir.
When & Why to Use This Skill
This Claude skill empowers Elixir developers to design and implement custom Credo checks tailored to specific project requirements. By automating the detection of unique code patterns, security vulnerabilities, and stylistic preferences, it enhances static analysis workflows and ensures consistent code quality across Elixir codebases.
Use Cases
- Security Auditing: Create checks to identify hardcoded credentials, sensitive data patterns, or insecure function calls unique to your application's environment.
- Architectural Guardrails: Enforce project-specific design patterns, such as restricting certain module dependencies or ensuring specific macro usage across an umbrella project.
- Automated Style Enforcement: Supplement standard Credo rules with custom linting for team-specific naming conventions, documentation requirements, or formatting standards.
- Refactoring & Migration: Automatically flag deprecated internal functions or legacy patterns during large-scale migrations to ensure all new code adheres to updated standards.
| name | credo-custom-checks |
|---|---|
| description | Use when creating custom Credo checks for project-specific code quality rules and standards in Elixir. |
| allowed-tools | [] |
Credo Custom Checks
Creating custom Credo checks for project-specific rules.
Creating a Custom Check
defmodule MyApp.Credo.Check.NoHardcodedSecrets do
use Credo.Check,
category: :warning,
base_priority: :high,
explanations: [
check: """
Detects hardcoded secrets in code.
"""
]
@impl true
def run(%SourceFile{} = source_file, params) do
issue_meta = IssueMeta.for(source_file, params)
Credo.Code.prewalk(source_file, &traverse(&1, &2, issue_meta))
end
defp traverse(
{:@, _, [{:secret_key, _, [value]}]} = ast,
issues,
issue_meta
)
when is_binary(value) do
new_issue = issue_for(issue_meta, value)
{ast, [new_issue | issues]}
end
defp traverse(ast, issues, _issue_meta) do
{ast, issues}
end
defp issue_for(issue_meta, value) do
format_issue(
issue_meta,
message: "Hardcoded secret found: #{String.slice(value, 0..5)}...",
trigger: value
)
end
end
Using Custom Checks
# .credo.exs
%{
configs: [
%{
name: "default",
requires: ["./lib/my_app/credo/check/*.ex"],
checks: %{
enabled: [
{MyApp.Credo.Check.NoHardcodedSecrets, []}
]
}
}
]
}