Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/linters v2 #90

Merged
merged 4 commits into from
Apr 16, 2024
Merged

Feature/linters v2 #90

merged 4 commits into from
Apr 16, 2024

Conversation

himanshu-wedensday
Copy link
Contributor

@himanshu-wedensday himanshu-wedensday commented Apr 16, 2024

Ticket Link


Related Links


Description


Steps to Reproduce / Test


GIF's


Summary by CodeRabbit

  • Refactor
    • Enhanced ESLint configurations and added new plugins to improve code quality checks.
    • Modified PropTypes definition in If component for clarity.
    • Updated Babel configuration to use modern syntax.
  • Documentation
    • Improved documentation for CharacterWithQuote component props.
  • Chores
    • Added ESLint disable comments in various files to bypass specific rules where necessary.
  • Chores
    • Updated ESLint configurations for prettier, sonarjs, security, and fp.
    • Adjusted settings for import resolver paths and aliases.
  • Chores
    • Added new ESLint plugins for functional programming, GitHub-specific rules, immutability checks, security best practices, and SonarJS integration.

Copy link

coderabbitai bot commented Apr 16, 2024

Walkthrough

The recent changes aim to refine the codebase by introducing stricter linting rules, enhanced documentation, and updated configurations. New ESLint plugins and configurations enforce code quality, security standards, and functional programming principles. These changes span across various files, including adjustments in ESLint settings, updates in component prop documentation, and syntax modifications in configuration files.

Changes

Files Change Summary
.eslintrc.js, babel.config.js, package.json Enhanced ESLint configurations, added new plugins, and updated settings.
app/components/atoms/If/index.js Changed PropTypes definition method to Object.assign.
app/components/molecules/CharacterWithQuote/index.js Enhanced documentation for component props.
app/components/atoms/LanguageProvider/reducer.js, app/scenes/RootScreen/reducer.js, app/scenes/RootScreen/saga.js Added ESLint disable comments for specific rules.
metro.config.js Added eslint-disable-next-line for the rule fp/no-mutation.

🐰✨
Code hops through fields of green,
Where bugs once lurked, now none are seen.
With lint and rules, we refine,
Each line of code, now crisp and fine.
Cheers to clean code, our endless quest,
With every update, we code our best!
🌟🐇


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between c7cb448 and eaad4d0.
Files selected for processing (2)
  • app/components/atoms/If/index.js (1 hunks)
  • babel.config.js (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • app/components/atoms/If/index.js
  • babel.config.js

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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link

github-actions bot commented Apr 16, 2024

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 95.12% 195/205
🟢 Branches 87.18% 34/39
🟢 Functions 93.51% 72/77
🟢 Lines 95.58% 173/181

Test suite run success

54 tests passing in 24 suites.

Report generated by 🧪jest coverage report action from eaad4d0

This comment has been minimized.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

app/components/atoms/If/index.js Outdated Show resolved Hide resolved
app/components/atoms/If/index.js Outdated Show resolved Hide resolved
babel.config.js Outdated
Comment on lines 8 to 9
// eslint-disable-next-line fp/no-mutation
module.exports = (api = { cache: () => {} }) => {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

The review comment suggested verifying the consistency of using arrow functions in configuration files across the project. The script executed searched for the pattern module.exports = ( in JavaScript files, which would typically indicate the use of arrow functions. The results show that the only instance of an arrow function in a module export is found in babel.config.js.

This indicates that the use of arrow functions in configuration files is not a common practice throughout the project. Therefore, the original review comment's concern about consistency is valid.

Conclusion: The use of an arrow function in babel.config.js is not consistent with other configuration files in the project.

Analysis chain

The use of an arrow function for defining the Babel configuration is a modern syntax choice. Ensure that this change is consistent with the coding standards of the project, especially regarding the use of arrow functions in configuration files.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check for consistency in the use of arrow functions in other configuration files
rg "module.exports = \(" --type js

Length of output: 102

.eslintrc.js Show resolved Hide resolved

This comment has been minimized.

Copy link

sonarqube-ws bot commented Apr 16, 2024

Passed

Analysis Details

0 Issues

  • Bug 0 Bugs
  • Vulnerability 0 Vulnerabilities
  • Code Smell 0 Code Smells

Coverage and Duplications

  • Coverage 100.00% Coverage (94.10% Estimated after merge)
  • Duplications 0.00% Duplicated Code (0.00% Estimated after merge)

Project ID: wednesday-solutions_react-native-template_AY7hdnRSB2n8RRmGoU2M

View in SonarQube

@alichherawalla alichherawalla merged commit c2a873f into master Apr 16, 2024
3 checks passed
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.

2 participants