Skip to content

Add comparison document for StructuredParams and similar gems - #4

Merged
Syati merged 1 commit into
mainfrom
update_readme
Sep 6, 2025
Merged

Add comparison document for StructuredParams and similar gems#4
Syati merged 1 commit into
mainfrom
update_readme

Conversation

@Syati

@Syati Syati commented Sep 6, 2025

Copy link
Copy Markdown
Owner

No description provided.

Copilot AI review requested due to automatic review settings September 6, 2025 02:41
@Syati
Syati merged commit f19ea99 into main Sep 6, 2025
3 checks passed
@Syati
Syati deleted the update_readme branch September 6, 2025 02:41

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation comparing StructuredParams with other parameter handling gems in the Ruby/Rails ecosystem. The comparison provides detailed feature matrices, code examples, and migration guidance to help developers choose the right tool for their needs.

  • Adds a new comparison document with feature matrices for StructuredParams vs typed_params, dry-validation, and reform
  • Provides detailed code examples showing the differences between each gem's approach
  • Includes migration guides with before/after code examples for transitioning from other gems
  • Updates README files to reference the new comparison documentation

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
docs/comparison.md New comprehensive comparison document with feature matrices, code examples, and migration guides
README.md Adds link to new gem comparison documentation
README_ja.md Adds link to new gem comparison documentation and fixes minor typos

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread README_ja.md
gem 'structured_params'

# 2. イニ��ャライザで型を登録
# 2. イニシャライザで型を登録

Copilot AI Sep 6, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The katakana spelling 'イニシャライザ' should be 'イニシャライザー' (with ー) to be more accurate for 'initializer'.

Suggested change
# 2. イニシャライザで型を登録
# 2. イニシャライザーで型を登録

Copilot uses AI. Check for mistakes.
Comment thread README_ja.md
- **[基本的な使用方法](docs/basic-usage.md)** - パラメータクラス、ネストオブジェクト、配列
- **[バリデーション](docs/validation.md)** - ネスト構造での ActiveModel バリデーション
- **[Strong Parameters](docs/strong-parameters.md)** - 自動 permit リスト生成
- **[バリデーション](docs/validation.md)** - ネスト構造でのActiveModelバリデーション使用

Copilot AI Sep 6, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing space between 'ActiveModel' and 'バリデーション' for better readability.

Suggested change
- **[バリデーション](docs/validation.md)** - ネスト構造でのActiveModelバリデーション使用
- **[バリデーション](docs/validation.md)** - ネスト構造での ActiveModel バリデーション使用

Copilot uses AI. Check for mistakes.
Comment thread README_ja.md
- **[バリデーション](docs/validation.md)** - ネスト構造での ActiveModel バリデーション
- **[Strong Parameters](docs/strong-parameters.md)** - 自動 permit リスト生成
- **[バリデーション](docs/validation.md)** - ネスト構造でのActiveModelバリデーション使用
- **[Strong Parameters](docs/strong-parameters.md)** - 自動permit リスト生成

Copilot AI Sep 6, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing space between '自動' and 'permit' for consistency with other entries.

Suggested change
- **[Strong Parameters](docs/strong-parameters.md)** - 自動permit リスト生成
- **[Strong Parameters](docs/strong-parameters.md)** - 自動 permit リスト生成

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants