7cc5c4f330d47060/tiktok-sparo
1
0
Fork 0
mirror of https://github.com/tiktok/sparo.git synced 2024-11-14 19:35:12 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
Sparo optimizes performance of Git operations for your large frontend monorepo.
137 commits 10 branches 48 tags 4.4 MiB
TypeScript 54.7%
JSON-with-Comments 33.1%
JavaScript 11%
Shell 0.9%
CSS 0.3%
Find a file
Cheng Liu 7d6ac10308
Merge pull request #32 from tiktok/feat-improve-checkout-error-log 
feat: improve error logs when running rush list failed
2024-03-01 11:59:39 -08:00
.github chore: add version bump 2024-02-23 20:05:45 -08:00
.vscode Initial commit of files being released as open source 2024-02-20 21:42:28 -08:00
apps Merge pull request #32 from tiktok/feat-improve-checkout-error-log 2024-03-01 11:59:39 -08:00
common Merge pull request #32 from tiktok/feat-improve-checkout-error-log 2024-03-01 11:59:39 -08:00
.gitattributes Initial commit of files being released as open source 2024-02-20 21:42:28 -08:00
.gitignore Add Docusaurus patterns to .gitignore 2024-02-21 22:52:59 -08:00
.prettierignore Initial commit of files being released as open source 2024-02-20 21:42:28 -08:00
.prettierrc.js Initial commit of files being released as open source 2024-02-20 21:42:28 -08:00
cspell.config.yaml Initial commit of files being released as open source 2024-02-20 21:42:28 -08:00
LICENSE Initial commit of files being released as open source 2024-02-20 21:42:28 -08:00
README.md Regenerate README.md 2024-02-21 22:28:44 -08:00
rush.json Add project to rush.json and upgrade to Node.js 18 (required for Docusaurus) 2024-02-21 22:28:27 -08:00

README.md

Sparo

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

Published Packages

Folder Version Changelog Package
/apps/sparo npm version changelog sparo
/apps/sparo-lib npm version sparo-lib

Unpublished Local Projects

Folder Description
/apps/website The Sparo documentation website

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