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

Runnable new-and-enhanced JS samples directory for v3 #438

Merged
merged 12 commits into from
Feb 3, 2023

Conversation

hossam-nasr
Copy link
Contributor

@hossam-nasr hossam-nasr commented Jan 26, 2023

This PR tackles a few issues, mainly resolves #421, but it also addresses #357, #356, and partially #276. Also provides good scaffolding for #394. This PR migrates the old samples and adds a new, runnable, new programming model v3-compatible samples-js directory. This PR is only for the JS samples, but I will create another one for another, separate TS directory. I also will delete the existing samples directory in a separate PR. In addition, this PR:

  • Renames functions to be simpler and more node idiomatic
  • Updates/replaces outdated/maintenance/deprecated packages used in the samples, such as moment (replaced with luxon), request (replaced with axios), and the deprecated wunderground weather API (replaced with OpenWeatherMap API), and maybe others
  • Leverages the ability to have multiple functions in the sample file to group related samples together

I tested all the samples manually and verified that they all work, with some notable exceptions:

Ofc, any design/organization/naming choices made here are subject to discussion :)

Copy link
Collaborator

@davidmrdavid davidmrdavid left a comment

Choose a reason for hiding this comment

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

Leaving some preliminary comments. Thank you for this PR

Copy link
Contributor

@ejizba ejizba left a comment

Choose a reason for hiding this comment

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

Approving the overall structure of this PR. I skimmed the code, but don't feel the samples directory is worth a detailed review from me personally. As mentioned offline, my favorite thing about this PR is that it got you to test a lot of scenarios 🙂 Good work!

Copy link
Collaborator

@davidmrdavid davidmrdavid left a comment

Choose a reason for hiding this comment

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

LGTM, although it seems you have some merge conflicts to resolve. Still, the contents of this PR seem good to me.

@hossam-nasr hossam-nasr enabled auto-merge (squash) February 3, 2023 18:10
@hossam-nasr hossam-nasr merged commit 9acd800 into v3.x Feb 3, 2023
@hossam-nasr hossam-nasr deleted the hossamnasr/samples branch February 3, 2023 18:14
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.

3 participants