Why I’m using a monorepo with Yarn workspaces

TL;DR

The author explains setting up Yarn workspaces for organizing a newsletter application into separate packages.

Transcript

so recently I've been taking my newsletter application and I wanted to apply a mono repo approach to this project now now I don't really have a good reason as to why other than I wanted to pull out different packages and have my business logic live in a separate folder and not have it lit directly in my next API and then I went down a path of start... Read More

Key Insights

• 👻 Yarn workspaces streamline the development process by allowing multiple packages to coexist within a single repository, enhancing project management.
• 🧐 The implementation of a mono repo can facilitate better separation of concerns, allowing developers to isolate business logic from UI and API components.
• 🎁 Typescript integration can present hurdles during package imports, and familiarity with the language and tooling is crucial to overcoming these challenges.
• ⌛ Dependency management becomes simpler with Yarn workspaces, ensuring that common libraries and tools are only installed once, optimizing both time and resources.
• 👨‍💻 Modular architecture enables greater flexibility; packages can be reused across different applications, making code maintenance and updates more efficient.
• 👋 Developers can adopt a best practice of defining clear package.json files for each workspace, specifying necessary dependencies for independent builds and tests.
• 👨‍💻 Yarn workspaces not only improve organization but also encourage better software quality through encapsulation, unit testing, and logical structuring of code.

Questions & Answers

Q: What motivated you to adopt a mono repo approach using Yarn workspaces in your project?

I wanted to organize different aspects of my newsletter application more effectively. By creating separate packages for business logic, UI, API, and scripts, I can manage dependencies and maintain a clean structure. This allows for better scalability, easier testing, and potential reuse of packages in future projects without duplicating code.

Q: What challenges did you encounter while importing packages with TypeScript, and how did you resolve them?

Initially, I faced issues with TypeScript imports when trying to use my business logic from other packages. I struggled to ensure types were correctly recognized across the application. Ultimately, I decided to forego some features and revert to a typical REST setup to avoid running into issues that could delay my progress while I became more familiar with Typescript.

Q: Why is it important to have self-contained packages in a Yarn workspace?

Self-contained packages allow each component to manage its own dependencies and configurations independently. This modular structure means that if a package needs to be pulled out for use in another repository or project, it can be done seamlessly without complications. Additionally, it aids in maintaining clearer boundaries between functionalities and promotes reusability.

Q: Can you elaborate on how Yarn workspaces save disk space in large projects?

Yarn workspaces help minimize disk space usage by hoisting shared dependencies to the root level of the project. Rather than each package having its own copy of the same library in individual node_modules directories, Yarn installs shared libraries only once at the root, reducing redundancy and conserving storage, especially in larger projects with overlapping dependencies.

Summary & Key Takeaways

• The content focuses on applying a mono repo approach using Yarn workspaces to organize various packages, including business logic, UI, API, and scripts within a newsletter application project.

• The author describes the challenges faced while importing packages, specifically with Typescript and using different tools, leading to a decision to revert to a simpler REST setup initially.

• Key benefits and practical implementations of Yarn workspaces are discussed, such as efficient dependency management, reduced disk space usage, and maintaining clean separation of business logic and application layers.