Prettier Integration

[Bashamega]

Fixes Issue

closes #153

Changes proposed

Check List (Check all the applicable boxes)

• [x] My code follows the code style of this project.
• [] My change requires changes to the documentation.
• [ ] I have updated the documentation accordingly.
• [x] All new and existing tests passed.
• [x] This PR does not contain plagiarized content.
• [x] The title of my pull request is a short description of the requested changes.

Screenshots

Note to reviewers

Summary by CodeRabbit

• Documentation

  • Improved clarity of the issue template in GitHub by adjusting the formatting and description fields.
  • Enhanced the readability of the CHANGELOG.md file by removing extraneous line breaks.
  • Made formatting adjustments to the README.md tables for better alignment.

• Chores

  • Introduced commands for formatting checks and writing in the pre-commit hook for better code quality.
  • Added Prettier configuration to standardize code formatting across the project.
  • Updated the version number in the app.json configuration file.

• Style

  • Consistently applied trailing commas and improved formatting in several JavaScript files to enhance code readability.

[coderabbitai[bot]]

Walkthrough

This update integrates Prettier for code formatting across the project, enhancing consistency and readability. Key changes include the addition of Prettier configuration, corresponding scripts in package.json, and formatting adjustments across various files to align with the new rules. These modifications streamline the codebase and improve its maintainability.

Changes

Files	Change Summary
.github/ISSUE_TEMPLATE/bug.yml	Improved formatting for clarity in the issue template.
.husky/pre-commit	Added formatting check command; integrated potential test command for future use.
.prettierrc	Created configuration file for Prettier with specific formatting rules (tabWidth, useTabs).
CHANGELOG.md	Streamlined formatting for clarity in version entries.
README.md	Adjusted table formatting for better readability.
package.json	Added scripts for Prettier formatting and included Prettier as a dependency.
src/** (multiple files)	Minor formatting adjustments (trailing commas) for consistency; no changes in logic.
src/config/app.json	Added newline for formatting; no other content changes.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Prettier
    participant CI/CD
    Developer->>Prettier: Format code
    alt If code is formatted correctly
        Prettier-->>Developer: Code is clean
    else If code needs changes
        Prettier-->>Developer: Suggest changes
    end
    Developer->>CI/CD: Commit changes
    CI/CD->>Prettier: Run pre-commit hook
    Prettier-->>CI/CD: Ensure code format compliance

Assessment against linked issues

Objective	Addressed	Explanation
Integrate Prettier for code formatting	✅
Add Prettier to pre-commit hooks	✅
Ensure code is formatted consistently	✅

Poem

🐰 In the land where code does hop,
Prettier came to make it stop,
With tidy lines and spaces bright,
Our code now gleams with pure delight!
Linting, checking, all in place,
A formatted world, a joyful space! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.