@teambit/builder 1.0.310 → 1.0.311
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.
- package/artifacts/__bit_junit.xml +1 -1
- package/artifacts/preview/teambit_pipelines_builder-preview.js +1 -1
- package/artifacts/schema.json +254 -127
- package/dist/builder.graphql.d.ts +7 -9
- package/dist/builder.route.d.ts +0 -1
- package/dist/{preview-1718853656395.js → preview-1719137078208.js} +2 -2
- package/package.json +17 -17
package/artifacts/schema.json
CHANGED
|
@@ -249,7 +249,8 @@
|
|
|
249
249
|
"character": 3
|
|
250
250
|
},
|
|
251
251
|
"raw": "/**\n * execute a pipeline of build tasks.\n */",
|
|
252
|
-
"comment": "execute a pipeline of build tasks."
|
|
252
|
+
"comment": "execute a pipeline of build tasks.",
|
|
253
|
+
"tags": []
|
|
253
254
|
},
|
|
254
255
|
"signature": "(method) BuildPipe.execute(): Promise<TaskResultsList>",
|
|
255
256
|
"name": "execute",
|
|
@@ -323,7 +324,8 @@
|
|
|
323
324
|
"character": 3
|
|
324
325
|
},
|
|
325
326
|
"raw": "/**\n * task itself. useful for getting its id/description later on.\n */",
|
|
326
|
-
"comment": "task itself. useful for getting its id/description later on."
|
|
327
|
+
"comment": "task itself. useful for getting its id/description later on.",
|
|
328
|
+
"tags": []
|
|
327
329
|
},
|
|
328
330
|
"signature": "(property) task: BuildTask",
|
|
329
331
|
"name": "task",
|
|
@@ -353,7 +355,8 @@
|
|
|
353
355
|
"character": 3
|
|
354
356
|
},
|
|
355
357
|
"raw": "/**\n * environment were the task was running\n */",
|
|
356
|
-
"comment": "environment were the task was running"
|
|
358
|
+
"comment": "environment were the task was running",
|
|
359
|
+
"tags": []
|
|
357
360
|
},
|
|
358
361
|
"signature": "(property) env: EnvDefinition",
|
|
359
362
|
"name": "env",
|
|
@@ -387,7 +390,8 @@
|
|
|
387
390
|
"character": 3
|
|
388
391
|
},
|
|
389
392
|
"raw": "/**\n * component build results.\n */",
|
|
390
|
-
"comment": "component build results."
|
|
393
|
+
"comment": "component build results.",
|
|
394
|
+
"tags": []
|
|
391
395
|
},
|
|
392
396
|
"signature": "(property) componentsResults: ComponentResult[]",
|
|
393
397
|
"name": "componentsResults",
|
|
@@ -425,7 +429,8 @@
|
|
|
425
429
|
"character": 3
|
|
426
430
|
},
|
|
427
431
|
"raw": "/**\n * artifacts generated by the build pipeline.\n * in case the task finished with errors, this prop is undefined.\n */",
|
|
428
|
-
"comment": "artifacts generated by the build pipeline.\nin case the task finished with errors, this prop is undefined."
|
|
432
|
+
"comment": "artifacts generated by the build pipeline.\nin case the task finished with errors, this prop is undefined.",
|
|
433
|
+
"tags": []
|
|
429
434
|
},
|
|
430
435
|
"signature": "(property) artifacts: ComponentMap<ArtifactList<FsArtifact>> | undefined",
|
|
431
436
|
"name": "artifacts",
|
|
@@ -501,7 +506,8 @@
|
|
|
501
506
|
"character": 3
|
|
502
507
|
},
|
|
503
508
|
"raw": "/**\n * timestamp of start initiation.\n */",
|
|
504
|
-
"comment": "timestamp of start initiation."
|
|
509
|
+
"comment": "timestamp of start initiation.",
|
|
510
|
+
"tags": []
|
|
505
511
|
},
|
|
506
512
|
"signature": "(property) startTime: number",
|
|
507
513
|
"name": "startTime",
|
|
@@ -531,7 +537,8 @@
|
|
|
531
537
|
"character": 3
|
|
532
538
|
},
|
|
533
539
|
"raw": "/**\n * timestamp of task completion.\n */",
|
|
534
|
-
"comment": "timestamp of task completion."
|
|
540
|
+
"comment": "timestamp of task completion.",
|
|
541
|
+
"tags": []
|
|
535
542
|
},
|
|
536
543
|
"signature": "(property) endTime: number",
|
|
537
544
|
"name": "endTime",
|
|
@@ -590,7 +597,8 @@
|
|
|
590
597
|
"character": 3
|
|
591
598
|
},
|
|
592
599
|
"raw": "/**\n * instance of the component\n */",
|
|
593
|
-
"comment": "instance of the component"
|
|
600
|
+
"comment": "instance of the component",
|
|
601
|
+
"tags": []
|
|
594
602
|
},
|
|
595
603
|
"signature": "(property) component: Component",
|
|
596
604
|
"name": "component",
|
|
@@ -624,7 +632,8 @@
|
|
|
624
632
|
"character": 3
|
|
625
633
|
},
|
|
626
634
|
"raw": "/**\n * metadata generated during component build.\n * this eventually gets saved into `aspectsData` prop of the builder aspect data.\n * it can be retrieved later on by `builder.getDataByAspect()` method.\n */",
|
|
627
|
-
"comment": "metadata generated during component build.\nthis eventually gets saved into `aspectsData` prop of the builder aspect data.\nit can be retrieved later on by `builder.getDataByAspect()` method."
|
|
635
|
+
"comment": "metadata generated during component build.\nthis eventually gets saved into `aspectsData` prop of the builder aspect data.\nit can be retrieved later on by `builder.getDataByAspect()` method.",
|
|
636
|
+
"tags": []
|
|
628
637
|
},
|
|
629
638
|
"signature": "(property) metadata?: TaskMetadata | undefined",
|
|
630
639
|
"name": "metadata",
|
|
@@ -654,7 +663,8 @@
|
|
|
654
663
|
"character": 3
|
|
655
664
|
},
|
|
656
665
|
"raw": "/**\n * returning errors from build tasks will cause a pipeline failure and logs all returned errors.\n */",
|
|
657
|
-
"comment": "returning errors from build tasks will cause a pipeline failure and logs all returned errors."
|
|
666
|
+
"comment": "returning errors from build tasks will cause a pipeline failure and logs all returned errors.",
|
|
667
|
+
"tags": []
|
|
658
668
|
},
|
|
659
669
|
"signature": "(property) errors?: (string | Error)[] | undefined",
|
|
660
670
|
"name": "errors",
|
|
@@ -714,7 +724,8 @@
|
|
|
714
724
|
"character": 3
|
|
715
725
|
},
|
|
716
726
|
"raw": "/**\n * warnings generated throughout the build task.\n */",
|
|
717
|
-
"comment": "warnings generated throughout the build task."
|
|
727
|
+
"comment": "warnings generated throughout the build task.",
|
|
728
|
+
"tags": []
|
|
718
729
|
},
|
|
719
730
|
"signature": "(property) warnings?: string[] | undefined",
|
|
720
731
|
"name": "warnings",
|
|
@@ -752,7 +763,8 @@
|
|
|
752
763
|
"character": 3
|
|
753
764
|
},
|
|
754
765
|
"raw": "/**\n * timestamp in milliseconds when the task started\n */",
|
|
755
|
-
"comment": "timestamp in milliseconds when the task started"
|
|
766
|
+
"comment": "timestamp in milliseconds when the task started",
|
|
767
|
+
"tags": []
|
|
756
768
|
},
|
|
757
769
|
"signature": "(property) startTime?: number | undefined",
|
|
758
770
|
"name": "startTime",
|
|
@@ -782,7 +794,8 @@
|
|
|
782
794
|
"character": 3
|
|
783
795
|
},
|
|
784
796
|
"raw": "/**\n * timestamp in milliseconds when the task ended\n */",
|
|
785
|
-
"comment": "timestamp in milliseconds when the task ended"
|
|
797
|
+
"comment": "timestamp in milliseconds when the task ended",
|
|
798
|
+
"tags": []
|
|
786
799
|
},
|
|
787
800
|
"signature": "(property) endTime?: number | undefined",
|
|
788
801
|
"name": "endTime",
|
|
@@ -900,7 +913,8 @@
|
|
|
900
913
|
"character": 3
|
|
901
914
|
},
|
|
902
915
|
"raw": "/**\n * all components about to be built/tagged.\n */",
|
|
903
|
-
"comment": "all components about to be built/tagged."
|
|
916
|
+
"comment": "all components about to be built/tagged.",
|
|
917
|
+
"tags": []
|
|
904
918
|
},
|
|
905
919
|
"signature": "(property) BuildContext.components: Component[]",
|
|
906
920
|
"name": "components",
|
|
@@ -942,7 +956,8 @@
|
|
|
942
956
|
"character": 3
|
|
943
957
|
},
|
|
944
958
|
"raw": "/**\n * network of capsules ready to be built.\n */",
|
|
945
|
-
"comment": "network of capsules ready to be built."
|
|
959
|
+
"comment": "network of capsules ready to be built.",
|
|
960
|
+
"tags": []
|
|
946
961
|
},
|
|
947
962
|
"signature": "(property) BuildContext.capsuleNetwork: Network",
|
|
948
963
|
"name": "capsuleNetwork",
|
|
@@ -976,7 +991,8 @@
|
|
|
976
991
|
"character": 3
|
|
977
992
|
},
|
|
978
993
|
"raw": "/**\n * data generated by tasks that were running before this task\n */",
|
|
979
|
-
"comment": "data generated by tasks that were running before this task"
|
|
994
|
+
"comment": "data generated by tasks that were running before this task",
|
|
995
|
+
"tags": []
|
|
980
996
|
},
|
|
981
997
|
"signature": "(property) BuildContext.previousTasksResults: TaskResults[]",
|
|
982
998
|
"name": "previousTasksResults",
|
|
@@ -1014,7 +1030,8 @@
|
|
|
1014
1030
|
"character": 3
|
|
1015
1031
|
},
|
|
1016
1032
|
"raw": "/**\n * Run the build pipeline in dev mode\n */",
|
|
1017
|
-
"comment": "Run the build pipeline in dev mode"
|
|
1033
|
+
"comment": "Run the build pipeline in dev mode",
|
|
1034
|
+
"tags": []
|
|
1018
1035
|
},
|
|
1019
1036
|
"signature": "(property) BuildContext.dev?: boolean | undefined",
|
|
1020
1037
|
"name": "dev",
|
|
@@ -1044,7 +1061,8 @@
|
|
|
1044
1061
|
"character": 3
|
|
1045
1062
|
},
|
|
1046
1063
|
"raw": "/**\n * pipe name such as \"build\", \"tas\", \"snap\".\n * an example usage is \"deploy\" task which is running in snap and tag pipeline and has different needs in each one.\n */",
|
|
1047
|
-
"comment": "pipe name such as \"build\", \"tas\", \"snap\".\nan example usage is \"deploy\" task which is running in snap and tag pipeline and has different needs in each one."
|
|
1064
|
+
"comment": "pipe name such as \"build\", \"tas\", \"snap\".\nan example usage is \"deploy\" task which is running in snap and tag pipeline and has different needs in each one.",
|
|
1065
|
+
"tags": []
|
|
1048
1066
|
},
|
|
1049
1067
|
"signature": "(property) BuildContext.pipeName: PipeName",
|
|
1050
1068
|
"name": "pipeName",
|
|
@@ -1074,7 +1092,8 @@
|
|
|
1074
1092
|
"character": 3
|
|
1075
1093
|
},
|
|
1076
1094
|
"raw": "/**\n * current lane-id if exists. empty when on main.\n */",
|
|
1077
|
-
"comment": "current lane-id if exists. empty when on main."
|
|
1095
|
+
"comment": "current lane-id if exists. empty when on main.",
|
|
1096
|
+
"tags": []
|
|
1078
1097
|
},
|
|
1079
1098
|
"signature": "(property) BuildContext.laneId?: LaneId | undefined",
|
|
1080
1099
|
"name": "laneId",
|
|
@@ -1117,7 +1136,7 @@
|
|
|
1117
1136
|
"_legacy": {
|
|
1118
1137
|
"scope": "teambit.pipelines",
|
|
1119
1138
|
"name": "builder",
|
|
1120
|
-
"version": "1.0.
|
|
1139
|
+
"version": "1.0.311"
|
|
1121
1140
|
},
|
|
1122
1141
|
"_scope": "teambit.pipelines"
|
|
1123
1142
|
}
|
|
@@ -1159,7 +1178,8 @@
|
|
|
1159
1178
|
"character": 3
|
|
1160
1179
|
},
|
|
1161
1180
|
"raw": "/**\n * aspect id serialized of the creator of the task.\n * todo: automate this so then it won't be needed to pass manually.\n */",
|
|
1162
|
-
"comment": "aspect id serialized of the creator of the task.\ntodo: automate this so then it won't be needed to pass manually."
|
|
1181
|
+
"comment": "aspect id serialized of the creator of the task.\ntodo: automate this so then it won't be needed to pass manually.",
|
|
1182
|
+
"tags": []
|
|
1163
1183
|
},
|
|
1164
1184
|
"signature": "(property) BuildTask.aspectId: string",
|
|
1165
1185
|
"name": "aspectId",
|
|
@@ -1189,7 +1209,8 @@
|
|
|
1189
1209
|
"character": 3
|
|
1190
1210
|
},
|
|
1191
1211
|
"raw": "/**\n * name of the task. function as an identifier among other tasks of the same aspectId.\n * spaces and special characters are not allowed. as a convention, use UpperCamelCase style.\n * (e.g. TypescriptCompiler).\n */",
|
|
1192
|
-
"comment": "name of the task. function as an identifier among other tasks of the same aspectId.\nspaces and special characters are not allowed. as a convention, use UpperCamelCase style.\n(e.g. TypescriptCompiler)."
|
|
1212
|
+
"comment": "name of the task. function as an identifier among other tasks of the same aspectId.\nspaces and special characters are not allowed. as a convention, use UpperCamelCase style.\n(e.g. TypescriptCompiler).",
|
|
1213
|
+
"tags": []
|
|
1193
1214
|
},
|
|
1194
1215
|
"signature": "(property) BuildTask.name: string",
|
|
1195
1216
|
"name": "name",
|
|
@@ -1219,7 +1240,8 @@
|
|
|
1219
1240
|
"character": 3
|
|
1220
1241
|
},
|
|
1221
1242
|
"raw": "/**\n * description of what the task does.\n * if available, the logger will log it show it in the status-line.\n */",
|
|
1222
|
-
"comment": "description of what the task does.\nif available, the logger will log it show it in the status-line."
|
|
1243
|
+
"comment": "description of what the task does.\nif available, the logger will log it show it in the status-line.",
|
|
1244
|
+
"tags": []
|
|
1223
1245
|
},
|
|
1224
1246
|
"signature": "(property) BuildTask.description?: string | undefined",
|
|
1225
1247
|
"name": "description",
|
|
@@ -1249,7 +1271,8 @@
|
|
|
1249
1271
|
"character": 3
|
|
1250
1272
|
},
|
|
1251
1273
|
"raw": "/**\n * where to put the task, before the env pipeline or after\n */",
|
|
1252
|
-
"comment": "where to put the task, before the env pipeline or after"
|
|
1274
|
+
"comment": "where to put the task, before the env pipeline or after",
|
|
1275
|
+
"tags": []
|
|
1253
1276
|
},
|
|
1254
1277
|
"signature": "(property) BuildTask.location?: TaskLocation | undefined",
|
|
1255
1278
|
"name": "location",
|
|
@@ -1279,7 +1302,8 @@
|
|
|
1279
1302
|
"character": 3
|
|
1280
1303
|
},
|
|
1281
1304
|
"raw": "/**\n * execute a task in a build context\n */",
|
|
1282
|
-
"comment": "execute a task in a build context"
|
|
1305
|
+
"comment": "execute a task in a build context",
|
|
1306
|
+
"tags": []
|
|
1283
1307
|
},
|
|
1284
1308
|
"signature": "(method) BuildTask.execute(context: BuildContext): Promise<BuiltTaskResult>",
|
|
1285
1309
|
"name": "execute",
|
|
@@ -1342,7 +1366,8 @@
|
|
|
1342
1366
|
"character": 3
|
|
1343
1367
|
},
|
|
1344
1368
|
"raw": "/**\n * run before the build pipeline has started. this is useful when some preparation are needed to\n * be done on all envs before the build starts.\n * e.g. typescript compiler needs to write the tsconfig file. doing it during the task, will\n * cause dependencies from other envs to get this tsconfig written.\n */",
|
|
1345
|
-
"comment": "run before the build pipeline has started. this is useful when some preparation are needed to\nbe done on all envs before the build starts.\ne.g. typescript compiler needs to write the tsconfig file. doing it during the task, will\ncause dependencies from other envs to get this tsconfig written."
|
|
1369
|
+
"comment": "run before the build pipeline has started. this is useful when some preparation are needed to\nbe done on all envs before the build starts.\ne.g. typescript compiler needs to write the tsconfig file. doing it during the task, will\ncause dependencies from other envs to get this tsconfig written.",
|
|
1370
|
+
"tags": []
|
|
1346
1371
|
},
|
|
1347
1372
|
"signature": "(method) BuildTask.preBuild?(context: BuildContext): Promise<void>",
|
|
1348
1373
|
"name": "preBuild",
|
|
@@ -1405,7 +1430,8 @@
|
|
|
1405
1430
|
"character": 3
|
|
1406
1431
|
},
|
|
1407
1432
|
"raw": "/**\n * run after the build pipeline completed for all envs. useful for doing some cleanup on the\n * capsules before the deployment starts.\n */",
|
|
1408
|
-
"comment": "run after the build pipeline completed for all envs. useful for doing some cleanup on the\ncapsules before the deployment starts."
|
|
1433
|
+
"comment": "run after the build pipeline completed for all envs. useful for doing some cleanup on the\ncapsules before the deployment starts.",
|
|
1434
|
+
"tags": []
|
|
1409
1435
|
},
|
|
1410
1436
|
"signature": "(method) BuildTask.postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>",
|
|
1411
1437
|
"name": "postBuild",
|
|
@@ -1488,7 +1514,8 @@
|
|
|
1488
1514
|
"character": 3
|
|
1489
1515
|
},
|
|
1490
1516
|
"raw": "/**\n * needed if you want the task to be running only after the dependencies were completed\n * for *all* envs.\n * normally this is not needed because the build-pipeline runs the tasks in the same order\n * they're located in the `getBuildPipe()` array and according to the task.location.\n * the case where this is useful is when a task not only needs to be after another task, but also\n * after all environments were running that task.\n * a dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use\n * \"aspectId:name\", e.g. \"teambit.compilation/compiler:TypescriptCompiler\".\n */",
|
|
1491
|
-
"comment": "needed if you want the task to be running only after the dependencies were completed\nfor *all* envs.\nnormally this is not needed because the build-pipeline runs the tasks in the same order\nthey're located in the `getBuildPipe()` array and according to the task.location.\nthe case where this is useful is when a task not only needs to be after another task, but also\nafter all environments were running that task.\na dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use\n\"aspectId:name\", e.g. \"teambit.compilation/compiler:TypescriptCompiler\"."
|
|
1517
|
+
"comment": "needed if you want the task to be running only after the dependencies were completed\nfor *all* envs.\nnormally this is not needed because the build-pipeline runs the tasks in the same order\nthey're located in the `getBuildPipe()` array and according to the task.location.\nthe case where this is useful is when a task not only needs to be after another task, but also\nafter all environments were running that task.\na dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use\n\"aspectId:name\", e.g. \"teambit.compilation/compiler:TypescriptCompiler\".",
|
|
1518
|
+
"tags": []
|
|
1492
1519
|
},
|
|
1493
1520
|
"signature": "(property) BuildTask.dependencies?: string[] | undefined",
|
|
1494
1521
|
"name": "dependencies",
|
|
@@ -1548,7 +1575,8 @@
|
|
|
1548
1575
|
"character": 3
|
|
1549
1576
|
},
|
|
1550
1577
|
"raw": "/**\n * build results for each of the components in the build context.\n */",
|
|
1551
|
-
"comment": "build results for each of the components in the build context."
|
|
1578
|
+
"comment": "build results for each of the components in the build context.",
|
|
1579
|
+
"tags": []
|
|
1552
1580
|
},
|
|
1553
1581
|
"signature": "(property) BuiltTaskResult.componentsResults: ComponentResult[]",
|
|
1554
1582
|
"name": "componentsResults",
|
|
@@ -1586,7 +1614,8 @@
|
|
|
1586
1614
|
"character": 3
|
|
1587
1615
|
},
|
|
1588
1616
|
"raw": "/**\n * array of artifact definitions to generate after a successful build.\n */",
|
|
1589
|
-
"comment": "array of artifact definitions to generate after a successful build."
|
|
1617
|
+
"comment": "array of artifact definitions to generate after a successful build.",
|
|
1618
|
+
"tags": []
|
|
1590
1619
|
},
|
|
1591
1620
|
"signature": "(property) BuiltTaskResult.artifacts?: ArtifactDefinition[] | undefined",
|
|
1592
1621
|
"name": "artifacts",
|
|
@@ -2352,7 +2381,8 @@
|
|
|
2352
2381
|
"character": 3
|
|
2353
2382
|
},
|
|
2354
2383
|
"raw": "/**\n * remove the onlyOverview from the preview data of the component if\n * the env is in the workspace\n * the env is not tagged with the component\n * the last tagged env has onlyOverview undefined in preview data\n *\n * We don't want to do this but have no choice because,\n * when we load components in workspace,\n * we set the onlyOverview to true in the env's preview data\n * which sets the onlyOverview to true in the component's preview data\n * but if you don't tag the env with the component,\n * the onlyOverview will be true in the component's preview data, since its env is in the workspace\n * even though the env it is tagged with doesn't have onlyOverview in its preview data\n * which will result in inconsistent preview data when exported to the scope\n */",
|
|
2355
|
-
"comment": "remove the onlyOverview from the preview data of the component if\nthe env is in the workspace\nthe env is not tagged with the component\nthe last tagged env has onlyOverview undefined in preview data\n\nWe don't want to do this but have no choice because,\nwhen we load components in workspace,\nwe set the onlyOverview to true in the env's preview data\nwhich sets the onlyOverview to true in the component's preview data\nbut if you don't tag the env with the component,\nthe onlyOverview will be true in the component's preview data, since its env is in the workspace\neven though the env it is tagged with doesn't have onlyOverview in its preview data\nwhich will result in inconsistent preview data when exported to the scope"
|
|
2384
|
+
"comment": "remove the onlyOverview from the preview data of the component if\nthe env is in the workspace\nthe env is not tagged with the component\nthe last tagged env has onlyOverview undefined in preview data\n\nWe don't want to do this but have no choice because,\nwhen we load components in workspace,\nwe set the onlyOverview to true in the env's preview data\nwhich sets the onlyOverview to true in the component's preview data\nbut if you don't tag the env with the component,\nthe onlyOverview will be true in the component's preview data, since its env is in the workspace\neven though the env it is tagged with doesn't have onlyOverview in its preview data\nwhich will result in inconsistent preview data when exported to the scope",
|
|
2385
|
+
"tags": []
|
|
2356
2386
|
},
|
|
2357
2387
|
"signature": "(method) BuilderMain.sanitizePreviewData(harmonyComps: Component[]): Promise<void>",
|
|
2358
2388
|
"name": "sanitizePreviewData",
|
|
@@ -3070,7 +3100,8 @@
|
|
|
3070
3100
|
"character": 3
|
|
3071
3101
|
},
|
|
3072
3102
|
"raw": "/**\n * this is the aspect's data that was generated as \"metadata\" of the task component-result during the build process\n * and saved by the builder aspect in the \"aspectsData\" property.\n * (not to be confused with the data saved in the aspect itself, which is saved in the \"data\" property of the aspect).\n */",
|
|
3073
|
-
"comment": "this is the aspect's data that was generated as \"metadata\" of the task component-result during the build process\nand saved by the builder aspect in the \"aspectsData\" property.\n(not to be confused with the data saved in the aspect itself, which is saved in the \"data\" property of the aspect)."
|
|
3103
|
+
"comment": "this is the aspect's data that was generated as \"metadata\" of the task component-result during the build process\nand saved by the builder aspect in the \"aspectsData\" property.\n(not to be confused with the data saved in the aspect itself, which is saved in the \"data\" property of the aspect).",
|
|
3104
|
+
"tags": []
|
|
3074
3105
|
},
|
|
3075
3106
|
"signature": "(method) BuilderMain.getDataByAspect(component: IComponent, aspectName: string): TaskMetadata | undefined",
|
|
3076
3107
|
"name": "getDataByAspect",
|
|
@@ -3682,7 +3713,8 @@
|
|
|
3682
3713
|
"character": 3
|
|
3683
3714
|
},
|
|
3684
3715
|
"raw": "/**\n * register a build task to apply on all component build pipelines.\n * build happens on `bit build` and as part of `bit tag --persist`.\n */",
|
|
3685
|
-
"comment": "register a build task to apply on all component build pipelines.\nbuild happens on `bit build` and as part of `bit tag --persist`."
|
|
3716
|
+
"comment": "register a build task to apply on all component build pipelines.\nbuild happens on `bit build` and as part of `bit tag --persist`.",
|
|
3717
|
+
"tags": []
|
|
3686
3718
|
},
|
|
3687
3719
|
"signature": "(method) BuilderMain.registerBuildTasks(tasks: BuildTask[]): this",
|
|
3688
3720
|
"name": "registerBuildTasks",
|
|
@@ -3742,6 +3774,7 @@
|
|
|
3742
3774
|
"character": 3
|
|
3743
3775
|
},
|
|
3744
3776
|
"raw": "/**\n * @deprecated use registerTagTasks or registerSnapTasks\n */",
|
|
3777
|
+
"comment": "",
|
|
3745
3778
|
"tags": [
|
|
3746
3779
|
{
|
|
3747
3780
|
"__schema": "TagSchema",
|
|
@@ -3813,7 +3846,8 @@
|
|
|
3813
3846
|
"character": 3
|
|
3814
3847
|
},
|
|
3815
3848
|
"raw": "/**\n * tag tasks that don't get executed on `bit build`, only on `bit tag'.\n * this pipeline is running once the build-pipeline has completed.\n */",
|
|
3816
|
-
"comment": "tag tasks that don't get executed on `bit build`, only on `bit tag'.\nthis pipeline is running once the build-pipeline has completed."
|
|
3849
|
+
"comment": "tag tasks that don't get executed on `bit build`, only on `bit tag'.\nthis pipeline is running once the build-pipeline has completed.",
|
|
3850
|
+
"tags": []
|
|
3817
3851
|
},
|
|
3818
3852
|
"signature": "(method) BuilderMain.registerTagTasks(tasks: BuildTask[]): this",
|
|
3819
3853
|
"name": "registerTagTasks",
|
|
@@ -3873,7 +3907,8 @@
|
|
|
3873
3907
|
"character": 3
|
|
3874
3908
|
},
|
|
3875
3909
|
"raw": "/**\n * tag tasks that don't get executed on `bit build`, only on `bit snap'.\n * this pipeline is running once the build-pipeline has completed.\n */",
|
|
3876
|
-
"comment": "tag tasks that don't get executed on `bit build`, only on `bit snap'.\nthis pipeline is running once the build-pipeline has completed."
|
|
3910
|
+
"comment": "tag tasks that don't get executed on `bit build`, only on `bit snap'.\nthis pipeline is running once the build-pipeline has completed.",
|
|
3911
|
+
"tags": []
|
|
3877
3912
|
},
|
|
3878
3913
|
"signature": "(method) BuilderMain.registerSnapTasks(tasks: BuildTask[]): this",
|
|
3879
3914
|
"name": "registerSnapTasks",
|
|
@@ -4368,7 +4403,8 @@
|
|
|
4368
4403
|
"character": 1
|
|
4369
4404
|
},
|
|
4370
4405
|
"raw": "/**\n * builder data format for the bit object store\n */",
|
|
4371
|
-
"comment": "builder data format for the bit object store"
|
|
4406
|
+
"comment": "builder data format for the bit object store",
|
|
4407
|
+
"tags": []
|
|
4372
4408
|
},
|
|
4373
4409
|
"signature": "type RawBuilderData = {\n pipeline: PipelineReport[];\n artifacts?: ArtifactObject[] | undefined;\n aspectsData: AspectData[];\n bitVersion?: string | undefined;\n}",
|
|
4374
4410
|
"name": "RawBuilderData",
|
|
@@ -4513,7 +4549,8 @@
|
|
|
4513
4549
|
"character": 1
|
|
4514
4550
|
},
|
|
4515
4551
|
"raw": "/**\n * builder data mapped to an ArtifactList instance\n */",
|
|
4516
|
-
"comment": "builder data mapped to an ArtifactList instance"
|
|
4552
|
+
"comment": "builder data mapped to an ArtifactList instance",
|
|
4553
|
+
"tags": []
|
|
4517
4554
|
},
|
|
4518
4555
|
"signature": "type BuilderData = Omit<RawBuilderData, \"artifacts\"> & {\n artifacts: ArtifactList<Artifact>;\n}",
|
|
4519
4556
|
"name": "BuilderData",
|
|
@@ -4847,7 +4884,8 @@
|
|
|
4847
4884
|
"character": 1
|
|
4848
4885
|
},
|
|
4849
4886
|
"raw": "/**\n * create and maintain build pipelines for component\n * dev environments.\n */",
|
|
4850
|
-
"comment": "create and maintain build pipelines for component\ndev environments."
|
|
4887
|
+
"comment": "create and maintain build pipelines for component\ndev environments.",
|
|
4888
|
+
"tags": []
|
|
4851
4889
|
},
|
|
4852
4890
|
"signature": "class Pipeline",
|
|
4853
4891
|
"name": "Pipeline",
|
|
@@ -4936,7 +4974,8 @@
|
|
|
4936
4974
|
"character": 3
|
|
4937
4975
|
},
|
|
4938
4976
|
"raw": "/**\n * add a build task to the pipeline.\n */",
|
|
4939
|
-
"comment": "add a build task to the pipeline."
|
|
4977
|
+
"comment": "add a build task to the pipeline.",
|
|
4978
|
+
"tags": []
|
|
4940
4979
|
},
|
|
4941
4980
|
"signature": "(method) Pipeline.add(tasks: TaskHandler[]): this",
|
|
4942
4981
|
"name": "add",
|
|
@@ -4996,7 +5035,8 @@
|
|
|
4996
5035
|
"character": 3
|
|
4997
5036
|
},
|
|
4998
5037
|
"raw": "/**\n * remove a build task from the pipeline.\n */",
|
|
4999
|
-
"comment": "remove a build task from the pipeline."
|
|
5038
|
+
"comment": "remove a build task from the pipeline.",
|
|
5039
|
+
"tags": []
|
|
5000
5040
|
},
|
|
5001
5041
|
"signature": "(method) Pipeline.remove(taskNames: string[]): this",
|
|
5002
5042
|
"name": "remove",
|
|
@@ -5056,7 +5096,8 @@
|
|
|
5056
5096
|
"character": 3
|
|
5057
5097
|
},
|
|
5058
5098
|
"raw": "/**\n * replace a build task in the pipeline.\n */",
|
|
5059
|
-
"comment": "replace a build task in the pipeline."
|
|
5099
|
+
"comment": "replace a build task in the pipeline.",
|
|
5100
|
+
"tags": []
|
|
5060
5101
|
},
|
|
5061
5102
|
"signature": "(method) Pipeline.replace(tasks: TaskHandler[]): this",
|
|
5062
5103
|
"name": "replace",
|
|
@@ -5189,7 +5230,8 @@
|
|
|
5189
5230
|
"character": 3
|
|
5190
5231
|
},
|
|
5191
5232
|
"raw": "/**\n * compute the pipeline.\n */",
|
|
5192
|
-
"comment": "compute the pipeline."
|
|
5233
|
+
"comment": "compute the pipeline.",
|
|
5234
|
+
"tags": []
|
|
5193
5235
|
},
|
|
5194
5236
|
"signature": "(method) Pipeline.compute(context: EnvContext): BuildTask[]",
|
|
5195
5237
|
"name": "compute",
|
|
@@ -5535,7 +5577,8 @@
|
|
|
5535
5577
|
"character": 3
|
|
5536
5578
|
},
|
|
5537
5579
|
"raw": "/**\n * return a build pipeline instance.\n */",
|
|
5538
|
-
"comment": "return a build pipeline instance."
|
|
5580
|
+
"comment": "return a build pipeline instance.",
|
|
5581
|
+
"tags": []
|
|
5539
5582
|
},
|
|
5540
5583
|
"signature": "(method) BuilderEnv.build(): Pipeline",
|
|
5541
5584
|
"name": "build",
|
|
@@ -5566,7 +5609,8 @@
|
|
|
5566
5609
|
"character": 3
|
|
5567
5610
|
},
|
|
5568
5611
|
"raw": "/**\n * return a snap pipeline instance.\n */",
|
|
5569
|
-
"comment": "return a snap pipeline instance."
|
|
5612
|
+
"comment": "return a snap pipeline instance.",
|
|
5613
|
+
"tags": []
|
|
5570
5614
|
},
|
|
5571
5615
|
"signature": "(method) BuilderEnv.snap(): Pipeline",
|
|
5572
5616
|
"name": "snap",
|
|
@@ -5597,7 +5641,8 @@
|
|
|
5597
5641
|
"character": 3
|
|
5598
5642
|
},
|
|
5599
5643
|
"raw": "/**\n * return a tag pipeline instance.\n */",
|
|
5600
|
-
"comment": "return a tag pipeline instance."
|
|
5644
|
+
"comment": "return a tag pipeline instance.",
|
|
5645
|
+
"tags": []
|
|
5601
5646
|
},
|
|
5602
5647
|
"signature": "(method) BuilderEnv.tag(): Pipeline",
|
|
5603
5648
|
"name": "tag",
|
|
@@ -5650,7 +5695,8 @@
|
|
|
5650
5695
|
"character": 3
|
|
5651
5696
|
},
|
|
5652
5697
|
"raw": "/**\n * store artifacts in the storage.\n */",
|
|
5653
|
-
"comment": "store artifacts in the storage."
|
|
5698
|
+
"comment": "store artifacts in the storage.",
|
|
5699
|
+
"tags": []
|
|
5654
5700
|
},
|
|
5655
5701
|
"signature": "(method) WholeArtifactStorageResolver.store(component: Component, artifact: FsArtifact): Promise<StoreResult | undefined | void>",
|
|
5656
5702
|
"name": "store",
|
|
@@ -5801,7 +5847,8 @@
|
|
|
5801
5847
|
"character": 3
|
|
5802
5848
|
},
|
|
5803
5849
|
"raw": "/**\n * name of the storage resolver.\n */",
|
|
5804
|
-
"comment": "name of the storage resolver."
|
|
5850
|
+
"comment": "name of the storage resolver.",
|
|
5851
|
+
"tags": []
|
|
5805
5852
|
}
|
|
5806
5853
|
}
|
|
5807
5854
|
]
|
|
@@ -5843,7 +5890,8 @@
|
|
|
5843
5890
|
"character": 3
|
|
5844
5891
|
},
|
|
5845
5892
|
"raw": "/**\n * store artifacts in the storage.\n */",
|
|
5846
|
-
"comment": "store artifacts in the storage."
|
|
5893
|
+
"comment": "store artifacts in the storage.",
|
|
5894
|
+
"tags": []
|
|
5847
5895
|
},
|
|
5848
5896
|
"signature": "(method) FileStorageResolver.storeFile(component: Component, artifact: FsArtifact, file: ArtifactVinyl): Promise<string | undefined | void>",
|
|
5849
5897
|
"name": "storeFile",
|
|
@@ -6014,7 +6062,8 @@
|
|
|
6014
6062
|
"character": 3
|
|
6015
6063
|
},
|
|
6016
6064
|
"raw": "/**\n * name of the storage resolver.\n */",
|
|
6017
|
-
"comment": "name of the storage resolver."
|
|
6065
|
+
"comment": "name of the storage resolver.",
|
|
6066
|
+
"tags": []
|
|
6018
6067
|
}
|
|
6019
6068
|
}
|
|
6020
6069
|
]
|
|
@@ -6110,7 +6159,8 @@
|
|
|
6110
6159
|
"character": 3
|
|
6111
6160
|
},
|
|
6112
6161
|
"raw": "/**\n * name of the artifact.\n * e.g. a project might utilize two different artifacts for the same typescript compiler, one\n * that generates ES5 files and another for ES6, this prop helps to distinguish between the two.\n */",
|
|
6113
|
-
"comment": "name of the artifact.\ne.g. a project might utilize two different artifacts for the same typescript compiler, one\nthat generates ES5 files and another for ES6, this prop helps to distinguish between the two."
|
|
6162
|
+
"comment": "name of the artifact.\ne.g. a project might utilize two different artifacts for the same typescript compiler, one\nthat generates ES5 files and another for ES6, this prop helps to distinguish between the two.",
|
|
6163
|
+
"tags": []
|
|
6114
6164
|
},
|
|
6115
6165
|
"signature": "(property) name: string",
|
|
6116
6166
|
"name": "name",
|
|
@@ -6140,7 +6190,8 @@
|
|
|
6140
6190
|
"character": 3
|
|
6141
6191
|
},
|
|
6142
6192
|
"raw": "/**\n * aspect id that created the artifact. sometimes it's not the same as the task.id.\n * e.g. teambit.compilation/compiler executes teambit.typescript/typescript code that generates dists artifacts\n * the generatedBy in this case is the teambit.typescript/typescript while the task.id is\n * teambit.compilation/compiler\n */",
|
|
6143
|
-
"comment": "aspect id that created the artifact. sometimes it's not the same as the task.id.\ne.g. teambit.compilation/compiler executes teambit.typescript/typescript code that generates dists artifacts\nthe generatedBy in this case is the teambit.typescript/typescript while the task.id is\nteambit.compilation/compiler"
|
|
6193
|
+
"comment": "aspect id that created the artifact. sometimes it's not the same as the task.id.\ne.g. teambit.compilation/compiler executes teambit.typescript/typescript code that generates dists artifacts\nthe generatedBy in this case is the teambit.typescript/typescript while the task.id is\nteambit.compilation/compiler",
|
|
6194
|
+
"tags": []
|
|
6144
6195
|
},
|
|
6145
6196
|
"signature": "(property) generatedBy?: string | undefined",
|
|
6146
6197
|
"name": "generatedBy",
|
|
@@ -6170,7 +6221,8 @@
|
|
|
6170
6221
|
"character": 3
|
|
6171
6222
|
},
|
|
6172
6223
|
"raw": "/**\n * description of the artifact.\n */",
|
|
6173
|
-
"comment": "description of the artifact."
|
|
6224
|
+
"comment": "description of the artifact.",
|
|
6225
|
+
"tags": []
|
|
6174
6226
|
},
|
|
6175
6227
|
"signature": "(property) description?: string | undefined",
|
|
6176
6228
|
"name": "description",
|
|
@@ -6200,7 +6252,8 @@
|
|
|
6200
6252
|
"character": 3
|
|
6201
6253
|
},
|
|
6202
6254
|
"raw": "/**\n * glob patterns of files to include upon artifact creation.\n * examples:\n * ['*.ts', '!foo.ts'] - matches all ts files but ignores foo.ts.\n * ['dist'] - matches all files recursively from dist dir. (similar to 'dist/**').\n *\n * the glob array are passed to [globby](https://www.npmjs.com/package/globby), which interprets the patterns\n * according to [minimatch](https://github.com/isaacs/minimatch#usage).\n */",
|
|
6203
|
-
"comment": "glob patterns of files to include upon artifact creation.\nexamples:\n['*.ts', '!foo.ts'] - matches all ts files but ignores foo.ts.\n['dist'] - matches all files recursively from dist dir. (similar to 'dist/**').\n\nthe glob array are passed to [globby](https://www.npmjs.com/package/globby), which interprets the patterns\naccording to [minimatch](https://github.com/isaacs/minimatch#usage)."
|
|
6255
|
+
"comment": "glob patterns of files to include upon artifact creation.\nexamples:\n['*.ts', '!foo.ts'] - matches all ts files but ignores foo.ts.\n['dist'] - matches all files recursively from dist dir. (similar to 'dist/**').\n\nthe glob array are passed to [globby](https://www.npmjs.com/package/globby), which interprets the patterns\naccording to [minimatch](https://github.com/isaacs/minimatch#usage).",
|
|
6256
|
+
"tags": []
|
|
6204
6257
|
},
|
|
6205
6258
|
"signature": "(property) globPatterns?: string[] | undefined",
|
|
6206
6259
|
"name": "globPatterns",
|
|
@@ -6238,6 +6291,7 @@
|
|
|
6238
6291
|
"character": 3
|
|
6239
6292
|
},
|
|
6240
6293
|
"raw": "/**\n * @deprecated use globPatterns instead.\n *\n * directories of files to include upon artifact creation. minimatch is used to match the patterns.\n * e.g. ['/tmp'] will include all files from tmp dir\n */",
|
|
6294
|
+
"comment": "",
|
|
6241
6295
|
"tags": [
|
|
6242
6296
|
{
|
|
6243
6297
|
"__schema": "TagSchema",
|
|
@@ -6287,6 +6341,7 @@
|
|
|
6287
6341
|
"character": 3
|
|
6288
6342
|
},
|
|
6289
6343
|
"raw": "/**\n * @deprecated use globPatterns instead.\n *\n * define the root directory for reading the artifacts from the capsule file system.\n * the rootDir must be unique per artifacts, otherwise we risk overriding data between artifacts.\n */",
|
|
6344
|
+
"comment": "",
|
|
6290
6345
|
"tags": [
|
|
6291
6346
|
{
|
|
6292
6347
|
"__schema": "TagSchema",
|
|
@@ -6328,6 +6383,7 @@
|
|
|
6328
6383
|
"character": 3
|
|
6329
6384
|
},
|
|
6330
6385
|
"raw": "/**\n * @deprecated use globPatterns instead.\n *\n * adds a directory prefix for all artifact files.\n */",
|
|
6386
|
+
"comment": "",
|
|
6331
6387
|
"tags": [
|
|
6332
6388
|
{
|
|
6333
6389
|
"__schema": "TagSchema",
|
|
@@ -6369,7 +6425,8 @@
|
|
|
6369
6425
|
"character": 3
|
|
6370
6426
|
},
|
|
6371
6427
|
"raw": "/**\n * determine the context of the artifact.\n * default artifact context is `component`.\n * \"env\" is useful when the same file is generated for all components, for example, \"preview\"\n * task may create the same webpack file for all components of that env.\n */",
|
|
6372
|
-
"comment": "determine the context of the artifact.\ndefault artifact context is `component`.\n\"env\" is useful when the same file is generated for all components, for example, \"preview\"\ntask may create the same webpack file for all components of that env."
|
|
6428
|
+
"comment": "determine the context of the artifact.\ndefault artifact context is `component`.\n\"env\" is useful when the same file is generated for all components, for example, \"preview\"\ntask may create the same webpack file for all components of that env.",
|
|
6429
|
+
"tags": []
|
|
6373
6430
|
},
|
|
6374
6431
|
"signature": "(property) context?: \"component\" | \"env\" | undefined",
|
|
6375
6432
|
"name": "context",
|
|
@@ -6418,7 +6475,8 @@
|
|
|
6418
6475
|
"character": 3
|
|
6419
6476
|
},
|
|
6420
6477
|
"raw": "/**\n * storage resolver. can be used to replace where artifacts are stored.\n * default resolver persists artifacts on scope. (not recommended for large files!)\n */",
|
|
6421
|
-
"comment": "storage resolver. can be used to replace where artifacts are stored.\ndefault resolver persists artifacts on scope. (not recommended for large files!)"
|
|
6478
|
+
"comment": "storage resolver. can be used to replace where artifacts are stored.\ndefault resolver persists artifacts on scope. (not recommended for large files!)",
|
|
6479
|
+
"tags": []
|
|
6422
6480
|
},
|
|
6423
6481
|
"signature": "(property) storageResolver?: ArtifactStorageResolver | undefined",
|
|
6424
6482
|
"name": "storageResolver",
|
|
@@ -6817,7 +6875,8 @@
|
|
|
6817
6875
|
"character": 3
|
|
6818
6876
|
},
|
|
6819
6877
|
"raw": "/**\n * archive all artifact files into a tar.\n */",
|
|
6820
|
-
"comment": "archive all artifact files into a tar."
|
|
6878
|
+
"comment": "archive all artifact files into a tar.",
|
|
6879
|
+
"tags": []
|
|
6821
6880
|
},
|
|
6822
6881
|
"signature": "(method) Artifact.tar(): void",
|
|
6823
6882
|
"name": "tar",
|
|
@@ -7084,7 +7143,8 @@
|
|
|
7084
7143
|
"character": 3
|
|
7085
7144
|
},
|
|
7086
7145
|
"raw": "/**\n * find by the artifact name. it's possible to have multiple artifacts with the same name, in which case it returns the first.\n */",
|
|
7087
|
-
"comment": "find by the artifact name. it's possible to have multiple artifacts with the same name, in which case it returns the first."
|
|
7146
|
+
"comment": "find by the artifact name. it's possible to have multiple artifacts with the same name, in which case it returns the first.",
|
|
7147
|
+
"tags": []
|
|
7088
7148
|
},
|
|
7089
7149
|
"signature": "(method) ArtifactList<T extends Artifact>.findByName(name: string): Artifact | undefined",
|
|
7090
7150
|
"name": "findByName",
|
|
@@ -7155,7 +7215,8 @@
|
|
|
7155
7215
|
"character": 3
|
|
7156
7216
|
},
|
|
7157
7217
|
"raw": "/**\n * find by the task name. it's possible to have multiple tasks with the same name (different aspects), in which case it returns the first.\n */",
|
|
7158
|
-
"comment": "find by the task name. it's possible to have multiple tasks with the same name (different aspects), in which case it returns the first."
|
|
7218
|
+
"comment": "find by the task name. it's possible to have multiple tasks with the same name (different aspects), in which case it returns the first.",
|
|
7219
|
+
"tags": []
|
|
7159
7220
|
},
|
|
7160
7221
|
"signature": "(method) ArtifactList<T extends Artifact>.findByTaskName(name: string): Artifact | undefined",
|
|
7161
7222
|
"name": "findByTaskName",
|
|
@@ -7247,7 +7308,8 @@
|
|
|
7247
7308
|
"character": 3
|
|
7248
7309
|
},
|
|
7249
7310
|
"raw": "/**\n * group artifacts by the storage resolver.\n */",
|
|
7250
|
-
"comment": "group artifacts by the storage resolver."
|
|
7311
|
+
"comment": "group artifacts by the storage resolver.",
|
|
7312
|
+
"tags": []
|
|
7251
7313
|
},
|
|
7252
7314
|
"signature": "(method) ArtifactList<T extends Artifact>.groupByResolver(): ResolverMap<T>",
|
|
7253
7315
|
"name": "groupByResolver",
|
|
@@ -7431,7 +7493,8 @@
|
|
|
7431
7493
|
"character": 3
|
|
7432
7494
|
},
|
|
7433
7495
|
"raw": "/**\n * store all artifacts using the configured storage resolvers.\n */",
|
|
7434
|
-
"comment": "store all artifacts using the configured storage resolvers."
|
|
7496
|
+
"comment": "store all artifacts using the configured storage resolvers.",
|
|
7497
|
+
"tags": []
|
|
7435
7498
|
},
|
|
7436
7499
|
"signature": "(method) ArtifactList<T extends Artifact>.store(component: Component): Promise<void[]>",
|
|
7437
7500
|
"name": "store",
|
|
@@ -7629,7 +7692,7 @@
|
|
|
7629
7692
|
"_legacy": {
|
|
7630
7693
|
"scope": "teambit.pipelines",
|
|
7631
7694
|
"name": "builder",
|
|
7632
|
-
"version": "1.0.
|
|
7695
|
+
"version": "1.0.311"
|
|
7633
7696
|
},
|
|
7634
7697
|
"_scope": "teambit.pipelines"
|
|
7635
7698
|
}
|
|
@@ -7930,7 +7993,8 @@
|
|
|
7930
7993
|
"character": 3
|
|
7931
7994
|
},
|
|
7932
7995
|
"raw": "/**\n * generate artifacts from a build context according to the spec defined in the artifact definitions.\n */",
|
|
7933
|
-
"comment": "generate artifacts from a build context according to the spec defined in the artifact definitions."
|
|
7996
|
+
"comment": "generate artifacts from a build context according to the spec defined in the artifact definitions.",
|
|
7997
|
+
"tags": []
|
|
7934
7998
|
},
|
|
7935
7999
|
"signature": "(method) ArtifactFactory.generate(context: BuildContext, defs: ArtifactDefinition[], task: BuildTask): ComponentMap<ArtifactList<FsArtifact>>",
|
|
7936
8000
|
"name": "generate",
|
|
@@ -8070,7 +8134,8 @@
|
|
|
8070
8134
|
"character": 1
|
|
8071
8135
|
},
|
|
8072
8136
|
"raw": "/**\n * this is the external interface for task. please make\n * sure to use only this interface outside of this builder\n * aspect.\n */",
|
|
8073
|
-
"comment": "this is the external interface for task. please make\nsure to use only this interface outside of this builder\naspect."
|
|
8137
|
+
"comment": "this is the external interface for task. please make\nsure to use only this interface outside of this builder\naspect.",
|
|
8138
|
+
"tags": []
|
|
8074
8139
|
},
|
|
8075
8140
|
"signature": "interface Task",
|
|
8076
8141
|
"name": "Task",
|
|
@@ -8090,7 +8155,8 @@
|
|
|
8090
8155
|
"character": 3
|
|
8091
8156
|
},
|
|
8092
8157
|
"raw": "/**\n * names ideally with dashes 'typescript'\n */",
|
|
8093
|
-
"comment": "names ideally with dashes 'typescript'"
|
|
8158
|
+
"comment": "names ideally with dashes 'typescript'",
|
|
8159
|
+
"tags": []
|
|
8094
8160
|
},
|
|
8095
8161
|
"signature": "(property) Task.name: string",
|
|
8096
8162
|
"name": "name",
|
|
@@ -8120,7 +8186,8 @@
|
|
|
8120
8186
|
"character": 3
|
|
8121
8187
|
},
|
|
8122
8188
|
"raw": "/**\n * description of what the task does.\n */",
|
|
8123
|
-
"comment": "description of what the task does."
|
|
8189
|
+
"comment": "description of what the task does.",
|
|
8190
|
+
"tags": []
|
|
8124
8191
|
},
|
|
8125
8192
|
"signature": "(property) Task.description?: string | undefined",
|
|
8126
8193
|
"name": "description",
|
|
@@ -8150,7 +8217,8 @@
|
|
|
8150
8217
|
"character": 3
|
|
8151
8218
|
},
|
|
8152
8219
|
"raw": "/**\n * execute a task in a build context\n */",
|
|
8153
|
-
"comment": "execute a task in a build context"
|
|
8220
|
+
"comment": "execute a task in a build context",
|
|
8221
|
+
"tags": []
|
|
8154
8222
|
},
|
|
8155
8223
|
"signature": "(method) Task.execute(context: BuildContext): Promise<BuiltTaskResult>",
|
|
8156
8224
|
"name": "execute",
|
|
@@ -8213,7 +8281,8 @@
|
|
|
8213
8281
|
"character": 3
|
|
8214
8282
|
},
|
|
8215
8283
|
"raw": "/**\n * run before the build pipeline has started. this is useful when some preparation are needed to\n * be done on all envs before the build starts.\n * e.g. typescript compiler needs to write the tsconfig file. doing it during the task, will\n * cause dependencies from other envs to get this tsconfig written.\n */",
|
|
8216
|
-
"comment": "run before the build pipeline has started. this is useful when some preparation are needed to\nbe done on all envs before the build starts.\ne.g. typescript compiler needs to write the tsconfig file. doing it during the task, will\ncause dependencies from other envs to get this tsconfig written."
|
|
8284
|
+
"comment": "run before the build pipeline has started. this is useful when some preparation are needed to\nbe done on all envs before the build starts.\ne.g. typescript compiler needs to write the tsconfig file. doing it during the task, will\ncause dependencies from other envs to get this tsconfig written.",
|
|
8285
|
+
"tags": []
|
|
8217
8286
|
},
|
|
8218
8287
|
"signature": "(method) Task.preBuild?(context: BuildContext): Promise<void>",
|
|
8219
8288
|
"name": "preBuild",
|
|
@@ -8276,7 +8345,8 @@
|
|
|
8276
8345
|
"character": 3
|
|
8277
8346
|
},
|
|
8278
8347
|
"raw": "/**\n * run after the build pipeline completed for all envs. useful for doing some cleanup on the\n * capsules before the deployment starts.\n */",
|
|
8279
|
-
"comment": "run after the build pipeline completed for all envs. useful for doing some cleanup on the\ncapsules before the deployment starts."
|
|
8348
|
+
"comment": "run after the build pipeline completed for all envs. useful for doing some cleanup on the\ncapsules before the deployment starts.",
|
|
8349
|
+
"tags": []
|
|
8280
8350
|
},
|
|
8281
8351
|
"signature": "(method) Task.postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>",
|
|
8282
8352
|
"name": "postBuild",
|
|
@@ -8359,7 +8429,8 @@
|
|
|
8359
8429
|
"character": 3
|
|
8360
8430
|
},
|
|
8361
8431
|
"raw": "/**\n * needed if you want the task to be running only after the dependencies were completed\n * for *all* envs.\n * normally this is not needed because the build-pipeline runs the tasks in the same order\n * they're located in the `getBuildPipe()` array and according to the task.location.\n * the case where this is useful is when a task not only needs to be after another task, but also\n * after all environments were running that task.\n * a dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use\n * \"aspectId:name\", e.g. \"teambit.compilation/compiler:TypescriptCompiler\".\n */",
|
|
8362
|
-
"comment": "needed if you want the task to be running only after the dependencies were completed\nfor *all* envs.\nnormally this is not needed because the build-pipeline runs the tasks in the same order\nthey're located in the `getBuildPipe()` array and according to the task.location.\nthe case where this is useful is when a task not only needs to be after another task, but also\nafter all environments were running that task.\na dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use\n\"aspectId:name\", e.g. \"teambit.compilation/compiler:TypescriptCompiler\"."
|
|
8432
|
+
"comment": "needed if you want the task to be running only after the dependencies were completed\nfor *all* envs.\nnormally this is not needed because the build-pipeline runs the tasks in the same order\nthey're located in the `getBuildPipe()` array and according to the task.location.\nthe case where this is useful is when a task not only needs to be after another task, but also\nafter all environments were running that task.\na dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use\n\"aspectId:name\", e.g. \"teambit.compilation/compiler:TypescriptCompiler\".",
|
|
8433
|
+
"tags": []
|
|
8363
8434
|
},
|
|
8364
8435
|
"signature": "(property) Task.dependencies?: string[] | undefined",
|
|
8365
8436
|
"name": "dependencies",
|
|
@@ -8576,7 +8647,8 @@
|
|
|
8576
8647
|
"character": 3
|
|
8577
8648
|
},
|
|
8578
8649
|
"raw": "/**\n * group errors from all tasks and show them nicely to the user\n */",
|
|
8579
|
-
"comment": "group errors from all tasks and show them nicely to the user"
|
|
8650
|
+
"comment": "group errors from all tasks and show them nicely to the user",
|
|
8651
|
+
"tags": []
|
|
8580
8652
|
},
|
|
8581
8653
|
"signature": "(method) TaskResultsList.getErrorMessageFormatted(): string | null",
|
|
8582
8654
|
"name": "getErrorMessageFormatted",
|
|
@@ -8731,7 +8803,8 @@
|
|
|
8731
8803
|
"character": 3
|
|
8732
8804
|
},
|
|
8733
8805
|
"raw": "/**\n * task itself. useful for getting its id/description later on.\n */",
|
|
8734
|
-
"comment": "task itself. useful for getting its id/description later on."
|
|
8806
|
+
"comment": "task itself. useful for getting its id/description later on.",
|
|
8807
|
+
"tags": []
|
|
8735
8808
|
},
|
|
8736
8809
|
"signature": "(property) task: BuildTask",
|
|
8737
8810
|
"name": "task",
|
|
@@ -8761,7 +8834,8 @@
|
|
|
8761
8834
|
"character": 3
|
|
8762
8835
|
},
|
|
8763
8836
|
"raw": "/**\n * environment were the task was running\n */",
|
|
8764
|
-
"comment": "environment were the task was running"
|
|
8837
|
+
"comment": "environment were the task was running",
|
|
8838
|
+
"tags": []
|
|
8765
8839
|
},
|
|
8766
8840
|
"signature": "(property) env: EnvDefinition",
|
|
8767
8841
|
"name": "env",
|
|
@@ -8795,7 +8869,8 @@
|
|
|
8795
8869
|
"character": 3
|
|
8796
8870
|
},
|
|
8797
8871
|
"raw": "/**\n * component build results.\n */",
|
|
8798
|
-
"comment": "component build results."
|
|
8872
|
+
"comment": "component build results.",
|
|
8873
|
+
"tags": []
|
|
8799
8874
|
},
|
|
8800
8875
|
"signature": "(property) componentsResults: ComponentResult[]",
|
|
8801
8876
|
"name": "componentsResults",
|
|
@@ -8833,7 +8908,8 @@
|
|
|
8833
8908
|
"character": 3
|
|
8834
8909
|
},
|
|
8835
8910
|
"raw": "/**\n * artifacts generated by the build pipeline.\n * in case the task finished with errors, this prop is undefined.\n */",
|
|
8836
|
-
"comment": "artifacts generated by the build pipeline.\nin case the task finished with errors, this prop is undefined."
|
|
8911
|
+
"comment": "artifacts generated by the build pipeline.\nin case the task finished with errors, this prop is undefined.",
|
|
8912
|
+
"tags": []
|
|
8837
8913
|
},
|
|
8838
8914
|
"signature": "(property) artifacts: ComponentMap<ArtifactList<FsArtifact>> | undefined",
|
|
8839
8915
|
"name": "artifacts",
|
|
@@ -8909,7 +8985,8 @@
|
|
|
8909
8985
|
"character": 3
|
|
8910
8986
|
},
|
|
8911
8987
|
"raw": "/**\n * timestamp of start initiation.\n */",
|
|
8912
|
-
"comment": "timestamp of start initiation."
|
|
8988
|
+
"comment": "timestamp of start initiation.",
|
|
8989
|
+
"tags": []
|
|
8913
8990
|
},
|
|
8914
8991
|
"signature": "(property) startTime: number",
|
|
8915
8992
|
"name": "startTime",
|
|
@@ -8939,7 +9016,8 @@
|
|
|
8939
9016
|
"character": 3
|
|
8940
9017
|
},
|
|
8941
9018
|
"raw": "/**\n * timestamp of task completion.\n */",
|
|
8942
|
-
"comment": "timestamp of task completion."
|
|
9019
|
+
"comment": "timestamp of task completion.",
|
|
9020
|
+
"tags": []
|
|
8943
9021
|
},
|
|
8944
9022
|
"signature": "(property) endTime: number",
|
|
8945
9023
|
"name": "endTime",
|
|
@@ -9166,7 +9244,8 @@
|
|
|
9166
9244
|
"character": 3
|
|
9167
9245
|
},
|
|
9168
9246
|
"raw": "/**\n * execute a pipeline of build tasks.\n */",
|
|
9169
|
-
"comment": "execute a pipeline of build tasks."
|
|
9247
|
+
"comment": "execute a pipeline of build tasks.",
|
|
9248
|
+
"tags": []
|
|
9170
9249
|
},
|
|
9171
9250
|
"signature": "(method) BuildPipe.execute(): Promise<TaskResultsList>",
|
|
9172
9251
|
"name": "execute",
|
|
@@ -9380,7 +9459,8 @@
|
|
|
9380
9459
|
"character": 3
|
|
9381
9460
|
},
|
|
9382
9461
|
"raw": "/**\n * instance of the component\n */",
|
|
9383
|
-
"comment": "instance of the component"
|
|
9462
|
+
"comment": "instance of the component",
|
|
9463
|
+
"tags": []
|
|
9384
9464
|
},
|
|
9385
9465
|
"signature": "(property) component: Component",
|
|
9386
9466
|
"name": "component",
|
|
@@ -9414,7 +9494,8 @@
|
|
|
9414
9494
|
"character": 3
|
|
9415
9495
|
},
|
|
9416
9496
|
"raw": "/**\n * metadata generated during component build.\n * this eventually gets saved into `aspectsData` prop of the builder aspect data.\n * it can be retrieved later on by `builder.getDataByAspect()` method.\n */",
|
|
9417
|
-
"comment": "metadata generated during component build.\nthis eventually gets saved into `aspectsData` prop of the builder aspect data.\nit can be retrieved later on by `builder.getDataByAspect()` method."
|
|
9497
|
+
"comment": "metadata generated during component build.\nthis eventually gets saved into `aspectsData` prop of the builder aspect data.\nit can be retrieved later on by `builder.getDataByAspect()` method.",
|
|
9498
|
+
"tags": []
|
|
9418
9499
|
},
|
|
9419
9500
|
"signature": "(property) metadata?: TaskMetadata | undefined",
|
|
9420
9501
|
"name": "metadata",
|
|
@@ -9444,7 +9525,8 @@
|
|
|
9444
9525
|
"character": 3
|
|
9445
9526
|
},
|
|
9446
9527
|
"raw": "/**\n * returning errors from build tasks will cause a pipeline failure and logs all returned errors.\n */",
|
|
9447
|
-
"comment": "returning errors from build tasks will cause a pipeline failure and logs all returned errors."
|
|
9528
|
+
"comment": "returning errors from build tasks will cause a pipeline failure and logs all returned errors.",
|
|
9529
|
+
"tags": []
|
|
9448
9530
|
},
|
|
9449
9531
|
"signature": "(property) errors?: (string | Error)[] | undefined",
|
|
9450
9532
|
"name": "errors",
|
|
@@ -9504,7 +9586,8 @@
|
|
|
9504
9586
|
"character": 3
|
|
9505
9587
|
},
|
|
9506
9588
|
"raw": "/**\n * warnings generated throughout the build task.\n */",
|
|
9507
|
-
"comment": "warnings generated throughout the build task."
|
|
9589
|
+
"comment": "warnings generated throughout the build task.",
|
|
9590
|
+
"tags": []
|
|
9508
9591
|
},
|
|
9509
9592
|
"signature": "(property) warnings?: string[] | undefined",
|
|
9510
9593
|
"name": "warnings",
|
|
@@ -9542,7 +9625,8 @@
|
|
|
9542
9625
|
"character": 3
|
|
9543
9626
|
},
|
|
9544
9627
|
"raw": "/**\n * timestamp in milliseconds when the task started\n */",
|
|
9545
|
-
"comment": "timestamp in milliseconds when the task started"
|
|
9628
|
+
"comment": "timestamp in milliseconds when the task started",
|
|
9629
|
+
"tags": []
|
|
9546
9630
|
},
|
|
9547
9631
|
"signature": "(property) startTime?: number | undefined",
|
|
9548
9632
|
"name": "startTime",
|
|
@@ -9572,7 +9656,8 @@
|
|
|
9572
9656
|
"character": 3
|
|
9573
9657
|
},
|
|
9574
9658
|
"raw": "/**\n * timestamp in milliseconds when the task ended\n */",
|
|
9575
|
-
"comment": "timestamp in milliseconds when the task ended"
|
|
9659
|
+
"comment": "timestamp in milliseconds when the task ended",
|
|
9660
|
+
"tags": []
|
|
9576
9661
|
},
|
|
9577
9662
|
"signature": "(property) endTime?: number | undefined",
|
|
9578
9663
|
"name": "endTime",
|
|
@@ -9706,7 +9791,8 @@
|
|
|
9706
9791
|
"character": 3
|
|
9707
9792
|
},
|
|
9708
9793
|
"raw": "/**\n * all components about to be built/tagged.\n */",
|
|
9709
|
-
"comment": "all components about to be built/tagged."
|
|
9794
|
+
"comment": "all components about to be built/tagged.",
|
|
9795
|
+
"tags": []
|
|
9710
9796
|
},
|
|
9711
9797
|
"signature": "(property) BuildContext.components: Component[]",
|
|
9712
9798
|
"name": "components",
|
|
@@ -9748,7 +9834,8 @@
|
|
|
9748
9834
|
"character": 3
|
|
9749
9835
|
},
|
|
9750
9836
|
"raw": "/**\n * network of capsules ready to be built.\n */",
|
|
9751
|
-
"comment": "network of capsules ready to be built."
|
|
9837
|
+
"comment": "network of capsules ready to be built.",
|
|
9838
|
+
"tags": []
|
|
9752
9839
|
},
|
|
9753
9840
|
"signature": "(property) BuildContext.capsuleNetwork: Network",
|
|
9754
9841
|
"name": "capsuleNetwork",
|
|
@@ -9782,7 +9869,8 @@
|
|
|
9782
9869
|
"character": 3
|
|
9783
9870
|
},
|
|
9784
9871
|
"raw": "/**\n * data generated by tasks that were running before this task\n */",
|
|
9785
|
-
"comment": "data generated by tasks that were running before this task"
|
|
9872
|
+
"comment": "data generated by tasks that were running before this task",
|
|
9873
|
+
"tags": []
|
|
9786
9874
|
},
|
|
9787
9875
|
"signature": "(property) BuildContext.previousTasksResults: TaskResults[]",
|
|
9788
9876
|
"name": "previousTasksResults",
|
|
@@ -9820,7 +9908,8 @@
|
|
|
9820
9908
|
"character": 3
|
|
9821
9909
|
},
|
|
9822
9910
|
"raw": "/**\n * Run the build pipeline in dev mode\n */",
|
|
9823
|
-
"comment": "Run the build pipeline in dev mode"
|
|
9911
|
+
"comment": "Run the build pipeline in dev mode",
|
|
9912
|
+
"tags": []
|
|
9824
9913
|
},
|
|
9825
9914
|
"signature": "(property) BuildContext.dev?: boolean | undefined",
|
|
9826
9915
|
"name": "dev",
|
|
@@ -9850,7 +9939,8 @@
|
|
|
9850
9939
|
"character": 3
|
|
9851
9940
|
},
|
|
9852
9941
|
"raw": "/**\n * pipe name such as \"build\", \"tas\", \"snap\".\n * an example usage is \"deploy\" task which is running in snap and tag pipeline and has different needs in each one.\n */",
|
|
9853
|
-
"comment": "pipe name such as \"build\", \"tas\", \"snap\".\nan example usage is \"deploy\" task which is running in snap and tag pipeline and has different needs in each one."
|
|
9942
|
+
"comment": "pipe name such as \"build\", \"tas\", \"snap\".\nan example usage is \"deploy\" task which is running in snap and tag pipeline and has different needs in each one.",
|
|
9943
|
+
"tags": []
|
|
9854
9944
|
},
|
|
9855
9945
|
"signature": "(property) BuildContext.pipeName: PipeName",
|
|
9856
9946
|
"name": "pipeName",
|
|
@@ -9880,7 +9970,8 @@
|
|
|
9880
9970
|
"character": 3
|
|
9881
9971
|
},
|
|
9882
9972
|
"raw": "/**\n * current lane-id if exists. empty when on main.\n */",
|
|
9883
|
-
"comment": "current lane-id if exists. empty when on main."
|
|
9973
|
+
"comment": "current lane-id if exists. empty when on main.",
|
|
9974
|
+
"tags": []
|
|
9884
9975
|
},
|
|
9885
9976
|
"signature": "(property) BuildContext.laneId?: LaneId | undefined",
|
|
9886
9977
|
"name": "laneId",
|
|
@@ -9923,7 +10014,7 @@
|
|
|
9923
10014
|
"_legacy": {
|
|
9924
10015
|
"scope": "teambit.pipelines",
|
|
9925
10016
|
"name": "builder",
|
|
9926
|
-
"version": "1.0.
|
|
10017
|
+
"version": "1.0.311"
|
|
9927
10018
|
},
|
|
9928
10019
|
"_scope": "teambit.pipelines"
|
|
9929
10020
|
}
|
|
@@ -10029,7 +10120,8 @@
|
|
|
10029
10120
|
"character": 3
|
|
10030
10121
|
},
|
|
10031
10122
|
"raw": "/**\n * aspect id serialized of the creator of the task.\n * todo: automate this so then it won't be needed to pass manually.\n */",
|
|
10032
|
-
"comment": "aspect id serialized of the creator of the task.\ntodo: automate this so then it won't be needed to pass manually."
|
|
10123
|
+
"comment": "aspect id serialized of the creator of the task.\ntodo: automate this so then it won't be needed to pass manually.",
|
|
10124
|
+
"tags": []
|
|
10033
10125
|
},
|
|
10034
10126
|
"signature": "(property) BuildTask.aspectId: string",
|
|
10035
10127
|
"name": "aspectId",
|
|
@@ -10059,7 +10151,8 @@
|
|
|
10059
10151
|
"character": 3
|
|
10060
10152
|
},
|
|
10061
10153
|
"raw": "/**\n * name of the task. function as an identifier among other tasks of the same aspectId.\n * spaces and special characters are not allowed. as a convention, use UpperCamelCase style.\n * (e.g. TypescriptCompiler).\n */",
|
|
10062
|
-
"comment": "name of the task. function as an identifier among other tasks of the same aspectId.\nspaces and special characters are not allowed. as a convention, use UpperCamelCase style.\n(e.g. TypescriptCompiler)."
|
|
10154
|
+
"comment": "name of the task. function as an identifier among other tasks of the same aspectId.\nspaces and special characters are not allowed. as a convention, use UpperCamelCase style.\n(e.g. TypescriptCompiler).",
|
|
10155
|
+
"tags": []
|
|
10063
10156
|
},
|
|
10064
10157
|
"signature": "(property) BuildTask.name: string",
|
|
10065
10158
|
"name": "name",
|
|
@@ -10089,7 +10182,8 @@
|
|
|
10089
10182
|
"character": 3
|
|
10090
10183
|
},
|
|
10091
10184
|
"raw": "/**\n * description of what the task does.\n * if available, the logger will log it show it in the status-line.\n */",
|
|
10092
|
-
"comment": "description of what the task does.\nif available, the logger will log it show it in the status-line."
|
|
10185
|
+
"comment": "description of what the task does.\nif available, the logger will log it show it in the status-line.",
|
|
10186
|
+
"tags": []
|
|
10093
10187
|
},
|
|
10094
10188
|
"signature": "(property) BuildTask.description?: string | undefined",
|
|
10095
10189
|
"name": "description",
|
|
@@ -10119,7 +10213,8 @@
|
|
|
10119
10213
|
"character": 3
|
|
10120
10214
|
},
|
|
10121
10215
|
"raw": "/**\n * where to put the task, before the env pipeline or after\n */",
|
|
10122
|
-
"comment": "where to put the task, before the env pipeline or after"
|
|
10216
|
+
"comment": "where to put the task, before the env pipeline or after",
|
|
10217
|
+
"tags": []
|
|
10123
10218
|
},
|
|
10124
10219
|
"signature": "(property) BuildTask.location?: TaskLocation | undefined",
|
|
10125
10220
|
"name": "location",
|
|
@@ -10149,7 +10244,8 @@
|
|
|
10149
10244
|
"character": 3
|
|
10150
10245
|
},
|
|
10151
10246
|
"raw": "/**\n * execute a task in a build context\n */",
|
|
10152
|
-
"comment": "execute a task in a build context"
|
|
10247
|
+
"comment": "execute a task in a build context",
|
|
10248
|
+
"tags": []
|
|
10153
10249
|
},
|
|
10154
10250
|
"signature": "(method) BuildTask.execute(context: BuildContext): Promise<BuiltTaskResult>",
|
|
10155
10251
|
"name": "execute",
|
|
@@ -10212,7 +10308,8 @@
|
|
|
10212
10308
|
"character": 3
|
|
10213
10309
|
},
|
|
10214
10310
|
"raw": "/**\n * run before the build pipeline has started. this is useful when some preparation are needed to\n * be done on all envs before the build starts.\n * e.g. typescript compiler needs to write the tsconfig file. doing it during the task, will\n * cause dependencies from other envs to get this tsconfig written.\n */",
|
|
10215
|
-
"comment": "run before the build pipeline has started. this is useful when some preparation are needed to\nbe done on all envs before the build starts.\ne.g. typescript compiler needs to write the tsconfig file. doing it during the task, will\ncause dependencies from other envs to get this tsconfig written."
|
|
10311
|
+
"comment": "run before the build pipeline has started. this is useful when some preparation are needed to\nbe done on all envs before the build starts.\ne.g. typescript compiler needs to write the tsconfig file. doing it during the task, will\ncause dependencies from other envs to get this tsconfig written.",
|
|
10312
|
+
"tags": []
|
|
10216
10313
|
},
|
|
10217
10314
|
"signature": "(method) BuildTask.preBuild?(context: BuildContext): Promise<void>",
|
|
10218
10315
|
"name": "preBuild",
|
|
@@ -10275,7 +10372,8 @@
|
|
|
10275
10372
|
"character": 3
|
|
10276
10373
|
},
|
|
10277
10374
|
"raw": "/**\n * run after the build pipeline completed for all envs. useful for doing some cleanup on the\n * capsules before the deployment starts.\n */",
|
|
10278
|
-
"comment": "run after the build pipeline completed for all envs. useful for doing some cleanup on the\ncapsules before the deployment starts."
|
|
10375
|
+
"comment": "run after the build pipeline completed for all envs. useful for doing some cleanup on the\ncapsules before the deployment starts.",
|
|
10376
|
+
"tags": []
|
|
10279
10377
|
},
|
|
10280
10378
|
"signature": "(method) BuildTask.postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>",
|
|
10281
10379
|
"name": "postBuild",
|
|
@@ -10358,7 +10456,8 @@
|
|
|
10358
10456
|
"character": 3
|
|
10359
10457
|
},
|
|
10360
10458
|
"raw": "/**\n * needed if you want the task to be running only after the dependencies were completed\n * for *all* envs.\n * normally this is not needed because the build-pipeline runs the tasks in the same order\n * they're located in the `getBuildPipe()` array and according to the task.location.\n * the case where this is useful is when a task not only needs to be after another task, but also\n * after all environments were running that task.\n * a dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use\n * \"aspectId:name\", e.g. \"teambit.compilation/compiler:TypescriptCompiler\".\n */",
|
|
10361
|
-
"comment": "needed if you want the task to be running only after the dependencies were completed\nfor *all* envs.\nnormally this is not needed because the build-pipeline runs the tasks in the same order\nthey're located in the `getBuildPipe()` array and according to the task.location.\nthe case where this is useful is when a task not only needs to be after another task, but also\nafter all environments were running that task.\na dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use\n\"aspectId:name\", e.g. \"teambit.compilation/compiler:TypescriptCompiler\"."
|
|
10459
|
+
"comment": "needed if you want the task to be running only after the dependencies were completed\nfor *all* envs.\nnormally this is not needed because the build-pipeline runs the tasks in the same order\nthey're located in the `getBuildPipe()` array and according to the task.location.\nthe case where this is useful is when a task not only needs to be after another task, but also\nafter all environments were running that task.\na dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use\n\"aspectId:name\", e.g. \"teambit.compilation/compiler:TypescriptCompiler\".",
|
|
10460
|
+
"tags": []
|
|
10362
10461
|
},
|
|
10363
10462
|
"signature": "(property) BuildTask.dependencies?: string[] | undefined",
|
|
10364
10463
|
"name": "dependencies",
|
|
@@ -10409,7 +10508,8 @@
|
|
|
10409
10508
|
"character": 3
|
|
10410
10509
|
},
|
|
10411
10510
|
"raw": "/**\n * build results for each of the components in the build context.\n */",
|
|
10412
|
-
"comment": "build results for each of the components in the build context."
|
|
10511
|
+
"comment": "build results for each of the components in the build context.",
|
|
10512
|
+
"tags": []
|
|
10413
10513
|
},
|
|
10414
10514
|
"signature": "(property) BuiltTaskResult.componentsResults: ComponentResult[]",
|
|
10415
10515
|
"name": "componentsResults",
|
|
@@ -10447,7 +10547,8 @@
|
|
|
10447
10547
|
"character": 3
|
|
10448
10548
|
},
|
|
10449
10549
|
"raw": "/**\n * array of artifact definitions to generate after a successful build.\n */",
|
|
10450
|
-
"comment": "array of artifact definitions to generate after a successful build."
|
|
10550
|
+
"comment": "array of artifact definitions to generate after a successful build.",
|
|
10551
|
+
"tags": []
|
|
10451
10552
|
},
|
|
10452
10553
|
"signature": "(property) BuiltTaskResult.artifacts?: ArtifactDefinition[] | undefined",
|
|
10453
10554
|
"name": "artifacts",
|
|
@@ -10710,7 +10811,8 @@
|
|
|
10710
10811
|
"character": 3
|
|
10711
10812
|
},
|
|
10712
10813
|
"raw": "/**\n * don't throw an error when the id includes only the aspect-id without the task name.\n * useful for task dependencies, when it's allowed to specify the aspect-id only.\n */",
|
|
10713
|
-
"comment": "don't throw an error when the id includes only the aspect-id without the task name.\nuseful for task dependencies, when it's allowed to specify the aspect-id only."
|
|
10814
|
+
"comment": "don't throw an error when the id includes only the aspect-id without the task name.\nuseful for task dependencies, when it's allowed to specify the aspect-id only.",
|
|
10815
|
+
"tags": []
|
|
10714
10816
|
},
|
|
10715
10817
|
"signature": "(method) BuildTaskHelper.deserializeIdAllowEmptyName(id: string): {\n aspectId: string;\n name?: string;\n}",
|
|
10716
10818
|
"name": "deserializeIdAllowEmptyName",
|
|
@@ -11099,7 +11201,8 @@
|
|
|
11099
11201
|
"character": 1
|
|
11100
11202
|
},
|
|
11101
11203
|
"raw": "/**\n * builder data format for the bit object store\n */",
|
|
11102
|
-
"comment": "builder data format for the bit object store"
|
|
11204
|
+
"comment": "builder data format for the bit object store",
|
|
11205
|
+
"tags": []
|
|
11103
11206
|
},
|
|
11104
11207
|
"signature": "type RawBuilderData = {\n pipeline: PipelineReport[];\n artifacts?: ArtifactObject[] | undefined;\n aspectsData: AspectData[];\n bitVersion?: string | undefined;\n}",
|
|
11105
11208
|
"name": "RawBuilderData",
|
|
@@ -11235,7 +11338,8 @@
|
|
|
11235
11338
|
"character": 1
|
|
11236
11339
|
},
|
|
11237
11340
|
"raw": "/**\n * builder data mapped to an ArtifactList instance\n */",
|
|
11238
|
-
"comment": "builder data mapped to an ArtifactList instance"
|
|
11341
|
+
"comment": "builder data mapped to an ArtifactList instance",
|
|
11342
|
+
"tags": []
|
|
11239
11343
|
},
|
|
11240
11344
|
"signature": "type BuilderData = Omit<RawBuilderData, \"artifacts\"> & {\n artifacts: ArtifactList<Artifact>;\n}",
|
|
11241
11345
|
"name": "BuilderData",
|
|
@@ -11918,7 +12022,8 @@
|
|
|
11918
12022
|
"character": 3
|
|
11919
12023
|
},
|
|
11920
12024
|
"raw": "/**\n * remove the onlyOverview from the preview data of the component if\n * the env is in the workspace\n * the env is not tagged with the component\n * the last tagged env has onlyOverview undefined in preview data\n *\n * We don't want to do this but have no choice because,\n * when we load components in workspace,\n * we set the onlyOverview to true in the env's preview data\n * which sets the onlyOverview to true in the component's preview data\n * but if you don't tag the env with the component,\n * the onlyOverview will be true in the component's preview data, since its env is in the workspace\n * even though the env it is tagged with doesn't have onlyOverview in its preview data\n * which will result in inconsistent preview data when exported to the scope\n */",
|
|
11921
|
-
"comment": "remove the onlyOverview from the preview data of the component if\nthe env is in the workspace\nthe env is not tagged with the component\nthe last tagged env has onlyOverview undefined in preview data\n\nWe don't want to do this but have no choice because,\nwhen we load components in workspace,\nwe set the onlyOverview to true in the env's preview data\nwhich sets the onlyOverview to true in the component's preview data\nbut if you don't tag the env with the component,\nthe onlyOverview will be true in the component's preview data, since its env is in the workspace\neven though the env it is tagged with doesn't have onlyOverview in its preview data\nwhich will result in inconsistent preview data when exported to the scope"
|
|
12025
|
+
"comment": "remove the onlyOverview from the preview data of the component if\nthe env is in the workspace\nthe env is not tagged with the component\nthe last tagged env has onlyOverview undefined in preview data\n\nWe don't want to do this but have no choice because,\nwhen we load components in workspace,\nwe set the onlyOverview to true in the env's preview data\nwhich sets the onlyOverview to true in the component's preview data\nbut if you don't tag the env with the component,\nthe onlyOverview will be true in the component's preview data, since its env is in the workspace\neven though the env it is tagged with doesn't have onlyOverview in its preview data\nwhich will result in inconsistent preview data when exported to the scope",
|
|
12026
|
+
"tags": []
|
|
11922
12027
|
},
|
|
11923
12028
|
"signature": "(method) BuilderMain.sanitizePreviewData(harmonyComps: Component[]): Promise<void>",
|
|
11924
12029
|
"name": "sanitizePreviewData",
|
|
@@ -12636,7 +12741,8 @@
|
|
|
12636
12741
|
"character": 3
|
|
12637
12742
|
},
|
|
12638
12743
|
"raw": "/**\n * this is the aspect's data that was generated as \"metadata\" of the task component-result during the build process\n * and saved by the builder aspect in the \"aspectsData\" property.\n * (not to be confused with the data saved in the aspect itself, which is saved in the \"data\" property of the aspect).\n */",
|
|
12639
|
-
"comment": "this is the aspect's data that was generated as \"metadata\" of the task component-result during the build process\nand saved by the builder aspect in the \"aspectsData\" property.\n(not to be confused with the data saved in the aspect itself, which is saved in the \"data\" property of the aspect)."
|
|
12744
|
+
"comment": "this is the aspect's data that was generated as \"metadata\" of the task component-result during the build process\nand saved by the builder aspect in the \"aspectsData\" property.\n(not to be confused with the data saved in the aspect itself, which is saved in the \"data\" property of the aspect).",
|
|
12745
|
+
"tags": []
|
|
12640
12746
|
},
|
|
12641
12747
|
"signature": "(method) BuilderMain.getDataByAspect(component: IComponent, aspectName: string): TaskMetadata | undefined",
|
|
12642
12748
|
"name": "getDataByAspect",
|
|
@@ -13248,7 +13354,8 @@
|
|
|
13248
13354
|
"character": 3
|
|
13249
13355
|
},
|
|
13250
13356
|
"raw": "/**\n * register a build task to apply on all component build pipelines.\n * build happens on `bit build` and as part of `bit tag --persist`.\n */",
|
|
13251
|
-
"comment": "register a build task to apply on all component build pipelines.\nbuild happens on `bit build` and as part of `bit tag --persist`."
|
|
13357
|
+
"comment": "register a build task to apply on all component build pipelines.\nbuild happens on `bit build` and as part of `bit tag --persist`.",
|
|
13358
|
+
"tags": []
|
|
13252
13359
|
},
|
|
13253
13360
|
"signature": "(method) BuilderMain.registerBuildTasks(tasks: BuildTask[]): this",
|
|
13254
13361
|
"name": "registerBuildTasks",
|
|
@@ -13308,6 +13415,7 @@
|
|
|
13308
13415
|
"character": 3
|
|
13309
13416
|
},
|
|
13310
13417
|
"raw": "/**\n * @deprecated use registerTagTasks or registerSnapTasks\n */",
|
|
13418
|
+
"comment": "",
|
|
13311
13419
|
"tags": [
|
|
13312
13420
|
{
|
|
13313
13421
|
"__schema": "TagSchema",
|
|
@@ -13379,7 +13487,8 @@
|
|
|
13379
13487
|
"character": 3
|
|
13380
13488
|
},
|
|
13381
13489
|
"raw": "/**\n * tag tasks that don't get executed on `bit build`, only on `bit tag'.\n * this pipeline is running once the build-pipeline has completed.\n */",
|
|
13382
|
-
"comment": "tag tasks that don't get executed on `bit build`, only on `bit tag'.\nthis pipeline is running once the build-pipeline has completed."
|
|
13490
|
+
"comment": "tag tasks that don't get executed on `bit build`, only on `bit tag'.\nthis pipeline is running once the build-pipeline has completed.",
|
|
13491
|
+
"tags": []
|
|
13383
13492
|
},
|
|
13384
13493
|
"signature": "(method) BuilderMain.registerTagTasks(tasks: BuildTask[]): this",
|
|
13385
13494
|
"name": "registerTagTasks",
|
|
@@ -13439,7 +13548,8 @@
|
|
|
13439
13548
|
"character": 3
|
|
13440
13549
|
},
|
|
13441
13550
|
"raw": "/**\n * tag tasks that don't get executed on `bit build`, only on `bit snap'.\n * this pipeline is running once the build-pipeline has completed.\n */",
|
|
13442
|
-
"comment": "tag tasks that don't get executed on `bit build`, only on `bit snap'.\nthis pipeline is running once the build-pipeline has completed."
|
|
13551
|
+
"comment": "tag tasks that don't get executed on `bit build`, only on `bit snap'.\nthis pipeline is running once the build-pipeline has completed.",
|
|
13552
|
+
"tags": []
|
|
13443
13553
|
},
|
|
13444
13554
|
"signature": "(method) BuilderMain.registerSnapTasks(tasks: BuildTask[]): this",
|
|
13445
13555
|
"name": "registerSnapTasks",
|
|
@@ -14022,7 +14132,8 @@
|
|
|
14022
14132
|
"character": 1
|
|
14023
14133
|
},
|
|
14024
14134
|
"raw": "/**\n * create and maintain build pipelines for component\n * dev environments.\n */",
|
|
14025
|
-
"comment": "create and maintain build pipelines for component\ndev environments."
|
|
14135
|
+
"comment": "create and maintain build pipelines for component\ndev environments.",
|
|
14136
|
+
"tags": []
|
|
14026
14137
|
},
|
|
14027
14138
|
"signature": "class Pipeline",
|
|
14028
14139
|
"name": "Pipeline",
|
|
@@ -14111,7 +14222,8 @@
|
|
|
14111
14222
|
"character": 3
|
|
14112
14223
|
},
|
|
14113
14224
|
"raw": "/**\n * add a build task to the pipeline.\n */",
|
|
14114
|
-
"comment": "add a build task to the pipeline."
|
|
14225
|
+
"comment": "add a build task to the pipeline.",
|
|
14226
|
+
"tags": []
|
|
14115
14227
|
},
|
|
14116
14228
|
"signature": "(method) Pipeline.add(tasks: TaskHandler[]): this",
|
|
14117
14229
|
"name": "add",
|
|
@@ -14171,7 +14283,8 @@
|
|
|
14171
14283
|
"character": 3
|
|
14172
14284
|
},
|
|
14173
14285
|
"raw": "/**\n * remove a build task from the pipeline.\n */",
|
|
14174
|
-
"comment": "remove a build task from the pipeline."
|
|
14286
|
+
"comment": "remove a build task from the pipeline.",
|
|
14287
|
+
"tags": []
|
|
14175
14288
|
},
|
|
14176
14289
|
"signature": "(method) Pipeline.remove(taskNames: string[]): this",
|
|
14177
14290
|
"name": "remove",
|
|
@@ -14231,7 +14344,8 @@
|
|
|
14231
14344
|
"character": 3
|
|
14232
14345
|
},
|
|
14233
14346
|
"raw": "/**\n * replace a build task in the pipeline.\n */",
|
|
14234
|
-
"comment": "replace a build task in the pipeline."
|
|
14347
|
+
"comment": "replace a build task in the pipeline.",
|
|
14348
|
+
"tags": []
|
|
14235
14349
|
},
|
|
14236
14350
|
"signature": "(method) Pipeline.replace(tasks: TaskHandler[]): this",
|
|
14237
14351
|
"name": "replace",
|
|
@@ -14364,7 +14478,8 @@
|
|
|
14364
14478
|
"character": 3
|
|
14365
14479
|
},
|
|
14366
14480
|
"raw": "/**\n * compute the pipeline.\n */",
|
|
14367
|
-
"comment": "compute the pipeline."
|
|
14481
|
+
"comment": "compute the pipeline.",
|
|
14482
|
+
"tags": []
|
|
14368
14483
|
},
|
|
14369
14484
|
"signature": "(method) Pipeline.compute(context: EnvContext): BuildTask[]",
|
|
14370
14485
|
"name": "compute",
|
|
@@ -14562,7 +14677,8 @@
|
|
|
14562
14677
|
"character": 3
|
|
14563
14678
|
},
|
|
14564
14679
|
"raw": "/**\n * store artifacts in the storage.\n */",
|
|
14565
|
-
"comment": "store artifacts in the storage."
|
|
14680
|
+
"comment": "store artifacts in the storage.",
|
|
14681
|
+
"tags": []
|
|
14566
14682
|
},
|
|
14567
14683
|
"signature": "(method) WholeArtifactStorageResolver.store(component: Component, artifact: FsArtifact): Promise<StoreResult | undefined | void>",
|
|
14568
14684
|
"name": "store",
|
|
@@ -14713,7 +14829,8 @@
|
|
|
14713
14829
|
"character": 3
|
|
14714
14830
|
},
|
|
14715
14831
|
"raw": "/**\n * name of the storage resolver.\n */",
|
|
14716
|
-
"comment": "name of the storage resolver."
|
|
14832
|
+
"comment": "name of the storage resolver.",
|
|
14833
|
+
"tags": []
|
|
14717
14834
|
}
|
|
14718
14835
|
}
|
|
14719
14836
|
]
|
|
@@ -14746,7 +14863,8 @@
|
|
|
14746
14863
|
"character": 3
|
|
14747
14864
|
},
|
|
14748
14865
|
"raw": "/**\n * store artifacts in the storage.\n */",
|
|
14749
|
-
"comment": "store artifacts in the storage."
|
|
14866
|
+
"comment": "store artifacts in the storage.",
|
|
14867
|
+
"tags": []
|
|
14750
14868
|
},
|
|
14751
14869
|
"signature": "(method) FileStorageResolver.storeFile(component: Component, artifact: FsArtifact, file: ArtifactVinyl): Promise<string | undefined | void>",
|
|
14752
14870
|
"name": "storeFile",
|
|
@@ -14917,7 +15035,8 @@
|
|
|
14917
15035
|
"character": 3
|
|
14918
15036
|
},
|
|
14919
15037
|
"raw": "/**\n * name of the storage resolver.\n */",
|
|
14920
|
-
"comment": "name of the storage resolver."
|
|
15038
|
+
"comment": "name of the storage resolver.",
|
|
15039
|
+
"tags": []
|
|
14921
15040
|
}
|
|
14922
15041
|
}
|
|
14923
15042
|
]
|
|
@@ -14990,7 +15109,8 @@
|
|
|
14990
15109
|
"character": 3
|
|
14991
15110
|
},
|
|
14992
15111
|
"raw": "/**\n * name of the storage resolver.\n */",
|
|
14993
|
-
"comment": "name of the storage resolver."
|
|
15112
|
+
"comment": "name of the storage resolver.",
|
|
15113
|
+
"tags": []
|
|
14994
15114
|
},
|
|
14995
15115
|
"signature": "(property) BaseStorageResolver.name: string",
|
|
14996
15116
|
"name": "name",
|
|
@@ -15302,7 +15422,8 @@
|
|
|
15302
15422
|
"character": 3
|
|
15303
15423
|
},
|
|
15304
15424
|
"raw": "/**\n * archive all artifact files into a tar.\n */",
|
|
15305
|
-
"comment": "archive all artifact files into a tar."
|
|
15425
|
+
"comment": "archive all artifact files into a tar.",
|
|
15426
|
+
"tags": []
|
|
15306
15427
|
},
|
|
15307
15428
|
"signature": "(method) Artifact.tar(): void",
|
|
15308
15429
|
"name": "tar",
|
|
@@ -15750,7 +15871,8 @@
|
|
|
15750
15871
|
"character": 3
|
|
15751
15872
|
},
|
|
15752
15873
|
"raw": "/**\n * generate artifacts from a build context according to the spec defined in the artifact definitions.\n */",
|
|
15753
|
-
"comment": "generate artifacts from a build context according to the spec defined in the artifact definitions."
|
|
15874
|
+
"comment": "generate artifacts from a build context according to the spec defined in the artifact definitions.",
|
|
15875
|
+
"tags": []
|
|
15754
15876
|
},
|
|
15755
15877
|
"signature": "(method) ArtifactFactory.generate(context: BuildContext, defs: ArtifactDefinition[], task: BuildTask): ComponentMap<ArtifactList<FsArtifact>>",
|
|
15756
15878
|
"name": "generate",
|
|
@@ -16113,7 +16235,8 @@
|
|
|
16113
16235
|
"character": 3
|
|
16114
16236
|
},
|
|
16115
16237
|
"raw": "/**\n * find by the artifact name. it's possible to have multiple artifacts with the same name, in which case it returns the first.\n */",
|
|
16116
|
-
"comment": "find by the artifact name. it's possible to have multiple artifacts with the same name, in which case it returns the first."
|
|
16238
|
+
"comment": "find by the artifact name. it's possible to have multiple artifacts with the same name, in which case it returns the first.",
|
|
16239
|
+
"tags": []
|
|
16117
16240
|
},
|
|
16118
16241
|
"signature": "(method) ArtifactList<T extends Artifact>.findByName(name: string): Artifact | undefined",
|
|
16119
16242
|
"name": "findByName",
|
|
@@ -16184,7 +16307,8 @@
|
|
|
16184
16307
|
"character": 3
|
|
16185
16308
|
},
|
|
16186
16309
|
"raw": "/**\n * find by the task name. it's possible to have multiple tasks with the same name (different aspects), in which case it returns the first.\n */",
|
|
16187
|
-
"comment": "find by the task name. it's possible to have multiple tasks with the same name (different aspects), in which case it returns the first."
|
|
16310
|
+
"comment": "find by the task name. it's possible to have multiple tasks with the same name (different aspects), in which case it returns the first.",
|
|
16311
|
+
"tags": []
|
|
16188
16312
|
},
|
|
16189
16313
|
"signature": "(method) ArtifactList<T extends Artifact>.findByTaskName(name: string): Artifact | undefined",
|
|
16190
16314
|
"name": "findByTaskName",
|
|
@@ -16276,7 +16400,8 @@
|
|
|
16276
16400
|
"character": 3
|
|
16277
16401
|
},
|
|
16278
16402
|
"raw": "/**\n * group artifacts by the storage resolver.\n */",
|
|
16279
|
-
"comment": "group artifacts by the storage resolver."
|
|
16403
|
+
"comment": "group artifacts by the storage resolver.",
|
|
16404
|
+
"tags": []
|
|
16280
16405
|
},
|
|
16281
16406
|
"signature": "(method) ArtifactList<T extends Artifact>.groupByResolver(): ResolverMap<T>",
|
|
16282
16407
|
"name": "groupByResolver",
|
|
@@ -16460,7 +16585,8 @@
|
|
|
16460
16585
|
"character": 3
|
|
16461
16586
|
},
|
|
16462
16587
|
"raw": "/**\n * store all artifacts using the configured storage resolvers.\n */",
|
|
16463
|
-
"comment": "store all artifacts using the configured storage resolvers."
|
|
16588
|
+
"comment": "store all artifacts using the configured storage resolvers.",
|
|
16589
|
+
"tags": []
|
|
16464
16590
|
},
|
|
16465
16591
|
"signature": "(method) ArtifactList<T extends Artifact>.store(component: Component): Promise<void[]>",
|
|
16466
16592
|
"name": "store",
|
|
@@ -16658,7 +16784,7 @@
|
|
|
16658
16784
|
"_legacy": {
|
|
16659
16785
|
"scope": "teambit.pipelines",
|
|
16660
16786
|
"name": "builder",
|
|
16661
|
-
"version": "1.0.
|
|
16787
|
+
"version": "1.0.311"
|
|
16662
16788
|
},
|
|
16663
16789
|
"_scope": "teambit.pipelines"
|
|
16664
16790
|
}
|
|
@@ -16860,7 +16986,8 @@
|
|
|
16860
16986
|
"character": 3
|
|
16861
16987
|
},
|
|
16862
16988
|
"raw": "/**\n * group errors from all tasks and show them nicely to the user\n */",
|
|
16863
|
-
"comment": "group errors from all tasks and show them nicely to the user"
|
|
16989
|
+
"comment": "group errors from all tasks and show them nicely to the user",
|
|
16990
|
+
"tags": []
|
|
16864
16991
|
},
|
|
16865
16992
|
"signature": "(method) TaskResultsList.getErrorMessageFormatted(): string | null",
|
|
16866
16993
|
"name": "getErrorMessageFormatted",
|
|
@@ -16943,7 +17070,7 @@
|
|
|
16943
17070
|
"componentId": {
|
|
16944
17071
|
"scope": "teambit.pipelines",
|
|
16945
17072
|
"name": "builder",
|
|
16946
|
-
"version": "1.0.
|
|
17073
|
+
"version": "1.0.311"
|
|
16947
17074
|
},
|
|
16948
17075
|
"taggedModuleExports": []
|
|
16949
17076
|
}
|