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

chore(#517): remove deprecated fields by default #690

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

Decipher
Copy link
Member

@Decipher Decipher commented Feb 12, 2024

Types of changes

  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Description

  • Changes the default behaviour for including deprecated entity fields.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly. (PR: #)
  • I have added tests to cover my changes (if not applicable, please state why)
  • All new and existing tests are passing.

Screenshots/Media:

Summary by CodeRabbit

  • Refactor
    • Updated the Druxt module configuration for improved performance and customization. Default settings for entity components fields are now set to false.

Copy link

changeset-bot bot commented Feb 12, 2024

🦋 Changeset detected

Latest commit: 2307e53

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
druxt-entity Minor
druxt-blocks Patch
druxt-site Patch
druxt-views Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

coderabbitai bot commented Feb 12, 2024

Walkthrough

The update simplifies the druxt module configuration for Nuxt.js projects by streamlining the handling of entity components. Specifically, it eliminates the component object within the entity configuration and alters the default behavior of field components to be inactive, requiring explicit activation.

Changes

File(s) Change Summary
.../entity/README.md, .../nuxtModule.js Removed entity.component object; set entity.components.fields default to false.

🐰✨
In the realm of code, where changes abide,
A rabbit hopped through, with strides so wide.
"Away with complexity, let simplicity reign!"
It tweaked and it tuned, with might and main.
Now fields lie dormant, by default, it's true,
A leap towards ease, with a hint of dew.
🌱🚀

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8407fd2 and 2307e53.
Files selected for processing (3)
  • .changeset/strange-bottles-impress.md (1 hunks)
  • packages/entity/README.md (2 hunks)
  • packages/entity/src/nuxtModule.js (1 hunks)
Additional comments: 3
.changeset/strange-bottles-impress.md (1)
  • 1-5: LGTM!
packages/entity/src/nuxtModule.js (1)
  • 41-41: LGTM!
packages/entity/README.md (1)
  • 97-97: LGTM!

Copy link

codecov bot commented Feb 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8407fd2) 96.23% compared to head (2307e53) 96.19%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #690      +/-   ##
===========================================
- Coverage    96.23%   96.19%   -0.05%     
===========================================
  Files           91       91              
  Lines         2367     2367              
  Branches       511      511              
===========================================
- Hits          2278     2277       -1     
- Misses          74       75       +1     
  Partials        15       15              

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

@Decipher Decipher merged commit 8e4d246 into develop Feb 12, 2024
8 of 9 checks passed
@Decipher Decipher deleted the feature/517-deprecated_warnings branch February 12, 2024 23: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.

1 participant