misc: update validation error format

[radulucut]

Closes #102

Summary by CodeRabbit

• Bug Fixes
  • Improved the clarity and structure of validation error messages with a new prefix and consistent parameter formatting.
  • Updated the fallback message for cases with no provided parameters to enhance readability.

[coderabbitai]

Walkthrough

This update refines the error message formatting in the getAPIErrorMessage function for validation errors. The modifications add a prefix ("Error: invalid parameters") and format error parameters with a leading dash. Additionally, the fallback message has been updated to a new wording. These changes enhance the readability and structure of the error messages without altering the underlying logic.

Changes

File(s)	Change Summary
packages/bot-utils/.../errors.ts	Refactored getAPIErrorMessage for validation errors: added "Error: invalid parameters" prefix, reformatted parameters with a leading dash, and updated fallback message wording.

Assessment against linked issues

Objective	Addressed	Explanation
Error format (#102)	✅

Poem

I'm a rabbit who loves clear code at night,
Hoping error messages now shine so bright.
With dashes, prefixes, and tweaks so fine,
Each validation error now reads in line.
Hoppin' happy for changes done just right! 🥕

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/bot-utils/src/errors.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-jsonc".

(The package "eslint-plugin-jsonc" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-jsonc@latest --save-dev

The plugin "eslint-plugin-jsonc" was referenced from the config file in ".eslintrc.cjs » @martin-kolarik/eslint-config/typescript » ./.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 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 525049b and e3cbf03.

📒 Files selected for processing (1)

• packages/bot-utils/src/errors.ts (1 hunks)

🔇 Additional comments (1)

packages/bot-utils/src/errors.ts (1)

39-43: Improved error message formatting for validation errors.

The changes enhance the readability of validation error messages with:

1. A clear "Error: invalid parameters" prefix
2. Bullet-point style formatting for each parameter error (with leading dashes)
3. Consistent formatting for the fallback error message

This makes the error messages more user-friendly while maintaining the same underlying logic.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.