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

fix: indentation for objects #101

Merged
merged 6 commits into from
Jun 18, 2024
Merged

fix: indentation for objects #101

merged 6 commits into from
Jun 18, 2024

Conversation

koladilip
Copy link
Collaborator

@koladilip koladilip commented Jun 18, 2024

What are the changes introduced in this PR?

Fix indentation for objects while reverse translating

What is the related Linear task?

Resolves INT-2240

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new generic utility introduced or modified. Please explain the changes.

N/A

Any technical or performance related pointers to consider with the change?

N/A

@coderabbitai review


Developer checklist

  • My code follows the style guidelines of this project

  • No breaking changes are being introduced.

  • All related docs linked with the PR?

  • All changes manually tested?

  • Any documentation changes needed with this change?

  • Is the PR limited to 10 file changes?

  • Is the PR limited to one linear task?

  • Are relevant unit and component test-cases added?

Reviewer checklist

  • Is the type of change in the PR title appropriate as per the changes?

  • Verified that there are no credentials or confidential data exposed with the changes.

Summary by CodeRabbit

  • New Features
    • Improved formatting in the translation functionality to enhance readability with consistent indentation.

@koladilip koladilip requested a review from a team as a code owner June 18, 2024 03:12
Copy link

coderabbitai bot commented Jun 18, 2024

Walkthrough

The recent changes introduce a new constant for indentation (INDENTATION_SPACES) and modify the translateExpressions and translateObjectExpression methods to utilize this constant. These adjustments aid in standardizing the indentation spacing within the reverse translator's output.

Changes

Files Change Summary
src/constants.ts Added a new constant INDENTATION_SPACES with a value of 4.
.../reverse_translator.ts Modified to import INDENTATION_SPACES, added getIndentation method, and updated translateExpressions to include a prefix parameter for handling indentation.

Poem

In code's grand forest deep and dense 🌲

Indents now make more sense;

With four small spaces leading the way,

Our syntax shines without delay.

Translating lines, precise and neat,

Hop along, let's make code sweet! 🐇


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

github-actions bot commented Jun 18, 2024

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 100% 4685/4685
🟢 Branches 100% 1246/1246
🟢 Functions 100% 353/353
🟢 Lines 100% 4685/4685

Test suite run success

187 tests passing in 4 suites.

Report generated by 🧪jest coverage report action from 2431bcc

Copy link

codecov bot commented Jun 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (97d95e8) to head (2431bcc).
Report is 25 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##              main      #101    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           14        14            
  Lines         4565      4685   +120     
  Branches      1082      1100    +18     
==========================================
+ Hits          4565      4685   +120     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4fe6873 and 2431bcc.

Files selected for processing (2)
  • src/constants.ts (1 hunks)
  • src/reverse_translator.ts (3 hunks)
Files skipped from review due to trivial changes (1)
  • src/constants.ts
Additional comments not posted (4)
src/reverse_translator.ts (4)

36-36: The import statement correctly includes the new INDENTATION_SPACES constant. Ensure that this constant is used consistently throughout the file.


218-219: The modification to include a prefix parameter in translateExpressions is correctly implemented. This allows dynamic indentation based on the translation context, which aligns with the PR's objectives to fix object indentation issues.


432-434: The getIndentation method is correctly implemented. It uses the INDENTATION_SPACES constant to generate a string of spaces based on the current indentation level. This method will help maintain consistent indentation across different parts of the translated output.


438-442: The changes to translateObjectExpression are well-implemented. The method now correctly adjusts the indentation level and applies it before and after translating the object properties. This ensures that the output is properly formatted, which is critical for readability and maintenance.

@koladilip koladilip merged commit b7ca7be into main Jun 18, 2024
12 checks passed
@koladilip koladilip deleted the fix.converter branch June 18, 2024 03:58
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