@teambit/harmony.content.cli-reference 2.0.193 → 2.0.195

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.78'
2
+ description: 'Bit command synopses. Bit version: 1.6.80'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -75,7 +75,7 @@
75
75
  ]
76
76
  ],
77
77
  "description": "create or reinitialize an empty workspace",
78
- "extendedDescription": "https://bit.dev/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project",
78
+ "extendedDescription": "if the current directory is already a workspace, it validates that bit files are correct and rewrite them if needed.",
79
79
  "group": "start",
80
80
  "private": false,
81
81
  "skipWorkspace": true
@@ -2993,7 +2993,7 @@
2993
2993
  ]
2994
2994
  ],
2995
2995
  "description": "snap components from a bare-scope",
2996
- "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\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[]; // dependencies component-ids to update their versions, e.g. [teambit.compilation/compiler@1.0.0, teambit.defender/tester@1.0.0]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n removeDependencies?: string[]; // component-id (for components) or package-name (for packages) to remove from the dependencies.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
2996
+ "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\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[]; // dependencies include versions. for components use component-id. e.g. [teambit.compilation/compiler@1.0.0, lodash@4.17.21]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n removeDependencies?: string[]; // component-id (for components) or package-name (for packages) to remove from the dependencies.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
2997
2997
  "group": "ungrouped",
2998
2998
  "private": true
2999
2999
  },
package/cli-reference.mdx CHANGED
@@ -930,7 +930,7 @@ bit export => export all staged snaps/tags of components to their remote scope.
930
930
  ## init
931
931
 
932
932
  **Description**: create or reinitialize an empty workspace
933
- https://bit.dev/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project
933
+ if the current directory is already a workspace, it validates that bit files are correct and rewrite them if needed.
934
934
 
935
935
  `bit init [path]`
936
936
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.78'
2
+ description: 'Bit command synopses. Bit version: 1.6.80'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -75,7 +75,7 @@
75
75
  ]
76
76
  ],
77
77
  "description": "create or reinitialize an empty workspace",
78
- "extendedDescription": "https://bit.dev/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project",
78
+ "extendedDescription": "if the current directory is already a workspace, it validates that bit files are correct and rewrite them if needed.",
79
79
  "group": "start",
80
80
  "private": false,
81
81
  "skipWorkspace": true
@@ -2993,7 +2993,7 @@
2993
2993
  ]
2994
2994
  ],
2995
2995
  "description": "snap components from a bare-scope",
2996
- "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\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[]; // dependencies component-ids to update their versions, e.g. [teambit.compilation/compiler@1.0.0, teambit.defender/tester@1.0.0]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n removeDependencies?: string[]; // component-id (for components) or package-name (for packages) to remove from the dependencies.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
2996
+ "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\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[]; // dependencies include versions. for components use component-id. e.g. [teambit.compilation/compiler@1.0.0, lodash@4.17.21]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n removeDependencies?: string[]; // component-id (for components) or package-name (for packages) to remove from the dependencies.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
2997
2997
  "group": "ungrouped",
2998
2998
  "private": true
2999
2999
  },
@@ -4583,10 +4583,7 @@ function MDXContent(_ref) {
4583
4583
  parentName: "p"
4584
4584
  }, "Description"), ": create or reinitialize an empty workspace", (0, _react2.mdx)("br", {
4585
4585
  parentName: "p"
4586
- }), "\n", (0, _react2.mdx)("a", {
4587
- parentName: "p",
4588
- "href": "https://bit.dev/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project"
4589
- }, "https://bit.dev/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4586
+ }), "\n", "if the current directory is already a workspace, it validates that bit files are correct and rewrite them if needed."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4590
4587
  parentName: "p"
4591
4588
  }, "bit init [path]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4592
4589
  parentName: "table"