Add command for migration purpose

[ReneWerner87]

[welcome[bot]]

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@ReneWerner87 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 37 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 39f8a570746a2d627ec91773762cf866e61d87f4 and e438e7dc4a020e875695dbfd3d1a880a7df2efa3.

⛔ Files ignored due to path filters (9)

• .github/release-drafter.yml is excluded by !**/*.yml
• .github/workflows/linter.yml is excluded by !**/*.yml
• .github/workflows/markdown.yml is excluded by !**/*.yml
• .github/workflows/security.yml is excluded by !**/*.yml
• .github/workflows/vulncheck.yml is excluded by !**/*.yml
• .golangci.yml is excluded by !**/*.yml
• .markdownlint.yml is excluded by !**/*.yml
• go.mod is excluded by !**/*.mod
• go.sum is excluded by !**/*.sum, !**/*.sum

📒 Files selected for processing (34)

• .github/CODE_OF_CONDUCT.md (1 hunks)
• .github/CONTRIBUTING.md (2 hunks)
• .github/ISSUE_TEMPLATE/---bug.md (1 hunks)
• .github/ISSUE_TEMPLATE/---feature.md (1 hunks)
• .github/ISSUE_TEMPLATE/---question.md (1 hunks)
• .github/pull_request_template.md (1 hunks)
• .gitignore (1 hunks)
• Makefile (1 hunks)
• README.md (3 hunks)
• cmd/dev.go (11 hunks)
• cmd/dev_test.go (11 hunks)
• cmd/helpers.go (3 hunks)
• cmd/helpers_test.go (3 hunks)
• cmd/internal/cmd.go (4 hunks)
• cmd/internal/helpers.go (2 hunks)
• cmd/internal/migrations/common.go (1 hunks)
• cmd/internal/migrations/lists.go (1 hunks)
• cmd/internal/migrations/v3/common.go (1 hunks)
• cmd/internal/migrations/v3/common_test.go (1 hunks)
• cmd/internal/prompt.go (6 hunks)
• cmd/internal/prompt_test.go (3 hunks)
• cmd/internal/task.go (4 hunks)
• cmd/migrate.go (1 hunks)
• cmd/new.go (2 hunks)
• cmd/new_test.go (2 hunks)
• cmd/root.go (4 hunks)
• cmd/root_test.go (7 hunks)
• cmd/tester_test.go (6 hunks)
• cmd/upgrade.go (1 hunks)
• cmd/upgrade_test.go (2 hunks)
• cmd/version.go (3 hunks)
• cmd/version_test.go (7 hunks)
• development.md (1 hunks)
• fiber/main.go (1 hunks)

Walkthrough

This update introduces a migration framework and command to automate codebase upgrades between Fiber versions. It adds new migration functions, test coverage for these, and refactors error handling, resource management, and code formatting throughout the CLI and supporting files. Documentation, templates, and ignore lists are also modernized for consistency and clarity.

Changes

File(s) / Group	Change Summary
.github/CODE_OF_CONDUCT.md, .github/CONTRIBUTING.md, .github/ISSUE_TEMPLATE/..., .github/pull_request_template.md, README.md	Improved markdown formatting, heading consistency, and link presentation in documentation and templates.
.gitignore	Expanded ignore patterns for test artifacts, IDE files, and dependency directories.
Makefile	Introduced new Makefile with common Go project targets (test, lint, coverage, etc.).
development.md	Added new development guide for local setup using air tool.
cmd/dev.go, cmd/dev_test.go	Refactored error handling, resource cleanup, and concurrency; modernized test code and assertions.
cmd/helpers.go, cmd/helpers_test.go	Improved error propagation, resource management, and test parallelism; updated JSON helpers and file handling.
cmd/internal/cmd.go, cmd/internal/helpers.go, cmd/internal/prompt.go, cmd/internal/prompt_test.go, cmd/internal/task.go	Refactored for better error handling, struct field order, method renaming, and test assertion style.
cmd/internal/migrations/common.go, cmd/internal/migrations/lists.go, cmd/internal/migrations/v3/common.go, cmd/internal/migrations/v3/common_test.go	New migration framework: Added migration functions for upgrading Fiber code, versioned migration lists, and comprehensive tests for migration logic.
cmd/migrate.go, cmd/root.go	Added new migrate CLI command; registered it in root command; improved error handling and version checking logic.
cmd/new.go, cmd/new_test.go	Enhanced error handling and explicit returns; switched to require for test assertions.
cmd/root_test.go, cmd/upgrade.go, cmd/upgrade_test.go, cmd/version.go, cmd/version_test.go, cmd/tester_test.go	Refactored for improved error handling, naming consistency, and test robustness; split version retrieval into separate functions with better HTTP handling.
fiber/main.go	Changed import style to multi-line block; no logic changes.

Sequence Diagram(s)

Migration Command Flow

sequenceDiagram
    participant User
    participant CLI
    participant Migrations
    participant MigrationFns

    User->>CLI: fiber migrate --to X.Y.Z
    CLI->>CLI: Parse and validate target version
    CLI->>Migrations: DoMigration(cmd, cwd, curr, target)
    loop For each Migration in Migrations
        Migrations->>Migrations: Check version constraints
        alt Constraints match
            Migrations->>MigrationFns: Run migration functions
        else Constraints don't match
            Migrations->>CLI: Print skip message
        end
    end
    Migrations->>CLI: Return success/failure
    CLI->>User: Print migration result

Migration Function File Transformation

sequenceDiagram
    participant MigrationFn
    participant FileSystem

    MigrationFn->>FileSystem: Walk directory tree
    loop For each Go file (excluding vendor)
        FileSystem->>MigrationFn: Read file content
        MigrationFn->>MigrationFn: Apply string/regex replacements
        MigrationFn->>FileSystem: Write updated content
    end
    MigrationFn->>CLI: Print migration status

Possibly related PRs

• gofiber/fiber#3354: Both PRs modify the Makefile's lint target, with this PR introducing a new Makefile and the referenced PR simplifying the lint command invocation.

Poem

🐇
Hop, hop! The code’s anew,
Migrations guide us, version through.
Helpers fixed, errors caught—
Tests now fail if bugs are sought.
With Makefile fresh and docs in tow,
This bunny’s proud to see us grow!
🥕

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

🧪 Generate unit tests

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment
• [ ] Commit unit tests in branch add-migration-command

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[ReneWerner87]

@coderabbitai summary

[coderabbitai[bot]]

✅ Actions performed

Summary regeneration triggered.