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

feat!: migrate to plugin v2 #924

Open
wants to merge 92 commits into
base: main
Choose a base branch
from
Open

Conversation

scolladon
Copy link
Owner

@scolladon scolladon commented Sep 29, 2024

Explain Your Changes


This Pull Request introduces significant updates as part of the migration to sfdx-git-delta v6. The changes align with Salesforce CLI v2 architecture and modern best practices. Below are the key updates:

  • Created a Migration Guide:
    A detailed guide has been written to assist users in migrating to the latest version, outlining key differences and steps for a smooth transition.

  • Upgraded to Salesforce Plugin v2 Architecture:
    Migrated the plugin to the sf plugin v2 architecture, benefiting from a more modular and efficient framework, improved performance, and compatibility with the latest CLI innovations.

  • Updated file and dir Attribute Naming:
    Changed the file and directory parameters to comply with Salesforce CLI naming conventions.
    See Design Guidelines for Flags.

    • Explanation of Changes: The old parameters are now deprecated, with warnings logged upon usage. Aliases have been created for backward compatibility. The deprecation is set for Winter '26.
  • Removed success: true in JSON Output:
    Simplified the JSON response by removing redundant success: true flags. The status attribute now provides sufficient information.

  • Deprecated Obsolete outputError Handling:
    Error output has been reworked to follow updated CLI error-handling patterns, ensuring a cleaner and more consistent experience.

  • Fixed apiVersion Attribute:
    Corrected an issue with the apiVersion parameter for better accuracy in version handling.

  • Refactored JSON Output (--json):
    JSON output has been refactored to merge seamlessly with the new output structure and remove duplication, improving readability and consistency.

  • Switched to Module-Type Export:
    The plugin now exports as an ESM module, removing CommonJS support. This change eliminates esmInteroperability issues and aligns with modern JavaScript module standards.

  • Updated CI Scripts:
    Continuous Integration (CI) scripts have been updated to use the new sf CLI format to ensure smooth automation and testing processes.

  • Updated Contribution Guide:
    The Contributing Guide has been updated to reflect changes to the new structure and tools. New contributors can easily adapt to the latest development workflows and toolbelt.

  • Dropped Backward Compatibility with sfdx/cli:
    There is no backward compatibility with sfdx/cli as it is now deprecated. Users must transition to salesforce/cli.

  • Migrated Back to npm:
    The plugin now uses npm as the default package manager, streamlining dependency management and build processes.


These changes ensure that sfdx-git-delta remains aligned with the latest Salesforce CLI guidelines, offering a more efficient, modern, and user-friendly experience.

Does this close any currently open issues?


closes #619
closes #906
closes #415
closes #924
closes #936

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13469 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13471 lines exceeds the maximum allowed for the inline comments feature.

Copy link

codecov bot commented Sep 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6417121) to head (9ef732b).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #924   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           40        44    +4     
  Lines         1018       990   -28     
  Branches       104       103    -1     
=========================================
- Hits          1018       990   -28     

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

@scolladon
Copy link
Owner Author

Need to wait for this issue kaelzhang/node-ignore#96 to be fixed

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from c984059 to ded5517 Compare October 5, 2024 12:19
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13725 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13743 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from 9a4354a to d3c2976 Compare October 5, 2024 13:55
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13739 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13957 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from 15c63bf to 18924d6 Compare October 6, 2024 11:58
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13959 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from 18924d6 to 1000228 Compare October 6, 2024 12:24
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13966 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from 1000228 to 3782651 Compare October 6, 2024 12:33
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13966 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from 3782651 to 575f0e1 Compare October 6, 2024 12:37
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13966 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from 575f0e1 to ee70dc9 Compare October 6, 2024 13:05
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13966 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 13990 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from e9204c2 to 3339f8d Compare October 6, 2024 16:07
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 14100 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon marked this pull request as ready for review October 6, 2024 16:34
@scolladon scolladon requested a review from mehdicherf as a code owner October 6, 2024 16:34
@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from 3339f8d to ab29eba Compare October 6, 2024 16:42
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 14098 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from ab29eba to d8a31de Compare October 8, 2024 11:45
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 14098 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 30751 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from 87865b5 to 014402f Compare November 4, 2024 20:33
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 100550 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 99967 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 99962 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 99962 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 99962 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 101106 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 101109 lines exceeds the maximum allowed for the inline comments feature.

@scolladon scolladon force-pushed the feat/migrate-to-plugin-v2 branch from 40d0a3b to 6f395a3 Compare December 9, 2024 19:26
Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 101109 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 101529 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 101084 lines exceeds the maximum allowed for the inline comments feature.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

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

The PR diff size of 101084 lines exceeds the maximum allowed for the inline comments feature.

Copy link

codeclimate bot commented Dec 18, 2024

Code Climate has analyzed commit 9ef732b and detected 0 issues on this pull request.

View more on Code Climate.

Copy link

Published under dev-924 npm channel.

$ sf plugins install sfdx-git-delta@dev-924

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant