@teambit/generator 1.0.311 → 1.0.312

Sign up to get free protection for your applications and to get access to all the features.
@@ -368,7 +368,8 @@
368
368
  "character": 3
369
369
  },
370
370
  "raw": "/**\n * register a new component template.\n */",
371
- "comment": "register a new component template."
371
+ "comment": "register a new component template.",
372
+ "tags": []
372
373
  },
373
374
  "signature": "(method) GeneratorMain.registerComponentTemplate(templates: ComponentTemplate[]): this",
374
375
  "name": "registerComponentTemplate",
@@ -428,7 +429,8 @@
428
429
  "character": 3
429
430
  },
430
431
  "raw": "/**\n * register a new workspace starter.\n */",
431
- "comment": "register a new workspace starter."
432
+ "comment": "register a new workspace starter.",
433
+ "tags": []
432
434
  },
433
435
  "signature": "(method) GeneratorMain.registerWorkspaceTemplate(templates: WorkspaceTemplate[]): this",
434
436
  "name": "registerWorkspaceTemplate",
@@ -531,7 +533,8 @@
531
533
  "character": 3
532
534
  },
533
535
  "raw": "/**\n * list all component templates registered in the workspace or workspace templates in case the\n * workspace is not available\n */",
534
- "comment": "list all component templates registered in the workspace or workspace templates in case the\nworkspace is not available"
536
+ "comment": "list all component templates registered in the workspace or workspace templates in case the\nworkspace is not available",
537
+ "tags": []
535
538
  },
536
539
  "signature": "(method) GeneratorMain.listTemplates({ aspect }?: {\n aspect?: string;\n}): Promise<TemplateDescriptor[]>",
537
540
  "name": "listTemplates",
@@ -649,6 +652,7 @@
649
652
  "character": 3
650
653
  },
651
654
  "raw": "/**\n * @deprecated use this.listTemplates()\n */",
655
+ "comment": "",
652
656
  "tags": [
653
657
  {
654
658
  "__schema": "TagSchema",
@@ -776,7 +780,8 @@
776
780
  "character": 3
777
781
  },
778
782
  "raw": "/**\n * get all component templates registered by a specific aspect ID.\n */",
779
- "comment": "get all component templates registered by a specific aspect ID."
783
+ "comment": "get all component templates registered by a specific aspect ID.",
784
+ "tags": []
780
785
  },
781
786
  "signature": "(method) GeneratorMain.getComponentTemplateByAspect(aspectId: string): ComponentTemplate[]",
782
787
  "name": "getComponentTemplateByAspect",
@@ -836,7 +841,8 @@
836
841
  "character": 3
837
842
  },
838
843
  "raw": "/**\n * returns a specific component template.\n */",
839
- "comment": "returns a specific component template."
844
+ "comment": "returns a specific component template.",
845
+ "tags": []
840
846
  },
841
847
  "signature": "(method) GeneratorMain.getComponentTemplate(name: string, aspectId?: string): Promise<ComponentTemplateWithId | undefined>",
842
848
  "name": "getComponentTemplate",
@@ -941,7 +947,8 @@
941
947
  "character": 3
942
948
  },
943
949
  "raw": "/**\n * in the case the aspect-id is given and this aspect doesn't exist locally, import it to the\n * global scope and load it from the capsule\n */",
944
- "comment": "in the case the aspect-id is given and this aspect doesn't exist locally, import it to the\nglobal scope and load it from the capsule"
950
+ "comment": "in the case the aspect-id is given and this aspect doesn't exist locally, import it to the\nglobal scope and load it from the capsule",
951
+ "tags": []
945
952
  },
946
953
  "signature": "(method) GeneratorMain.findWorkspaceTemplateInGlobalScope(aspectId: string, name?: string): Promise<{\n workspaceTemplate?: WorkspaceTemplate | undefined;\n aspect?: Component | undefined;\n}>",
947
954
  "name": "findWorkspaceTemplateInGlobalScope",
@@ -1155,7 +1162,8 @@
1155
1162
  "character": 3
1156
1163
  },
1157
1164
  "raw": "/**\n * returns a specific workspace template.\n */",
1158
- "comment": "returns a specific workspace template."
1165
+ "comment": "returns a specific workspace template.",
1166
+ "tags": []
1159
1167
  },
1160
1168
  "signature": "(method) GeneratorMain.getWorkspaceTemplate(name: string, aspectId?: string): Promise<{\n workspaceTemplate: WorkspaceTemplate;\n aspect?: Component | undefined;\n}>",
1161
1169
  "name": "getWorkspaceTemplate",
@@ -1683,7 +1691,8 @@
1683
1691
  "character": 3
1684
1692
  },
1685
1693
  "raw": "/**\n * list all starter templates registered by an env.\n */",
1686
- "comment": "list all starter templates registered by an env."
1694
+ "comment": "list all starter templates registered by an env.",
1695
+ "tags": []
1687
1696
  },
1688
1697
  "signature": "(method) GeneratorMain.listEnvWorkspaceTemplates(envId: string, remoteEnvsAspect?: EnvsMain): Promise<Array<WorkspaceTemplateWithId>>",
1689
1698
  "name": "listEnvWorkspaceTemplates",
@@ -1784,7 +1793,8 @@
1784
1793
  "character": 3
1785
1794
  },
1786
1795
  "raw": "/**\n * list all component templates registered by an env.\n */",
1787
- "comment": "list all component templates registered by an env."
1796
+ "comment": "list all component templates registered by an env.",
1797
+ "tags": []
1788
1798
  },
1789
1799
  "signature": "(method) GeneratorMain.listEnvComponentTemplateDescriptors(ids?: string[], aspectId?: string): Promise<TemplateDescriptor[]>",
1790
1800
  "name": "listEnvComponentTemplateDescriptors",
@@ -2472,7 +2482,8 @@
2472
2482
  "character": 1
2473
2483
  },
2474
2484
  "raw": "/**\n * ComponentContext represents foundational properties for a component context.\n */",
2475
- "comment": "ComponentContext represents foundational properties for a component context."
2485
+ "comment": "ComponentContext represents foundational properties for a component context.",
2486
+ "tags": []
2476
2487
  },
2477
2488
  "signature": "type ComponentContext = BaseComponentTemplateOptions",
2478
2489
  "name": "ComponentContext",
@@ -2541,7 +2552,8 @@
2541
2552
  "character": 3
2542
2553
  },
2543
2554
  "raw": "/**\n * template function for generating the file of a certain component.,\n */",
2544
- "comment": "template function for generating the file of a certain component.,"
2555
+ "comment": "template function for generating the file of a certain component.,",
2556
+ "tags": []
2545
2557
  },
2546
2558
  "signature": "(method) ComponentTemplate.generateFiles(context: ComponentContext): Promise<ComponentFile[]> | ComponentFile[]",
2547
2559
  "name": "generateFiles",
@@ -2639,7 +2651,8 @@
2639
2651
  "character": 3
2640
2652
  },
2641
2653
  "raw": "/**\n * component config. gets saved in the .bitmap file and it overrides the workspace.jsonc config.\n * for example, you can set the env that will be used for this component as follows:\n * \"teambit.envs/envs\": {\n * \"env\": \"teambit.harmony/aspect\"\n * },\n */",
2642
- "comment": "component config. gets saved in the .bitmap file and it overrides the workspace.jsonc config.\nfor example, you can set the env that will be used for this component as follows:\n\"teambit.envs/envs\": {\n \"env\": \"teambit.harmony/aspect\"\n},"
2654
+ "comment": "component config. gets saved in the .bitmap file and it overrides the workspace.jsonc config.\nfor example, you can set the env that will be used for this component as follows:\n\"teambit.envs/envs\": {\n \"env\": \"teambit.harmony/aspect\"\n},",
2655
+ "tags": []
2643
2656
  },
2644
2657
  "signature": "(property) ComponentTemplate.config?: ComponentConfig | ((context: ConfigContext) => ComponentConfig) | undefined",
2645
2658
  "name": "config",
@@ -2763,7 +2776,8 @@
2763
2776
  "character": 3
2764
2777
  },
2765
2778
  "raw": "/**\n * name of the component template. for example: `hook`, `react-component` or `module`.\n */",
2766
- "comment": "name of the component template. for example: `hook`, `react-component` or `module`."
2779
+ "comment": "name of the component template. for example: `hook`, `react-component` or `module`.",
2780
+ "tags": []
2767
2781
  }
2768
2782
  },
2769
2783
  {
@@ -2793,7 +2807,8 @@
2793
2807
  "character": 3
2794
2808
  },
2795
2809
  "raw": "/**\n * short description of the template. shown in the `bit templates` command.\n */",
2796
- "comment": "short description of the template. shown in the `bit templates` command."
2810
+ "comment": "short description of the template. shown in the `bit templates` command.",
2811
+ "tags": []
2797
2812
  }
2798
2813
  },
2799
2814
  {
@@ -2823,7 +2838,8 @@
2823
2838
  "character": 3
2824
2839
  },
2825
2840
  "raw": "/**\n * hide this template so that it is not listed with `bit templates`\n */",
2826
- "comment": "hide this template so that it is not listed with `bit templates`"
2841
+ "comment": "hide this template so that it is not listed with `bit templates`",
2842
+ "tags": []
2827
2843
  }
2828
2844
  },
2829
2845
  {
@@ -2853,7 +2869,8 @@
2853
2869
  "character": 3
2854
2870
  },
2855
2871
  "raw": "/**\n * env to use for the generated component.\n */",
2856
- "comment": "env to use for the generated component."
2872
+ "comment": "env to use for the generated component.",
2873
+ "tags": []
2857
2874
  }
2858
2875
  },
2859
2876
  {
@@ -2883,7 +2900,8 @@
2883
2900
  "character": 3
2884
2901
  },
2885
2902
  "raw": "/**\n * adds a metadata that the component that this template creates is of type env.\n * This will be used later to do further configuration for example:\n * - ensure to create the .bit_root for it\n */",
2886
- "comment": "adds a metadata that the component that this template creates is of type env.\nThis will be used later to do further configuration for example:\n- ensure to create the .bit_root for it"
2903
+ "comment": "adds a metadata that the component that this template creates is of type env.\nThis will be used later to do further configuration for example:\n- ensure to create the .bit_root for it",
2904
+ "tags": []
2887
2905
  }
2888
2906
  },
2889
2907
  {
@@ -2913,7 +2931,8 @@
2913
2931
  "character": 3
2914
2932
  },
2915
2933
  "raw": "/**\n * adds a metadata that the component that this template creates is of type app.\n * This will be used later to do further configuration for example:\n * - add it to the workspace.jsonc as app\n * - ensure to create the .bit_root for it\n */",
2916
- "comment": "adds a metadata that the component that this template creates is of type app.\nThis will be used later to do further configuration for example:\n- add it to the workspace.jsonc as app\n- ensure to create the .bit_root for it"
2934
+ "comment": "adds a metadata that the component that this template creates is of type app.\nThis will be used later to do further configuration for example:\n- add it to the workspace.jsonc as app\n- ensure to create the .bit_root for it",
2935
+ "tags": []
2917
2936
  }
2918
2937
  },
2919
2938
  {
@@ -2951,7 +2970,8 @@
2951
2970
  "character": 3
2952
2971
  },
2953
2972
  "raw": "/**\n * list of dependencies to install when the component is created.\n */",
2954
- "comment": "list of dependencies to install when the component is created."
2973
+ "comment": "list of dependencies to install when the component is created.",
2974
+ "tags": []
2955
2975
  }
2956
2976
  },
2957
2977
  {
@@ -2981,7 +3001,8 @@
2981
3001
  "character": 3
2982
3002
  },
2983
3003
  "raw": "/**\n * Perform installation of missing dependencies after component generation.\n * This is the same as of running `bit install --add-missing-deps` after component generation.\n */",
2984
- "comment": "Perform installation of missing dependencies after component generation.\nThis is the same as of running `bit install --add-missing-deps` after component generation."
3004
+ "comment": "Perform installation of missing dependencies after component generation.\nThis is the same as of running `bit install --add-missing-deps` after component generation.",
3005
+ "tags": []
2985
3006
  }
2986
3007
  }
2987
3008
  ]
@@ -3023,7 +3044,8 @@
3023
3044
  "character": 3
3024
3045
  },
3025
3046
  "raw": "/**\n * name of the component template. for example: `hook`, `react-component` or `module`.\n */",
3026
- "comment": "name of the component template. for example: `hook`, `react-component` or `module`."
3047
+ "comment": "name of the component template. for example: `hook`, `react-component` or `module`.",
3048
+ "tags": []
3027
3049
  },
3028
3050
  "signature": "(property) ComponentTemplateOptions.name?: string | undefined",
3029
3051
  "name": "name",
@@ -3053,7 +3075,8 @@
3053
3075
  "character": 3
3054
3076
  },
3055
3077
  "raw": "/**\n * short description of the template. shown in the `bit templates` command.\n */",
3056
- "comment": "short description of the template. shown in the `bit templates` command."
3078
+ "comment": "short description of the template. shown in the `bit templates` command.",
3079
+ "tags": []
3057
3080
  },
3058
3081
  "signature": "(property) ComponentTemplateOptions.description?: string | undefined",
3059
3082
  "name": "description",
@@ -3083,7 +3106,8 @@
3083
3106
  "character": 3
3084
3107
  },
3085
3108
  "raw": "/**\n * hide this template so that it is not listed with `bit templates`\n */",
3086
- "comment": "hide this template so that it is not listed with `bit templates`"
3109
+ "comment": "hide this template so that it is not listed with `bit templates`",
3110
+ "tags": []
3087
3111
  },
3088
3112
  "signature": "(property) ComponentTemplateOptions.hidden?: boolean | undefined",
3089
3113
  "name": "hidden",
@@ -3113,7 +3137,8 @@
3113
3137
  "character": 3
3114
3138
  },
3115
3139
  "raw": "/**\n * env to use for the generated component.\n */",
3116
- "comment": "env to use for the generated component."
3140
+ "comment": "env to use for the generated component.",
3141
+ "tags": []
3117
3142
  },
3118
3143
  "signature": "(property) ComponentTemplateOptions.env?: string | undefined",
3119
3144
  "name": "env",
@@ -3143,7 +3168,8 @@
3143
3168
  "character": 3
3144
3169
  },
3145
3170
  "raw": "/**\n * adds a metadata that the component that this template creates is of type env.\n * This will be used later to do further configuration for example:\n * - ensure to create the .bit_root for it\n */",
3146
- "comment": "adds a metadata that the component that this template creates is of type env.\nThis will be used later to do further configuration for example:\n- ensure to create the .bit_root for it"
3171
+ "comment": "adds a metadata that the component that this template creates is of type env.\nThis will be used later to do further configuration for example:\n- ensure to create the .bit_root for it",
3172
+ "tags": []
3147
3173
  },
3148
3174
  "signature": "(property) ComponentTemplateOptions.isEnv?: boolean | undefined",
3149
3175
  "name": "isEnv",
@@ -3173,7 +3199,8 @@
3173
3199
  "character": 3
3174
3200
  },
3175
3201
  "raw": "/**\n * adds a metadata that the component that this template creates is of type app.\n * This will be used later to do further configuration for example:\n * - add it to the workspace.jsonc as app\n * - ensure to create the .bit_root for it\n */",
3176
- "comment": "adds a metadata that the component that this template creates is of type app.\nThis will be used later to do further configuration for example:\n- add it to the workspace.jsonc as app\n- ensure to create the .bit_root for it"
3202
+ "comment": "adds a metadata that the component that this template creates is of type app.\nThis will be used later to do further configuration for example:\n- add it to the workspace.jsonc as app\n- ensure to create the .bit_root for it",
3203
+ "tags": []
3177
3204
  },
3178
3205
  "signature": "(property) ComponentTemplateOptions.isApp?: boolean | undefined",
3179
3206
  "name": "isApp",
@@ -3203,7 +3230,8 @@
3203
3230
  "character": 3
3204
3231
  },
3205
3232
  "raw": "/**\n * list of dependencies to install when the component is created.\n */",
3206
- "comment": "list of dependencies to install when the component is created."
3233
+ "comment": "list of dependencies to install when the component is created.",
3234
+ "tags": []
3207
3235
  },
3208
3236
  "signature": "(property) ComponentTemplateOptions.dependencies?: string[] | undefined",
3209
3237
  "name": "dependencies",
@@ -3241,7 +3269,8 @@
3241
3269
  "character": 3
3242
3270
  },
3243
3271
  "raw": "/**\n * Perform installation of missing dependencies after component generation.\n * This is the same as of running `bit install --add-missing-deps` after component generation.\n */",
3244
- "comment": "Perform installation of missing dependencies after component generation.\nThis is the same as of running `bit install --add-missing-deps` after component generation."
3272
+ "comment": "Perform installation of missing dependencies after component generation.\nThis is the same as of running `bit install --add-missing-deps` after component generation.",
3273
+ "tags": []
3245
3274
  },
3246
3275
  "signature": "(property) ComponentTemplateOptions.installMissingDependencies?: boolean | undefined",
3247
3276
  "name": "installMissingDependencies",
@@ -3293,7 +3322,8 @@
3293
3322
  "character": 3
3294
3323
  },
3295
3324
  "raw": "/**\n * relative path of the file within the component.\n */",
3296
- "comment": "relative path of the file within the component."
3325
+ "comment": "relative path of the file within the component.",
3326
+ "tags": []
3297
3327
  },
3298
3328
  "signature": "(property) ComponentFile.relativePath: string",
3299
3329
  "name": "relativePath",
@@ -3323,7 +3353,8 @@
3323
3353
  "character": 3
3324
3354
  },
3325
3355
  "raw": "/**\n * file content\n */",
3326
- "comment": "file content"
3356
+ "comment": "file content",
3357
+ "tags": []
3327
3358
  },
3328
3359
  "signature": "(property) ComponentFile.content: string",
3329
3360
  "name": "content",
@@ -3353,7 +3384,8 @@
3353
3384
  "character": 3
3354
3385
  },
3355
3386
  "raw": "/**\n * whether this file will be tracked as the main file\n */",
3356
- "comment": "whether this file will be tracked as the main file"
3387
+ "comment": "whether this file will be tracked as the main file",
3388
+ "tags": []
3357
3389
  },
3358
3390
  "signature": "(property) ComponentFile.isMain?: boolean | undefined",
3359
3391
  "name": "isMain",
@@ -3471,7 +3503,8 @@
3471
3503
  "character": 3
3472
3504
  },
3473
3505
  "raw": "/**\n * Aspect id of the aspect that register the template itself\n */",
3474
- "comment": "Aspect id of the aspect that register the template itself"
3506
+ "comment": "Aspect id of the aspect that register the template itself",
3507
+ "tags": []
3475
3508
  },
3476
3509
  "signature": "(property) ConfigContext.aspectId: string",
3477
3510
  "name": "aspectId",
@@ -3513,7 +3546,8 @@
3513
3546
  "character": 1
3514
3547
  },
3515
3548
  "raw": "/**\n * WorkspaceContext represents foundational properties for a workspace context.\n */",
3516
- "comment": "WorkspaceContext represents foundational properties for a workspace context."
3549
+ "comment": "WorkspaceContext represents foundational properties for a workspace context.",
3550
+ "tags": []
3517
3551
  },
3518
3552
  "signature": "type WorkspaceContext = BaseWorkspaceOptions",
3519
3553
  "name": "WorkspaceContext",
@@ -3562,7 +3596,8 @@
3562
3596
  "character": 3
3563
3597
  },
3564
3598
  "raw": "/**\n * name of the workspace starter. for example: `react-workspace`.\n */",
3565
- "comment": "name of the workspace starter. for example: `react-workspace`."
3599
+ "comment": "name of the workspace starter. for example: `react-workspace`.",
3600
+ "tags": []
3566
3601
  },
3567
3602
  "signature": "(property) WorkspaceTemplate.name: string",
3568
3603
  "name": "name",
@@ -3592,7 +3627,8 @@
3592
3627
  "character": 3
3593
3628
  },
3594
3629
  "raw": "/**\n * name of an app created in the workspace. for example: `my-app`.\n * This will be used to instruct the user to run `bit run <appName>` in the new workspace.\n */",
3595
- "comment": "name of an app created in the workspace. for example: `my-app`.\nThis will be used to instruct the user to run `bit run <appName>` in the new workspace."
3630
+ "comment": "name of an app created in the workspace. for example: `my-app`.\nThis will be used to instruct the user to run `bit run <appName>` in the new workspace.",
3631
+ "tags": []
3596
3632
  },
3597
3633
  "signature": "(property) WorkspaceTemplate.appName?: string | undefined",
3598
3634
  "name": "appName",
@@ -3622,7 +3658,8 @@
3622
3658
  "character": 3
3623
3659
  },
3624
3660
  "raw": "/**\n * short description of the starter. shown in the `bit starter` command when outside of bit-workspace.\n */",
3625
- "comment": "short description of the starter. shown in the `bit starter` command when outside of bit-workspace."
3661
+ "comment": "short description of the starter. shown in the `bit starter` command when outside of bit-workspace.",
3662
+ "tags": []
3626
3663
  },
3627
3664
  "signature": "(property) WorkspaceTemplate.description?: string | undefined",
3628
3665
  "name": "description",
@@ -3652,7 +3689,8 @@
3652
3689
  "character": 3
3653
3690
  },
3654
3691
  "raw": "/**\n * hide this starter so that it is not listed with `bit starter`\n */",
3655
- "comment": "hide this starter so that it is not listed with `bit starter`"
3692
+ "comment": "hide this starter so that it is not listed with `bit starter`",
3693
+ "tags": []
3656
3694
  },
3657
3695
  "signature": "(property) WorkspaceTemplate.hidden?: boolean | undefined",
3658
3696
  "name": "hidden",
@@ -3682,7 +3720,8 @@
3682
3720
  "character": 3
3683
3721
  },
3684
3722
  "raw": "/**\n * starter function for generating the template files,\n */",
3685
- "comment": "starter function for generating the template files,"
3723
+ "comment": "starter function for generating the template files,",
3724
+ "tags": []
3686
3725
  },
3687
3726
  "signature": "(method) WorkspaceTemplate.generateFiles(context: WorkspaceContext): Promise<WorkspaceFile[]>",
3688
3727
  "name": "generateFiles",
@@ -3753,6 +3792,7 @@
3753
3792
  "character": 3
3754
3793
  },
3755
3794
  "raw": "/**\n * @deprecated use `fork()` or `import()` instead\n * this is working similarly to `fork()`\n */",
3795
+ "comment": "",
3756
3796
  "tags": [
3757
3797
  {
3758
3798
  "__schema": "TagSchema",
@@ -3835,7 +3875,8 @@
3835
3875
  "character": 3
3836
3876
  },
3837
3877
  "raw": "/**\n * import components into the new workspace, don't change their source code.\n */",
3838
- "comment": "import components into the new workspace, don't change their source code."
3878
+ "comment": "import components into the new workspace, don't change their source code.",
3879
+ "tags": []
3839
3880
  },
3840
3881
  "signature": "(property) WorkspaceTemplate.import?: ((context: WorkspaceContext) => ImportComponentInfo[]) | undefined",
3841
3882
  "name": "import",
@@ -3906,7 +3947,8 @@
3906
3947
  "character": 3
3907
3948
  },
3908
3949
  "raw": "/**\n * populate existing components into the new workspace and add them as new components.\n * change their source code and update the dependency names according to the new component names.\n */",
3909
- "comment": "populate existing components into the new workspace and add them as new components.\nchange their source code and update the dependency names according to the new component names."
3950
+ "comment": "populate existing components into the new workspace and add them as new components.\nchange their source code and update the dependency names according to the new component names.",
3951
+ "tags": []
3910
3952
  },
3911
3953
  "signature": "(property) WorkspaceTemplate.fork?: ((context: WorkspaceContext) => ForkComponentInfo[]) | undefined",
3912
3954
  "name": "fork",
@@ -3977,7 +4019,8 @@
3977
4019
  "character": 3
3978
4020
  },
3979
4021
  "raw": "/**\n * populate new components into the new workspace and add them as new components.\n */",
3980
- "comment": "populate new components into the new workspace and add them as new components."
4022
+ "comment": "populate new components into the new workspace and add them as new components.",
4023
+ "tags": []
3981
4024
  },
3982
4025
  "signature": "(property) WorkspaceTemplate.create?: ((context: WorkspaceContext) => CreateComponentInfo[]) | undefined",
3983
4026
  "name": "create",
@@ -4070,7 +4113,8 @@
4070
4113
  "character": 3
4071
4114
  },
4072
4115
  "raw": "/**\n * name of the workspace starter. for example: `react-workspace`.\n */",
4073
- "comment": "name of the workspace starter. for example: `react-workspace`."
4116
+ "comment": "name of the workspace starter. for example: `react-workspace`.",
4117
+ "tags": []
4074
4118
  },
4075
4119
  "signature": "(property) WorkspaceTemplate.name: string",
4076
4120
  "name": "name",
@@ -4100,7 +4144,8 @@
4100
4144
  "character": 3
4101
4145
  },
4102
4146
  "raw": "/**\n * name of an app created in the workspace. for example: `my-app`.\n * This will be used to instruct the user to run `bit run <appName>` in the new workspace.\n */",
4103
- "comment": "name of an app created in the workspace. for example: `my-app`.\nThis will be used to instruct the user to run `bit run <appName>` in the new workspace."
4147
+ "comment": "name of an app created in the workspace. for example: `my-app`.\nThis will be used to instruct the user to run `bit run <appName>` in the new workspace.",
4148
+ "tags": []
4104
4149
  },
4105
4150
  "signature": "(property) WorkspaceTemplate.appName?: string | undefined",
4106
4151
  "name": "appName",
@@ -4130,7 +4175,8 @@
4130
4175
  "character": 3
4131
4176
  },
4132
4177
  "raw": "/**\n * short description of the starter. shown in the `bit starter` command when outside of bit-workspace.\n */",
4133
- "comment": "short description of the starter. shown in the `bit starter` command when outside of bit-workspace."
4178
+ "comment": "short description of the starter. shown in the `bit starter` command when outside of bit-workspace.",
4179
+ "tags": []
4134
4180
  },
4135
4181
  "signature": "(property) WorkspaceTemplate.description?: string | undefined",
4136
4182
  "name": "description",
@@ -4160,7 +4206,8 @@
4160
4206
  "character": 3
4161
4207
  },
4162
4208
  "raw": "/**\n * hide this starter so that it is not listed with `bit starter`\n */",
4163
- "comment": "hide this starter so that it is not listed with `bit starter`"
4209
+ "comment": "hide this starter so that it is not listed with `bit starter`",
4210
+ "tags": []
4164
4211
  },
4165
4212
  "signature": "(property) WorkspaceTemplate.hidden?: boolean | undefined",
4166
4213
  "name": "hidden",
@@ -4190,7 +4237,8 @@
4190
4237
  "character": 3
4191
4238
  },
4192
4239
  "raw": "/**\n * starter function for generating the template files,\n */",
4193
- "comment": "starter function for generating the template files,"
4240
+ "comment": "starter function for generating the template files,",
4241
+ "tags": []
4194
4242
  },
4195
4243
  "signature": "(method) WorkspaceTemplate.generateFiles(context: WorkspaceContext): Promise<WorkspaceFile[]>",
4196
4244
  "name": "generateFiles",
@@ -4261,6 +4309,7 @@
4261
4309
  "character": 3
4262
4310
  },
4263
4311
  "raw": "/**\n * @deprecated use `fork()` or `import()` instead\n * this is working similarly to `fork()`\n */",
4312
+ "comment": "",
4264
4313
  "tags": [
4265
4314
  {
4266
4315
  "__schema": "TagSchema",
@@ -4343,7 +4392,8 @@
4343
4392
  "character": 3
4344
4393
  },
4345
4394
  "raw": "/**\n * import components into the new workspace, don't change their source code.\n */",
4346
- "comment": "import components into the new workspace, don't change their source code."
4395
+ "comment": "import components into the new workspace, don't change their source code.",
4396
+ "tags": []
4347
4397
  },
4348
4398
  "signature": "(property) WorkspaceTemplate.import?: ((context: WorkspaceContext) => ImportComponentInfo[]) | undefined",
4349
4399
  "name": "import",
@@ -4414,7 +4464,8 @@
4414
4464
  "character": 3
4415
4465
  },
4416
4466
  "raw": "/**\n * populate existing components into the new workspace and add them as new components.\n * change their source code and update the dependency names according to the new component names.\n */",
4417
- "comment": "populate existing components into the new workspace and add them as new components.\nchange their source code and update the dependency names according to the new component names."
4467
+ "comment": "populate existing components into the new workspace and add them as new components.\nchange their source code and update the dependency names according to the new component names.",
4468
+ "tags": []
4418
4469
  },
4419
4470
  "signature": "(property) WorkspaceTemplate.fork?: ((context: WorkspaceContext) => ForkComponentInfo[]) | undefined",
4420
4471
  "name": "fork",
@@ -4485,7 +4536,8 @@
4485
4536
  "character": 3
4486
4537
  },
4487
4538
  "raw": "/**\n * populate new components into the new workspace and add them as new components.\n */",
4488
- "comment": "populate new components into the new workspace and add them as new components."
4539
+ "comment": "populate new components into the new workspace and add them as new components.",
4540
+ "tags": []
4489
4541
  },
4490
4542
  "signature": "(property) WorkspaceTemplate.create?: ((context: WorkspaceContext) => CreateComponentInfo[]) | undefined",
4491
4543
  "name": "create",
@@ -4579,7 +4631,8 @@
4579
4631
  "character": 3
4580
4632
  },
4581
4633
  "raw": "/**\n * relative path of the file within the workspace.\n */",
4582
- "comment": "relative path of the file within the workspace."
4634
+ "comment": "relative path of the file within the workspace.",
4635
+ "tags": []
4583
4636
  },
4584
4637
  "signature": "(property) WorkspaceFile.relativePath: string",
4585
4638
  "name": "relativePath",
@@ -4609,7 +4662,8 @@
4609
4662
  "character": 3
4610
4663
  },
4611
4664
  "raw": "/**\n * file content\n */",
4612
- "comment": "file content"
4665
+ "comment": "file content",
4666
+ "tags": []
4613
4667
  },
4614
4668
  "signature": "(property) WorkspaceFile.content: string",
4615
4669
  "name": "content",
@@ -4661,7 +4715,8 @@
4661
4715
  "character": 3
4662
4716
  },
4663
4717
  "raw": "/**\n * a new component name. if not specified, use the original id (without the scope)\n */",
4664
- "comment": "a new component name. if not specified, use the original id (without the scope)"
4718
+ "comment": "a new component name. if not specified, use the original id (without the scope)",
4719
+ "tags": []
4665
4720
  },
4666
4721
  "signature": "(property) ForkComponentInfo.targetName?: string | undefined",
4667
4722
  "name": "targetName",
@@ -4691,7 +4746,8 @@
4691
4746
  "character": 3
4692
4747
  },
4693
4748
  "raw": "/**\n * a new scope for the component. if not specified, use the original scope\n */",
4694
- "comment": "a new scope for the component. if not specified, use the original scope"
4749
+ "comment": "a new scope for the component. if not specified, use the original scope",
4750
+ "tags": []
4695
4751
  },
4696
4752
  "signature": "(property) ForkComponentInfo.targetScope?: string | undefined",
4697
4753
  "name": "targetScope",
@@ -4721,7 +4777,8 @@
4721
4777
  "character": 3
4722
4778
  },
4723
4779
  "raw": "/**\n * env to use for the component.\n */",
4724
- "comment": "env to use for the component."
4780
+ "comment": "env to use for the component.",
4781
+ "tags": []
4725
4782
  },
4726
4783
  "signature": "(property) ForkComponentInfo.env?: string | undefined",
4727
4784
  "name": "env",
@@ -4751,7 +4808,8 @@
4751
4808
  "character": 3
4752
4809
  },
4753
4810
  "raw": "/**\n * component config. gets saved in the .bitmap file and overrides the workspace.jsonc config.\n * for example, you can set the env that will be used for this component as follows:\n * \"teambit.envs/envs\": {\n * \"env\": \"teambit.harmony/aspect\"\n * },\n */",
4754
- "comment": "component config. gets saved in the .bitmap file and overrides the workspace.jsonc config.\nfor example, you can set the env that will be used for this component as follows:\n\"teambit.envs/envs\": {\n \"env\": \"teambit.harmony/aspect\"\n},"
4811
+ "comment": "component config. gets saved in the .bitmap file and overrides the workspace.jsonc config.\nfor example, you can set the env that will be used for this component as follows:\n\"teambit.envs/envs\": {\n \"env\": \"teambit.harmony/aspect\"\n},",
4812
+ "tags": []
4755
4813
  },
4756
4814
  "signature": "(property) ForkComponentInfo.config?: ComponentConfig | undefined",
4757
4815
  "name": "config",
@@ -4815,7 +4873,8 @@
4815
4873
  "character": 3
4816
4874
  },
4817
4875
  "raw": "/**\n * full component id\n */",
4818
- "comment": "full component id"
4876
+ "comment": "full component id",
4877
+ "tags": []
4819
4878
  }
4820
4879
  },
4821
4880
  {
@@ -4845,7 +4904,8 @@
4845
4904
  "character": 3
4846
4905
  },
4847
4906
  "raw": "/**\n * path where to write the component\n */",
4848
- "comment": "path where to write the component"
4907
+ "comment": "path where to write the component",
4908
+ "tags": []
4849
4909
  }
4850
4910
  }
4851
4911
  ]
@@ -4887,7 +4947,8 @@
4887
4947
  "character": 3
4888
4948
  },
4889
4949
  "raw": "/**\n * full component id\n */",
4890
- "comment": "full component id"
4950
+ "comment": "full component id",
4951
+ "tags": []
4891
4952
  },
4892
4953
  "signature": "(property) ImportComponentInfo.id: string",
4893
4954
  "name": "id",
@@ -4917,7 +4978,8 @@
4917
4978
  "character": 3
4918
4979
  },
4919
4980
  "raw": "/**\n * path where to write the component\n */",
4920
- "comment": "path where to write the component"
4981
+ "comment": "path where to write the component",
4982
+ "tags": []
4921
4983
  },
4922
4984
  "signature": "(property) ImportComponentInfo.path?: string | undefined",
4923
4985
  "name": "path",
@@ -4969,7 +5031,8 @@
4969
5031
  "character": 3
4970
5032
  },
4971
5033
  "raw": "/**\n * the template for generating the component\n */",
4972
- "comment": "the template for generating the component"
5034
+ "comment": "the template for generating the component",
5035
+ "tags": []
4973
5036
  },
4974
5037
  "signature": "(property) CreateComponentInfo.templateName: string",
4975
5038
  "name": "templateName",
@@ -4999,7 +5062,8 @@
4999
5062
  "character": 3
5000
5063
  },
5001
5064
  "raw": "/**\n * component name to generate\n */",
5002
- "comment": "component name to generate"
5065
+ "comment": "component name to generate",
5066
+ "tags": []
5003
5067
  },
5004
5068
  "signature": "(property) CreateComponentInfo.componentName: string",
5005
5069
  "name": "componentName",
@@ -5029,7 +5093,8 @@
5029
5093
  "character": 3
5030
5094
  },
5031
5095
  "raw": "/**\n * sets the component's scope-name. if not entered, the default-scope will be used\n */",
5032
- "comment": "sets the component's scope-name. if not entered, the default-scope will be used"
5096
+ "comment": "sets the component's scope-name. if not entered, the default-scope will be used",
5097
+ "tags": []
5033
5098
  },
5034
5099
  "signature": "(property) CreateComponentInfo.scope?: string | undefined",
5035
5100
  "name": "scope",
@@ -5059,7 +5124,8 @@
5059
5124
  "character": 3
5060
5125
  },
5061
5126
  "raw": "/**\n * relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`\n */",
5062
- "comment": "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
5127
+ "comment": "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`",
5128
+ "tags": []
5063
5129
  },
5064
5130
  "signature": "(property) CreateComponentInfo.path?: string | undefined",
5065
5131
  "name": "path",
@@ -5089,7 +5155,8 @@
5089
5155
  "character": 3
5090
5156
  },
5091
5157
  "raw": "/**\n * set the component's environment. (overrides the env from variants and the template)\n */",
5092
- "comment": "set the component's environment. (overrides the env from variants and the template)"
5158
+ "comment": "set the component's environment. (overrides the env from variants and the template)",
5159
+ "tags": []
5093
5160
  },
5094
5161
  "signature": "(property) CreateComponentInfo.env?: string | undefined",
5095
5162
  "name": "env",
@@ -5119,7 +5186,8 @@
5119
5186
  "character": 3
5120
5187
  },
5121
5188
  "raw": "/**\n * aspect-id of the template.\n */",
5122
- "comment": "aspect-id of the template."
5189
+ "comment": "aspect-id of the template.",
5190
+ "tags": []
5123
5191
  },
5124
5192
  "signature": "(property) CreateComponentInfo.aspect?: string | undefined",
5125
5193
  "name": "aspect",
@@ -5171,7 +5239,8 @@
5171
5239
  "character": 3
5172
5240
  },
5173
5241
  "raw": "/**\n * return a template list instance.\n */",
5174
- "comment": "return a template list instance."
5242
+ "comment": "return a template list instance.",
5243
+ "tags": []
5175
5244
  },
5176
5245
  "signature": "(method) GeneratorEnv.generators(): EnvHandler<TemplateList>",
5177
5246
  "name": "generators",
@@ -5217,7 +5286,8 @@
5217
5286
  "character": 3
5218
5287
  },
5219
5288
  "raw": "/**\n * return a starter list instance.\n */",
5220
- "comment": "return a starter list instance."
5289
+ "comment": "return a starter list instance.",
5290
+ "tags": []
5221
5291
  },
5222
5292
  "signature": "(method) GeneratorEnv.starters(): EnvHandler<StarterList>",
5223
5293
  "name": "starters",
@@ -6383,7 +6453,8 @@
6383
6453
  "character": 3
6384
6454
  },
6385
6455
  "raw": "/**\n * array of aspects to include in the list of templates.\n */",
6386
- "comment": "array of aspects to include in the list of templates."
6456
+ "comment": "array of aspects to include in the list of templates.",
6457
+ "tags": []
6387
6458
  },
6388
6459
  "signature": "(property) aspects: string[]",
6389
6460
  "name": "aspects",
@@ -6421,7 +6492,8 @@
6421
6492
  "character": 3
6422
6493
  },
6423
6494
  "raw": "/**\n * by default core templates are shown.\n * use this to hide them unless `--show-all` flag of `bit templates` was used\n */",
6424
- "comment": "by default core templates are shown.\nuse this to hide them unless `--show-all` flag of `bit templates` was used"
6495
+ "comment": "by default core templates are shown.\nuse this to hide them unless `--show-all` flag of `bit templates` was used",
6496
+ "tags": []
6425
6497
  },
6426
6498
  "signature": "(property) hideCoreTemplates: boolean",
6427
6499
  "name": "hideCoreTemplates",
@@ -6451,7 +6523,8 @@
6451
6523
  "character": 3
6452
6524
  },
6453
6525
  "raw": "/**\n * default envs.\n */",
6454
- "comment": "default envs."
6526
+ "comment": "default envs.",
6527
+ "tags": []
6455
6528
  },
6456
6529
  "signature": "(property) envs?: string[] | undefined",
6457
6530
  "name": "envs",
@@ -6824,7 +6897,8 @@
6824
6897
  "character": 3
6825
6898
  },
6826
6899
  "raw": "/**\n * register a new component template.\n */",
6827
- "comment": "register a new component template."
6900
+ "comment": "register a new component template.",
6901
+ "tags": []
6828
6902
  },
6829
6903
  "signature": "(method) GeneratorMain.registerComponentTemplate(templates: ComponentTemplate[]): this",
6830
6904
  "name": "registerComponentTemplate",
@@ -6884,7 +6958,8 @@
6884
6958
  "character": 3
6885
6959
  },
6886
6960
  "raw": "/**\n * register a new workspace starter.\n */",
6887
- "comment": "register a new workspace starter."
6961
+ "comment": "register a new workspace starter.",
6962
+ "tags": []
6888
6963
  },
6889
6964
  "signature": "(method) GeneratorMain.registerWorkspaceTemplate(templates: WorkspaceTemplate[]): this",
6890
6965
  "name": "registerWorkspaceTemplate",
@@ -6987,7 +7062,8 @@
6987
7062
  "character": 3
6988
7063
  },
6989
7064
  "raw": "/**\n * list all component templates registered in the workspace or workspace templates in case the\n * workspace is not available\n */",
6990
- "comment": "list all component templates registered in the workspace or workspace templates in case the\nworkspace is not available"
7065
+ "comment": "list all component templates registered in the workspace or workspace templates in case the\nworkspace is not available",
7066
+ "tags": []
6991
7067
  },
6992
7068
  "signature": "(method) GeneratorMain.listTemplates({ aspect }?: {\n aspect?: string;\n}): Promise<TemplateDescriptor[]>",
6993
7069
  "name": "listTemplates",
@@ -7105,6 +7181,7 @@
7105
7181
  "character": 3
7106
7182
  },
7107
7183
  "raw": "/**\n * @deprecated use this.listTemplates()\n */",
7184
+ "comment": "",
7108
7185
  "tags": [
7109
7186
  {
7110
7187
  "__schema": "TagSchema",
@@ -7232,7 +7309,8 @@
7232
7309
  "character": 3
7233
7310
  },
7234
7311
  "raw": "/**\n * get all component templates registered by a specific aspect ID.\n */",
7235
- "comment": "get all component templates registered by a specific aspect ID."
7312
+ "comment": "get all component templates registered by a specific aspect ID.",
7313
+ "tags": []
7236
7314
  },
7237
7315
  "signature": "(method) GeneratorMain.getComponentTemplateByAspect(aspectId: string): ComponentTemplate[]",
7238
7316
  "name": "getComponentTemplateByAspect",
@@ -7292,7 +7370,8 @@
7292
7370
  "character": 3
7293
7371
  },
7294
7372
  "raw": "/**\n * returns a specific component template.\n */",
7295
- "comment": "returns a specific component template."
7373
+ "comment": "returns a specific component template.",
7374
+ "tags": []
7296
7375
  },
7297
7376
  "signature": "(method) GeneratorMain.getComponentTemplate(name: string, aspectId?: string): Promise<ComponentTemplateWithId | undefined>",
7298
7377
  "name": "getComponentTemplate",
@@ -7397,7 +7476,8 @@
7397
7476
  "character": 3
7398
7477
  },
7399
7478
  "raw": "/**\n * in the case the aspect-id is given and this aspect doesn't exist locally, import it to the\n * global scope and load it from the capsule\n */",
7400
- "comment": "in the case the aspect-id is given and this aspect doesn't exist locally, import it to the\nglobal scope and load it from the capsule"
7479
+ "comment": "in the case the aspect-id is given and this aspect doesn't exist locally, import it to the\nglobal scope and load it from the capsule",
7480
+ "tags": []
7401
7481
  },
7402
7482
  "signature": "(method) GeneratorMain.findWorkspaceTemplateInGlobalScope(aspectId: string, name?: string): Promise<{\n workspaceTemplate?: WorkspaceTemplate | undefined;\n aspect?: Component | undefined;\n}>",
7403
7483
  "name": "findWorkspaceTemplateInGlobalScope",
@@ -7611,7 +7691,8 @@
7611
7691
  "character": 3
7612
7692
  },
7613
7693
  "raw": "/**\n * returns a specific workspace template.\n */",
7614
- "comment": "returns a specific workspace template."
7694
+ "comment": "returns a specific workspace template.",
7695
+ "tags": []
7615
7696
  },
7616
7697
  "signature": "(method) GeneratorMain.getWorkspaceTemplate(name: string, aspectId?: string): Promise<{\n workspaceTemplate: WorkspaceTemplate;\n aspect?: Component | undefined;\n}>",
7617
7698
  "name": "getWorkspaceTemplate",
@@ -8139,7 +8220,8 @@
8139
8220
  "character": 3
8140
8221
  },
8141
8222
  "raw": "/**\n * list all starter templates registered by an env.\n */",
8142
- "comment": "list all starter templates registered by an env."
8223
+ "comment": "list all starter templates registered by an env.",
8224
+ "tags": []
8143
8225
  },
8144
8226
  "signature": "(method) GeneratorMain.listEnvWorkspaceTemplates(envId: string, remoteEnvsAspect?: EnvsMain): Promise<Array<WorkspaceTemplateWithId>>",
8145
8227
  "name": "listEnvWorkspaceTemplates",
@@ -8240,7 +8322,8 @@
8240
8322
  "character": 3
8241
8323
  },
8242
8324
  "raw": "/**\n * list all component templates registered by an env.\n */",
8243
- "comment": "list all component templates registered by an env."
8325
+ "comment": "list all component templates registered by an env.",
8326
+ "tags": []
8244
8327
  },
8245
8328
  "signature": "(method) GeneratorMain.listEnvComponentTemplateDescriptors(ids?: string[], aspectId?: string): Promise<TemplateDescriptor[]>",
8246
8329
  "name": "listEnvComponentTemplateDescriptors",
@@ -9200,7 +9283,8 @@
9200
9283
  "character": 1
9201
9284
  },
9202
9285
  "raw": "/**\n * BaseComponentTemplateOptions describes the foundational properties for components.\n */",
9203
- "comment": "BaseComponentTemplateOptions describes the foundational properties for components."
9286
+ "comment": "BaseComponentTemplateOptions describes the foundational properties for components.",
9287
+ "tags": []
9204
9288
  },
9205
9289
  "signature": "interface BaseComponentTemplateOptions",
9206
9290
  "name": "BaseComponentTemplateOptions",
@@ -9220,7 +9304,8 @@
9220
9304
  "character": 3
9221
9305
  },
9222
9306
  "raw": "/**\n * component-name as entered by the user, e.g. `use-date`.\n * without the scope and the namespace.\n */",
9223
- "comment": "component-name as entered by the user, e.g. `use-date`.\nwithout the scope and the namespace."
9307
+ "comment": "component-name as entered by the user, e.g. `use-date`.\nwithout the scope and the namespace.",
9308
+ "tags": []
9224
9309
  },
9225
9310
  "signature": "(property) BaseComponentTemplateOptions.name: string",
9226
9311
  "name": "name",
@@ -9250,7 +9335,8 @@
9250
9335
  "character": 3
9251
9336
  },
9252
9337
  "raw": "/**\n * component-name as upper camel case, e.g. `use-date` becomes `UseDate`.\n * useful when generating the file content, for example for a class name.\n */",
9253
- "comment": "component-name as upper camel case, e.g. `use-date` becomes `UseDate`.\nuseful when generating the file content, for example for a class name."
9338
+ "comment": "component-name as upper camel case, e.g. `use-date` becomes `UseDate`.\nuseful when generating the file content, for example for a class name.",
9339
+ "tags": []
9254
9340
  },
9255
9341
  "signature": "(property) BaseComponentTemplateOptions.namePascalCase: string",
9256
9342
  "name": "namePascalCase",
@@ -9280,7 +9366,8 @@
9280
9366
  "character": 3
9281
9367
  },
9282
9368
  "raw": "/**\n * component-name as lower camel case, e.g. `use-date` becomes `useDate`.\n * useful when generating the file content, for example for a function/variable name.\n */",
9283
- "comment": "component-name as lower camel case, e.g. `use-date` becomes `useDate`.\nuseful when generating the file content, for example for a function/variable name."
9369
+ "comment": "component-name as lower camel case, e.g. `use-date` becomes `useDate`.\nuseful when generating the file content, for example for a function/variable name.",
9370
+ "tags": []
9284
9371
  },
9285
9372
  "signature": "(property) BaseComponentTemplateOptions.nameCamelCase: string",
9286
9373
  "name": "nameCamelCase",
@@ -9310,7 +9397,8 @@
9310
9397
  "character": 3
9311
9398
  },
9312
9399
  "raw": "/**\n * component id.\n * the name is the name+namespace. the scope is the scope entered by --scope flag or the defaultScope\n */",
9313
- "comment": "component id.\nthe name is the name+namespace. the scope is the scope entered by --scope flag or the defaultScope"
9400
+ "comment": "component id.\nthe name is the name+namespace. the scope is the scope entered by --scope flag or the defaultScope",
9401
+ "tags": []
9314
9402
  },
9315
9403
  "signature": "(property) BaseComponentTemplateOptions.componentId: ComponentID",
9316
9404
  "name": "componentId",
@@ -9344,7 +9432,8 @@
9344
9432
  "character": 3
9345
9433
  },
9346
9434
  "raw": "/**\n * aspect id of the aspect that register the template itself\n */",
9347
- "comment": "aspect id of the aspect that register the template itself"
9435
+ "comment": "aspect id of the aspect that register the template itself",
9436
+ "tags": []
9348
9437
  },
9349
9438
  "signature": "(property) BaseComponentTemplateOptions.aspectId: string | ComponentID",
9350
9439
  "name": "aspectId",
@@ -9397,7 +9486,8 @@
9397
9486
  "character": 3
9398
9487
  },
9399
9488
  "raw": "/**\n * env id of the env that register the template itself.\n * This will be usually identical to the aspectId but aspectId will always exist,\n * while envId will be undefined if the template is not registered by an env.\n */",
9400
- "comment": "env id of the env that register the template itself.\nThis will be usually identical to the aspectId but aspectId will always exist,\nwhile envId will be undefined if the template is not registered by an env."
9489
+ "comment": "env id of the env that register the template itself.\nThis will be usually identical to the aspectId but aspectId will always exist,\nwhile envId will be undefined if the template is not registered by an env.",
9490
+ "tags": []
9401
9491
  },
9402
9492
  "signature": "(property) BaseComponentTemplateOptions.envId?: ComponentID | undefined",
9403
9493
  "name": "envId",
@@ -9431,7 +9521,8 @@
9431
9521
  "character": 3
9432
9522
  },
9433
9523
  "raw": "/**\n * path of the component.\n */",
9434
- "comment": "path of the component."
9524
+ "comment": "path of the component.",
9525
+ "tags": []
9435
9526
  },
9436
9527
  "signature": "(property) BaseComponentTemplateOptions.path?: string | undefined",
9437
9528
  "name": "path",
@@ -9461,7 +9552,8 @@
9461
9552
  "character": 3
9462
9553
  },
9463
9554
  "raw": "/**\n * scope of the component.\n */",
9464
- "comment": "scope of the component."
9555
+ "comment": "scope of the component.",
9556
+ "tags": []
9465
9557
  },
9466
9558
  "signature": "(property) BaseComponentTemplateOptions.scope?: string | undefined",
9467
9559
  "name": "scope",
@@ -9491,7 +9583,8 @@
9491
9583
  "character": 3
9492
9584
  },
9493
9585
  "raw": "/**\n * namespace of the component.\n */",
9494
- "comment": "namespace of the component."
9586
+ "comment": "namespace of the component.",
9587
+ "tags": []
9495
9588
  },
9496
9589
  "signature": "(property) BaseComponentTemplateOptions.namespace?: string | undefined",
9497
9590
  "name": "namespace",
@@ -9524,7 +9617,8 @@
9524
9617
  "character": 1
9525
9618
  },
9526
9619
  "raw": "/**\n * ComponentContext represents foundational properties for a component context.\n */",
9527
- "comment": "ComponentContext represents foundational properties for a component context."
9620
+ "comment": "ComponentContext represents foundational properties for a component context.",
9621
+ "tags": []
9528
9622
  },
9529
9623
  "signature": "type ComponentContext = BaseComponentTemplateOptions",
9530
9624
  "name": "ComponentContext",
@@ -9564,7 +9658,8 @@
9564
9658
  "character": 3
9565
9659
  },
9566
9660
  "raw": "/**\n * relative path of the file within the component.\n */",
9567
- "comment": "relative path of the file within the component."
9661
+ "comment": "relative path of the file within the component.",
9662
+ "tags": []
9568
9663
  },
9569
9664
  "signature": "(property) ComponentFile.relativePath: string",
9570
9665
  "name": "relativePath",
@@ -9594,7 +9689,8 @@
9594
9689
  "character": 3
9595
9690
  },
9596
9691
  "raw": "/**\n * file content\n */",
9597
- "comment": "file content"
9692
+ "comment": "file content",
9693
+ "tags": []
9598
9694
  },
9599
9695
  "signature": "(property) ComponentFile.content: string",
9600
9696
  "name": "content",
@@ -9624,7 +9720,8 @@
9624
9720
  "character": 3
9625
9721
  },
9626
9722
  "raw": "/**\n * whether this file will be tracked as the main file\n */",
9627
- "comment": "whether this file will be tracked as the main file"
9723
+ "comment": "whether this file will be tracked as the main file",
9724
+ "tags": []
9628
9725
  },
9629
9726
  "signature": "(property) ComponentFile.isMain?: boolean | undefined",
9630
9727
  "name": "isMain",
@@ -9667,7 +9764,8 @@
9667
9764
  "character": 3
9668
9765
  },
9669
9766
  "raw": "/**\n * Aspect id of the aspect that register the template itself\n */",
9670
- "comment": "Aspect id of the aspect that register the template itself"
9767
+ "comment": "Aspect id of the aspect that register the template itself",
9768
+ "tags": []
9671
9769
  },
9672
9770
  "signature": "(property) ConfigContext.aspectId: string",
9673
9771
  "name": "aspectId",
@@ -9767,7 +9865,8 @@
9767
9865
  "character": 3
9768
9866
  },
9769
9867
  "raw": "/**\n * name of the component template. for example: `hook`, `react-component` or `module`.\n */",
9770
- "comment": "name of the component template. for example: `hook`, `react-component` or `module`."
9868
+ "comment": "name of the component template. for example: `hook`, `react-component` or `module`.",
9869
+ "tags": []
9771
9870
  },
9772
9871
  "signature": "(property) ComponentTemplateOptions.name?: string | undefined",
9773
9872
  "name": "name",
@@ -9797,7 +9896,8 @@
9797
9896
  "character": 3
9798
9897
  },
9799
9898
  "raw": "/**\n * short description of the template. shown in the `bit templates` command.\n */",
9800
- "comment": "short description of the template. shown in the `bit templates` command."
9899
+ "comment": "short description of the template. shown in the `bit templates` command.",
9900
+ "tags": []
9801
9901
  },
9802
9902
  "signature": "(property) ComponentTemplateOptions.description?: string | undefined",
9803
9903
  "name": "description",
@@ -9827,7 +9927,8 @@
9827
9927
  "character": 3
9828
9928
  },
9829
9929
  "raw": "/**\n * hide this template so that it is not listed with `bit templates`\n */",
9830
- "comment": "hide this template so that it is not listed with `bit templates`"
9930
+ "comment": "hide this template so that it is not listed with `bit templates`",
9931
+ "tags": []
9831
9932
  },
9832
9933
  "signature": "(property) ComponentTemplateOptions.hidden?: boolean | undefined",
9833
9934
  "name": "hidden",
@@ -9857,7 +9958,8 @@
9857
9958
  "character": 3
9858
9959
  },
9859
9960
  "raw": "/**\n * env to use for the generated component.\n */",
9860
- "comment": "env to use for the generated component."
9961
+ "comment": "env to use for the generated component.",
9962
+ "tags": []
9861
9963
  },
9862
9964
  "signature": "(property) ComponentTemplateOptions.env?: string | undefined",
9863
9965
  "name": "env",
@@ -9887,7 +9989,8 @@
9887
9989
  "character": 3
9888
9990
  },
9889
9991
  "raw": "/**\n * adds a metadata that the component that this template creates is of type env.\n * This will be used later to do further configuration for example:\n * - ensure to create the .bit_root for it\n */",
9890
- "comment": "adds a metadata that the component that this template creates is of type env.\nThis will be used later to do further configuration for example:\n- ensure to create the .bit_root for it"
9992
+ "comment": "adds a metadata that the component that this template creates is of type env.\nThis will be used later to do further configuration for example:\n- ensure to create the .bit_root for it",
9993
+ "tags": []
9891
9994
  },
9892
9995
  "signature": "(property) ComponentTemplateOptions.isEnv?: boolean | undefined",
9893
9996
  "name": "isEnv",
@@ -9917,7 +10020,8 @@
9917
10020
  "character": 3
9918
10021
  },
9919
10022
  "raw": "/**\n * adds a metadata that the component that this template creates is of type app.\n * This will be used later to do further configuration for example:\n * - add it to the workspace.jsonc as app\n * - ensure to create the .bit_root for it\n */",
9920
- "comment": "adds a metadata that the component that this template creates is of type app.\nThis will be used later to do further configuration for example:\n- add it to the workspace.jsonc as app\n- ensure to create the .bit_root for it"
10023
+ "comment": "adds a metadata that the component that this template creates is of type app.\nThis will be used later to do further configuration for example:\n- add it to the workspace.jsonc as app\n- ensure to create the .bit_root for it",
10024
+ "tags": []
9921
10025
  },
9922
10026
  "signature": "(property) ComponentTemplateOptions.isApp?: boolean | undefined",
9923
10027
  "name": "isApp",
@@ -9947,7 +10051,8 @@
9947
10051
  "character": 3
9948
10052
  },
9949
10053
  "raw": "/**\n * list of dependencies to install when the component is created.\n */",
9950
- "comment": "list of dependencies to install when the component is created."
10054
+ "comment": "list of dependencies to install when the component is created.",
10055
+ "tags": []
9951
10056
  },
9952
10057
  "signature": "(property) ComponentTemplateOptions.dependencies?: string[] | undefined",
9953
10058
  "name": "dependencies",
@@ -9985,7 +10090,8 @@
9985
10090
  "character": 3
9986
10091
  },
9987
10092
  "raw": "/**\n * Perform installation of missing dependencies after component generation.\n * This is the same as of running `bit install --add-missing-deps` after component generation.\n */",
9988
- "comment": "Perform installation of missing dependencies after component generation.\nThis is the same as of running `bit install --add-missing-deps` after component generation."
10093
+ "comment": "Perform installation of missing dependencies after component generation.\nThis is the same as of running `bit install --add-missing-deps` after component generation.",
10094
+ "tags": []
9989
10095
  },
9990
10096
  "signature": "(property) ComponentTemplateOptions.installMissingDependencies?: boolean | undefined",
9991
10097
  "name": "installMissingDependencies",
@@ -10048,7 +10154,8 @@
10048
10154
  "character": 3
10049
10155
  },
10050
10156
  "raw": "/**\n * template function for generating the file of a certain component.,\n */",
10051
- "comment": "template function for generating the file of a certain component.,"
10157
+ "comment": "template function for generating the file of a certain component.,",
10158
+ "tags": []
10052
10159
  },
10053
10160
  "signature": "(method) ComponentTemplate.generateFiles(context: ComponentContext): Promise<ComponentFile[]> | ComponentFile[]",
10054
10161
  "name": "generateFiles",
@@ -10146,7 +10253,8 @@
10146
10253
  "character": 3
10147
10254
  },
10148
10255
  "raw": "/**\n * component config. gets saved in the .bitmap file and it overrides the workspace.jsonc config.\n * for example, you can set the env that will be used for this component as follows:\n * \"teambit.envs/envs\": {\n * \"env\": \"teambit.harmony/aspect\"\n * },\n */",
10149
- "comment": "component config. gets saved in the .bitmap file and it overrides the workspace.jsonc config.\nfor example, you can set the env that will be used for this component as follows:\n\"teambit.envs/envs\": {\n \"env\": \"teambit.harmony/aspect\"\n},"
10256
+ "comment": "component config. gets saved in the .bitmap file and it overrides the workspace.jsonc config.\nfor example, you can set the env that will be used for this component as follows:\n\"teambit.envs/envs\": {\n \"env\": \"teambit.harmony/aspect\"\n},",
10257
+ "tags": []
10150
10258
  },
10151
10259
  "signature": "(property) ComponentTemplate.config?: ComponentConfig | ((context: ConfigContext) => ComponentConfig) | undefined",
10152
10260
  "name": "config",
@@ -10270,7 +10378,8 @@
10270
10378
  "character": 3
10271
10379
  },
10272
10380
  "raw": "/**\n * name of the component template. for example: `hook`, `react-component` or `module`.\n */",
10273
- "comment": "name of the component template. for example: `hook`, `react-component` or `module`."
10381
+ "comment": "name of the component template. for example: `hook`, `react-component` or `module`.",
10382
+ "tags": []
10274
10383
  }
10275
10384
  },
10276
10385
  {
@@ -10300,7 +10409,8 @@
10300
10409
  "character": 3
10301
10410
  },
10302
10411
  "raw": "/**\n * short description of the template. shown in the `bit templates` command.\n */",
10303
- "comment": "short description of the template. shown in the `bit templates` command."
10412
+ "comment": "short description of the template. shown in the `bit templates` command.",
10413
+ "tags": []
10304
10414
  }
10305
10415
  },
10306
10416
  {
@@ -10330,7 +10440,8 @@
10330
10440
  "character": 3
10331
10441
  },
10332
10442
  "raw": "/**\n * hide this template so that it is not listed with `bit templates`\n */",
10333
- "comment": "hide this template so that it is not listed with `bit templates`"
10443
+ "comment": "hide this template so that it is not listed with `bit templates`",
10444
+ "tags": []
10334
10445
  }
10335
10446
  },
10336
10447
  {
@@ -10360,7 +10471,8 @@
10360
10471
  "character": 3
10361
10472
  },
10362
10473
  "raw": "/**\n * env to use for the generated component.\n */",
10363
- "comment": "env to use for the generated component."
10474
+ "comment": "env to use for the generated component.",
10475
+ "tags": []
10364
10476
  }
10365
10477
  },
10366
10478
  {
@@ -10390,7 +10502,8 @@
10390
10502
  "character": 3
10391
10503
  },
10392
10504
  "raw": "/**\n * adds a metadata that the component that this template creates is of type env.\n * This will be used later to do further configuration for example:\n * - ensure to create the .bit_root for it\n */",
10393
- "comment": "adds a metadata that the component that this template creates is of type env.\nThis will be used later to do further configuration for example:\n- ensure to create the .bit_root for it"
10505
+ "comment": "adds a metadata that the component that this template creates is of type env.\nThis will be used later to do further configuration for example:\n- ensure to create the .bit_root for it",
10506
+ "tags": []
10394
10507
  }
10395
10508
  },
10396
10509
  {
@@ -10420,7 +10533,8 @@
10420
10533
  "character": 3
10421
10534
  },
10422
10535
  "raw": "/**\n * adds a metadata that the component that this template creates is of type app.\n * This will be used later to do further configuration for example:\n * - add it to the workspace.jsonc as app\n * - ensure to create the .bit_root for it\n */",
10423
- "comment": "adds a metadata that the component that this template creates is of type app.\nThis will be used later to do further configuration for example:\n- add it to the workspace.jsonc as app\n- ensure to create the .bit_root for it"
10536
+ "comment": "adds a metadata that the component that this template creates is of type app.\nThis will be used later to do further configuration for example:\n- add it to the workspace.jsonc as app\n- ensure to create the .bit_root for it",
10537
+ "tags": []
10424
10538
  }
10425
10539
  },
10426
10540
  {
@@ -10458,7 +10572,8 @@
10458
10572
  "character": 3
10459
10573
  },
10460
10574
  "raw": "/**\n * list of dependencies to install when the component is created.\n */",
10461
- "comment": "list of dependencies to install when the component is created."
10575
+ "comment": "list of dependencies to install when the component is created.",
10576
+ "tags": []
10462
10577
  }
10463
10578
  },
10464
10579
  {
@@ -10488,7 +10603,8 @@
10488
10603
  "character": 3
10489
10604
  },
10490
10605
  "raw": "/**\n * Perform installation of missing dependencies after component generation.\n * This is the same as of running `bit install --add-missing-deps` after component generation.\n */",
10491
- "comment": "Perform installation of missing dependencies after component generation.\nThis is the same as of running `bit install --add-missing-deps` after component generation."
10606
+ "comment": "Perform installation of missing dependencies after component generation.\nThis is the same as of running `bit install --add-missing-deps` after component generation.",
10607
+ "tags": []
10492
10608
  }
10493
10609
  }
10494
10610
  ]
@@ -10522,7 +10638,8 @@
10522
10638
  "character": 1
10523
10639
  },
10524
10640
  "raw": "/**\n * BaseWorkspaceOptions describes the foundational properties for workspaces.\n */",
10525
- "comment": "BaseWorkspaceOptions describes the foundational properties for workspaces."
10641
+ "comment": "BaseWorkspaceOptions describes the foundational properties for workspaces.",
10642
+ "tags": []
10526
10643
  },
10527
10644
  "signature": "interface BaseWorkspaceOptions",
10528
10645
  "name": "BaseWorkspaceOptions",
@@ -10542,7 +10659,8 @@
10542
10659
  "character": 3
10543
10660
  },
10544
10661
  "raw": "/**\n * The name of the workspace as provided by the user (e.g., `react-app`).\n * This is also used as the directory name for the workspace.\n */",
10545
- "comment": "The name of the workspace as provided by the user (e.g., `react-app`).\nThis is also used as the directory name for the workspace."
10662
+ "comment": "The name of the workspace as provided by the user (e.g., `react-app`).\nThis is also used as the directory name for the workspace.",
10663
+ "tags": []
10546
10664
  },
10547
10665
  "signature": "(property) BaseWorkspaceOptions.name: string",
10548
10666
  "name": "name",
@@ -10572,7 +10690,8 @@
10572
10690
  "character": 3
10573
10691
  },
10574
10692
  "raw": "/**\n * The default scope provided by the user.\n * This is set in the workspace.jsonc and is utilized for components within the workspace.\n */",
10575
- "comment": "The default scope provided by the user.\nThis is set in the workspace.jsonc and is utilized for components within the workspace."
10693
+ "comment": "The default scope provided by the user.\nThis is set in the workspace.jsonc and is utilized for components within the workspace.",
10694
+ "tags": []
10576
10695
  },
10577
10696
  "signature": "(property) BaseWorkspaceOptions.defaultScope?: string | undefined",
10578
10697
  "name": "defaultScope",
@@ -10602,7 +10721,8 @@
10602
10721
  "character": 3
10603
10722
  },
10604
10723
  "raw": "/**\n * Indicates whether the user has opted to avoid creating components (typically with a `--empty` flag).\n */",
10605
- "comment": "Indicates whether the user has opted to avoid creating components (typically with a `--empty` flag)."
10724
+ "comment": "Indicates whether the user has opted to avoid creating components (typically with a `--empty` flag).",
10725
+ "tags": []
10606
10726
  },
10607
10727
  "signature": "(property) BaseWorkspaceOptions.empty?: boolean | undefined",
10608
10728
  "name": "empty",
@@ -10632,7 +10752,8 @@
10632
10752
  "character": 3
10633
10753
  },
10634
10754
  "raw": "/**\n * Represents the aspect in the context where a remote aspect is imported (often via the `--aspect` flag).\n * This is useful for obtaining the aspect-id and other related information.\n */",
10635
- "comment": "Represents the aspect in the context where a remote aspect is imported (often via the `--aspect` flag).\nThis is useful for obtaining the aspect-id and other related information."
10755
+ "comment": "Represents the aspect in the context where a remote aspect is imported (often via the `--aspect` flag).\nThis is useful for obtaining the aspect-id and other related information.",
10756
+ "tags": []
10636
10757
  },
10637
10758
  "signature": "(property) BaseWorkspaceOptions.aspectComponent?: Component | undefined",
10638
10759
  "name": "aspectComponent",
@@ -10666,7 +10787,8 @@
10666
10787
  "character": 3
10667
10788
  },
10668
10789
  "raw": "/**\n * Represents the selected template to initialize or create the workspace.\n */",
10669
- "comment": "Represents the selected template to initialize or create the workspace."
10790
+ "comment": "Represents the selected template to initialize or create the workspace.",
10791
+ "tags": []
10670
10792
  },
10671
10793
  "signature": "(property) BaseWorkspaceOptions.template: WorkspaceTemplate",
10672
10794
  "name": "template",
@@ -10696,7 +10818,8 @@
10696
10818
  "character": 3
10697
10819
  },
10698
10820
  "raw": "/**\n * Flag to check if Git repository generation should be skipped.\n */",
10699
- "comment": "Flag to check if Git repository generation should be skipped."
10821
+ "comment": "Flag to check if Git repository generation should be skipped.",
10822
+ "tags": []
10700
10823
  },
10701
10824
  "signature": "(property) BaseWorkspaceOptions.skipGit?: boolean | undefined",
10702
10825
  "name": "skipGit",
@@ -10726,7 +10849,8 @@
10726
10849
  "character": 3
10727
10850
  },
10728
10851
  "raw": "/**\n * Local path to the workspace template.\n * Useful during the development of a workspace-template.\n */",
10729
- "comment": "Local path to the workspace template.\nUseful during the development of a workspace-template."
10852
+ "comment": "Local path to the workspace template.\nUseful during the development of a workspace-template.",
10853
+ "tags": []
10730
10854
  },
10731
10855
  "signature": "(property) BaseWorkspaceOptions.loadFrom?: string | undefined",
10732
10856
  "name": "loadFrom",
@@ -10759,7 +10883,8 @@
10759
10883
  "character": 1
10760
10884
  },
10761
10885
  "raw": "/**\n * WorkspaceContext represents foundational properties for a workspace context.\n */",
10762
- "comment": "WorkspaceContext represents foundational properties for a workspace context."
10886
+ "comment": "WorkspaceContext represents foundational properties for a workspace context.",
10887
+ "tags": []
10763
10888
  },
10764
10889
  "signature": "type WorkspaceContext = BaseWorkspaceOptions",
10765
10890
  "name": "WorkspaceContext",
@@ -10799,7 +10924,8 @@
10799
10924
  "character": 3
10800
10925
  },
10801
10926
  "raw": "/**\n * relative path of the file within the workspace.\n */",
10802
- "comment": "relative path of the file within the workspace."
10927
+ "comment": "relative path of the file within the workspace.",
10928
+ "tags": []
10803
10929
  },
10804
10930
  "signature": "(property) WorkspaceFile.relativePath: string",
10805
10931
  "name": "relativePath",
@@ -10829,7 +10955,8 @@
10829
10955
  "character": 3
10830
10956
  },
10831
10957
  "raw": "/**\n * file content\n */",
10832
- "comment": "file content"
10958
+ "comment": "file content",
10959
+ "tags": []
10833
10960
  },
10834
10961
  "signature": "(property) WorkspaceFile.content: string",
10835
10962
  "name": "content",
@@ -10872,7 +10999,8 @@
10872
10999
  "character": 3
10873
11000
  },
10874
11001
  "raw": "/**\n * the template for generating the component\n */",
10875
- "comment": "the template for generating the component"
11002
+ "comment": "the template for generating the component",
11003
+ "tags": []
10876
11004
  },
10877
11005
  "signature": "(property) CreateComponentInfo.templateName: string",
10878
11006
  "name": "templateName",
@@ -10902,7 +11030,8 @@
10902
11030
  "character": 3
10903
11031
  },
10904
11032
  "raw": "/**\n * component name to generate\n */",
10905
- "comment": "component name to generate"
11033
+ "comment": "component name to generate",
11034
+ "tags": []
10906
11035
  },
10907
11036
  "signature": "(property) CreateComponentInfo.componentName: string",
10908
11037
  "name": "componentName",
@@ -10932,7 +11061,8 @@
10932
11061
  "character": 3
10933
11062
  },
10934
11063
  "raw": "/**\n * sets the component's scope-name. if not entered, the default-scope will be used\n */",
10935
- "comment": "sets the component's scope-name. if not entered, the default-scope will be used"
11064
+ "comment": "sets the component's scope-name. if not entered, the default-scope will be used",
11065
+ "tags": []
10936
11066
  },
10937
11067
  "signature": "(property) CreateComponentInfo.scope?: string | undefined",
10938
11068
  "name": "scope",
@@ -10962,7 +11092,8 @@
10962
11092
  "character": 3
10963
11093
  },
10964
11094
  "raw": "/**\n * relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`\n */",
10965
- "comment": "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
11095
+ "comment": "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`",
11096
+ "tags": []
10966
11097
  },
10967
11098
  "signature": "(property) CreateComponentInfo.path?: string | undefined",
10968
11099
  "name": "path",
@@ -10992,7 +11123,8 @@
10992
11123
  "character": 3
10993
11124
  },
10994
11125
  "raw": "/**\n * set the component's environment. (overrides the env from variants and the template)\n */",
10995
- "comment": "set the component's environment. (overrides the env from variants and the template)"
11126
+ "comment": "set the component's environment. (overrides the env from variants and the template)",
11127
+ "tags": []
10996
11128
  },
10997
11129
  "signature": "(property) CreateComponentInfo.env?: string | undefined",
10998
11130
  "name": "env",
@@ -11022,7 +11154,8 @@
11022
11154
  "character": 3
11023
11155
  },
11024
11156
  "raw": "/**\n * aspect-id of the template.\n */",
11025
- "comment": "aspect-id of the template."
11157
+ "comment": "aspect-id of the template.",
11158
+ "tags": []
11026
11159
  },
11027
11160
  "signature": "(property) CreateComponentInfo.aspect?: string | undefined",
11028
11161
  "name": "aspect",
@@ -11065,7 +11198,8 @@
11065
11198
  "character": 3
11066
11199
  },
11067
11200
  "raw": "/**\n * a new component name. if not specified, use the original id (without the scope)\n */",
11068
- "comment": "a new component name. if not specified, use the original id (without the scope)"
11201
+ "comment": "a new component name. if not specified, use the original id (without the scope)",
11202
+ "tags": []
11069
11203
  },
11070
11204
  "signature": "(property) ForkComponentInfo.targetName?: string | undefined",
11071
11205
  "name": "targetName",
@@ -11095,7 +11229,8 @@
11095
11229
  "character": 3
11096
11230
  },
11097
11231
  "raw": "/**\n * a new scope for the component. if not specified, use the original scope\n */",
11098
- "comment": "a new scope for the component. if not specified, use the original scope"
11232
+ "comment": "a new scope for the component. if not specified, use the original scope",
11233
+ "tags": []
11099
11234
  },
11100
11235
  "signature": "(property) ForkComponentInfo.targetScope?: string | undefined",
11101
11236
  "name": "targetScope",
@@ -11125,7 +11260,8 @@
11125
11260
  "character": 3
11126
11261
  },
11127
11262
  "raw": "/**\n * env to use for the component.\n */",
11128
- "comment": "env to use for the component."
11263
+ "comment": "env to use for the component.",
11264
+ "tags": []
11129
11265
  },
11130
11266
  "signature": "(property) ForkComponentInfo.env?: string | undefined",
11131
11267
  "name": "env",
@@ -11155,7 +11291,8 @@
11155
11291
  "character": 3
11156
11292
  },
11157
11293
  "raw": "/**\n * component config. gets saved in the .bitmap file and overrides the workspace.jsonc config.\n * for example, you can set the env that will be used for this component as follows:\n * \"teambit.envs/envs\": {\n * \"env\": \"teambit.harmony/aspect\"\n * },\n */",
11158
- "comment": "component config. gets saved in the .bitmap file and overrides the workspace.jsonc config.\nfor example, you can set the env that will be used for this component as follows:\n\"teambit.envs/envs\": {\n \"env\": \"teambit.harmony/aspect\"\n},"
11294
+ "comment": "component config. gets saved in the .bitmap file and overrides the workspace.jsonc config.\nfor example, you can set the env that will be used for this component as follows:\n\"teambit.envs/envs\": {\n \"env\": \"teambit.harmony/aspect\"\n},",
11295
+ "tags": []
11159
11296
  },
11160
11297
  "signature": "(property) ForkComponentInfo.config?: ComponentConfig | undefined",
11161
11298
  "name": "config",
@@ -11219,7 +11356,8 @@
11219
11356
  "character": 3
11220
11357
  },
11221
11358
  "raw": "/**\n * full component id\n */",
11222
- "comment": "full component id"
11359
+ "comment": "full component id",
11360
+ "tags": []
11223
11361
  }
11224
11362
  },
11225
11363
  {
@@ -11249,7 +11387,8 @@
11249
11387
  "character": 3
11250
11388
  },
11251
11389
  "raw": "/**\n * path where to write the component\n */",
11252
- "comment": "path where to write the component"
11390
+ "comment": "path where to write the component",
11391
+ "tags": []
11253
11392
  }
11254
11393
  }
11255
11394
  ]
@@ -11272,6 +11411,7 @@
11272
11411
  "character": 1
11273
11412
  },
11274
11413
  "raw": "/**\n * @deprecated use ForkComponentInfo instead.\n */",
11414
+ "comment": "",
11275
11415
  "tags": [
11276
11416
  {
11277
11417
  "__schema": "TagSchema",
@@ -11322,7 +11462,8 @@
11322
11462
  "character": 3
11323
11463
  },
11324
11464
  "raw": "/**\n * full component id\n */",
11325
- "comment": "full component id"
11465
+ "comment": "full component id",
11466
+ "tags": []
11326
11467
  },
11327
11468
  "signature": "(property) ImportComponentInfo.id: string",
11328
11469
  "name": "id",
@@ -11352,7 +11493,8 @@
11352
11493
  "character": 3
11353
11494
  },
11354
11495
  "raw": "/**\n * path where to write the component\n */",
11355
- "comment": "path where to write the component"
11496
+ "comment": "path where to write the component",
11497
+ "tags": []
11356
11498
  },
11357
11499
  "signature": "(property) ImportComponentInfo.path?: string | undefined",
11358
11500
  "name": "path",
@@ -11395,7 +11537,8 @@
11395
11537
  "character": 3
11396
11538
  },
11397
11539
  "raw": "/**\n * name of the workspace starter. for example: `react-workspace`.\n */",
11398
- "comment": "name of the workspace starter. for example: `react-workspace`."
11540
+ "comment": "name of the workspace starter. for example: `react-workspace`.",
11541
+ "tags": []
11399
11542
  },
11400
11543
  "signature": "(property) WorkspaceTemplate.name: string",
11401
11544
  "name": "name",
@@ -11425,7 +11568,8 @@
11425
11568
  "character": 3
11426
11569
  },
11427
11570
  "raw": "/**\n * name of an app created in the workspace. for example: `my-app`.\n * This will be used to instruct the user to run `bit run <appName>` in the new workspace.\n */",
11428
- "comment": "name of an app created in the workspace. for example: `my-app`.\nThis will be used to instruct the user to run `bit run <appName>` in the new workspace."
11571
+ "comment": "name of an app created in the workspace. for example: `my-app`.\nThis will be used to instruct the user to run `bit run <appName>` in the new workspace.",
11572
+ "tags": []
11429
11573
  },
11430
11574
  "signature": "(property) WorkspaceTemplate.appName?: string | undefined",
11431
11575
  "name": "appName",
@@ -11455,7 +11599,8 @@
11455
11599
  "character": 3
11456
11600
  },
11457
11601
  "raw": "/**\n * short description of the starter. shown in the `bit starter` command when outside of bit-workspace.\n */",
11458
- "comment": "short description of the starter. shown in the `bit starter` command when outside of bit-workspace."
11602
+ "comment": "short description of the starter. shown in the `bit starter` command when outside of bit-workspace.",
11603
+ "tags": []
11459
11604
  },
11460
11605
  "signature": "(property) WorkspaceTemplate.description?: string | undefined",
11461
11606
  "name": "description",
@@ -11485,7 +11630,8 @@
11485
11630
  "character": 3
11486
11631
  },
11487
11632
  "raw": "/**\n * hide this starter so that it is not listed with `bit starter`\n */",
11488
- "comment": "hide this starter so that it is not listed with `bit starter`"
11633
+ "comment": "hide this starter so that it is not listed with `bit starter`",
11634
+ "tags": []
11489
11635
  },
11490
11636
  "signature": "(property) WorkspaceTemplate.hidden?: boolean | undefined",
11491
11637
  "name": "hidden",
@@ -11515,7 +11661,8 @@
11515
11661
  "character": 3
11516
11662
  },
11517
11663
  "raw": "/**\n * starter function for generating the template files,\n */",
11518
- "comment": "starter function for generating the template files,"
11664
+ "comment": "starter function for generating the template files,",
11665
+ "tags": []
11519
11666
  },
11520
11667
  "signature": "(method) WorkspaceTemplate.generateFiles(context: WorkspaceContext): Promise<WorkspaceFile[]>",
11521
11668
  "name": "generateFiles",
@@ -11586,6 +11733,7 @@
11586
11733
  "character": 3
11587
11734
  },
11588
11735
  "raw": "/**\n * @deprecated use `fork()` or `import()` instead\n * this is working similarly to `fork()`\n */",
11736
+ "comment": "",
11589
11737
  "tags": [
11590
11738
  {
11591
11739
  "__schema": "TagSchema",
@@ -11668,7 +11816,8 @@
11668
11816
  "character": 3
11669
11817
  },
11670
11818
  "raw": "/**\n * import components into the new workspace, don't change their source code.\n */",
11671
- "comment": "import components into the new workspace, don't change their source code."
11819
+ "comment": "import components into the new workspace, don't change their source code.",
11820
+ "tags": []
11672
11821
  },
11673
11822
  "signature": "(property) WorkspaceTemplate.import?: ((context: WorkspaceContext) => ImportComponentInfo[]) | undefined",
11674
11823
  "name": "import",
@@ -11739,7 +11888,8 @@
11739
11888
  "character": 3
11740
11889
  },
11741
11890
  "raw": "/**\n * populate existing components into the new workspace and add them as new components.\n * change their source code and update the dependency names according to the new component names.\n */",
11742
- "comment": "populate existing components into the new workspace and add them as new components.\nchange their source code and update the dependency names according to the new component names."
11891
+ "comment": "populate existing components into the new workspace and add them as new components.\nchange their source code and update the dependency names according to the new component names.",
11892
+ "tags": []
11743
11893
  },
11744
11894
  "signature": "(property) WorkspaceTemplate.fork?: ((context: WorkspaceContext) => ForkComponentInfo[]) | undefined",
11745
11895
  "name": "fork",
@@ -11810,7 +11960,8 @@
11810
11960
  "character": 3
11811
11961
  },
11812
11962
  "raw": "/**\n * populate new components into the new workspace and add them as new components.\n */",
11813
- "comment": "populate new components into the new workspace and add them as new components."
11963
+ "comment": "populate new components into the new workspace and add them as new components.",
11964
+ "tags": []
11814
11965
  },
11815
11966
  "signature": "(property) WorkspaceTemplate.create?: ((context: WorkspaceContext) => CreateComponentInfo[]) | undefined",
11816
11967
  "name": "create",
@@ -11905,7 +12056,8 @@
11905
12056
  "character": 3
11906
12057
  },
11907
12058
  "raw": "/**\n * return a template list instance.\n */",
11908
- "comment": "return a template list instance."
12059
+ "comment": "return a template list instance.",
12060
+ "tags": []
11909
12061
  },
11910
12062
  "signature": "(method) GeneratorEnv.generators(): EnvHandler<TemplateList>",
11911
12063
  "name": "generators",
@@ -11951,7 +12103,8 @@
11951
12103
  "character": 3
11952
12104
  },
11953
12105
  "raw": "/**\n * return a starter list instance.\n */",
11954
- "comment": "return a starter list instance."
12106
+ "comment": "return a starter list instance.",
12107
+ "tags": []
11955
12108
  },
11956
12109
  "signature": "(method) GeneratorEnv.starters(): EnvHandler<StarterList>",
11957
12110
  "name": "starters",
@@ -13331,7 +13484,7 @@
13331
13484
  "componentId": {
13332
13485
  "scope": "teambit.generator",
13333
13486
  "name": "generator",
13334
- "version": "1.0.311"
13487
+ "version": "1.0.312"
13335
13488
  },
13336
13489
  "taggedModuleExports": []
13337
13490
  }