@teambit/checkout 1.0.310 → 1.0.312

package/artifacts/__bit_junit.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuites tests="3" failures="0" errors="0" skipped="0">
-  <testsuite name="teambit.component/checkout@1.0.310" tests="3" failures="0" errors="0" skipped="0">
+  <testsuite name="teambit.component/checkout@1.0.312" tests="3" failures="0" errors="0" skipped="0">
     <testcase classname="dist/checkout.spec.js" name="should bring the files back"/>
-    <testcase classname="dist/checkout.spec.js" name="the workspace should get the component as a valid component" time="0.044"/>
+    <testcase classname="dist/checkout.spec.js" name="the workspace should get the component as a valid component" time="0.047"/>
     <testcase classname="dist/checkout.spec.js" name="should checkout according to the number of generations specified" time="0.002"/>
   </testsuite>
 </testsuites>

package/artifacts/schema.json

@@ -247,7 +247,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * if .bitmap entry exists but the rootDir is missing from the filesystem, find the component in the scope and restore it.\n   * returns the restored component ids.\n   */",
-                "comment": "if .bitmap entry exists but the rootDir is missing from the filesystem, find the component in the scope and restore it.\nreturns the restored component ids."
+                "comment": "if .bitmap entry exists but the rootDir is missing from the filesystem, find the component in the scope and restore it.\nreturns the restored component ids.",
+                "tags": []
               },
               "signature": "(method) CheckoutMain.restoreMissingComponents(checkoutProps: CheckoutProps): Promise<ComponentID[] | undefined>",
               "name": "restoreMissingComponents",
@@ -1205,7 +1206,8 @@
               "character": 1
             },
             "raw": "/**\n * relevant only when\n * 1) there is no conflict => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.output.\n * 2) there is conflict and mergeStrategy is manual => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.conflict.\n *\n * this function only updates the files content, it doesn't write the files\n */",
-            "comment": "relevant only when\n1) there is no conflict => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.output.\n2) there is conflict and mergeStrategy is manual => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.conflict.\n\nthis function only updates the files content, it doesn't write the files"
+            "comment": "relevant only when\n1) there is no conflict => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.output.\n2) there is conflict and mergeStrategy is manual => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.conflict.\n\nthis function only updates the files content, it doesn't write the files",
+            "tags": []
           },
           "signature": "function applyModifiedVersion(componentFiles: SourceFile[], mergeResults: MergeResultsThreeWay, mergeStrategy: MergeStrategy | null | undefined): {\n    filesStatus: Record<string, any>;\n    modifiedFiles: SourceFile[];\n}",
           "name": "applyModifiedVersion",
@@ -1417,7 +1419,8 @@
               "character": 1
             },
             "raw": "/**\n * This function optionally returns \"component\" object. If it returns, it means it needs to be written to the filesystem.\n * Otherwise, it means the component is already up to date and no need to write it.\n *\n * If no need to change anything (ours), then don't return the component object.\n * Otherwise, either return the component object as is (if no conflicts or \"theirs\"), or change the files in this\n * component object. Later, this component object is written to the filesystem.\n *\n * 1) when the files are modified with conflicts and the strategy is \"ours\", or forceOurs was used, leave the FS as is.\n *\n * 2) when the files are modified with conflicts and the strategy is \"theirs\", or forceTheirs was used, write the\n * component according to \"component\" object\n *\n * 3) when files are modified with no conflict or files are modified with conflicts and the\n * strategy is manual, load the component according to id.version and update component.files.\n * applyModifiedVersion() docs explains what files are updated/added.\n *\n * Side note:\n * Deleted file => if files are in used version but not in the modified one, no need to delete it. (similar to git).\n * Added file => if files are not in used version but in the modified one, they'll be under mergeResults.addFiles\n */",
-            "comment": "This function optionally returns \"component\" object. If it returns, it means it needs to be written to the filesystem.\nOtherwise, it means the component is already up to date and no need to write it.\n\nIf no need to change anything (ours), then don't return the component object.\nOtherwise, either return the component object as is (if no conflicts or \"theirs\"), or change the files in this\ncomponent object. Later, this component object is written to the filesystem.\n\n1) when the files are modified with conflicts and the strategy is \"ours\", or forceOurs was used, leave the FS as is.\n\n2) when the files are modified with conflicts and the strategy is \"theirs\", or forceTheirs was used, write the\ncomponent according to \"component\" object\n\n3) when files are modified with no conflict or files are modified with conflicts and the\nstrategy is manual, load the component according to id.version and update component.files.\napplyModifiedVersion() docs explains what files are updated/added.\n\nSide note:\nDeleted file => if files are in used version but not in the modified one, no need to delete it. (similar to git).\nAdded file => if files are not in used version but in the modified one, they'll be under mergeResults.addFiles"
+            "comment": "This function optionally returns \"component\" object. If it returns, it means it needs to be written to the filesystem.\nOtherwise, it means the component is already up to date and no need to write it.\n\nIf no need to change anything (ours), then don't return the component object.\nOtherwise, either return the component object as is (if no conflicts or \"theirs\"), or change the files in this\ncomponent object. Later, this component object is written to the filesystem.\n\n1) when the files are modified with conflicts and the strategy is \"ours\", or forceOurs was used, leave the FS as is.\n\n2) when the files are modified with conflicts and the strategy is \"theirs\", or forceTheirs was used, write the\ncomponent according to \"component\" object\n\n3) when files are modified with no conflict or files are modified with conflicts and the\nstrategy is manual, load the component according to id.version and update component.files.\napplyModifiedVersion() docs explains what files are updated/added.\n\nSide note:\nDeleted file => if files are in used version but not in the modified one, no need to delete it. (similar to git).\nAdded file => if files are not in used version but in the modified one, they'll be under mergeResults.addFiles",
+            "tags": []
           },
           "signature": "function applyVersion(consumer: Consumer, id: ComponentID, componentFromFS: ConsumerComponent | null | undefined, mergeResults: MergeResultsThreeWay | null | undefined, checkoutProps: CheckoutProps): Promise<ApplyVersionWithComps>",
           "name": "applyVersion",
@@ -1636,7 +1639,8 @@
               "character": 1
             },
             "raw": "/**\n * when files exist on the filesystem but not on the checked out versions, they need to be deleted.\n * without this function, these files would be left on the filesystem. (we don't delete the comp-dir before writing).\n * this needs to be done *before* the component is written to the filesystem, otherwise, it won't work when a file\n * has a case change. e.g. from uppercase to lowercase. (see merge-lane.e2e 'renaming files from uppercase to lowercase').\n */",
-            "comment": "when files exist on the filesystem but not on the checked out versions, they need to be deleted.\nwithout this function, these files would be left on the filesystem. (we don't delete the comp-dir before writing).\nthis needs to be done *before* the component is written to the filesystem, otherwise, it won't work when a file\nhas a case change. e.g. from uppercase to lowercase. (see merge-lane.e2e 'renaming files from uppercase to lowercase')."
+            "comment": "when files exist on the filesystem but not on the checked out versions, they need to be deleted.\nwithout this function, these files would be left on the filesystem. (we don't delete the comp-dir before writing).\nthis needs to be done *before* the component is written to the filesystem, otherwise, it won't work when a file\nhas a case change. e.g. from uppercase to lowercase. (see merge-lane.e2e 'renaming files from uppercase to lowercase').",
+            "tags": []
           },
           "signature": "function removeFilesIfNeeded(filesStatus: FilesStatus, consumer: Consumer, componentFromFS?: ConsumerComponent): Promise<void>",
           "name": "removeFilesIfNeeded",
@@ -3203,7 +3207,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * if .bitmap entry exists but the rootDir is missing from the filesystem, find the component in the scope and restore it.\n   * returns the restored component ids.\n   */",
-                "comment": "if .bitmap entry exists but the rootDir is missing from the filesystem, find the component in the scope and restore it.\nreturns the restored component ids."
+                "comment": "if .bitmap entry exists but the rootDir is missing from the filesystem, find the component in the scope and restore it.\nreturns the restored component ids.",
+                "tags": []
               },
               "signature": "(method) CheckoutMain.restoreMissingComponents(checkoutProps: CheckoutProps): Promise<ComponentID[] | undefined>",
               "name": "restoreMissingComponents",
@@ -3960,7 +3965,8 @@
               "character": 1
             },
             "raw": "/**\n * This function optionally returns \"component\" object. If it returns, it means it needs to be written to the filesystem.\n * Otherwise, it means the component is already up to date and no need to write it.\n *\n * If no need to change anything (ours), then don't return the component object.\n * Otherwise, either return the component object as is (if no conflicts or \"theirs\"), or change the files in this\n * component object. Later, this component object is written to the filesystem.\n *\n * 1) when the files are modified with conflicts and the strategy is \"ours\", or forceOurs was used, leave the FS as is.\n *\n * 2) when the files are modified with conflicts and the strategy is \"theirs\", or forceTheirs was used, write the\n * component according to \"component\" object\n *\n * 3) when files are modified with no conflict or files are modified with conflicts and the\n * strategy is manual, load the component according to id.version and update component.files.\n * applyModifiedVersion() docs explains what files are updated/added.\n *\n * Side note:\n * Deleted file => if files are in used version but not in the modified one, no need to delete it. (similar to git).\n * Added file => if files are not in used version but in the modified one, they'll be under mergeResults.addFiles\n */",
-            "comment": "This function optionally returns \"component\" object. If it returns, it means it needs to be written to the filesystem.\nOtherwise, it means the component is already up to date and no need to write it.\n\nIf no need to change anything (ours), then don't return the component object.\nOtherwise, either return the component object as is (if no conflicts or \"theirs\"), or change the files in this\ncomponent object. Later, this component object is written to the filesystem.\n\n1) when the files are modified with conflicts and the strategy is \"ours\", or forceOurs was used, leave the FS as is.\n\n2) when the files are modified with conflicts and the strategy is \"theirs\", or forceTheirs was used, write the\ncomponent according to \"component\" object\n\n3) when files are modified with no conflict or files are modified with conflicts and the\nstrategy is manual, load the component according to id.version and update component.files.\napplyModifiedVersion() docs explains what files are updated/added.\n\nSide note:\nDeleted file => if files are in used version but not in the modified one, no need to delete it. (similar to git).\nAdded file => if files are not in used version but in the modified one, they'll be under mergeResults.addFiles"
+            "comment": "This function optionally returns \"component\" object. If it returns, it means it needs to be written to the filesystem.\nOtherwise, it means the component is already up to date and no need to write it.\n\nIf no need to change anything (ours), then don't return the component object.\nOtherwise, either return the component object as is (if no conflicts or \"theirs\"), or change the files in this\ncomponent object. Later, this component object is written to the filesystem.\n\n1) when the files are modified with conflicts and the strategy is \"ours\", or forceOurs was used, leave the FS as is.\n\n2) when the files are modified with conflicts and the strategy is \"theirs\", or forceTheirs was used, write the\ncomponent according to \"component\" object\n\n3) when files are modified with no conflict or files are modified with conflicts and the\nstrategy is manual, load the component according to id.version and update component.files.\napplyModifiedVersion() docs explains what files are updated/added.\n\nSide note:\nDeleted file => if files are in used version but not in the modified one, no need to delete it. (similar to git).\nAdded file => if files are not in used version but in the modified one, they'll be under mergeResults.addFiles",
+            "tags": []
           },
           "signature": "function applyVersion(consumer: Consumer, id: ComponentID, componentFromFS: ConsumerComponent | null | undefined, mergeResults: MergeResultsThreeWay | null | undefined, checkoutProps: CheckoutProps): Promise<ApplyVersionWithComps>",
           "name": "applyVersion",
@@ -4268,7 +4274,8 @@
               "character": 1
             },
             "raw": "/**\n * when files exist on the filesystem but not on the checked out versions, they need to be deleted.\n * without this function, these files would be left on the filesystem. (we don't delete the comp-dir before writing).\n * this needs to be done *before* the component is written to the filesystem, otherwise, it won't work when a file\n * has a case change. e.g. from uppercase to lowercase. (see merge-lane.e2e 'renaming files from uppercase to lowercase').\n */",
-            "comment": "when files exist on the filesystem but not on the checked out versions, they need to be deleted.\nwithout this function, these files would be left on the filesystem. (we don't delete the comp-dir before writing).\nthis needs to be done *before* the component is written to the filesystem, otherwise, it won't work when a file\nhas a case change. e.g. from uppercase to lowercase. (see merge-lane.e2e 'renaming files from uppercase to lowercase')."
+            "comment": "when files exist on the filesystem but not on the checked out versions, they need to be deleted.\nwithout this function, these files would be left on the filesystem. (we don't delete the comp-dir before writing).\nthis needs to be done *before* the component is written to the filesystem, otherwise, it won't work when a file\nhas a case change. e.g. from uppercase to lowercase. (see merge-lane.e2e 'renaming files from uppercase to lowercase').",
+            "tags": []
           },
           "signature": "function removeFilesIfNeeded(filesStatus: FilesStatus, consumer: Consumer, componentFromFS?: ConsumerComponent): Promise<void>",
           "name": "removeFilesIfNeeded",
@@ -4369,7 +4376,8 @@
               "character": 1
             },
             "raw": "/**\n * relevant only when\n * 1) there is no conflict => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.output.\n * 2) there is conflict and mergeStrategy is manual => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.conflict.\n *\n * this function only updates the files content, it doesn't write the files\n */",
-            "comment": "relevant only when\n1) there is no conflict => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.output.\n2) there is conflict and mergeStrategy is manual => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.conflict.\n\nthis function only updates the files content, it doesn't write the files"
+            "comment": "relevant only when\n1) there is no conflict => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.output.\n2) there is conflict and mergeStrategy is manual => add files from mergeResults: addFiles, overrideFiles and modifiedFiles.conflict.\n\nthis function only updates the files content, it doesn't write the files",
+            "tags": []
           },
           "signature": "function applyModifiedVersion(componentFiles: SourceFile[], mergeResults: MergeResultsThreeWay, mergeStrategy: MergeStrategy | null | undefined): {\n    filesStatus: Record<string, any>;\n    modifiedFiles: SourceFile[];\n}",
           "name": "applyModifiedVersion",
@@ -5377,7 +5385,7 @@
                   "_legacy": {
                     "scope": "teambit.component",
                     "name": "checkout",
-                    "version": "1.0.310"
+                    "version": "1.0.312"
                   },
                   "_scope": "teambit.component"
                 }
@@ -5480,7 +5488,7 @@
   "componentId": {
     "scope": "teambit.component",
     "name": "checkout",
-    "version": "1.0.310"
+    "version": "1.0.312"
   },
   "taggedModuleExports": []
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/checkout",
-  "version": "1.0.310",
+  "version": "1.0.312",
   "homepage": "https://bit.cloud/teambit/component/checkout",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.component",
     "name": "checkout",
-    "version": "1.0.310"
+    "version": "1.0.312"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -15,13 +15,13 @@
     "@teambit/bit-error": "0.0.404",
     "@teambit/component-id": "1.2.0",
     "@teambit/harmony": "0.4.6",
-    "@teambit/cli": "0.0.887",
-    "@teambit/merging": "1.0.310",
-    "@teambit/component-writer": "1.0.310",
-    "@teambit/importer": "1.0.310",
-    "@teambit/logger": "0.0.980",
-    "@teambit/remove": "1.0.310",
-    "@teambit/workspace": "1.0.310"
+    "@teambit/cli": "0.0.889",
+    "@teambit/merging": "1.0.312",
+    "@teambit/component-writer": "1.0.312",
+    "@teambit/importer": "1.0.312",
+    "@teambit/logger": "0.0.982",
+    "@teambit/remove": "1.0.312",
+    "@teambit/workspace": "1.0.312"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -35,8 +35,8 @@
     "@teambit/harmony.envs.core-aspect-env": "0.0.39",
     "@teambit/component.testing.mock-components": "0.0.205",
     "@teambit/harmony.testing.load-aspect": "0.0.200",
-    "@teambit/lister": "1.0.310",
-    "@teambit/snapping": "1.0.310",
+    "@teambit/lister": "1.0.312",
+    "@teambit/snapping": "1.0.312",
     "@teambit/workspace.testing.mock-workspace": "0.0.27"
   },
   "peerDependencies": {