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: root mappings #86

Merged
merged 3 commits into from
Jun 13, 2024
Merged

fix: root mappings #86

merged 3 commits into from
Jun 13, 2024

Conversation

koladilip
Copy link
Collaborator

@koladilip koladilip commented Jun 13, 2024

What are the changes introduced in this PR?

currently it is not supported when only root mappings are present

What is the related Linear task?

Resolves INT-2160

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

  • Chores

    • Updated .eslintignore to reflect filename change from vite.config.ts to vite.config.mts.
    • Switched commitlint.config.js to use module.exports.
  • Dependencies

    • Removed "type": "module" from package.json.
    • Updated @commitlint/cli and @commitlint/config-conventional versions.
  • New Features

    • Added new mapping scenarios in test data files, including invalid_root_mapping1.json, invalid_root_mapping2.json, and only_root_mapping.json.
  • Refactor

    • Updated various test scenario files to use mappingsPath instead of templatePath.
    • Modified function in vite.config.mts for dynamic filename generation.
    • Revised Scenario type in tests to replace containsMappings with mappingsPath.
  • Configuration

    • Updated tsconfig.json to target ESNext for language and module code generation.
  • Tests

    • Added processFlatMapping function to iterate and process mapping parts.

@koladilip koladilip requested a review from a team as a code owner June 13, 2024 09:05
Copy link

coderabbitai bot commented Jun 13, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

This update includes several key changes across various files in the project. Major updates involve refactoring configurations, improving scenarios, and making TypeScript project adjustments. Specifically, ESLint configuration was updated, TypeScript syntax in files was adjusted, mappings scenarios were restructured, and key dependencies were upgraded. New test cases were added to ensure mapping functionality, and some project configurations were modernized by setting JavaScript language versions and module code generations to ESNext.

Changes

Files Change Summaries
.eslintignore Renamed vite.config.ts to vite.config.mts.
commitlint.config.js Switched from export default to module.exports.
package.json Removed "type": "module", updated dependencies @commitlint/cli and @commitlint/config-conventional.
src/utils/converter.ts Updated to accept flatMappingASTs array, added processFlatMapping function.
test/scenarios/mappings/data.ts Restructured scenarios with mappingsPath, added new scenarios with description and error fields.
test/scenarios/mappings/invalid...1.json Added new mappings for transforming JSON input keys to output keys.
test/scenarios/mappings/invalid...2.json Added new mappings to transform input paths to output paths with JSON path notation.
test/scenarios/mappings/only_root...json Introduced mapping where both input and output are set to "$".
test/types.ts Updated Scenario type to use mappingsPath instead of containsMappings.
test/utils/scenario.ts Added getDefaultPathType function, updated logic for defaultPathType and evaluateScenario.
tsconfig.json Updated "target" to ESNext, "module" to ESNext.
vite.config.mts Changed fileName property to a function returning 'json-template.js'.

Sequence Diagram(s)

sequenceDiagram
    actor Dev as Developer
    participant Config as Configuration Files
    participant Tests as Test Files
    participant Vite as Vite Config

    Dev->>Config: Update .eslintignore to include vite.config.mts
    Dev->>Config: Change commitlint.config.js to use module.exports
    Dev->>Config: Remove "type": "module" from package.json
    Config->>Tests: Update test types and scenarios
    Dev->>Tests: Add new mapping scenarios
    Dev->>Vite: Update target ESNext and module in tsconfig.json
    Dev->>Vite: Change fileName function in vite.config.mts
Loading

Poem

In the realm of code, changes bloom,
With mapping paths and configs in tune.
Tests arise, new scenarios in place,
Each function dances, a graceful embrace.
TypeScript whispers, "ESNext we greet,"
Commitlint smiles, a more modular beat.
Together they craft, a world so neat.

- 🐇 CodeRabbit.


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

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 100% 4565/4565
🟢 Branches 100% 1227/1227
🟢 Functions 100% 347/347
🟢 Lines 100% 4565/4565

Test suite run success

170 tests passing in 4 suites.

Report generated by 🧪jest coverage report action from 97d95e8

Copy link

Copy link

codecov bot commented Jun 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (63b15d8) to head (97d95e8).
Report is 67 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #86   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           14        14           
  Lines         4549      4565   +16     
  Branches      1076      1082    +6     
=========================================
+ Hits          4549      4565   +16     

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

@koladilip koladilip merged commit cc4893f into main Jun 13, 2024
11 checks passed
@koladilip koladilip deleted the fix.mappings branch June 13, 2024 09:09
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.

1 participant