Merge pull request #42 from collective/add-noDepth-shallow-clone-option

Added an option per repo to allow to shallow clone it with no deep

Author: sneridagh

README.md

@@ -170,6 +170,7 @@ Properties:
 - `tag`: Optional. Tag name.
 - `develop`: Optional. Boolean, can be toggled on/off to activate/deactivate a package. If activated, then deactivated afterwards, the package gets removed from `jsconfig` maintaining the synchronization with `mrs.developer.json`. Default is `true`.
 - `output`: Optional. Output directory override per repository.
+- `filterBlobs`: Optional. Used together with `tag` or `branch`, it creates a partial clone defaulting to the tag or branch specified. This partial clone won't clone the whole repository, but only the tag or branch specified.
 
 ## Usage with (non-TypeScript) React
 

src/index.js

@@ -40,10 +40,15 @@ function getDefaultBranch(repository) {
     .then((result) => result.replace('origin/', ''));
 }
 
-function cloneRepository(name, path, url, fetchUrl) {
+function cloneRepository(name, path, url, fetchUrl, options = {}) {
   console.log(`Cloning ${name} from ${fetchUrl || url}...`);
+  const { filterBlobs, tag, branch } = options;
+  const cloneOptions =
+    filterBlobs && (tag || branch)
+      ? ['-b', tag || branch, '--filter=blob:none']
+      : undefined;
   return gitP()
-    .clone(getRemotePath(fetchUrl || url), path)
+    .clone(getRemotePath(fetchUrl || url), path, cloneOptions)
     .then(() => {
       if (fetchUrl) {
         return gitP(path).remote([
@@ -215,7 +220,7 @@ function checkoutRepository(name, root, settings, options) {
     fetchUrl = settings.https;
   }
   const promise = !fs.existsSync(pathToRepo)
-    ? cloneRepository(name, pathToRepo, url, fetchUrl)
+    ? cloneRepository(name, pathToRepo, url, fetchUrl, settings)
     : openRepository(name, pathToRepo);
   return promise.then((git) => {
     if (git) {

test/cloneRepositoryTest.js

@@ -21,6 +21,14 @@ describe('cloneRepository', () => {
     expect(exists).to.be.true;
   });
 
+  it('puts the repository in ./src/develop with a partial (noDeep) clone', async () => {
+    const repo = await developer
+      .cloneRepository('repo1', './test/src/develop/repo1', './test/fake-remote/repo1', null, { filterBlobs: true, tag: '1.0.0' });
+
+    const branches = await repo.branchLocal();
+    expect(branches.all[0]).to.be.equals('(no');
+  });
+
   it('gets the repository remotes', async () => {
     const repo = await developer.cloneRepository('repo1', './test/src/develop/repo1', './test/fake-remote/repo1');
     const remotes = await repo.getRemotes();