🚧 UNDER CONSTRUCTION 🚧

This project is still under development. It is not yet ready for general usage. If you have questions or feedback, let us know using GitHub discussions.

Monorepo for Sparo toolkit

Sparo optimizes performance of Git operations for your large frontend monorepo.

Key features

• Familiar interface: The sparo command-line interface (CLI) wrapper offers better defaults and performance suggestions without altering the familiar git syntax. (The native git CLI is also supported.)

• A proven solution: Git provides quite a lot of ingredients for optimizing very large repos; Sparo is your recipe for combining these features intelligently.

• Simplified sparse checkout: Work with sparse checkout profiles instead of confusing "cones" and globs

• Frontend integration: Sparo leverages Rush and PNPM workspace configurations, including the ability to automatically checkout project dependencies

• Dual workflows: The sparo-ci tool implements a specialized checkout model optimized for continuous integration (CI) pipelines

• Extra safeguards: Avoid common Git mistakes such as checkouts with staged files outside the active view

• Go beyond Git hooks: Optionally collect anonymized Git timing metrics in your monorepo, enabling your build team to set data-driven goals for local developer experience (not just CI!)

  (Metrics are transmitted to your own service and are not accessible by any other party.)

For details, consult the Sparo documentation.

Packages

Folder	Description
/apps/sparo	Improve Git performance in your large scale frontend monorepo by integrating sparse checkout with Rush and PNPM

Contributing

Building the projects in this monorepo:

1. Install the RushJS tool:

   npm install -g @microsoft/rush
   

2. Clone the repo:

   git clone https://github.com/tiktok/sparo.git
   

3. Install the dependencies

   cd sparo
   rush install
   

4. Build all projects

   rush build
   

How to invoke your locally build sparo command:

cd apps/sparo
node lib/start.js