@teambit/harmony.content.cli-reference 1.95.83 → 1.95.85

package/cli-reference.json

@@ -436,7 +436,7 @@
       ]
     ],
     "description": "Add any subset of files to be tracked as a component(s).",
-    "extendedDescription": "all flags support glob patterns and {PARENT} {FILE_NAME} annotations\n  https://bit.dev/docs/components/adding-components",
+    "extendedDescription": "Learn the recommended workflow for tracking directories as components, in the link below.",
     "group": "development",
     "private": false
   },
@@ -1215,13 +1215,13 @@
       ]
     ],
     "description": "switch between component versions or remove local changes",
-    "extendedDescription": "\n  `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n  `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n  `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
+    "extendedDescription": "\n  `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n  `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n  `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n  `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
     "group": "development",
     "private": false,
     "arguments": [
       {
         "name": "to",
-        "description": "permitted values: [head, reset, specific-version]. 'head' - last snap/tag. 'reset' - removes local changes"
+        "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
       },
       {
         "name": "component-pattern",
@@ -2138,7 +2138,7 @@
     ]
   },
   {
-    "name": "_tag <component-id...>",
+    "name": "_tag <data>",
     "alias": "",
     "options": [
       [
@@ -2215,15 +2215,10 @@
         "I",
         "ignore-newest-version",
         "ignore existing of newer versions (default = false)"
-      ],
-      [
-        "b",
-        "build",
-        "EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag"
       ]
     ],
     "description": "create an immutable and exportable component snapshot, tagged with a release version.",
-    "extendedDescription": "you can specify a version per id using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major",
+    "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the tag.\nthe input data is a stringified JSON of an array of the following object.\n{\n  componentId: string;    // ids always have scope, so it's safe to parse them from string\n  dependencies: string[]; // e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n  versionToTag?: string;  // specific version (e.g. '1.0.0') or semver (e.g. 'minor', 'patch')\n  prereleaseId?: string;  // applicable when versionToTag is a pre-release. (e.g. \"dev\", for 1.0.0-dev.1)\n  message?: string;       // tag-message.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
     "group": "development",
     "private": true,
     "remoteOp": true
@@ -3384,7 +3379,7 @@
       ]
     ],
     "description": "clears Bit's cache from current working machine",
-    "extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash\nhttps://bit.dev/docs/workspace/clearing-cache",
+    "extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash",
     "group": "general",
     "private": false,
     "skipWorkspace": true

package/cli-reference.mdx

@@ -7,8 +7,7 @@ Commands that are marked as workspace only must be executed inside a workspace.
 **Alias**: `a`  
 **Workspace only**: yes  
 **Description**: Add any subset of files to be tracked as a component(s).  
-all flags support glob patterns and {PARENT} {FILE_NAME} annotations  
- https://bit.dev/docs/components/adding-components
+Learn the recommended workflow for tracking directories as components, in the link below.
 
 `bit add [path...]`
 
@@ -221,6 +220,7 @@ with no args, only workspace's capsules are deleted
 
 `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version  
  `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all  
+ `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all  
  `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
 
 `bit checkout <to> [component-pattern]`
@@ -249,8 +249,7 @@ The following gets removed by this command:
 
 1. V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)
 2. components cache on the filesystem (mainly the dependencies graph and docs)
-3. scope's index file, which maps the component-id:object-hash  
-   https://bit.dev/docs/workspace/clearing-cache
+3. scope's index file, which maps the component-id:object-hash
 
 `bit clear-cache`
 

package/dist/cli-reference.json

@@ -436,7 +436,7 @@
             ]
         ],
         "description": "Add any subset of files to be tracked as a component(s).",
-        "extendedDescription": "all flags support glob patterns and {PARENT} {FILE_NAME} annotations\n  https://bit.dev/docs/components/adding-components",
+        "extendedDescription": "Learn the recommended workflow for tracking directories as components, in the link below.",
         "group": "development",
         "private": false
     },
@@ -1215,13 +1215,13 @@
             ]
         ],
         "description": "switch between component versions or remove local changes",
-        "extendedDescription": "\n  `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n  `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n  `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
+        "extendedDescription": "\n  `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n  `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n  `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n  `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
         "group": "development",
         "private": false,
         "arguments": [
             {
                 "name": "to",
-                "description": "permitted values: [head, reset, specific-version]. 'head' - last snap/tag. 'reset' - removes local changes"
+                "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
             },
             {
                 "name": "component-pattern",
@@ -2138,7 +2138,7 @@
         ]
     },
     {
-        "name": "_tag <component-id...>",
+        "name": "_tag <data>",
         "alias": "",
         "options": [
             [
@@ -2215,15 +2215,10 @@
                 "I",
                 "ignore-newest-version",
                 "ignore existing of newer versions (default = false)"
-            ],
-            [
-                "b",
-                "build",
-                "EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag"
             ]
         ],
         "description": "create an immutable and exportable component snapshot, tagged with a release version.",
-        "extendedDescription": "you can specify a version per id using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major",
+        "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the tag.\nthe input data is a stringified JSON of an array of the following object.\n{\n  componentId: string;    // ids always have scope, so it's safe to parse them from string\n  dependencies: string[]; // e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n  versionToTag?: string;  // specific version (e.g. '1.0.0') or semver (e.g. 'minor', 'patch')\n  prereleaseId?: string;  // applicable when versionToTag is a pre-release. (e.g. \"dev\", for 1.0.0-dev.1)\n  message?: string;       // tag-message.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
         "group": "development",
         "private": true,
         "remoteOp": true
@@ -3384,7 +3379,7 @@
             ]
         ],
         "description": "clears Bit's cache from current working machine",
-        "extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash\nhttps://bit.dev/docs/workspace/clearing-cache",
+        "extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash",
         "group": "general",
         "private": false,
         "skipWorkspace": true

package/dist/cli-reference.mdx.js

@@ -4,31 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = MDXContent;
-
 var _react = _interopRequireDefault(require("react"));
-
 var _react2 = require("@mdx-js/react");
-
 var _excluded = ["components"];
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
-
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
-
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-
 /* @jsxRuntime classic */
-
 /* @jsx mdx */
+
 var layoutProps = {};
 var MDXLayout = "wrapper";
-
 function MDXContent(_ref) {
   var components = _ref.components,
-      props = _objectWithoutProperties(_ref, _excluded);
-
+    props = _objectWithoutProperties(_ref, _excluded);
   return (0, _react2.mdx)(MDXLayout, _extends({}, layoutProps, props, {
     components: components,
     mdxType: "MDXLayout"
@@ -46,12 +36,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Description"), ": Add any subset of files to be tracked as a component(s).", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "all flags support glob patterns and {PARENT} {FILE_NAME} annotations", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "", (0, _react2.mdx)("a", {
-    parentName: "p",
-    "href": "https://bit.dev/docs/components/adding-components"
-  }, "https://bit.dev/docs/components/adding-components")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }), "\n", "Learn the recommended workflow for tracking directories as components, in the link below."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit add [path...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
@@ -1034,6 +1019,10 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", "", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
+  }, "bit checkout latest [component-pattern]"), " => checkout to the latest satisfying semver tag, omit ", "[component-pattern]", " to checkout latest for all", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", "", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
   }, "bit checkout reset [component-pattern]"), " => remove local modifications from the specified ids (or all components when --all is used)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit checkout <to> [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
@@ -1221,12 +1210,7 @@ function MDXContent(_ref) {
     parentName: "ol"
   }, "components cache on the filesystem (mainly the dependencies graph and docs)"), (0, _react2.mdx)("li", {
     parentName: "ol"
-  }, "scope's index file, which maps the component-id:object-hash", (0, _react2.mdx)("br", {
-    parentName: "li"
-  }), (0, _react2.mdx)("a", {
-    parentName: "li",
-    "href": "https://bit.dev/docs/workspace/clearing-cache"
-  }, "https://bit.dev/docs/workspace/clearing-cache"))), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "scope's index file, which maps the component-id:object-hash")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit clear-cache")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
@@ -5969,7 +5953,6 @@ function MDXContent(_ref) {
     "align": null
   }, "json format")))), (0, _react2.mdx)("hr", null));
 }
-
 ;
 MDXContent.isMDXComponent = true;