@teambit/harmony.content.cli-reference 2.0.896 → 2.0.898

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,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.13.31'
2
+ description: 'Bit command synopses. Bit version: 1.13.33'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -2162,8 +2162,8 @@
2162
2162
  ],
2163
2163
  [
2164
2164
  "",
2165
- "write-deps <workspace.jsonc|package.json>",
2166
- "write all workspace component dependencies to package.json or workspace.jsonc, resolving conflicts by picking the ranges that match the highest versions"
2165
+ "write-deps <target>",
2166
+ "write all workspace component dependencies to the specified target (\"package.json\" or \"workspace.jsonc\"), resolving conflicts by picking the ranges that match the highest versions"
2167
2167
  ],
2168
2168
  [
2169
2169
  "",
package/cli-reference.mdx CHANGED
@@ -1093,32 +1093,32 @@ without arguments, fetches all workspace components' latest versions from their
1093
1093
  | ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1094
1094
  | `component-patterns...` | component IDs or component patterns (separated by space). Use patterns to import groups of components using a common scope or namespace. E.g., "utils/\*" (wrap with double quotes) |
1095
1095
 
1096
- | **Option** | **Option alias** | **Description** |
1097
- | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
1098
- | `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
1099
- | `--objects` | `-o` | import components objects to the local scope without checkout (without writing them to the file system). This is the default behavior for import with no id argument |
1100
- | `--override` | `-O` | override local changes |
1101
- | `--verbose` | `-v` | show verbose output for inspection |
1102
- | `--json` | `-j` | return the output as JSON |
1103
- | `--skip-dependency-installation` | `-x` | do not auto-install dependencies of the imported components |
1104
- | `--skip-write-config-files` | | do not write config files (such as eslint, tsconfig, prettier, etc...) |
1105
- | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
1106
- | `--dependencies` | | import all dependencies (bit components only) of imported components and write them to the workspace |
1107
- | `--dependencies-head` | | same as --dependencies, except it imports the dependencies with their head version |
1108
- | `--dependents` | | import components found while traversing from the imported components upwards to the workspace components |
1109
- | `--dependents-via <string>` | | same as --dependents except the traversal must go through the specified component. to specify multiple components, wrap with quotes and separate by a comma |
1110
- | `--dependents-all` | | same as --dependents except not prompting for selecting paths but rather selecting all paths and showing final confirmation before importing |
1111
- | `--dependents-dry-run` | | DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and wait for confirmation before importing them |
1112
- | `--silent` | | no prompt for --dependents/--dependents-via flags |
1113
- | `--filter-envs <envs>` | | only import components that have the specified environment (e.g., "teambit.react/react-env") |
1114
- | `--save-in-lane` | | when checked out to a lane and the component is not on the remote-lane, save it in the lane (defaults to save on main) |
1115
- | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
1116
- | `--fetch-deps` | | fetch dependencies (bit components) objects to the local scope, but dont add to the workspace. Useful to resolve errors about missing dependency data |
1117
- | `--write-deps <workspace.jsonc | package.json>` | | write all workspace component dependencies to package.json or workspace.jsonc, resolving conflicts by picking the ranges that match the highest versions |
1118
- | `--track-only` | | do not write any component files, just create .bitmap entries of the imported components. Useful when the files already exist and just want to re-add the component to the bitmap |
1119
- | `--include-deprecated` | | when importing with patterns, include deprecated components (default to exclude them) |
1120
- | `--lane-only` | | when using wildcards on a lane, only import components that exist on the lane (never from main) |
1121
- | `--owner` | | treat the argument as an owner name and import all components from all scopes of that owner |
1096
+ | **Option** | **Option alias** | **Description** |
1097
+ | -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1098
+ | `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
1099
+ | `--objects` | `-o` | import components objects to the local scope without checkout (without writing them to the file system). This is the default behavior for import with no id argument |
1100
+ | `--override` | `-O` | override local changes |
1101
+ | `--verbose` | `-v` | show verbose output for inspection |
1102
+ | `--json` | `-j` | return the output as JSON |
1103
+ | `--skip-dependency-installation` | `-x` | do not auto-install dependencies of the imported components |
1104
+ | `--skip-write-config-files` | | do not write config files (such as eslint, tsconfig, prettier, etc...) |
1105
+ | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
1106
+ | `--dependencies` | | import all dependencies (bit components only) of imported components and write them to the workspace |
1107
+ | `--dependencies-head` | | same as --dependencies, except it imports the dependencies with their head version |
1108
+ | `--dependents` | | import components found while traversing from the imported components upwards to the workspace components |
1109
+ | `--dependents-via <string>` | | same as --dependents except the traversal must go through the specified component. to specify multiple components, wrap with quotes and separate by a comma |
1110
+ | `--dependents-all` | | same as --dependents except not prompting for selecting paths but rather selecting all paths and showing final confirmation before importing |
1111
+ | `--dependents-dry-run` | | DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and wait for confirmation before importing them |
1112
+ | `--silent` | | no prompt for --dependents/--dependents-via flags |
1113
+ | `--filter-envs <envs>` | | only import components that have the specified environment (e.g., "teambit.react/react-env") |
1114
+ | `--save-in-lane` | | when checked out to a lane and the component is not on the remote-lane, save it in the lane (defaults to save on main) |
1115
+ | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
1116
+ | `--fetch-deps` | | fetch dependencies (bit components) objects to the local scope, but dont add to the workspace. Useful to resolve errors about missing dependency data |
1117
+ | `--write-deps <target>` | | write all workspace component dependencies to the specified target ("package.json" or "workspace.jsonc"), resolving conflicts by picking the ranges that match the highest versions |
1118
+ | `--track-only` | | do not write any component files, just create .bitmap entries of the imported components. Useful when the files already exist and just want to re-add the component to the bitmap |
1119
+ | `--include-deprecated` | | when importing with patterns, include deprecated components (default to exclude them) |
1120
+ | `--lane-only` | | when using wildcards on a lane, only import components that exist on the lane (never from main) |
1121
+ | `--owner` | | treat the argument as an owner name and import all components from all scopes of that owner |
1122
1122
 
1123
1123
  ---
1124
1124
 
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.13.31'
2
+ description: 'Bit command synopses. Bit version: 1.13.33'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -2162,8 +2162,8 @@
2162
2162
  ],
2163
2163
  [
2164
2164
  "",
2165
- "write-deps <workspace.jsonc|package.json>",
2166
- "write all workspace component dependencies to package.json or workspace.jsonc, resolving conflicts by picking the ranges that match the highest versions"
2165
+ "write-deps <target>",
2166
+ "write all workspace component dependencies to the specified target (\"package.json\" or \"workspace.jsonc\"), resolving conflicts by picking the ranges that match the highest versions"
2167
2167
  ],
2168
2168
  [
2169
2169
  "",
@@ -2259,69 +2259,69 @@ function _createMdxContent(props) {
2259
2259
  children: "Option alias"
2260
2260
  }), " | ", (0, _jsxRuntime.jsx)(_components.strong, {
2261
2261
  children: "Description"
2262
- }), " |\n| -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2262
+ }), " |\n| -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2263
2263
  children: "--path <path>"
2264
2264
  }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
2265
2265
  children: "-p"
2266
- }), " | import components into a specific directory (a relative path in the workspace) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2266
+ }), " | import components into a specific directory (a relative path in the workspace) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2267
2267
  children: "--objects"
2268
2268
  }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
2269
2269
  children: "-o"
2270
- }), " | import components objects to the local scope without checkout (without writing them to the file system). This is the default behavior for import with no id argument |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2270
+ }), " | import components objects to the local scope without checkout (without writing them to the file system). This is the default behavior for import with no id argument |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2271
2271
  children: "--override"
2272
2272
  }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
2273
2273
  children: "-O"
2274
- }), " | override local changes |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2274
+ }), " | override local changes |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2275
2275
  children: "--verbose"
2276
2276
  }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
2277
2277
  children: "-v"
2278
- }), " | show verbose output for inspection |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2278
+ }), " | show verbose output for inspection |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2279
2279
  children: "--json"
2280
2280
  }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
2281
2281
  children: "-j"
2282
- }), " | return the output as JSON |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2282
+ }), " | return the output as JSON |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2283
2283
  children: "--skip-dependency-installation"
2284
2284
  }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
2285
2285
  children: "-x"
2286
- }), " | do not auto-install dependencies of the imported components |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2286
+ }), " | do not auto-install dependencies of the imported components |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2287
2287
  children: "--skip-write-config-files"
2288
- }), " | | do not write config files (such as eslint, tsconfig, prettier, etc...) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2288
+ }), " | | do not write config files (such as eslint, tsconfig, prettier, etc...) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2289
2289
  children: "--merge [strategy]"
2290
2290
  }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
2291
2291
  children: "-m"
2292
- }), " | merge local changes with the imported version. strategy should be \"theirs\", \"ours\" or \"manual\" |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2292
+ }), " | merge local changes with the imported version. strategy should be \"theirs\", \"ours\" or \"manual\" |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2293
2293
  children: "--dependencies"
2294
- }), " | | import all dependencies (bit components only) of imported components and write them to the workspace |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2294
+ }), " | | import all dependencies (bit components only) of imported components and write them to the workspace |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2295
2295
  children: "--dependencies-head"
2296
- }), " | | same as --dependencies, except it imports the dependencies with their head version |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2296
+ }), " | | same as --dependencies, except it imports the dependencies with their head version |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2297
2297
  children: "--dependents"
2298
- }), " | | import components found while traversing from the imported components upwards to the workspace components |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2298
+ }), " | | import components found while traversing from the imported components upwards to the workspace components |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2299
2299
  children: "--dependents-via <string>"
2300
- }), " | | same as --dependents except the traversal must go through the specified component. to specify multiple components, wrap with quotes and separate by a comma |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2300
+ }), " | | same as --dependents except the traversal must go through the specified component. to specify multiple components, wrap with quotes and separate by a comma |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2301
2301
  children: "--dependents-all"
2302
- }), " | | same as --dependents except not prompting for selecting paths but rather selecting all paths and showing final confirmation before importing |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2302
+ }), " | | same as --dependents except not prompting for selecting paths but rather selecting all paths and showing final confirmation before importing |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2303
2303
  children: "--dependents-dry-run"
2304
- }), " | | DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and wait for confirmation before importing them |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2304
+ }), " | | DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and wait for confirmation before importing them |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2305
2305
  children: "--silent"
2306
- }), " | | no prompt for --dependents/--dependents-via flags |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2306
+ }), " | | no prompt for --dependents/--dependents-via flags |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2307
2307
  children: "--filter-envs <envs>"
2308
- }), " | | only import components that have the specified environment (e.g., \"teambit.react/react-env\") |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2308
+ }), " | | only import components that have the specified environment (e.g., \"teambit.react/react-env\") |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2309
2309
  children: "--save-in-lane"
2310
- }), " | | when checked out to a lane and the component is not on the remote-lane, save it in the lane (defaults to save on main) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2310
+ }), " | | when checked out to a lane and the component is not on the remote-lane, save it in the lane (defaults to save on main) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2311
2311
  children: "--all-history"
2312
- }), " | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2312
+ }), " | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2313
2313
  children: "--fetch-deps"
2314
- }), " | | fetch dependencies (bit components) objects to the local scope, but dont add to the workspace. Useful to resolve errors about missing dependency data |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2315
- children: "--write-deps <workspace.jsonc | package.json>"
2316
- }), " | | write all workspace component dependencies to package.json or workspace.jsonc, resolving conflicts by picking the ranges that match the highest versions |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2314
+ }), " | | fetch dependencies (bit components) objects to the local scope, but dont add to the workspace. Useful to resolve errors about missing dependency data |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2315
+ children: "--write-deps <target>"
2316
+ }), " | | write all workspace component dependencies to the specified target (\"package.json\" or \"workspace.jsonc\"), resolving conflicts by picking the ranges that match the highest versions |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2317
2317
  children: "--track-only"
2318
- }), " | | do not write any component files, just create .bitmap entries of the imported components. Useful when the files already exist and just want to re-add the component to the bitmap |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2318
+ }), " | | do not write any component files, just create .bitmap entries of the imported components. Useful when the files already exist and just want to re-add the component to the bitmap |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2319
2319
  children: "--include-deprecated"
2320
- }), " | | when importing with patterns, include deprecated components (default to exclude them) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2320
+ }), " | | when importing with patterns, include deprecated components (default to exclude them) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2321
2321
  children: "--lane-only"
2322
- }), " | | when using wildcards on a lane, only import components that exist on the lane (never from main) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2322
+ }), " | | when using wildcards on a lane, only import components that exist on the lane (never from main) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2323
2323
  children: "--owner"
2324
- }), " | | treat the argument as an owner name and import all components from all scopes of that owner |"]
2324
+ }), " | | treat the argument as an owner name and import all components from all scopes of that owner |"]
2325
2325
  }), "\n", (0, _jsxRuntime.jsx)(_components.hr, {}), "\n", (0, _jsxRuntime.jsx)(_components.h2, {
2326
2326
  children: "init"
2327
2327
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {