ecto_annotate

0.1.0

A Mix task to annotate your Ecto schemas with database column information, relationships, and associations - inspired by Ruby's annotate gem.

HexDocs

Current section

Files

Jump to

Readme 1 Version 2 Dependencies Dependants Files Activity

ecto_annotate CHANGELOG.md

Raw

CHANGELOG.md

# Changelog

## 0.1.0 (2025-01-07)

### Added
- Initial release of EctoAnnotate
- Mix task to scan and display Ecto schema information
- Automatic annotation writing to schema files
- Support for displaying:
  - Primary keys (integer id vs binary_id)
  - Columns with types, defaults, and constraints
  - Indexes with unique flags
  - Foreign keys with on_delete/on_update actions
  - Associations with ID type detection
- Beautiful colored CLI output
- Configuration file support (`.ecto_annotate.exs`)
- Customizable paths for migrations and schemas
- Directory exclusion support
- Annotation position control (top or before schema)
- Remove annotations functionality

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT