Skip to content

Add a monorepo template? #122

@natemoo-re

Description

@natemoo-re

Current Behavior

Currently, users can scaffold out a monorepo manually, then add tsdx as a dependency at the root of the project.

Desired Behavior

Users should be able to scaffold out a monorepo project using npx tsdx create. Just like the current templates, users could pass a flag or select from the interactive prompt.

Suggested Solution

Create two new templates, monorepo-basic and monorepo-react. In both cases, the only additional dependency would be lerna. The root package.json scripts would use lerna run command and any packages would use tsdx command.

  1. Add these options directly to the create template prompt and add CLI flags for each.

  2. Add an additional prompt to the create command which allows you to select a project structure (basic or monorepo?) and add a —monorepo CLI flag which will automatically resolve the monorepo templates.

Who does this impact? Who is this for?

This feature would be very beneficial for anyone managing a larger project who wishes to leverage both tsdx and lerna.

Describe alternatives you've considered

If this use case seems out of scope, improving the documentation around integrating with lerna would be helpful to guide users through manual setup.

As a possible alternative, tsdx could become monorepo-aware so that running npx tsdx create mylib from within a monorepo could scaffold out a new package in the packages/ (or configured in lerna.json) directory.

Additional context

I have created a minimal tsdx-monorepo example project.

I would be happy to contribute to this feature, but I want to collect feedback and hash out the preferred approach before starting.

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind: featureNew feature or requestscope: templatesRelated to an init template, not necessarily to core (but could influence core)topic: monorepoRelated to Lerna monorepos

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions