Standardize sort order param

[jaruesink]

Summary

• prefer sortOrder over sortDesc
• update Bazza filters storybook and loader
• clarify sort order in hook and parser docs

Testing

• npx biome check . (fails: connect EHOSTUNREACH)

Summary by CodeRabbit

• Refactor

  • Updated sorting parameters in the data table to use a more explicit string-based sort order ('asc' or 'desc') in the URL and internal state, replacing the previous boolean approach.

• Documentation

  • Added clarifying comments to indicate that the sort order parameter accepts only 'asc' or 'desc' values.

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[coderabbitai]

Walkthrough

The updates standardize the sorting state representation in the data table components and related utilities by replacing the boolean sortDesc parameter with a string-based sortOrder parameter ('asc' or 'desc'). The changes affect URL parameter handling, internal state logic, and documentation comments, ensuring consistency and clarity throughout the codebase.

Changes

File(s)	Change Summary
apps/docs/src/remix-hook-form/data-table-bazza-filters.stories.tsx	Refactored sorting logic to use sortOrder ('asc'/'desc') instead of boolean sortDesc in URL and state. Console logs and parameter keys updated accordingly.
packages/components/src/remix-hook-form/data-table-router-parsers.ts	Added a comment clarifying that sortOrder is expected to be 'asc' or 'desc' in the type definition.
packages/components/src/remix-hook-form/use-data-table-url-state.ts	Added inline comments documenting that sortOrder represents 'asc' or 'desc' in state objects.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DataTableWithBazzaFilters
    participant URL
    participant handleDataFetch

    User->>DataTableWithBazzaFilters: Triggers sort action
    DataTableWithBazzaFilters->>URL: Updates search param sortOrder ('asc'/'desc')
    URL->>handleDataFetch: Passes sortOrder param
    handleDataFetch->>handleDataFetch: Converts sortOrder to desc flag (sortOrder === 'desc')
    handleDataFetch-->>DataTableWithBazzaFilters: Returns sorted data
    DataTableWithBazzaFilters-->>User: Displays sorted table

Loading

Poem

A hop and a skip, the sort order's new,
No more booleans, just 'asc' or 'desc' will do!
URLs are clearer, the code shines bright,
With comments to guide us, all feels right.
🐇✨ Sorting made simple, as rabbits prefer—so true!

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a9619c and f035f99.

📒 Files selected for processing (3)

• apps/docs/src/remix-hook-form/data-table-bazza-filters.stories.tsx (4 hunks)
• packages/components/src/remix-hook-form/data-table-router-parsers.ts (1 hunks)
• packages/components/src/remix-hook-form/use-data-table-url-state.ts (2 hunks)

🔇 Additional comments (10)

packages/components/src/remix-hook-form/data-table-router-parsers.ts (1)

124-124: Documentation improvement looks good!

The added comment clarifies the expected values for the sortOrder property, which aligns with the PR objective of standardizing sorting parameters throughout the codebase.

packages/components/src/remix-hook-form/use-data-table-url-state.ts (2)

23-24: Well-placed clarifying comment!

The added comment clearly indicates the expected values for the sortOrder parameter, maintaining consistency with the standardization effort.

---

87-88: Consistent documentation!

This comment maintains the same standardized documentation approach used elsewhere, helping developers understand the expected values.

apps/docs/src/remix-hook-form/data-table-bazza-filters.stories.tsx (7)

344-344: Good parameter standardization!

The change from a boolean sortDesc to a string-based sortOrder parameter with explicit casting improves type safety and clarity.

---

348-348: Proper boolean conversion!

The approach to transform the string-based sortOrder into a boolean desc flag for the sorting state is correct.

---

362-362: Clean bidirectional conversion!

The conversion from boolean desc flag back to string sortOrder value is implemented correctly.

---

365-365: Consistent parameter cleanup!

Updated parameter deletion to match the new standardized naming convention.

---

444-444: Consistent loader parameter handling!

The loader function now correctly uses the standardized sortOrder parameter with appropriate default and type casting.

---

447-447: Updated logging!

Console logging has been updated to reflect the parameter name change, which helps with debugging.

---

515-515: Proper sort logic adaptation!

The sort comparison now correctly uses the string-based sortOrder parameter instead of the boolean approach.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch codex/decide-consistent-parameter-name-and-update-code
• Post Copyable Unit Tests in Comment

---

🪧 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 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.

[github-actions]

📝 Storybook Preview: View Storybook

This preview will be updated automatically when you push new changes to this PR.

Note: The preview will be available after the workflow completes and the PR is approved for deployment.

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[jaruesink]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.