@teambit/compiler 1.0.309 → 1.0.311

package/artifacts/__bit_junit.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuites tests="0" failures="0" errors="0" skipped="0">
-  <testsuite name="teambit.compilation/compiler@1.0.309" tests="0" failures="0" errors="0" skipped="0"/>
+  <testsuite name="teambit.compilation/compiler@1.0.311" tests="0" failures="0" errors="0" skipped="0"/>
 </testsuites>

package/artifacts/preview/teambit_compilation_compiler-preview.js

@@ -1 +1 @@
-!function(e,n){"object"==typeof exports&&"object"==typeof module?module.exports=n():"function"==typeof define&&define.amd?define([],n):"object"==typeof exports?exports["teambit.compilation/compiler-preview"]=n():e["teambit.compilation/compiler-preview"]=n()}(self,(()=>(()=>{"use strict";var e={4713:(e,n,t)=>{var o={id:"teambit.compilation/content/compiler-overview@1.95.0",homepage:"https://bit.dev/teambit/compilation/content/compiler-overview",exported:!0};Object.defineProperty(n,"__esModule",{value:!0}),n.default=u,p(t(41594));var i=t(5016),r=t(65682),a=["components"];function p(e){return e&&e.__esModule?e:{default:e}}function m(){return m=Object.assign||function(e){for(var n=1;n<arguments.length;n++){var t=arguments[n];for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o])}return e},m.apply(this,arguments)}function l(e,n){if(null==e)return{};var t,o,i=d(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o<r.length;o++)t=r[o],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}function d(e,n){if(null==e)return{};var t,o,i={},r=Object.keys(e);for(o=0;o<r.length;o++)t=r[o],n.indexOf(t)>=0||(i[t]=e[t]);return i}p.__bit_component=o,m.__bit_component=o,l.__bit_component=o,d.__bit_component=o;var c={},s="wrapper";function u(e){var n=e.components,t=l(e,a);return(0,i.mdx)(s,m({},c,t,{components:n,mdxType:"MDXLayout"}),(0,i.mdx)(r.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,i.mdx)("h1",null,"Compiler overview"),(0,i.mdx)("p",null,"The Compiler aspect provides a single interface for Component compilation, ",(0,i.mdx)("a",{parentName:"p",href:"/"},"during development")," and ",(0,i.mdx)("a",{parentName:"p",href:"/"},"during build"),".\nIt enables you to use the same commands and APIs to compile any Component, regardless of the specific compiler it uses."),(0,i.mdx)("div",{className:"admonition admonition-info alert alert--info"},(0,i.mdx)("div",{parentName:"div",className:"admonition-heading"},(0,i.mdx)("h5",{parentName:"div"},(0,i.mdx)("span",{parentName:"h5",className:"admonition-icon"},(0,i.mdx)("svg",{parentName:"span",xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"},(0,i.mdx)("path",{parentName:"svg",fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))),"info")),(0,i.mdx)("div",{parentName:"div",className:"admonition-content"},(0,i.mdx)("p",{parentName:"div"},"The specific compiler used by a Component (",(0,i.mdx)("a",{parentName:"p",href:"/"},"Babel"),", ",(0,i.mdx)("a",{parentName:"p",href:"/"},"TypeScript"),", and so on) is set by the Component's Env."))),(0,i.mdx)("h2",null,"Compiling during development"),(0,i.mdx)("p",null,"Run the following to compile all your Workspace Components:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},"bit compile\n")),(0,i.mdx)("p",null,"The following output lists the compilation results in a single format:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},"  STATUS        COMPONENT ID\n✔ SUCCESS       apps/bit-dev\n✔ SUCCESS       blocks/component/architecture-breakdown\n✔ SUCCESS       blocks/footer\n✔ SUCCESS       blocks/header\n✔ SUCCESS       buttons/button\n✔ SUCCESS       content/adding-components\n")),(0,i.mdx)("p",null,"To 'watch' Components for changes, and to auto-compile modified Components, run:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre"},"bit watch\n")),(0,i.mdx)("p",null,"The compiled code is written into each Component's corresponding package, in the ",(0,i.mdx)("a",{parentName:"p",href:"/dependencies/node-modules"},(0,i.mdx)("inlineCode",{parentName:"a"},"node_modules")," directory")," of your workspace.\nFor example, the compiled code for ",(0,i.mdx)("inlineCode",{parentName:"p"},"company.scope/ui/text")," will be found in the ",(0,i.mdx)("inlineCode",{parentName:"p"},"./node_modules/@company/scope.ui.text/dist")," directory (inside your workspace)."),(0,i.mdx)("p",null,"To learn more about compilation in the Workspace, see ",(0,i.mdx)("a",{parentName:"p",href:"/"},"'Compiling during development'"),"."),(0,i.mdx)("h2",null,"Compiling during build"),(0,i.mdx)("p",null,"Run the following to compile Components as part of the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"build pipeline")," (which prepares Components for distribution):"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},"bit build\n")),(0,i.mdx)("p",null,"The output to the terminal details the specific compilers being used, as well as the Envs that use them:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},'...\n✔ env "teambit.harmony/aspect", task "teambit.compilation/compiler:BabelCompiler (compile components for artifact dist)" has completed successfully in 363ms\n✔ env "teambit.react/react", task "teambit.compilation/compiler:TSCompiler (compile components for artifact dist)" has completed successfully in 1s\n✔ env "teambit.mdx/mdx", task "teambit.compilation/compiler:MDXCompiler (compile components)" has completed successfully in 879ms\n...\nthe build has been completed. total: 19 tasks\n')),(0,i.mdx)("p",null,"The compiled code is written into the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"Component's Capsule"),". Run ",(0,i.mdx)("a",{parentName:"p",href:"/"},(0,i.mdx)("inlineCode",{parentName:"a"},"bit snap"))," or ",(0,i.mdx)("a",{parentName:"p",href:"/"},(0,i.mdx)("inlineCode",{parentName:"a"},"bit tag"))," to execute the build pipeline (as well as other pipelines), and have the compiled code persisted in the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"Component version"),", and included in the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"Component's package"),"."),(0,i.mdx)("p",null,"To learn more about compilation in the Workspace, see ",(0,i.mdx)("a",{parentName:"p",href:"/"},"'Compiling during build'"),"."),(0,i.mdx)("h2",null,"Compilation strategies and standards"),(0,i.mdx)("p",null,"The Compiler aspect does not set specific compilation strategies as these are defined by the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"specific compilers")," themselves (and are often configurable by the Envs that use them)."),(0,i.mdx)("p",null,"However, all official Bit compilers are configured to favor dev experience when compiling during development, and to favor runtime performance and code universality, when compiling for distribution (during build)."),(0,i.mdx)("p",null,"For example, Bit's ",(0,i.mdx)("a",{parentName:"p",href:"/"},"TypeScript compiler")," performs type-checking when compiling during build but skips it when compiling during development.\nThis enables faster compilation and better dev experience."),(0,i.mdx)("p",null,"To examine a Component's specific compiler config, run the following:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre"},"bit env get COMPONENT_ID\n")),(0,i.mdx)("p",null,"For example:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre"},"bit env get company.demo/ui/card\n")),(0,i.mdx)("p",null,"The output details the Component's env config which includes the compiler config:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},'Environment: teambit.react/react\n...\nteambit.compilation/compiler\n\nconfigured compiler: teambit.typescript/typescript (TypeScript @ 4.4.2)\ncompiler config:\n{\n  "compilerOptions": {\n    "lib": [\n      "es2019",\n      "DOM",\n      "ES6",\n      "DOM.Iterable"\n    ],\n    "target": "es2015",\n    "module": "commonjs",\n    "jsx": "react",\n    "declaration": true,\n    "sourceMap": true,\n    "skipLibCheck": true,\n    "moduleResolution": "node",\n    "esModuleInterop": true,\n    "resolveJsonModule": true,\n    "outDir": "dist"\n  },\n  "exclude": [\n    "dist"\n  ]\n}\n\n')),(0,i.mdx)("h2",null,"Setting a Component with a specific compiler"),(0,i.mdx)("p",null,"Specific compilers are applied on Components via the Components' Envs. For example, the ",(0,i.mdx)("inlineCode",{parentName:"p"},"company.demo/ui/card")," Component examined earlier, is applied with\nthe ",(0,i.mdx)("a",{parentName:"p",href:"/"},"TypeScript")," compiler by its Env, the React Env."),(0,i.mdx)("p",null,"To learn how to use a specific compiler, see ",(0,i.mdx)("a",{parentName:"p",href:"/"},"'Using compilers'"),".")))}u.__bit_component=o,u.isMDXComponent=!0},79391:(e,n,t)=>{Object.defineProperty(n,"Ay",{enumerable:!0,get:function(){return o.default}});var o=i(t(4713));function i(e){return e&&e.__esModule?e:{default:e}}i.__bit_component={id:"teambit.compilation/content/compiler-overview@1.95.0",homepage:"https://bit.dev/teambit/compilation/content/compiler-overview",exported:!0}},89914:(e,n,t)=>{var o={id:"teambit.compilation/compiler@1.0.309",homepage:"https://bit.cloud/teambit/compilation/compiler",exported:!0};function i(){const e=r(t(41594));return i=function(){return e},e}function r(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(n,"__esModule",{value:!0}),n.Logo=void 0,i.__bit_component=o,r.__bit_component=o;const a=()=>i().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},i().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/compiler.svg"}));a.__bit_component=o,n.Logo=a},5016:e=>{e.exports=MdxJsReact},41594:e=>{e.exports=React},65682:e=>{e.exports=TeambitMdxUiMdxScopeContext}},n={};function t(o){var i=n[o];if(void 0!==i)return i.exports;var r=n[o]={exports:{}};return e[o](r,r.exports,t),r.exports}t.d=(e,n)=>{for(var o in n)t.o(n,o)&&!t.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:n[o]})},t.o=(e,n)=>Object.prototype.hasOwnProperty.call(e,n),t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};t.r(o),t.d(o,{compositions:()=>f,compositions_metadata:()=>x,overview:()=>h});var i={};t.r(i),t.d(i,{default:()=>u});var r=t(89914),a=(t(41594),t(5016)),p=t(65682),m=t(79391),l=["components"];function d(){return d=Object.assign?Object.assign.bind():function(e){for(var n=1;n<arguments.length;n++){var t=arguments[n];for(var o in t)({}).hasOwnProperty.call(t,o)&&(e[o]=t[o])}return e},d.apply(null,arguments)}var c={},s="wrapper";function u(e){var n=e.components,t=function(e,n){if(null==e)return{};var t,o,i=function(e,n){if(null==e)return{};var t={};for(var o in e)if({}.hasOwnProperty.call(e,o)){if(n.indexOf(o)>=0)continue;t[o]=e[o]}return t}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o<r.length;o++)t=r[o],n.indexOf(t)>=0||{}.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}(e,l);return(0,a.mdx)(s,d({},c,t,{components:n,mdxType:"MDXLayout"}),(0,a.mdx)(p.MDXScopeProvider,{components:{CompilerOverview:m.Ay},mdxType:"MDXScopeProvider"},(0,a.mdx)(m.Ay,{mdxType:"CompilerOverview"})))}u.isMDXComponent=!0;const f=[r],h=[i],x={compositions:[{displayName:"Logo",identifier:"Logo"}]};return o})()));
+!function(e,n){"object"==typeof exports&&"object"==typeof module?module.exports=n():"function"==typeof define&&define.amd?define([],n):"object"==typeof exports?exports["teambit.compilation/compiler-preview"]=n():e["teambit.compilation/compiler-preview"]=n()}(self,(()=>(()=>{"use strict";var e={93926:(e,n,t)=>{var o={id:"teambit.compilation/content/compiler-overview@1.95.0",homepage:"https://bit.dev/teambit/compilation/content/compiler-overview",exported:!0};Object.defineProperty(n,"__esModule",{value:!0}),n.default=u,p(t(41594));var i=t(5016),r=t(65682),a=["components"];function p(e){return e&&e.__esModule?e:{default:e}}function m(){return m=Object.assign||function(e){for(var n=1;n<arguments.length;n++){var t=arguments[n];for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o])}return e},m.apply(this,arguments)}function l(e,n){if(null==e)return{};var t,o,i=d(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o<r.length;o++)t=r[o],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}function d(e,n){if(null==e)return{};var t,o,i={},r=Object.keys(e);for(o=0;o<r.length;o++)t=r[o],n.indexOf(t)>=0||(i[t]=e[t]);return i}p.__bit_component=o,m.__bit_component=o,l.__bit_component=o,d.__bit_component=o;var c={},s="wrapper";function u(e){var n=e.components,t=l(e,a);return(0,i.mdx)(s,m({},c,t,{components:n,mdxType:"MDXLayout"}),(0,i.mdx)(r.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,i.mdx)("h1",null,"Compiler overview"),(0,i.mdx)("p",null,"The Compiler aspect provides a single interface for Component compilation, ",(0,i.mdx)("a",{parentName:"p",href:"/"},"during development")," and ",(0,i.mdx)("a",{parentName:"p",href:"/"},"during build"),".\nIt enables you to use the same commands and APIs to compile any Component, regardless of the specific compiler it uses."),(0,i.mdx)("div",{className:"admonition admonition-info alert alert--info"},(0,i.mdx)("div",{parentName:"div",className:"admonition-heading"},(0,i.mdx)("h5",{parentName:"div"},(0,i.mdx)("span",{parentName:"h5",className:"admonition-icon"},(0,i.mdx)("svg",{parentName:"span",xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"},(0,i.mdx)("path",{parentName:"svg",fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))),"info")),(0,i.mdx)("div",{parentName:"div",className:"admonition-content"},(0,i.mdx)("p",{parentName:"div"},"The specific compiler used by a Component (",(0,i.mdx)("a",{parentName:"p",href:"/"},"Babel"),", ",(0,i.mdx)("a",{parentName:"p",href:"/"},"TypeScript"),", and so on) is set by the Component's Env."))),(0,i.mdx)("h2",null,"Compiling during development"),(0,i.mdx)("p",null,"Run the following to compile all your Workspace Components:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},"bit compile\n")),(0,i.mdx)("p",null,"The following output lists the compilation results in a single format:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},"  STATUS        COMPONENT ID\n✔ SUCCESS       apps/bit-dev\n✔ SUCCESS       blocks/component/architecture-breakdown\n✔ SUCCESS       blocks/footer\n✔ SUCCESS       blocks/header\n✔ SUCCESS       buttons/button\n✔ SUCCESS       content/adding-components\n")),(0,i.mdx)("p",null,"To 'watch' Components for changes, and to auto-compile modified Components, run:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre"},"bit watch\n")),(0,i.mdx)("p",null,"The compiled code is written into each Component's corresponding package, in the ",(0,i.mdx)("a",{parentName:"p",href:"/dependencies/node-modules"},(0,i.mdx)("inlineCode",{parentName:"a"},"node_modules")," directory")," of your workspace.\nFor example, the compiled code for ",(0,i.mdx)("inlineCode",{parentName:"p"},"company.scope/ui/text")," will be found in the ",(0,i.mdx)("inlineCode",{parentName:"p"},"./node_modules/@company/scope.ui.text/dist")," directory (inside your workspace)."),(0,i.mdx)("p",null,"To learn more about compilation in the Workspace, see ",(0,i.mdx)("a",{parentName:"p",href:"/"},"'Compiling during development'"),"."),(0,i.mdx)("h2",null,"Compiling during build"),(0,i.mdx)("p",null,"Run the following to compile Components as part of the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"build pipeline")," (which prepares Components for distribution):"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},"bit build\n")),(0,i.mdx)("p",null,"The output to the terminal details the specific compilers being used, as well as the Envs that use them:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},'...\n✔ env "teambit.harmony/aspect", task "teambit.compilation/compiler:BabelCompiler (compile components for artifact dist)" has completed successfully in 363ms\n✔ env "teambit.react/react", task "teambit.compilation/compiler:TSCompiler (compile components for artifact dist)" has completed successfully in 1s\n✔ env "teambit.mdx/mdx", task "teambit.compilation/compiler:MDXCompiler (compile components)" has completed successfully in 879ms\n...\nthe build has been completed. total: 19 tasks\n')),(0,i.mdx)("p",null,"The compiled code is written into the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"Component's Capsule"),". Run ",(0,i.mdx)("a",{parentName:"p",href:"/"},(0,i.mdx)("inlineCode",{parentName:"a"},"bit snap"))," or ",(0,i.mdx)("a",{parentName:"p",href:"/"},(0,i.mdx)("inlineCode",{parentName:"a"},"bit tag"))," to execute the build pipeline (as well as other pipelines), and have the compiled code persisted in the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"Component version"),", and included in the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"Component's package"),"."),(0,i.mdx)("p",null,"To learn more about compilation in the Workspace, see ",(0,i.mdx)("a",{parentName:"p",href:"/"},"'Compiling during build'"),"."),(0,i.mdx)("h2",null,"Compilation strategies and standards"),(0,i.mdx)("p",null,"The Compiler aspect does not set specific compilation strategies as these are defined by the ",(0,i.mdx)("a",{parentName:"p",href:"/"},"specific compilers")," themselves (and are often configurable by the Envs that use them)."),(0,i.mdx)("p",null,"However, all official Bit compilers are configured to favor dev experience when compiling during development, and to favor runtime performance and code universality, when compiling for distribution (during build)."),(0,i.mdx)("p",null,"For example, Bit's ",(0,i.mdx)("a",{parentName:"p",href:"/"},"TypeScript compiler")," performs type-checking when compiling during build but skips it when compiling during development.\nThis enables faster compilation and better dev experience."),(0,i.mdx)("p",null,"To examine a Component's specific compiler config, run the following:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre"},"bit env get COMPONENT_ID\n")),(0,i.mdx)("p",null,"For example:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre"},"bit env get company.demo/ui/card\n")),(0,i.mdx)("p",null,"The output details the Component's env config which includes the compiler config:"),(0,i.mdx)("pre",null,(0,i.mdx)("code",{parentName:"pre",className:"language-bash"},'Environment: teambit.react/react\n...\nteambit.compilation/compiler\n\nconfigured compiler: teambit.typescript/typescript (TypeScript @ 4.4.2)\ncompiler config:\n{\n  "compilerOptions": {\n    "lib": [\n      "es2019",\n      "DOM",\n      "ES6",\n      "DOM.Iterable"\n    ],\n    "target": "es2015",\n    "module": "commonjs",\n    "jsx": "react",\n    "declaration": true,\n    "sourceMap": true,\n    "skipLibCheck": true,\n    "moduleResolution": "node",\n    "esModuleInterop": true,\n    "resolveJsonModule": true,\n    "outDir": "dist"\n  },\n  "exclude": [\n    "dist"\n  ]\n}\n\n')),(0,i.mdx)("h2",null,"Setting a Component with a specific compiler"),(0,i.mdx)("p",null,"Specific compilers are applied on Components via the Components' Envs. For example, the ",(0,i.mdx)("inlineCode",{parentName:"p"},"company.demo/ui/card")," Component examined earlier, is applied with\nthe ",(0,i.mdx)("a",{parentName:"p",href:"/"},"TypeScript")," compiler by its Env, the React Env."),(0,i.mdx)("p",null,"To learn how to use a specific compiler, see ",(0,i.mdx)("a",{parentName:"p",href:"/"},"'Using compilers'"),".")))}u.__bit_component=o,u.isMDXComponent=!0},5856:(e,n,t)=>{Object.defineProperty(n,"Ay",{enumerable:!0,get:function(){return o.default}});var o=i(t(93926));function i(e){return e&&e.__esModule?e:{default:e}}i.__bit_component={id:"teambit.compilation/content/compiler-overview@1.95.0",homepage:"https://bit.dev/teambit/compilation/content/compiler-overview",exported:!0}},2842:(e,n,t)=>{var o={id:"teambit.compilation/compiler@1.0.311",homepage:"https://bit.cloud/teambit/compilation/compiler",exported:!0};function i(){const e=r(t(41594));return i=function(){return e},e}function r(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(n,"__esModule",{value:!0}),n.Logo=void 0,i.__bit_component=o,r.__bit_component=o;const a=()=>i().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},i().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/compiler.svg"}));a.__bit_component=o,n.Logo=a},5016:e=>{e.exports=MdxJsReact},41594:e=>{e.exports=React},65682:e=>{e.exports=TeambitMdxUiMdxScopeContext}},n={};function t(o){var i=n[o];if(void 0!==i)return i.exports;var r=n[o]={exports:{}};return e[o](r,r.exports,t),r.exports}t.d=(e,n)=>{for(var o in n)t.o(n,o)&&!t.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:n[o]})},t.o=(e,n)=>Object.prototype.hasOwnProperty.call(e,n),t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};t.r(o),t.d(o,{compositions:()=>f,compositions_metadata:()=>x,overview:()=>h});var i={};t.r(i),t.d(i,{default:()=>u});var r=t(2842),a=(t(41594),t(5016)),p=t(65682),m=t(5856),l=["components"];function d(){return d=Object.assign?Object.assign.bind():function(e){for(var n=1;n<arguments.length;n++){var t=arguments[n];for(var o in t)({}).hasOwnProperty.call(t,o)&&(e[o]=t[o])}return e},d.apply(null,arguments)}var c={},s="wrapper";function u(e){var n=e.components,t=function(e,n){if(null==e)return{};var t,o,i=function(e,n){if(null==e)return{};var t={};for(var o in e)if({}.hasOwnProperty.call(e,o)){if(n.indexOf(o)>=0)continue;t[o]=e[o]}return t}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o<r.length;o++)t=r[o],n.indexOf(t)>=0||{}.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}(e,l);return(0,a.mdx)(s,d({},c,t,{components:n,mdxType:"MDXLayout"}),(0,a.mdx)(p.MDXScopeProvider,{components:{CompilerOverview:m.Ay},mdxType:"MDXScopeProvider"},(0,a.mdx)(m.Ay,{mdxType:"CompilerOverview"})))}u.isMDXComponent=!0;const f=[r],h=[i],x={compositions:[{displayName:"Logo",identifier:"Logo"}]};return o})()));

package/artifacts/schema.json

@@ -276,7 +276,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * Run compilation on `bit new` and when new components are imported\n   */",
-                "comment": "Run compilation on `bit new` and when new components are imported"
+                "comment": "Run compilation on `bit new` and when new components are imported",
+                "tags": []
               },
               "signature": "(method) CompilerMain.compileOnWorkspace(componentsIds?: string[] | ComponentID[] | ComponentID[], options?: CompileOptions): Promise<BuildResult[]>",
               "name": "compileOnWorkspace",
@@ -413,7 +414,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * API to create a new compiler task, it facilitates the usage of multiple compilers.\n   * with this method you can create any number of compilers and add them to the buildPipeline.\n   */",
-                "comment": "API to create a new compiler task, it facilitates the usage of multiple compilers.\nwith this method you can create any number of compilers and add them to the buildPipeline."
+                "comment": "API to create a new compiler task, it facilitates the usage of multiple compilers.\nwith this method you can create any number of compilers and add them to the buildPipeline.",
+                "tags": []
               },
               "signature": "(method) CompilerMain.createTask(name: string, compiler: Compiler): CompilerTask",
               "name": "createTask",
@@ -485,7 +487,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * find the compiler configured on the workspace and ask for the dist path.\n   */",
-                "comment": "find the compiler configured on the workspace and ask for the dist path."
+                "comment": "find the compiler configured on the workspace and ask for the dist path.",
+                "tags": []
               },
               "signature": "(method) CompilerMain.getDistPathBySrcPath(component: Component, srcPath: string): string | null",
               "name": "getDistPathBySrcPath",
@@ -580,7 +583,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * find the compiler configured on the workspace and ask for the dist folder path.\n   */",
-                "comment": "find the compiler configured on the workspace and ask for the dist folder path."
+                "comment": "find the compiler configured on the workspace and ask for the dist folder path.",
+                "tags": []
               },
               "signature": "(method) CompilerMain.getRelativeDistFolder(component: Component): string",
               "name": "getRelativeDistFolder",
@@ -1155,7 +1159,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * instance of compiler to use.\n   */",
-                  "comment": "instance of compiler to use."
+                  "comment": "instance of compiler to use.",
+                  "tags": []
                 },
                 "signature": "(property) compiler: EnvHandler<Compiler>",
                 "name": "compiler",
@@ -1200,7 +1205,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * name of compiler task\n   */",
-                  "comment": "name of compiler task"
+                  "comment": "name of compiler task",
+                  "tags": []
                 },
                 "signature": "(property) name?: string | undefined",
                 "name": "name",
@@ -1242,7 +1248,8 @@
               "character": 1
             },
             "raw": "/**\n * compiler build task. Allows to compile components during component build.\n */",
-            "comment": "compiler build task. Allows to compile components during component build."
+            "comment": "compiler build task. Allows to compile components during component build.",
+            "tags": []
           },
           "signature": "class CompilerTask",
           "name": "CompilerTask",
@@ -1704,7 +1711,7 @@
                   "_legacy": {
                     "scope": "teambit.compilation",
                     "name": "compiler",
-                    "version": "1.0.309"
+                    "version": "1.0.311"
                   },
                   "_scope": "teambit.compilation"
                 }
@@ -1746,7 +1753,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * return a compiler instance.\n   */",
-                "comment": "return a compiler instance."
+                "comment": "return a compiler instance.",
+                "tags": []
               },
               "signature": "(method) CompilerEnv.compiler(): EnvHandler<Compiler>",
               "name": "compiler",
@@ -1960,7 +1968,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * id of the compiler.\n   */",
-                "comment": "id of the compiler."
+                "comment": "id of the compiler.",
+                "tags": []
               },
               "signature": "(property) Compiler.id: string",
               "name": "id",
@@ -1990,7 +1999,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * Delete dist folder before writing the new compiled files\n   */",
-                "comment": "Delete dist folder before writing the new compiled files"
+                "comment": "Delete dist folder before writing the new compiled files",
+                "tags": []
               },
               "signature": "(property) Compiler.deleteDistDir?: boolean | undefined",
               "name": "deleteDistDir",
@@ -2020,7 +2030,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * serialized config of the compiler.\n   */",
-                "comment": "serialized config of the compiler."
+                "comment": "serialized config of the compiler.",
+                "tags": []
               },
               "signature": "(method) Compiler.displayConfig?(): string",
               "name": "displayConfig",
@@ -2051,7 +2062,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * transpile a single file that gets saved into the workspace, used by `bit compile` and during\n   * development\n   */",
-                "comment": "transpile a single file that gets saved into the workspace, used by `bit compile` and during\ndevelopment"
+                "comment": "transpile a single file that gets saved into the workspace, used by `bit compile` and during\ndevelopment",
+                "tags": []
               },
               "signature": "(property) Compiler.transpileFile?: ((fileContent: string, params: TranspileFileParams) => TranspileFileOutput | Promise<TranspileFileOutput>) | undefined",
               "name": "transpileFile",
@@ -2164,7 +2176,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * transpile all the files of a component, use this when you can't use `transpileFile`\n   */",
-                "comment": "transpile all the files of a component, use this when you can't use `transpileFile`"
+                "comment": "transpile all the files of a component, use this when you can't use `transpileFile`",
+                "tags": []
               },
               "signature": "(property) Compiler.transpileComponent?: ((params: TranspileComponentParams) => Promise<void>) | undefined",
               "name": "transpileComponent",
@@ -2238,7 +2251,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * compile components inside isolated capsules. this being used during tag for the release.\n   * meaning, the final package of the component has the dists generated by this method.\n   *\n   * no need to handle non-supported-files (e.g. assets) in this method because the compiler-aspect already copies them\n   * into the compiler.dist in the preBuild stage.\n   */",
-                "comment": "compile components inside isolated capsules. this being used during tag for the release.\nmeaning, the final package of the component has the dists generated by this method.\n\nno need to handle non-supported-files (e.g. assets) in this method because the compiler-aspect already copies them\ninto the compiler.dist in the preBuild stage."
+                "comment": "compile components inside isolated capsules. this being used during tag for the release.\nmeaning, the final package of the component has the dists generated by this method.\n\nno need to handle non-supported-files (e.g. assets) in this method because the compiler-aspect already copies them\ninto the compiler.dist in the preBuild stage.",
+                "tags": []
               },
               "signature": "(method) Compiler.build(context: BuildContext): Promise<BuiltTaskResult>",
               "name": "build",
@@ -2309,7 +2323,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * return the dist dir of the compiled files (relative path from the component root dir)\n   */",
-                "comment": "return the dist dir of the compiled files (relative path from the component root dir)"
+                "comment": "return the dist dir of the compiled files (relative path from the component root dir)",
+                "tags": []
               },
               "signature": "(method) Compiler.getDistDir?(): string",
               "name": "getDistDir",
@@ -2340,7 +2355,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * given a source file, return its parallel in the dists. e.g. \"index.ts\" => \"dist/index.js\"\n   * both, the return path and the given path are relative paths.\n   */",
-                "comment": "given a source file, return its parallel in the dists. e.g. \"index.ts\" => \"dist/index.js\"\nboth, the return path and the given path are relative paths."
+                "comment": "given a source file, return its parallel in the dists. e.g. \"index.ts\" => \"dist/index.js\"\nboth, the return path and the given path are relative paths.",
+                "tags": []
               },
               "signature": "(method) Compiler.getDistPathBySrcPath(srcPath: string): string",
               "name": "getDistPathBySrcPath",
@@ -2392,7 +2408,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * given a component, returns the path to the source folder to use for the preview, uses the one\n   * in node_modules by default\n   */",
-                "comment": "given a component, returns the path to the source folder to use for the preview, uses the one\nin node_modules by default"
+                "comment": "given a component, returns the path to the source folder to use for the preview, uses the one\nin node_modules by default",
+                "tags": []
               },
               "signature": "(method) Compiler.getPreviewComponentRootPath?(component: Component): string",
               "name": "getPreviewComponentRootPath",
@@ -2448,7 +2465,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * only supported files matching get compiled. others, are copied to the dist dir.\n   */",
-                "comment": "only supported files matching get compiled. others, are copied to the dist dir."
+                "comment": "only supported files matching get compiled. others, are copied to the dist dir.",
+                "tags": []
               },
               "signature": "(method) Compiler.isFileSupported(filePath: string): boolean",
               "name": "isFileSupported",
@@ -2500,7 +2518,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * sugar to create a Compiler task via the concrete compiler\n   */",
-                "comment": "sugar to create a Compiler task via the concrete compiler"
+                "comment": "sugar to create a Compiler task via the concrete compiler",
+                "tags": []
               },
               "signature": "(method) Compiler.createTask?(name?: string): BuildTask",
               "name": "createTask",
@@ -2556,7 +2575,8 @@
                   "character": 3
                 },
                 "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   */",
-                "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."
+                "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.",
+                "tags": []
               },
               "signature": "(method) Compiler.preBuild?(context: BuildContext): Promise<void>",
               "name": "preBuild",
@@ -2623,7 +2643,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * run after the build pipeline completed for all envs. useful for some cleanups\n   */",
-                "comment": "run after the build pipeline completed for all envs. useful for some cleanups"
+                "comment": "run after the build pipeline completed for all envs. useful for some cleanups",
+                "tags": []
               },
               "signature": "(method) Compiler.postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>",
               "name": "postBuild",
@@ -2714,7 +2735,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * returns the version of the current compiler instance (e.g. '4.0.1').\n   */",
-                "comment": "returns the version of the current compiler instance (e.g. '4.0.1')."
+                "comment": "returns the version of the current compiler instance (e.g. '4.0.1').",
+                "tags": []
               },
               "signature": "(method) Compiler.version(): string",
               "name": "version",
@@ -2745,7 +2767,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * returns the display name of the current compiler instance (e.g. 'TypeScript')\n   */",
-                "comment": "returns the display name of the current compiler instance (e.g. 'TypeScript')"
+                "comment": "returns the display name of the current compiler instance (e.g. 'TypeScript')",
+                "tags": []
               },
               "signature": "(property) Compiler.displayName: string",
               "name": "displayName",
@@ -2809,7 +2832,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * name of the compiler.\n   */",
-                      "comment": "name of the compiler."
+                      "comment": "name of the compiler.",
+                      "tags": []
                     }
                   },
                   {
@@ -2839,7 +2863,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * relative path of the dist directory inside the capsule. e.g. \"dist\".\n   */",
-                      "comment": "relative path of the dist directory inside the capsule. e.g. \"dist\"."
+                      "comment": "relative path of the dist directory inside the capsule. e.g. \"dist\".",
+                      "tags": []
                     }
                   },
                   {
@@ -2877,7 +2902,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * determines which ones of the generated files will be saved in the bit objects when tagging.\n   * e.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\n   * see https://github.com/mrmlnc/fast-glob for the supported glob patters syntax.\n   */",
-                      "comment": "determines which ones of the generated files will be saved in the bit objects when tagging.\ne.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\nsee https://github.com/mrmlnc/fast-glob for the supported glob patters syntax."
+                      "comment": "determines which ones of the generated files will be saved in the bit objects when tagging.\ne.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\nsee https://github.com/mrmlnc/fast-glob for the supported glob patters syntax.",
+                      "tags": []
                     }
                   },
                   {
@@ -2907,7 +2933,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * whether or not unsupported files (such as assets) should be copied into the dist directory\n   */",
-                      "comment": "whether or not unsupported files (such as assets) should be copied into the dist directory"
+                      "comment": "whether or not unsupported files (such as assets) should be copied into the dist directory",
+                      "tags": []
                     }
                   },
                   {
@@ -2937,7 +2964,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * optional. default to \"dist\".\n   * useful when the build pipeline has multiple compiler tasks of the same compiler.\n   * e.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\n   * the second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly.\n   */",
-                      "comment": "optional. default to \"dist\".\nuseful when the build pipeline has multiple compiler tasks of the same compiler.\ne.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\nthe second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly."
+                      "comment": "optional. default to \"dist\".\nuseful when the build pipeline has multiple compiler tasks of the same compiler.\ne.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\nthe second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly.",
+                      "tags": []
                     }
                   }
                 ]
@@ -2964,7 +2992,7 @@
                   "_legacy": {
                     "scope": "teambit.compilation",
                     "name": "compiler",
-                    "version": "1.0.309"
+                    "version": "1.0.311"
                   },
                   "_scope": "teambit.compilation"
                 }
@@ -3006,7 +3034,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * name of the compiler.\n   */",
-                "comment": "name of the compiler."
+                "comment": "name of the compiler.",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.name?: string | undefined",
               "name": "name",
@@ -3036,7 +3065,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * relative path of the dist directory inside the capsule. e.g. \"dist\".\n   */",
-                "comment": "relative path of the dist directory inside the capsule. e.g. \"dist\"."
+                "comment": "relative path of the dist directory inside the capsule. e.g. \"dist\".",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.distDir: string",
               "name": "distDir",
@@ -3066,7 +3096,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * determines which ones of the generated files will be saved in the bit objects when tagging.\n   * e.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\n   * see https://github.com/mrmlnc/fast-glob for the supported glob patters syntax.\n   */",
-                "comment": "determines which ones of the generated files will be saved in the bit objects when tagging.\ne.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\nsee https://github.com/mrmlnc/fast-glob for the supported glob patters syntax."
+                "comment": "determines which ones of the generated files will be saved in the bit objects when tagging.\ne.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\nsee https://github.com/mrmlnc/fast-glob for the supported glob patters syntax.",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.distGlobPatterns?: string[] | undefined",
               "name": "distGlobPatterns",
@@ -3104,7 +3135,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * whether or not unsupported files (such as assets) should be copied into the dist directory\n   */",
-                "comment": "whether or not unsupported files (such as assets) should be copied into the dist directory"
+                "comment": "whether or not unsupported files (such as assets) should be copied into the dist directory",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.shouldCopyNonSupportedFiles?: boolean | undefined",
               "name": "shouldCopyNonSupportedFiles",
@@ -3134,7 +3166,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * optional. default to \"dist\".\n   * useful when the build pipeline has multiple compiler tasks of the same compiler.\n   * e.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\n   * the second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly.\n   */",
-                "comment": "optional. default to \"dist\".\nuseful when the build pipeline has multiple compiler tasks of the same compiler.\ne.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\nthe second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly."
+                "comment": "optional. default to \"dist\".\nuseful when the build pipeline has multiple compiler tasks of the same compiler.\ne.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\nthe second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly.",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.artifactName?: string | undefined",
               "name": "artifactName",
@@ -3587,7 +3620,7 @@
                 "_legacy": {
                   "scope": "teambit.compilation",
                   "name": "compiler",
-                  "version": "1.0.309"
+                  "version": "1.0.311"
                 },
                 "_scope": "teambit.compilation"
               }
@@ -3863,7 +3896,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * Run compilation on `bit new` and when new components are imported\n   */",
-                "comment": "Run compilation on `bit new` and when new components are imported"
+                "comment": "Run compilation on `bit new` and when new components are imported",
+                "tags": []
               },
               "signature": "(method) CompilerMain.compileOnWorkspace(componentsIds?: string[] | ComponentID[] | ComponentID[], options?: CompileOptions): Promise<BuildResult[]>",
               "name": "compileOnWorkspace",
@@ -4000,7 +4034,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * API to create a new compiler task, it facilitates the usage of multiple compilers.\n   * with this method you can create any number of compilers and add them to the buildPipeline.\n   */",
-                "comment": "API to create a new compiler task, it facilitates the usage of multiple compilers.\nwith this method you can create any number of compilers and add them to the buildPipeline."
+                "comment": "API to create a new compiler task, it facilitates the usage of multiple compilers.\nwith this method you can create any number of compilers and add them to the buildPipeline.",
+                "tags": []
               },
               "signature": "(method) CompilerMain.createTask(name: string, compiler: Compiler): CompilerTask",
               "name": "createTask",
@@ -4072,7 +4107,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * find the compiler configured on the workspace and ask for the dist path.\n   */",
-                "comment": "find the compiler configured on the workspace and ask for the dist path."
+                "comment": "find the compiler configured on the workspace and ask for the dist path.",
+                "tags": []
               },
               "signature": "(method) CompilerMain.getDistPathBySrcPath(component: Component, srcPath: string): string | null",
               "name": "getDistPathBySrcPath",
@@ -4167,7 +4203,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * find the compiler configured on the workspace and ask for the dist folder path.\n   */",
-                "comment": "find the compiler configured on the workspace and ask for the dist folder path."
+                "comment": "find the compiler configured on the workspace and ask for the dist folder path.",
+                "tags": []
               },
               "signature": "(method) CompilerMain.getRelativeDistFolder(component: Component): string",
               "name": "getRelativeDistFolder",
@@ -4765,7 +4802,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * instance of compiler to use.\n   */",
-                  "comment": "instance of compiler to use."
+                  "comment": "instance of compiler to use.",
+                  "tags": []
                 },
                 "signature": "(property) compiler: EnvHandler<Compiler>",
                 "name": "compiler",
@@ -4810,7 +4848,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * name of compiler task\n   */",
-                  "comment": "name of compiler task"
+                  "comment": "name of compiler task",
+                  "tags": []
                 },
                 "signature": "(property) name?: string | undefined",
                 "name": "name",
@@ -4843,7 +4882,8 @@
               "character": 1
             },
             "raw": "/**\n * compiler build task. Allows to compile components during component build.\n */",
-            "comment": "compiler build task. Allows to compile components during component build."
+            "comment": "compiler build task. Allows to compile components during component build.",
+            "tags": []
           },
           "signature": "class CompilerTask",
           "name": "CompilerTask",
@@ -5305,7 +5345,7 @@
                   "_legacy": {
                     "scope": "teambit.compilation",
                     "name": "compiler",
-                    "version": "1.0.309"
+                    "version": "1.0.311"
                   },
                   "_scope": "teambit.compilation"
                 }
@@ -5349,7 +5389,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * return a compiler instance.\n   */",
-                "comment": "return a compiler instance."
+                "comment": "return a compiler instance.",
+                "tags": []
               },
               "signature": "(method) CompilerEnv.compiler(): EnvHandler<Compiler>",
               "name": "compiler",
@@ -5828,7 +5869,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * name of the compiler.\n   */",
-                "comment": "name of the compiler."
+                "comment": "name of the compiler.",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.name?: string | undefined",
               "name": "name",
@@ -5858,7 +5900,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * relative path of the dist directory inside the capsule. e.g. \"dist\".\n   */",
-                "comment": "relative path of the dist directory inside the capsule. e.g. \"dist\"."
+                "comment": "relative path of the dist directory inside the capsule. e.g. \"dist\".",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.distDir: string",
               "name": "distDir",
@@ -5888,7 +5931,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * determines which ones of the generated files will be saved in the bit objects when tagging.\n   * e.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\n   * see https://github.com/mrmlnc/fast-glob for the supported glob patters syntax.\n   */",
-                "comment": "determines which ones of the generated files will be saved in the bit objects when tagging.\ne.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\nsee https://github.com/mrmlnc/fast-glob for the supported glob patters syntax."
+                "comment": "determines which ones of the generated files will be saved in the bit objects when tagging.\ne.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\nsee https://github.com/mrmlnc/fast-glob for the supported glob patters syntax.",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.distGlobPatterns?: string[] | undefined",
               "name": "distGlobPatterns",
@@ -5926,7 +5970,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * whether or not unsupported files (such as assets) should be copied into the dist directory\n   */",
-                "comment": "whether or not unsupported files (such as assets) should be copied into the dist directory"
+                "comment": "whether or not unsupported files (such as assets) should be copied into the dist directory",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.shouldCopyNonSupportedFiles?: boolean | undefined",
               "name": "shouldCopyNonSupportedFiles",
@@ -5956,7 +6001,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * optional. default to \"dist\".\n   * useful when the build pipeline has multiple compiler tasks of the same compiler.\n   * e.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\n   * the second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly.\n   */",
-                "comment": "optional. default to \"dist\".\nuseful when the build pipeline has multiple compiler tasks of the same compiler.\ne.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\nthe second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly."
+                "comment": "optional. default to \"dist\".\nuseful when the build pipeline has multiple compiler tasks of the same compiler.\ne.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\nthe second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly.",
+                "tags": []
               },
               "signature": "(property) CompilerOptions.artifactName?: string | undefined",
               "name": "artifactName",
@@ -5999,7 +6045,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * id of the compiler.\n   */",
-                "comment": "id of the compiler."
+                "comment": "id of the compiler.",
+                "tags": []
               },
               "signature": "(property) Compiler.id: string",
               "name": "id",
@@ -6029,7 +6076,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * Delete dist folder before writing the new compiled files\n   */",
-                "comment": "Delete dist folder before writing the new compiled files"
+                "comment": "Delete dist folder before writing the new compiled files",
+                "tags": []
               },
               "signature": "(property) Compiler.deleteDistDir?: boolean | undefined",
               "name": "deleteDistDir",
@@ -6059,7 +6107,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * serialized config of the compiler.\n   */",
-                "comment": "serialized config of the compiler."
+                "comment": "serialized config of the compiler.",
+                "tags": []
               },
               "signature": "(method) Compiler.displayConfig?(): string",
               "name": "displayConfig",
@@ -6090,7 +6139,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * transpile a single file that gets saved into the workspace, used by `bit compile` and during\n   * development\n   */",
-                "comment": "transpile a single file that gets saved into the workspace, used by `bit compile` and during\ndevelopment"
+                "comment": "transpile a single file that gets saved into the workspace, used by `bit compile` and during\ndevelopment",
+                "tags": []
               },
               "signature": "(property) Compiler.transpileFile?: ((fileContent: string, params: TranspileFileParams) => TranspileFileOutput | Promise<TranspileFileOutput>) | undefined",
               "name": "transpileFile",
@@ -6203,7 +6253,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * transpile all the files of a component, use this when you can't use `transpileFile`\n   */",
-                "comment": "transpile all the files of a component, use this when you can't use `transpileFile`"
+                "comment": "transpile all the files of a component, use this when you can't use `transpileFile`",
+                "tags": []
               },
               "signature": "(property) Compiler.transpileComponent?: ((params: TranspileComponentParams) => Promise<void>) | undefined",
               "name": "transpileComponent",
@@ -6277,7 +6328,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * compile components inside isolated capsules. this being used during tag for the release.\n   * meaning, the final package of the component has the dists generated by this method.\n   *\n   * no need to handle non-supported-files (e.g. assets) in this method because the compiler-aspect already copies them\n   * into the compiler.dist in the preBuild stage.\n   */",
-                "comment": "compile components inside isolated capsules. this being used during tag for the release.\nmeaning, the final package of the component has the dists generated by this method.\n\nno need to handle non-supported-files (e.g. assets) in this method because the compiler-aspect already copies them\ninto the compiler.dist in the preBuild stage."
+                "comment": "compile components inside isolated capsules. this being used during tag for the release.\nmeaning, the final package of the component has the dists generated by this method.\n\nno need to handle non-supported-files (e.g. assets) in this method because the compiler-aspect already copies them\ninto the compiler.dist in the preBuild stage.",
+                "tags": []
               },
               "signature": "(method) Compiler.build(context: BuildContext): Promise<BuiltTaskResult>",
               "name": "build",
@@ -6348,7 +6400,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * return the dist dir of the compiled files (relative path from the component root dir)\n   */",
-                "comment": "return the dist dir of the compiled files (relative path from the component root dir)"
+                "comment": "return the dist dir of the compiled files (relative path from the component root dir)",
+                "tags": []
               },
               "signature": "(method) Compiler.getDistDir?(): string",
               "name": "getDistDir",
@@ -6379,7 +6432,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * given a source file, return its parallel in the dists. e.g. \"index.ts\" => \"dist/index.js\"\n   * both, the return path and the given path are relative paths.\n   */",
-                "comment": "given a source file, return its parallel in the dists. e.g. \"index.ts\" => \"dist/index.js\"\nboth, the return path and the given path are relative paths."
+                "comment": "given a source file, return its parallel in the dists. e.g. \"index.ts\" => \"dist/index.js\"\nboth, the return path and the given path are relative paths.",
+                "tags": []
               },
               "signature": "(method) Compiler.getDistPathBySrcPath(srcPath: string): string",
               "name": "getDistPathBySrcPath",
@@ -6431,7 +6485,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * given a component, returns the path to the source folder to use for the preview, uses the one\n   * in node_modules by default\n   */",
-                "comment": "given a component, returns the path to the source folder to use for the preview, uses the one\nin node_modules by default"
+                "comment": "given a component, returns the path to the source folder to use for the preview, uses the one\nin node_modules by default",
+                "tags": []
               },
               "signature": "(method) Compiler.getPreviewComponentRootPath?(component: Component): string",
               "name": "getPreviewComponentRootPath",
@@ -6487,7 +6542,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * only supported files matching get compiled. others, are copied to the dist dir.\n   */",
-                "comment": "only supported files matching get compiled. others, are copied to the dist dir."
+                "comment": "only supported files matching get compiled. others, are copied to the dist dir.",
+                "tags": []
               },
               "signature": "(method) Compiler.isFileSupported(filePath: string): boolean",
               "name": "isFileSupported",
@@ -6539,7 +6595,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * sugar to create a Compiler task via the concrete compiler\n   */",
-                "comment": "sugar to create a Compiler task via the concrete compiler"
+                "comment": "sugar to create a Compiler task via the concrete compiler",
+                "tags": []
               },
               "signature": "(method) Compiler.createTask?(name?: string): BuildTask",
               "name": "createTask",
@@ -6595,7 +6652,8 @@
                   "character": 3
                 },
                 "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   */",
-                "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."
+                "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.",
+                "tags": []
               },
               "signature": "(method) Compiler.preBuild?(context: BuildContext): Promise<void>",
               "name": "preBuild",
@@ -6662,7 +6720,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * run after the build pipeline completed for all envs. useful for some cleanups\n   */",
-                "comment": "run after the build pipeline completed for all envs. useful for some cleanups"
+                "comment": "run after the build pipeline completed for all envs. useful for some cleanups",
+                "tags": []
               },
               "signature": "(method) Compiler.postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>",
               "name": "postBuild",
@@ -6753,7 +6812,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * returns the version of the current compiler instance (e.g. '4.0.1').\n   */",
-                "comment": "returns the version of the current compiler instance (e.g. '4.0.1')."
+                "comment": "returns the version of the current compiler instance (e.g. '4.0.1').",
+                "tags": []
               },
               "signature": "(method) Compiler.version(): string",
               "name": "version",
@@ -6784,7 +6844,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * returns the display name of the current compiler instance (e.g. 'TypeScript')\n   */",
-                "comment": "returns the display name of the current compiler instance (e.g. 'TypeScript')"
+                "comment": "returns the display name of the current compiler instance (e.g. 'TypeScript')",
+                "tags": []
               },
               "signature": "(property) Compiler.displayName: string",
               "name": "displayName",
@@ -6848,7 +6909,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * name of the compiler.\n   */",
-                      "comment": "name of the compiler."
+                      "comment": "name of the compiler.",
+                      "tags": []
                     }
                   },
                   {
@@ -6878,7 +6940,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * relative path of the dist directory inside the capsule. e.g. \"dist\".\n   */",
-                      "comment": "relative path of the dist directory inside the capsule. e.g. \"dist\"."
+                      "comment": "relative path of the dist directory inside the capsule. e.g. \"dist\".",
+                      "tags": []
                     }
                   },
                   {
@@ -6916,7 +6979,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * determines which ones of the generated files will be saved in the bit objects when tagging.\n   * e.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\n   * see https://github.com/mrmlnc/fast-glob for the supported glob patters syntax.\n   */",
-                      "comment": "determines which ones of the generated files will be saved in the bit objects when tagging.\ne.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\nsee https://github.com/mrmlnc/fast-glob for the supported glob patters syntax."
+                      "comment": "determines which ones of the generated files will be saved in the bit objects when tagging.\ne.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];\nsee https://github.com/mrmlnc/fast-glob for the supported glob patters syntax.",
+                      "tags": []
                     }
                   },
                   {
@@ -6946,7 +7010,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * whether or not unsupported files (such as assets) should be copied into the dist directory\n   */",
-                      "comment": "whether or not unsupported files (such as assets) should be copied into the dist directory"
+                      "comment": "whether or not unsupported files (such as assets) should be copied into the dist directory",
+                      "tags": []
                     }
                   },
                   {
@@ -6976,7 +7041,8 @@
                         "character": 3
                       },
                       "raw": "/**\n   * optional. default to \"dist\".\n   * useful when the build pipeline has multiple compiler tasks of the same compiler.\n   * e.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\n   * the second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly.\n   */",
-                      "comment": "optional. default to \"dist\".\nuseful when the build pipeline has multiple compiler tasks of the same compiler.\ne.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\nthe second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly."
+                      "comment": "optional. default to \"dist\".\nuseful when the build pipeline has multiple compiler tasks of the same compiler.\ne.g. using the same Babel compiler for two different tasks, one for creating \"es5\" files, and\nthe second for creating \"esm\". the artifact names would be \"es5\" and \"esm\" accordingly.",
+                      "tags": []
                     }
                   }
                 ]
@@ -7003,7 +7069,7 @@
                   "_legacy": {
                     "scope": "teambit.compilation",
                     "name": "compiler",
-                    "version": "1.0.309"
+                    "version": "1.0.311"
                   },
                   "_scope": "teambit.compilation"
                 }
@@ -7150,7 +7216,7 @@
                   "_legacy": {
                     "scope": "teambit.compilation",
                     "name": "compiler",
-                    "version": "1.0.309"
+                    "version": "1.0.311"
                   },
                   "_scope": "teambit.compilation"
                 }
@@ -7223,7 +7289,7 @@
   "componentId": {
     "scope": "teambit.compilation",
     "name": "compiler",
-    "version": "1.0.309"
+    "version": "1.0.311"
   },
   "taggedModuleExports": []
 }

package/dist/{preview-1718767379753.js → preview-1719137078208.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.compilation_compiler@1.0.309/dist/compiler.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.compilation_compiler@1.0.309/dist/compiler.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.compilation_compiler@1.0.311/dist/compiler.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.compilation_compiler@1.0.311/dist/compiler.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/compiler",
-  "version": "1.0.309",
+  "version": "1.0.311",
   "homepage": "https://bit.cloud/teambit/compilation/compiler",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.compilation",
     "name": "compiler",
-    "version": "1.0.309"
+    "version": "1.0.311"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -19,23 +19,23 @@
     "@teambit/component-id": "1.2.0",
     "@teambit/bit-roots": "0.0.133",
     "@teambit/bit-error": "0.0.404",
-    "@teambit/envs": "1.0.309",
-    "@teambit/cli": "0.0.886",
-    "@teambit/logger": "0.0.979",
-    "@teambit/pubsub": "1.0.309",
-    "@teambit/aspect-loader": "1.0.309",
-    "@teambit/builder": "1.0.309",
+    "@teambit/envs": "1.0.311",
+    "@teambit/cli": "0.0.888",
+    "@teambit/logger": "0.0.981",
+    "@teambit/pubsub": "1.0.311",
+    "@teambit/aspect-loader": "1.0.311",
+    "@teambit/builder": "1.0.311",
     "@teambit/component-issues": "0.0.149",
-    "@teambit/component": "1.0.309",
-    "@teambit/dependency-resolver": "1.0.309",
-    "@teambit/generator": "1.0.310",
-    "@teambit/issues": "1.0.309",
-    "@teambit/ui": "1.0.309",
-    "@teambit/watcher": "1.0.309",
-    "@teambit/workspace": "1.0.309",
-    "@teambit/isolator": "1.0.309",
+    "@teambit/component": "1.0.311",
+    "@teambit/dependency-resolver": "1.0.311",
+    "@teambit/generator": "1.0.312",
+    "@teambit/issues": "1.0.311",
+    "@teambit/ui": "1.0.311",
+    "@teambit/watcher": "1.0.311",
+    "@teambit/workspace": "1.0.311",
+    "@teambit/isolator": "1.0.311",
     "@teambit/toolbox.fs.hard-link-directory": "0.0.21",
-    "@teambit/multi-compiler": "1.0.309",
+    "@teambit/multi-compiler": "1.0.311",
     "@teambit/workspace.modules.node-modules-linker": "0.0.174"
   },
   "devDependencies": {