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

Migrate to yarn workspaces #4562

Closed
wants to merge 2 commits into from
Closed

Conversation

mWaldbaur
Copy link

PR Type

Does this PR add a new feature, or fix a bug?

Feature

Why should this PR be included?

It makes development experience better.

Checklist

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Is there an existing issue for this PR?
    • link issue here
  • Have the files been linted and formatted?
  • Have the docs been updated to match the changes in the PR?
  • Have the tests been updated to match the changes in the PR?
  • Have you run the tests locally to confirm they pass?

New Features

This PR makes the examples use yarn instead of NPM.

What new capabilities does this PR add?

What docs changes are needed to explain this?

@codesandbox-ci
Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 0e6c4db:

Sandbox Source
Vanilla Configuration
Vanilla Typescript Configuration

@markerikson
Copy link
Contributor

We don't actually have any subpackages in here that would need workspaces. What are you trying to work on?

@mWaldbaur
Copy link
Author

We don't actually have any subpackages in here that would need workspaces. What are you trying to work on?

Sorry, I should have explained this in the PR description. I turned the examples into workspaces. This allows them to be treated as workspaces, meaning they can use yarn and can be tested easily.

@markerikson
Copy link
Contributor

Honestly, most of those examples are obsolete and need to be rewritten or deleted.

We also don't want to generally install them when you clone the repo and set it up.

What's the background on this effort?

@mWaldbaur
Copy link
Author

Honestly, most of those examples are obsolete and need to be rewritten or deleted.

We also don't want to generally install them when you clone the repo and set it up.

Oh, okay. I was not aware of that.

What's the background on this effort?

I was just looking for an open source project to contribute to 😅, nothing else. I'm still learning React & Redux, and I was checking out your repo and noticed the recent migration to Yarn, and noticed that the existence of package-lock.json the examples dir showed the migration was not completed, so I decided to try to complete it.

@markerikson
Copy link
Contributor

Ah, gotcha.

Yeah, there's an issue from 3 years ago I had filed saying "we really ought to rewrite the examples":

and then not much happened with it.

Honestly, the main things we could use help with atm are docs, across all 3 of our repos:

as well as testing of the beta versions of our libs in various environments as we work towards the upcoming major releases.

@mWaldbaur
Copy link
Author

Okay, I'll try to contribute towards that too, but I think this PR could serve as a good starting point, because it simplifies the way examples are handled (Through the package manager instead of custom scripts), so future improvements can build on top of these cleanups.

If you think this doesn't make sense, I can close this PR 😃 and focus more on other doc improvements in the future.

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.

None yet

2 participants