Skip to content

Conversation

@RamRamez
Copy link
Member

@RamRamez RamRamez commented May 23, 2025

Fix Eslint config to match other Giveth and GM reps

Summary by CodeRabbit

  • Style
    • Unified code formatting by removing trailing semicolons and commas, adjusting whitespace, and applying consistent single-quote usage across the project.
  • Chores
    • Updated Prettier configuration to refine formatting options.
    • Added eslint-plugin-import and integrated Prettier formatting and import order rules into ESLint.
    • Renamed project to "worldview-be" with updated version and metadata in package configuration.
  • Tests
    • Reformatted test files to align with updated code style without altering test logic or coverage.

@coderabbitai
Copy link

coderabbitai bot commented May 23, 2025

Walkthrough

This update modifies the .prettierrc configuration file to add new formatting options and adjusts the ESLint configuration by adding the eslint-plugin-import plugin and replacing some TypeScript ESLint rules with Prettier formatting enforcement and import ordering rules. Across the codebase, trailing semicolons and some trailing commas are removed from TypeScript and JavaScript files, standardizing code style without changing any logic or functionality. Some method signatures were refined for typing, and decorators were added to user controller methods.

Changes

File(s) or Group Change Summary
.prettierrc Modified to include "arrowParens": "avoid", "semi": false, "tabWidth": 2, "useTabs": false, and "endOfLine": "auto"; reordered existing options.
eslint.config.mjs, package.json Added eslint-plugin-import plugin and new ESLint rules for Prettier formatting and import order; added plugin to devDependencies.
src/**/*.ts, test/app.e2e-spec.ts Removed trailing semicolons and some trailing commas from all TypeScript files, including DTOs, controllers, services, modules, validators, decorators, constants, exceptions, filters, and test files. No logic or functionality changed.
src/auth/jwt.service.ts, src/common/validators.ts Refined method signatures for better typing (decode method and validator validate methods).
src/user/user.controller.ts Added @User('worldID') decorator to method parameters and @Public() decorator to one method; also removed trailing semicolons.
src/poll/Poll.dto.ts, src/user/user.dto.ts Minor explicit type cast added in transform decorators; trailing semicolons removed.
src/main.ts Reformatted code to remove semicolons and streamline arrow function syntax; added error handling in bootstrap.

Sequence Diagram(s)

sequenceDiagram
  participant Developer
  participant ESLint
  participant Codebase

  Developer->>ESLint: Runs linting
  ESLint->>Codebase: Checks code style (Prettier rules enforced)
  Codebase-->>ESLint: Returns code with no semicolons, single quotes, trailing commas as configured
  ESLint-->>Developer: Reports errors if formatting rules violated
Loading

Poem

No semicolons left upon the ground,
The code is neat, no errors found.
Prettier’s rules now live in ESLint’s den,
Formatting’s unified—again and again!
A rabbit hops through fields of style,
Whiskers twitching, code compiled.
🐇✨

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.


📜 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 c8f48b8 and df37fe2.

📒 Files selected for processing (3)
  • .prettierrc (1 hunks)
  • eslint.config.mjs (2 hunks)
  • package.json (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • package.json
  • .prettierrc
  • eslint.config.mjs
✨ Finishing Touches
  • 📝 Generate Docstrings

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

@RamRamez RamRamez requested a review from Meriem-BM May 24, 2025 11:29
@RamRamez RamRamez merged commit 4f1ee01 into develop May 25, 2025
1 check passed
@RamRamez RamRamez deleted the set-eslint branch May 25, 2025 12:21
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.

3 participants