Skip to content

Add deprecation annotations to ported utils #39

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

Merged
merged 3 commits into from
Jan 4, 2024

Conversation

brandenrodgers
Copy link
Contributor

@brandenrodgers brandenrodgers commented Jan 2, 2024

Description and Context

Adding deprecation annotations to exported utils that the HubSpot CLI is now importing from the new local-dev-lib library. This should help to prevent new changes from being made in this library for exports that aren't being used anymore.

Screenshots

TODO

Who to Notify

Copy link
Contributor

@camden11 camden11 left a comment

Choose a reason for hiding this comment

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

There's a few places where it might be helpful to indicate the new import path. I also noticed there's a few more places where we'll need to add the annotation:

  • git.js
  • sandboxes.js
  • trackUsage within filemapper.js (new import path: @hubspot/local-dev-lib/trackUsage)

@brandenrodgers
Copy link
Contributor Author

@camden11 I added deprecation annotations to the sandboxes and trackUsage exports, but it looks like the CLI is still using the git utils exported from cli-lib.

Copy link
Contributor

@camden11 camden11 left a comment

Choose a reason for hiding this comment

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

@brandenrodgers it's not using the github utils, but confusingly there's a separate file called git.js that it is using. (this has been renamed to gitignore.ts in local dev lib) Approving but just make sure to add that final annotaiton before you merge!

@brandenrodgers brandenrodgers merged commit a29e889 into main Jan 4, 2024
@brandenrodgers brandenrodgers deleted the br-add-deprecation-comments branch January 4, 2024 21:49
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