feature: Inspector Gadget

README.md

@@ -6,11 +6,13 @@ RelSpec is a comprehensive database relations management tool that reads, transf
 
 ## Overview
 
-RelSpec provides bidirectional conversion and comparison between various database specification formats, allowing you to:
+RelSpec provides bidirectional conversion, comparison, and validation of database specification formats, allowing you to:
 - Inspect live databases and extract their structure
-- Convert between different ORM models (GORM, Bun , etc.)
+- Validate schemas against configurable rules and naming conventions
+- Convert between different ORM models (GORM, Bun, etc.)
 - Transform legacy schema definitions (Clarion DCTX, XML, JSON, etc.)
 - Generate standardized specification files (JSON, YAML, etc.)
+- Compare database schemas and track changes
 
 ![1.00](./assets/image/relspec1_512.jpg)
 
@@ -60,6 +62,19 @@ RelSpec can write database schemas to multiple formats:
 - [JSON](pkg/writers/json/README.md) - RelSpec canonical JSON format
 - [YAML](pkg/writers/yaml/README.md) - RelSpec canonical YAML format
 
+### Inspector (Schema Validation)
+
+RelSpec includes a powerful schema validation and linting tool:
+
+- [Inspector](pkg/inspector/README.md) - Validate database schemas against configurable rules
+  - Enforce naming conventions (snake_case, camelCase, custom patterns)
+  - Check primary key and foreign key standards
+  - Detect missing indexes on foreign keys
+  - Prevent use of SQL reserved keywords
+  - Ensure schema integrity (missing PKs, orphaned FKs, circular dependencies)
+  - Support for custom validation rules
+  - Multiple output formats (Markdown with colors, JSON)
+  - CI/CD integration ready
 
 ## Use of AI
 [Rules and use of AI](./AI_USE.md)
@@ -74,30 +89,65 @@ go install -v git.warky.dev/wdevs/relspecgo/cmd/relspec@latest
 
 ## Usage
 
+### Schema Conversion
+
 ```bash
-# Inspect database and generate GORM models
-relspec --input db --conn "postgres://..." --output gorm --out-file models.go
+# Convert PostgreSQL database to GORM models
+relspec convert --from pgsql --from-conn "postgres://user:pass@localhost/mydb" \
+                --to gorm --to-path models/ --package models
 
 # Convert GORM models to Bun
-relspec --input gorm --in-file existing.go --output bun --out-file bun_models.go
+relspec convert --from gorm --from-path models.go \
+                --to bun --to-path bun_models.go --package models
 
 # Export database schema to JSON
-relspec --input db --conn "mysql://..." --output json --out-file schema.json
+relspec convert --from pgsql --from-conn "postgres://..." \
+                --to json --to-path schema.json
 
-# Convert Clarion DCTX to YAML
-relspec --input dctx --in-file legacy.dctx --output yaml --out-file schema.yaml
+# Convert DBML to PostgreSQL SQL
+relspec convert --from dbml --from-path schema.dbml \
+                --to pgsql --to-path schema.sql
+```
+
+### Schema Validation
+
+```bash
+# Validate a PostgreSQL database with default rules
+relspec inspect --from pgsql --from-conn "postgres://user:pass@localhost/mydb"
+
+# Validate DBML file with custom rules
+relspec inspect --from dbml --from-path schema.dbml --rules .relspec-rules.yaml
+
+# Generate JSON validation report
+relspec inspect --from json --from-path db.json \
+                --output-format json --output report.json
+
+# Validate specific schema only
+relspec inspect --from pgsql --from-conn "..." --schema public
+```
+
+### Schema Comparison
+
+```bash
+# Compare two database schemas
+relspec diff --from pgsql --from-conn "postgres://localhost/db1" \
+             --to pgsql --to-conn "postgres://localhost/db2"
 ```
 
 ## Project Structure
 
 ```
 relspecgo/
-├── cmd/              # CLI application
+├── cmd/
+│   └── relspec/      # CLI application (convert, inspect, diff, scripts)
 ├── pkg/
-│   ├── readers/      # Input format readers
-│   ├── writers/      # Output format writers
+│   ├── readers/      # Input format readers (DBML, GORM, PostgreSQL, etc.)
+│   ├── writers/      # Output format writers (GORM, Bun, SQL, etc.)
+│   ├── inspector/    # Schema validation and linting
+│   ├── diff/         # Schema comparison
 │   ├── models/       # Internal data models
-│   └── transform/    # Transformation logic
+│   ├── transform/    # Transformation logic
+│   └── pgsql/        # PostgreSQL utilities (keywords, data types)
 ├── examples/         # Usage examples
 └── tests/            # Test files
 ```