tiktok-sparo/apps/website/docs/index.md at eb3eda4e4e692f3862e967db0a5c4d3f2e97ad81

mirror of https://github.com/tiktok/sparo.git synced 2024-12-13 01:01:03 -05:00

Pete Gonzalez 16beb15473 Finally fix the problem where ```shell was not highlighted correctly

2024-03-01 00:58:10 -08:00

title	hide_title	custom_edit_url
Overview	true	null

import { ThemedImage } from '@site/src/components/ThemedImage';

Clone faster!

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

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.)

Try out Sparo in 5 easy steps:

Ensure you are using the latest Git version. For macOS, we recommend to use brew install git. For other operating systems, see the Git documentation for instructions.
Clone your RushJS monorepo:
```
sparo clone https://github.com/my-company/my-monorepo.git
```
👉 For a real world demo, try this repo: https://github.com/Azure/azure-sdk-for-js.git

💡 Support for PNPM and Yarn workspaces is planned but not implemented yet. Contributions welcome!
Define a Sparo profile describing the subset of repository folders for Git sparse checkout. Here is a basic example:

common/sparo-profiles/my-team.json
```
{
  "selections": [
     {
       "selector": "--to",
       "argument": "my-rush-project"
     }
  ]
}
```
The --to project selector instructs Sparo to checkout all dependencies in the workspace that are required to build my-rush-project.

👉 If you're demoing azure-sdk-for-js, replace my-rush-project with @azure/arm-commerce.
Check out your Sparo profile:
```
sparo checkout --profile my-team
```
For everyday work, consider choosing mirrored subcommands such as sparo revert instead of git revert. The Sparo wrapper provides (1) better defaults, (2) suggestions for better performance, and (3) optional anonymized performance metrics.

Examples:
```
sparo pull

sparo commit -m "Example command"
```