@teambit/pipelines.aspect-docs.builder 0.0.0-02c7dcca80975692ca58bea9be10f787b9ea26ca

package/builder.composition.tsx

@@ -0,0 +1,12 @@
+import React from 'react';
+import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
+import { MDXLayout } from '@teambit/mdx.ui.mdx-layout';
+import { Builder } from './index';
+
+export const BuilderDocs = () => (
+  <ThemeCompositions>
+    <MDXLayout>
+      <Builder />
+    </MDXLayout>
+  </ThemeCompositions>
+);

package/builder.docs.mdx

@@ -0,0 +1,34 @@
+---
+description: 'Docs for Builder Aspect'
+labels: ['docs', 'aspect', 'extensions']
+---
+
+import { Builder } from './index';
+
+## Static Content Page in MDX
+
+Docs for Builder aspect
+
+### Component usage
+
+Use your component in any mdx file:
+
+```jsx
+import { Builder } from '@teambit/aspect-docs.builder';
+
+<Builder />;
+```
+
+### Render with theme and MDX providers
+
+```jsx
+import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
+import { MDXLayout } from '@teambit/ui.mdx-layout';
+import { Builder } from '@teambit/aspect-docs.builder';
+
+<ThemeCompositions>
+  <MDXLayout>
+    <Builder />
+  </MDXLayout>
+</ThemeCompositions>;
+```

package/builder.mdx

@@ -0,0 +1,345 @@
+## Background
+
+Bit's build process is an extensible CI for independent components. It validates a component is not dependent on its context (the workspace), tests it, and generates all artifacts necessary for it to be viewed and consumed as an independent module (its distributable code, bundled preview, etc.).
+
+The Build Pipeline is an Environment Service responsible for sequencing and executing a component's Build Tasks. As mentioned earlier, these tasks are performed on a component only after it's been isolated from the rest of the workspace.
+
+A component's default series of Build Tasks is composed of tasks set by Bit and by its environment.
+
+## Isolated builds
+
+Components authored in a Bit workspace are created to be completely portable, and thus independent. To address that, the build process starts by creating a component 'capsule' which is an isolated instance of a component, generated in a separate directory in your filesystem.
+
+As part of the capsule creation, all packages listed as dependencies of that component will be installed. This step is necessary to validate there are no dependency-graph issues (a component that is not totally isolated will be able to use packages installed in parent directories in your workspace, by other components. This will translate into a "false positive" result when testing for dependency-graph issues in a non-isolated location).
+
+## Incremental builds
+
+When a component "goes through" the build pipeline, all of its dependencies are built as well. If a dependency has not changed since its last build, the build process will use its artifacts from the previous build (and will not process it again). This optimization to the build process supplements the "innate optimization" that naturally comes from developing (and building) independent components instead of a single monolithic codebase.
+
+## Environment-specific builds
+
+Each Bit environment determines its own build pipeline. That means, a single workspace that uses multiple environments will run a different set of build tasks on different components depending on their associated environment. This is another Bit feature that enables seamless transitioning between different development environments, all in the same workspace. It also makes it much easier to integrate the Build Pipeline in your (remote) CI, as it only requires executing the build step - all other per-component build configurations are already set by the various environments being used.
+
+Since environments are extensible, so are the build pipelines configured by them.
+
+## Build task
+
+An example of a build-task is `compile`, it's written in the compiler aspect and is running on each one of the capsules created by the build process. build-tasks in many cases generate artifacts, in this case, the compiler generates `dists` files and write them on the isolated capsules. There artifacts files are used later for example when creating packages.
+
+## Pipelines
+
+There are three pipelines: `build`, `tag` and `snap`.
+
+- `bit build` runs the build pipeline.
+- `bit tag` runs the build pipeline and then the tag pipeline.
+- `bit snap` runs the build pipeline and then the snap pipeline.
+
+## List Build Tasks
+
+To get a list of all the tasks that will be running per pipeline on a specific component, run `bit build --list-tasks <id>`.
+Here is an example of the relevant part from the output:
+
+```
+➜  bit build --list-tasks ui/tooltip
+Tasks List
+id:    teambit.design/ui/tooltip@0.0.347
+envId: teambit.react/react
+
+Build Pipeline Tasks:
+teambit.harmony/aspect:CoreExporter
+teambit.compilation/compiler:TSCompiler
+teambit.defender/tester:TestComponents
+teambit.pkg/pkg:PreparePackages
+teambit.pkg/pkg:PublishDryRun
+teambit.preview/preview:GeneratePreview
+
+Tag Pipeline Tasks:
+teambit.harmony/application:build_ui_application
+teambit.pkg/pkg:PublishComponents
+
+Snap Pipeline Tasks:
+<N/A>
+```
+
+## Implementing Build Tasks
+
+The `BuildTask` interface is a good start to understand how to implement a new build-task.
+When writing a build task, the `Network` object is passed and it includes the seeders capsules, as well as the entire graph including the dependencies.
+Keep in mind that the entire graph may contain components from other envs.
+
+Some tasks, such as, compiling in typescript and bundling with Webpack, need the entire graph.
+Others, such as, Babel, need only the seeders. However, normally, the bundling is running after the compilation and it expects to have the dependencies compiled, so you might need the entire graph regardless.
+
+## Adding Tasks to a pipeline
+
+There are two ways of adding tasks to the build pipeline.
+
+1. `getBuildPipe()` method of the env. (or `getTagPipe()` and `getSnapPipe()`)
+2. registering to the slot via `builder.registerBuildTask()`. (or `registerTagTask()` and `registerSnapTask()`)
+
+in the option #1, it's possible to determine the order. e.g. `getBuildPipe() { return [taskA, taskB, taskC]; }`
+in the option #2, the register happens once the extension is loaded, so there is no way to put
+one task before/after another task as of now.
+
+## Sequencing the build tasks
+
+The Build Pipeline takes into consideration the following factors when deciding the order of which to execute each task:
+
+- **Location**: A task can be executed either at the start or end of the build pipeline. This can be explicitly configured by the task itself.
+- **Dependencies**: A task can depend on other tasks. That means, the dependencies must be completed successfully for all envs before this task starts. The dependencies are applicable inside a location and not across locations. This is configured by the task itself.
+- **An environment's list of build tasks**: This is the array of tasks as it is defined by an environment
+
+## Executing the pipelines
+
+Commands that trigger the build pipeline:
+
+- `bit build` - runs the build pipeline on your local machine, for the entire workspace. The output data will not persist. - That is most often used for testing and debugging the build process.
+- `bit tag` - runs the tag pipeline in addition to the build pipeline, before creating a new component release version. The output data will persist.
+- `bit snap` - runs the snap pipeline in addition to the build pipeline. The output data will persist.
+
+Build pipelines are determined by the environments in use. That means, in order to override the default pipeline, we need to create a new environment extension or modify an existing one.
+
+The example task below, shown being used by a customized environment, prints out the component name of every component handled by it. In addition to that, the task returns the component name as custom metadata to be logged and/or stored in the component tagged version. [See a demo project here](https://github.com/teambit/harmony-build-examples).
+
+> Information returned by a build task will only persist if the build-pipeline was triggered by the 'hard-tag' command (`bit tag <component-id>`).
+
+```ts title="print-cmp-name-task.ts"
+import { BuildTask, BuildContext, BuiltTaskResult, ComponentResult } from '@teambit/builder';
+
+// A task is an implementation of 'BuildTask' provided by the 'builder' aspect
+export class PrintCmpNameTask implements BuildTask {
+  // The constructor leaves these properties up to the hands of the environment using this task
+  constructor(
+    readonly aspectId: string,
+    readonly name: string
+  ) {}
+
+  // This is where the task logic is placed. It will be executed by the build pipeline
+  async execute(context: BuildContext): Promise<BuiltTaskResult> {
+    const componentsResults: ComponentResult[] = [];
+
+    // Go through every isolated component instance
+    context.capsuleNetwork.seedersCapsules.forEach((capsule) => {
+      console.log(`The current component name is: ${capsule.component.id.name}`);
+
+      componentsResults.push({
+        component: capsule.component,
+        metadata: { customProp: capsule.component.id.name },
+      });
+    });
+    return {
+      // An array of component objects, enriched with additional data produced by the task
+      componentsResults,
+    };
+  }
+}
+```
+
+```ts title="customized-react.extension.ts"
+import { EnvsMain, EnvsAspect } from '@teambit/envs';
+import { ReactAspect, ReactMain } from '@teambit/react';
+
+// Import the task
+import { PrintCmpNameTask } from './print-cmp-name-task';
+
+export class CustomReact {
+  constructor(private react: ReactMain) {}
+
+  static dependencies: any = [EnvsAspect, ReactAspect];
+
+  static async provider([envs, react]: [EnvsMain, ReactMain]) {
+    // Get the environment's default build pipeline
+    const reactPipe = react.env.getBuildPipe();
+
+    // Add the custom task to the end of the build tasks sequence.
+    // Provide the task with the component ID of the extension using it.
+    // Provide the ask with a name.
+    const tasks = [...reactPipe, new PrintCompTask('extensions/custom-react', 'PrintCmpNameTask')];
+
+    // Create a new environment by merging these configurations with the env's default ones
+    const customReactEnv = react.compose([react.overrideBuildPipe(tasks)]);
+
+    // register the extension as an environment
+    envs.registerEnv(customReactEnv);
+    return new CustomReact(react);
+  }
+}
+```
+
+## Positioning a build task in the pipeline
+
+A build task is positioned in the build pipeline sequence either by overriding the entire _customizable_ pipeline or, by registering it to a location in the pipeline using the designated builder slot.
+
+### Override the build pipeline sequence
+
+This methodology leaves the task completely agnostic as to its position in the build pipeline. Instead, the task position is determined by the environment using the `getBuildPipe` Environment Handler.
+
+The example above shows the React environment `overrideBuildPipe` method being used to override its default pipeline. This method uses the `getBuildPipe()` Environment Handler, internally.
+
+### Append to the start or end of the pipeline, in relation to other tasks
+
+This methodology places the task at the start or end of the build pipeline sequence, and lists all other tasks needed to run successfully before it is executed.
+
+Example:
+
+```ts title="print-cmp-name-task.ts"
+import { BuildTask, BuildContext, BuiltTaskResult, ComponentResult } from '@teambit/builder';
+
+export class PrintCmpNameTask implements BuildTask {
+  constructor(
+    readonly aspectId: string,
+    readonly name: string
+  ) {}
+
+  // Place the task at the end of the build pipeline
+  readonly location = 'end';
+
+  // Run this task only after the '@teambit/preview' task is completed successfully
+  readonly dependencies = ['@teambit/preview'];
+
+  async execute(context: BuildContext): Promise<BuiltTaskResult> {
+    const componentsResults: ComponentResult[] = [];
+    context.capsuleNetwork.seedersCapsules.forEach((capsule) => {
+      console.log(`The current component name is: ${capsule.component.id.name}`);
+
+      componentsResults.push({
+        component: capsule.component,
+        metadata: { customProp: capsule.component.id.name },
+      });
+    });
+    return {
+      componentsResults,
+    };
+  }
+}
+```
+
+```ts title="customized-react.extension.ts"
+import { EnvsMain, EnvsAspect } from '@teambit/envs';
+import { ReactAspect, ReactMain } from '@teambit/react';
+import { BuilderMain } from '@teambit/builder';
+
+// Import the task (in reality, it should be an independent component)
+import { PrintCmpNameTask } from './print-cmp-name-task';
+
+export class CustomReact {
+  constructor(private react: ReactMain) {}
+
+  static dependencies: any = [EnvsAspect, ReactAspect];
+
+  // Inject the builder
+  static async provider([envs, react, builder]: [EnvsMain, ReactMain, BuilderMain]) {
+    // Register this task using the registration slot, made available by the 'builder'.
+    // Here, the environment has no say in the positioning of the task
+    builder.registerBuildTasks([new ExampleTask('extensions/custom-react', 'PrintCmpNameTask')]);
+
+    const customReactEnv = react.compose([]);
+
+    envs.registerEnv(customReactEnv);
+    return new CustomReact(react);
+  }
+}
+```
+
+## A build task anatomy
+
+- **aspectId** <br />
+  `aspectId: string`<br />
+  The component ID of the environment using this task.
+
+- **name** <br />
+  `name: string` <br />
+  A name for this task. Only alphanumerical characters are allowed. PascalCase should be used as a convention.
+
+- **location** <br />
+  `location?: 'start' | 'end'` <br />
+  The section of the build-pipeline to which to append this task.
+
+- **dependencies** <br />
+  `dependencies?: string[]` <br />
+  An list of tasks that must be completed before this task gets executed. <br />
+  For example `dependencies = ['@teambit/preview']`.
+
+- **execute** <br />
+  `execute(context: BuildContext): Promise<BuiltTaskResult>` <br />
+  The execute method is where all the task logic is placed.
+
+  - **context** (argument) <br />
+    `context: BuildContext` <br />
+    The context of the build pipeline. Use this object (provided by the build pipeline) to get information regarding all components handled by the build pipeline. <br /><br />
+    For example, `context.capsuleNetwork.seedersCapsules` are models representing isolated instances of components handled by the build pipeline. These isolated instances are independent projects, generated in your local filesystem (by the build pipeline).
+
+  - **return** <br />
+    `Promise<BuiltTaskResult>` <br />
+    A `context` method returns an object with data regarding the build task process, additional data regarding the components handled by the task and, if available, data regarding the different artifacts generated by this task.<br />
+    The returned object has the following attributes:
+
+    - **componentsResults** <br />
+      `componentsResults: ComponentResult[]`
+      An array of objects, each containing an instance of an object handled the task and additional information regarding the process and the component itself.
+    - **component** <br />
+      `component: Component` <br />
+      An instance of the component handled by the task (see the above task example).
+
+    - **metadata** <br />
+      `metadata?: { [key: string]: Serializable }` <br />
+      Component metadata generated during the build task.
+
+    - **errors** <br />
+      `errors?: Array<Error | string>` <br />
+      Build task errors. A task returning errors will abort the build pipeline and log the returned errors.
+
+    - **warnings** <br />
+      `warnings?: string[]` <br />
+      warnings generated throughout the build task.
+
+    - **startTime** <br />
+      `startTime?: number` <br />
+      A timestamp (in milliseconds) of when the task started
+
+    - **endTime** <br />
+      `endTime?: number` <br />
+      A timestamp (in milliseconds) of when the task ended
+    - **artifacts** <br />
+      `artifacts?: ArtifactDefinition[]` <br />
+      An array of artifact definitions to generate after a successful build
+    - **name** <br />
+      `name: string` <br />
+      The name of the artifact. <br />
+      For example, a project might utilize two different artifacts for the same typescript compiler, one that generates ES5 files and another for ES6. This prop helps to distinguish between the two.
+    - **generatedBy** <br />
+      `generatedBy?: string;` <br />
+      Id of the component that generated this artifact.
+
+    - **description** <br />
+      `description?: string` <br />
+      A description of the artifact. <br />
+
+    - **globPatterns** <br />
+      `globPatterns: string[]` <br />
+      Glob patterns of files to include upon artifact creation. Minimatch is used to match the patterns. <br />
+      For example, `['*.ts', '!foo.ts']` matches all ts files but ignores `foo.ts`.
+
+    - **rootDir** <br />
+      `rootDir?: string` <br />
+      Defines the root directory of the artifacts in the capsule file system. The rootDir must be unique for every artifact, otherwise data might be overridden.
+
+    - **dirPrefix** <br />
+      `dirPrefix?: string` <br />
+      Adds a directory prefix for all artifact files.
+
+    - **context** <br />
+      `context?: 'component' | 'env'` <br />
+      Determine the context of the artifact. The default artifact context is `component`. `env` is useful when the same file is generated for all components, for example, a "preview" task may create the same webpack file for all components of that env.
+
+    - **storageResolver** <br />
+      `storageResolver?: string` <br />
+      Used to replace the location of the stored artifacts. The default resolver persists artifacts on scope (that's not recommended for large files).
+
+- **preBuild** (advanced) <br />
+  `preBuild?(context: BuildContext): Promise<void>` <br />
+  Runs before the build pipeline has started. This method should only be used when preparations are needed to be done on all environments before the build starts.
+
+- **postBuild** (advanced) <br />
+  `postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>` <br />
+  Runs after the dependencies were completed for all environments.

package/dist/builder.composition.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const BuilderDocs: () => React.JSX.Element;

package/dist/builder.composition.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BuilderDocs = void 0;
+const react_1 = __importDefault(require("react"));
+const documenter_theme_theme_compositions_1 = require("@teambit/documenter.theme.theme-compositions");
+const mdx_ui_mdx_layout_1 = require("@teambit/mdx.ui.mdx-layout");
+const index_1 = require("./index");
+const BuilderDocs = () => (react_1.default.createElement(documenter_theme_theme_compositions_1.ThemeCompositions, null,
+    react_1.default.createElement(mdx_ui_mdx_layout_1.MDXLayout, null,
+        react_1.default.createElement(index_1.Builder, null))));
+exports.BuilderDocs = BuilderDocs;
+//# sourceMappingURL=builder.composition.js.map

package/dist/builder.composition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.composition.js","sourceRoot":"","sources":["../builder.composition.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,sGAAiF;AACjF,kEAAuD;AACvD,mCAAkC;AAE3B,MAAM,WAAW,GAAG,GAAG,EAAE,CAAC,CAC/B,8BAAC,uDAAiB;IAChB,8BAAC,6BAAS;QACR,8BAAC,eAAO,OAAG,CACD,CACM,CACrB,CAAC;AANW,QAAA,WAAW,eAMtB"}

package/dist/builder.docs.mdx

@@ -0,0 +1,34 @@
+---
+description: 'Docs for Builder Aspect'
+labels: ['docs', 'aspect', 'extensions']
+---
+
+import { Builder } from './index';
+
+## Static Content Page in MDX
+
+Docs for Builder aspect
+
+### Component usage
+
+Use your component in any mdx file:
+
+```jsx
+import { Builder } from '@teambit/aspect-docs.builder';
+
+<Builder />;
+```
+
+### Render with theme and MDX providers
+
+```jsx
+import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
+import { MDXLayout } from '@teambit/ui.mdx-layout';
+import { Builder } from '@teambit/aspect-docs.builder';
+
+<ThemeCompositions>
+  <MDXLayout>
+    <Builder />
+  </MDXLayout>
+</ThemeCompositions>;
+```

package/dist/builder.mdx.js

@@ -0,0 +1,355 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = MDXContent;
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@mdx-js/react");
+var _excluded = ["components"]; // @ts-nocheck
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+/* @jsxRuntime classic */
+/* @jsx mdx */
+
+var layoutProps = {};
+var MDXLayout = "wrapper";
+function MDXContent(_ref) {
+  var components = _ref.components,
+    props = _objectWithoutProperties(_ref, _excluded);
+  return (0, _react2.mdx)(MDXLayout, _extends({}, layoutProps, props, {
+    components: components,
+    mdxType: "MDXLayout"
+  }), (0, _react2.mdx)("h2", null, "Background"), (0, _react2.mdx)("p", null, "Bit's build process is an extensible CI for independent components. It validates a component is not dependent on its context (the workspace), tests it, and generates all artifacts necessary for it to be viewed and consumed as an independent module (its distributable code, bundled preview, etc.)."), (0, _react2.mdx)("p", null, "The Build Pipeline is an Environment Service responsible for sequencing and executing a component's Build Tasks. As mentioned earlier, these tasks are performed on a component only after it's been isolated from the rest of the workspace."), (0, _react2.mdx)("p", null, "A component's default series of Build Tasks is composed of tasks set by Bit and by its environment."), (0, _react2.mdx)("h2", null, "Isolated builds"), (0, _react2.mdx)("p", null, "Components authored in a Bit workspace are created to be completely portable, and thus independent. To address that, the build process starts by creating a component 'capsule' which is an isolated instance of a component, generated in a separate directory in your filesystem."), (0, _react2.mdx)("p", null, "As part of the capsule creation, all packages listed as dependencies of that component will be installed. This step is necessary to validate there are no dependency-graph issues (a component that is not totally isolated will be able to use packages installed in parent directories in your workspace, by other components. This will translate into a \"false positive\" result when testing for dependency-graph issues in a non-isolated location)."), (0, _react2.mdx)("h2", null, "Incremental builds"), (0, _react2.mdx)("p", null, "When a component \"goes through\" the build pipeline, all of its dependencies are built as well. If a dependency has not changed since its last build, the build process will use its artifacts from the previous build (and will not process it again). This optimization to the build process supplements the \"innate optimization\" that naturally comes from developing (and building) independent components instead of a single monolithic codebase."), (0, _react2.mdx)("h2", null, "Environment-specific builds"), (0, _react2.mdx)("p", null, "Each Bit environment determines its own build pipeline. That means, a single workspace that uses multiple environments will run a different set of build tasks on different components depending on their associated environment. This is another Bit feature that enables seamless transitioning between different development environments, all in the same workspace. It also makes it much easier to integrate the Build Pipeline in your (remote) CI, as it only requires executing the build step - all other per-component build configurations are already set by the various environments being used."), (0, _react2.mdx)("p", null, "Since environments are extensible, so are the build pipelines configured by them."), (0, _react2.mdx)("h2", null, "Build task"), (0, _react2.mdx)("p", null, "An example of a build-task is ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "compile"), ", it's written in the compiler aspect and is running on each one of the capsules created by the build process. build-tasks in many cases generate artifacts, in this case, the compiler generates ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "dists"), " files and write them on the isolated capsules. There artifacts files are used later for example when creating packages."), (0, _react2.mdx)("h2", null, "Pipelines"), (0, _react2.mdx)("p", null, "There are three pipelines: ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "build"), ", ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "tag"), " and ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "snap"), "."), (0, _react2.mdx)("ul", null, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "bit build"), " runs the build pipeline."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "bit tag"), " runs the build pipeline and then the tag pipeline."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "bit snap"), " runs the build pipeline and then the snap pipeline.")), (0, _react2.mdx)("h2", null, "List Build Tasks"), (0, _react2.mdx)("p", null, "To get a list of all the tasks that will be running per pipeline on a specific component, run ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "bit build --list-tasks <id>"), ".\nHere is an example of the relevant part from the output:"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre"
+  }, "\u279C  bit build --list-tasks ui/tooltip\nTasks List\nid:    teambit.design/ui/tooltip@0.0.347\nenvId: teambit.react/react\n\nBuild Pipeline Tasks:\nteambit.harmony/aspect:CoreExporter\nteambit.compilation/compiler:TSCompiler\nteambit.defender/tester:TestComponents\nteambit.pkg/pkg:PreparePackages\nteambit.pkg/pkg:PublishDryRun\nteambit.preview/preview:GeneratePreview\n\nTag Pipeline Tasks:\nteambit.harmony/application:build_ui_application\nteambit.pkg/pkg:PublishComponents\n\nSnap Pipeline Tasks:\n<N/A>\n")), (0, _react2.mdx)("h2", null, "Implementing Build Tasks"), (0, _react2.mdx)("p", null, "The ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "BuildTask"), " interface is a good start to understand how to implement a new build-task.\nWhen writing a build task, the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "Network"), " object is passed and it includes the seeders capsules, as well as the entire graph including the dependencies.\nKeep in mind that the entire graph may contain components from other envs."), (0, _react2.mdx)("p", null, "Some tasks, such as, compiling in typescript and bundling with Webpack, need the entire graph.\nOthers, such as, Babel, need only the seeders. However, normally, the bundling is running after the compilation and it expects to have the dependencies compiled, so you might need the entire graph regardless."), (0, _react2.mdx)("h2", null, "Adding Tasks to a pipeline"), (0, _react2.mdx)("p", null, "There are two ways of adding tasks to the build pipeline."), (0, _react2.mdx)("ol", null, (0, _react2.mdx)("li", {
+    parentName: "ol"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "getBuildPipe()"), " method of the env. (or ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "getTagPipe()"), " and ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "getSnapPipe()"), ")"), (0, _react2.mdx)("li", {
+    parentName: "ol"
+  }, "registering to the slot via ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "builder.registerBuildTask()"), ". (or ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "registerTagTask()"), " and ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "registerSnapTask()"), ")")), (0, _react2.mdx)("p", null, "in the option #1, it's possible to determine the order. e.g. ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "getBuildPipe() { return [taskA, taskB, taskC]; }"), "\nin the option #2, the register happens once the extension is loaded, so there is no way to put\none task before/after another task as of now."), (0, _react2.mdx)("h2", null, "Sequencing the build tasks"), (0, _react2.mdx)("p", null, "The Build Pipeline takes into consideration the following factors when deciding the order of which to execute each task:"), (0, _react2.mdx)("ul", null, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "li"
+  }, "Location"), ": A task can be executed either at the start or end of the build pipeline. This can be explicitly configured by the task itself."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "li"
+  }, "Dependencies"), ": A task can depend on other tasks. That means, the dependencies must be completed successfully for all envs before this task starts. The dependencies are applicable inside a location and not across locations. This is configured by the task itself."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "li"
+  }, "An environment's list of build tasks"), ": This is the array of tasks as it is defined by an environment")), (0, _react2.mdx)("h2", null, "Executing the pipelines"), (0, _react2.mdx)("p", null, "Commands that trigger the build pipeline:"), (0, _react2.mdx)("ul", null, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "bit build"), " - runs the build pipeline on your local machine, for the entire workspace. The output data will not persist. - That is most often used for testing and debugging the build process."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "bit tag"), " - runs the tag pipeline in addition to the build pipeline, before creating a new component release version. The output data will persist."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "bit snap"), " - runs the snap pipeline in addition to the build pipeline. The output data will persist.")), (0, _react2.mdx)("p", null, "Build pipelines are determined by the environments in use. That means, in order to override the default pipeline, we need to create a new environment extension or modify an existing one."), (0, _react2.mdx)("p", null, "The example task below, shown being used by a customized environment, prints out the component name of every component handled by it. In addition to that, the task returns the component name as custom metadata to be logged and/or stored in the component tagged version. ", (0, _react2.mdx)("a", {
+    parentName: "p",
+    "href": "https://github.com/teambit/harmony-build-examples"
+  }, "See a demo project here"), "."), (0, _react2.mdx)("blockquote", null, (0, _react2.mdx)("p", {
+    parentName: "blockquote"
+  }, "Information returned by a build task will only persist if the build-pipeline was triggered by the 'hard-tag' command (", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "bit tag <component-id>"), ").")), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-ts",
+    "metastring": "title=\"print-cmp-name-task.ts\"",
+    "title": "\"print-cmp-name-task.ts\""
+  }, "import { BuildTask, BuildContext, BuiltTaskResult, ComponentResult } from '@teambit/builder';\n\n// A task is an implementation of 'BuildTask' provided by the 'builder' aspect\nexport class PrintCmpNameTask implements BuildTask {\n  // The constructor leaves these properties up to the hands of the environment using this task\n  constructor(\n    readonly aspectId: string,\n    readonly name: string\n  ) {}\n\n  // This is where the task logic is placed. It will be executed by the build pipeline\n  async execute(context: BuildContext): Promise<BuiltTaskResult> {\n    const componentsResults: ComponentResult[] = [];\n\n    // Go through every isolated component instance\n    context.capsuleNetwork.seedersCapsules.forEach((capsule) => {\n      console.log(`The current component name is: ${capsule.component.id.name}`);\n\n      componentsResults.push({\n        component: capsule.component,\n        metadata: { customProp: capsule.component.id.name },\n      });\n    });\n    return {\n      // An array of component objects, enriched with additional data produced by the task\n      componentsResults,\n    };\n  }\n}\n")), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-ts",
+    "metastring": "title=\"customized-react.extension.ts\"",
+    "title": "\"customized-react.extension.ts\""
+  }, "import { EnvsMain, EnvsAspect } from '@teambit/envs';\nimport { ReactAspect, ReactMain } from '@teambit/react';\n\n// Import the task\nimport { PrintCmpNameTask } from './print-cmp-name-task';\n\nexport class CustomReact {\n  constructor(private react: ReactMain) {}\n\n  static dependencies: any = [EnvsAspect, ReactAspect];\n\n  static async provider([envs, react]: [EnvsMain, ReactMain]) {\n    // Get the environment's default build pipeline\n    const reactPipe = react.env.getBuildPipe();\n\n    // Add the custom task to the end of the build tasks sequence.\n    // Provide the task with the component ID of the extension using it.\n    // Provide the ask with a name.\n    const tasks = [...reactPipe, new PrintCompTask('extensions/custom-react', 'PrintCmpNameTask')];\n\n    // Create a new environment by merging these configurations with the env's default ones\n    const customReactEnv = react.compose([react.overrideBuildPipe(tasks)]);\n\n    // register the extension as an environment\n    envs.registerEnv(customReactEnv);\n    return new CustomReact(react);\n  }\n}\n")), (0, _react2.mdx)("h2", null, "Positioning a build task in the pipeline"), (0, _react2.mdx)("p", null, "A build task is positioned in the build pipeline sequence either by overriding the entire ", (0, _react2.mdx)("em", {
+    parentName: "p"
+  }, "customizable"), " pipeline or, by registering it to a location in the pipeline using the designated builder slot."), (0, _react2.mdx)("h3", null, "Override the build pipeline sequence"), (0, _react2.mdx)("p", null, "This methodology leaves the task completely agnostic as to its position in the build pipeline. Instead, the task position is determined by the environment using the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "getBuildPipe"), " Environment Handler."), (0, _react2.mdx)("p", null, "The example above shows the React environment ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "overrideBuildPipe"), " method being used to override its default pipeline. This method uses the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "getBuildPipe()"), " Environment Handler, internally."), (0, _react2.mdx)("h3", null, "Append to the start or end of the pipeline, in relation to other tasks"), (0, _react2.mdx)("p", null, "This methodology places the task at the start or end of the build pipeline sequence, and lists all other tasks needed to run successfully before it is executed."), (0, _react2.mdx)("p", null, "Example:"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-ts",
+    "metastring": "title=\"print-cmp-name-task.ts\"",
+    "title": "\"print-cmp-name-task.ts\""
+  }, "import { BuildTask, BuildContext, BuiltTaskResult, ComponentResult } from '@teambit/builder';\n\nexport class PrintCmpNameTask implements BuildTask {\n  constructor(\n    readonly aspectId: string,\n    readonly name: string\n  ) {}\n\n  // Place the task at the end of the build pipeline\n  readonly location = 'end';\n\n  // Run this task only after the '@teambit/preview' task is completed successfully\n  readonly dependencies = ['@teambit/preview'];\n\n  async execute(context: BuildContext): Promise<BuiltTaskResult> {\n    const componentsResults: ComponentResult[] = [];\n    context.capsuleNetwork.seedersCapsules.forEach((capsule) => {\n      console.log(`The current component name is: ${capsule.component.id.name}`);\n\n      componentsResults.push({\n        component: capsule.component,\n        metadata: { customProp: capsule.component.id.name },\n      });\n    });\n    return {\n      componentsResults,\n    };\n  }\n}\n")), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-ts",
+    "metastring": "title=\"customized-react.extension.ts\"",
+    "title": "\"customized-react.extension.ts\""
+  }, "import { EnvsMain, EnvsAspect } from '@teambit/envs';\nimport { ReactAspect, ReactMain } from '@teambit/react';\nimport { BuilderMain } from '@teambit/builder';\n\n// Import the task (in reality, it should be an independent component)\nimport { PrintCmpNameTask } from './print-cmp-name-task';\n\nexport class CustomReact {\n  constructor(private react: ReactMain) {}\n\n  static dependencies: any = [EnvsAspect, ReactAspect];\n\n  // Inject the builder\n  static async provider([envs, react, builder]: [EnvsMain, ReactMain, BuilderMain]) {\n    // Register this task using the registration slot, made available by the 'builder'.\n    // Here, the environment has no say in the positioning of the task\n    builder.registerBuildTasks([new ExampleTask('extensions/custom-react', 'PrintCmpNameTask')]);\n\n    const customReactEnv = react.compose([]);\n\n    envs.registerEnv(customReactEnv);\n    return new CustomReact(react);\n  }\n}\n")), (0, _react2.mdx)("h2", null, "A build task anatomy"), (0, _react2.mdx)("ul", null, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "aspectId"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "aspectId: string"), (0, _react2.mdx)("br", null), "\nThe component ID of the environment using this task.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "name"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "name: string"), " ", (0, _react2.mdx)("br", null), "\nA name for this task. Only alphanumerical characters are allowed. PascalCase should be used as a convention.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "location"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "location?: 'start' | 'end'"), " ", (0, _react2.mdx)("br", null), "\nThe section of the build-pipeline to which to append this task.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "dependencies"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "dependencies?: string[]"), " ", (0, _react2.mdx)("br", null), "\nAn list of tasks that must be completed before this task gets executed. ", (0, _react2.mdx)("br", null), "\nFor example ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "dependencies = ['@teambit/preview']"), ".")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "execute"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "execute(context: BuildContext): Promise<BuiltTaskResult>"), " ", (0, _react2.mdx)("br", null), "\nThe execute method is where all the task logic is placed."), (0, _react2.mdx)("ul", {
+    parentName: "li"
+  }, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "context"), " (argument) ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "context: BuildContext"), " ", (0, _react2.mdx)("br", null), "\nThe context of the build pipeline. Use this object (provided by the build pipeline) to get information regarding all components handled by the build pipeline. ", (0, _react2.mdx)("br", null), (0, _react2.mdx)("br", null), "\nFor example, ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "context.capsuleNetwork.seedersCapsules"), " are models representing isolated instances of components handled by the build pipeline. These isolated instances are independent projects, generated in your local filesystem (by the build pipeline).")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "return"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "Promise<BuiltTaskResult>"), " ", (0, _react2.mdx)("br", null), "\nA ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "context"), " method returns an object with data regarding the build task process, additional data regarding the components handled by the task and, if available, data regarding the different artifacts generated by this task.", (0, _react2.mdx)("br", null), "\nThe returned object has the following attributes:"), (0, _react2.mdx)("ul", {
+    parentName: "li"
+  }, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "componentsResults"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "componentsResults: ComponentResult[]"), "\nAn array of objects, each containing an instance of an object handled the task and additional information regarding the process and the component itself.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "component"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "component: Component"), " ", (0, _react2.mdx)("br", null), "\nAn instance of the component handled by the task (see the above task example).")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "metadata"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "metadata?: { [key: string]: Serializable }"), " ", (0, _react2.mdx)("br", null), "\nComponent metadata generated during the build task.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "errors"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "errors?: Array<Error | string>"), " ", (0, _react2.mdx)("br", null), "\nBuild task errors. A task returning errors will abort the build pipeline and log the returned errors.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "warnings"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "warnings?: string[]"), " ", (0, _react2.mdx)("br", null), "\nwarnings generated throughout the build task.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "startTime"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "startTime?: number"), " ", (0, _react2.mdx)("br", null), "\nA timestamp (in milliseconds) of when the task started")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "endTime"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "endTime?: number"), " ", (0, _react2.mdx)("br", null), "\nA timestamp (in milliseconds) of when the task ended")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "artifacts"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "artifacts?: ArtifactDefinition[]"), " ", (0, _react2.mdx)("br", null), "\nAn array of artifact definitions to generate after a successful build")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "name"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "name: string"), " ", (0, _react2.mdx)("br", null), "\nThe name of the artifact. ", (0, _react2.mdx)("br", null), "\nFor example, a project might utilize two different artifacts for the same typescript compiler, one that generates ES5 files and another for ES6. This prop helps to distinguish between the two.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "generatedBy"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "generatedBy?: string;"), " ", (0, _react2.mdx)("br", null), "\nId of the component that generated this artifact.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "description"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "description?: string"), " ", (0, _react2.mdx)("br", null), "\nA description of the artifact. ", (0, _react2.mdx)("br", null))), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "globPatterns"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "globPatterns: string[]"), " ", (0, _react2.mdx)("br", null), "\nGlob patterns of files to include upon artifact creation. Minimatch is used to match the patterns. ", (0, _react2.mdx)("br", null), "\nFor example, ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "['*.ts', '!foo.ts']"), " matches all ts files but ignores ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "foo.ts"), ".")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "rootDir"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "rootDir?: string"), " ", (0, _react2.mdx)("br", null), "\nDefines the root directory of the artifacts in the capsule file system. The rootDir must be unique for every artifact, otherwise data might be overridden.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "dirPrefix"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "dirPrefix?: string"), " ", (0, _react2.mdx)("br", null), "\nAdds a directory prefix for all artifact files.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "context"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "context?: 'component' | 'env'"), " ", (0, _react2.mdx)("br", null), "\nDetermine the context of the artifact. The default artifact context is ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "component"), ". ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "env"), " is useful when the same file is generated for all components, for example, a \"preview\" task may create the same webpack file for all components of that env.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "storageResolver"), " ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "storageResolver?: string"), " ", (0, _react2.mdx)("br", null), "\nUsed to replace the location of the stored artifacts. The default resolver persists artifacts on scope (that's not recommended for large files).")))))), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "preBuild"), " (advanced) ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "preBuild?(context: BuildContext): Promise<void>"), " ", (0, _react2.mdx)("br", null), "\nRuns before the build pipeline has started. This method should only be used when preparations are needed to be done on all environments before the build starts.")), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("p", {
+    parentName: "li"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "postBuild"), " (advanced) ", (0, _react2.mdx)("br", null), "\n", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>"), " ", (0, _react2.mdx)("br", null), "\nRuns after the dependencies were completed for all environments."))));
+}
+;
+MDXContent.isMDXComponent = true;
+
+//# sourceMappingURL=builder.mdx.js.map

package/dist/builder.mdx.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_react","_interopRequireDefault","require","_react2","_excluded","e","__esModule","_extends","Object","assign","bind","n","arguments","length","t","r","hasOwnProperty","call","apply","_objectWithoutProperties","o","i","_objectWithoutPropertiesLoose","getOwnPropertySymbols","indexOf","propertyIsEnumerable","layoutProps","MDXLayout","MDXContent","_ref","components","props","mdx","mdxType","parentName","isMDXComponent"],"sourceRoot":"/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.pipelines_aspect-docs_builder@02c7dcca80975692ca58bea9be10f787b9ea26ca","sources":["builder.mdx.js"],"sourcesContent":["\n// @ts-nocheck\nimport React from 'react'\nimport { mdx } from '@mdx-js/react'\n\n/* @jsxRuntime classic */\n/* @jsx mdx */\n\n\n\n\nconst layoutProps = {\n  \n};\nconst MDXLayout = \"wrapper\"\nexport default function MDXContent({\n  components,\n  ...props\n}) {\n  return <MDXLayout {...layoutProps} {...props} components={components} mdxType=\"MDXLayout\">\n    <h2>{`Background`}</h2>\n    <p>{`Bit's build process is an extensible CI for independent components. It validates a component is not dependent on its context (the workspace), tests it, and generates all artifacts necessary for it to be viewed and consumed as an independent module (its distributable code, bundled preview, etc.).`}</p>\n    <p>{`The Build Pipeline is an Environment Service responsible for sequencing and executing a component's Build Tasks. As mentioned earlier, these tasks are performed on a component only after it's been isolated from the rest of the workspace.`}</p>\n    <p>{`A component's default series of Build Tasks is composed of tasks set by Bit and by its environment.`}</p>\n    <h2>{`Isolated builds`}</h2>\n    <p>{`Components authored in a Bit workspace are created to be completely portable, and thus independent. To address that, the build process starts by creating a component 'capsule' which is an isolated instance of a component, generated in a separate directory in your filesystem.`}</p>\n    <p>{`As part of the capsule creation, all packages listed as dependencies of that component will be installed. This step is necessary to validate there are no dependency-graph issues (a component that is not totally isolated will be able to use packages installed in parent directories in your workspace, by other components. This will translate into a \"false positive\" result when testing for dependency-graph issues in a non-isolated location).`}</p>\n    <h2>{`Incremental builds`}</h2>\n    <p>{`When a component \"goes through\" the build pipeline, all of its dependencies are built as well. If a dependency has not changed since its last build, the build process will use its artifacts from the previous build (and will not process it again). This optimization to the build process supplements the \"innate optimization\" that naturally comes from developing (and building) independent components instead of a single monolithic codebase.`}</p>\n    <h2>{`Environment-specific builds`}</h2>\n    <p>{`Each Bit environment determines its own build pipeline. That means, a single workspace that uses multiple environments will run a different set of build tasks on different components depending on their associated environment. This is another Bit feature that enables seamless transitioning between different development environments, all in the same workspace. It also makes it much easier to integrate the Build Pipeline in your (remote) CI, as it only requires executing the build step - all other per-component build configurations are already set by the various environments being used.`}</p>\n    <p>{`Since environments are extensible, so are the build pipelines configured by them.`}</p>\n    <h2>{`Build task`}</h2>\n    <p>{`An example of a build-task is `}<inlineCode parentName=\"p\">{`compile`}</inlineCode>{`, it's written in the compiler aspect and is running on each one of the capsules created by the build process. build-tasks in many cases generate artifacts, in this case, the compiler generates `}<inlineCode parentName=\"p\">{`dists`}</inlineCode>{` files and write them on the isolated capsules. There artifacts files are used later for example when creating packages.`}</p>\n    <h2>{`Pipelines`}</h2>\n    <p>{`There are three pipelines: `}<inlineCode parentName=\"p\">{`build`}</inlineCode>{`, `}<inlineCode parentName=\"p\">{`tag`}</inlineCode>{` and `}<inlineCode parentName=\"p\">{`snap`}</inlineCode>{`.`}</p>\n    <ul>\n      <li parentName=\"ul\"><inlineCode parentName=\"li\">{`bit build`}</inlineCode>{` runs the build pipeline.`}</li>\n      <li parentName=\"ul\"><inlineCode parentName=\"li\">{`bit tag`}</inlineCode>{` runs the build pipeline and then the tag pipeline.`}</li>\n      <li parentName=\"ul\"><inlineCode parentName=\"li\">{`bit snap`}</inlineCode>{` runs the build pipeline and then the snap pipeline.`}</li>\n    </ul>\n    <h2>{`List Build Tasks`}</h2>\n    <p>{`To get a list of all the tasks that will be running per pipeline on a specific component, run `}<inlineCode parentName=\"p\">{`bit build --list-tasks <id>`}</inlineCode>{`.\nHere is an example of the relevant part from the output:`}</p>\n    <pre><code parentName=\"pre\" {...{}}>{`➜  bit build --list-tasks ui/tooltip\nTasks List\nid:    teambit.design/ui/tooltip@0.0.347\nenvId: teambit.react/react\n\nBuild Pipeline Tasks:\nteambit.harmony/aspect:CoreExporter\nteambit.compilation/compiler:TSCompiler\nteambit.defender/tester:TestComponents\nteambit.pkg/pkg:PreparePackages\nteambit.pkg/pkg:PublishDryRun\nteambit.preview/preview:GeneratePreview\n\nTag Pipeline Tasks:\nteambit.harmony/application:build_ui_application\nteambit.pkg/pkg:PublishComponents\n\nSnap Pipeline Tasks:\n<N/A>\n`}</code></pre>\n    <h2>{`Implementing Build Tasks`}</h2>\n    <p>{`The `}<inlineCode parentName=\"p\">{`BuildTask`}</inlineCode>{` interface is a good start to understand how to implement a new build-task.\nWhen writing a build task, the `}<inlineCode parentName=\"p\">{`Network`}</inlineCode>{` object is passed and it includes the seeders capsules, as well as the entire graph including the dependencies.\nKeep in mind that the entire graph may contain components from other envs.`}</p>\n    <p>{`Some tasks, such as, compiling in typescript and bundling with Webpack, need the entire graph.\nOthers, such as, Babel, need only the seeders. However, normally, the bundling is running after the compilation and it expects to have the dependencies compiled, so you might need the entire graph regardless.`}</p>\n    <h2>{`Adding Tasks to a pipeline`}</h2>\n    <p>{`There are two ways of adding tasks to the build pipeline.`}</p>\n    <ol>\n      <li parentName=\"ol\"><inlineCode parentName=\"li\">{`getBuildPipe()`}</inlineCode>{` method of the env. (or `}<inlineCode parentName=\"li\">{`getTagPipe()`}</inlineCode>{` and `}<inlineCode parentName=\"li\">{`getSnapPipe()`}</inlineCode>{`)`}</li>\n      <li parentName=\"ol\">{`registering to the slot via `}<inlineCode parentName=\"li\">{`builder.registerBuildTask()`}</inlineCode>{`. (or `}<inlineCode parentName=\"li\">{`registerTagTask()`}</inlineCode>{` and `}<inlineCode parentName=\"li\">{`registerSnapTask()`}</inlineCode>{`)`}</li>\n    </ol>\n    <p>{`in the option #1, it's possible to determine the order. e.g. `}<inlineCode parentName=\"p\">{`getBuildPipe() { return [taskA, taskB, taskC]; }`}</inlineCode>{`\nin the option #2, the register happens once the extension is loaded, so there is no way to put\none task before/after another task as of now.`}</p>\n    <h2>{`Sequencing the build tasks`}</h2>\n    <p>{`The Build Pipeline takes into consideration the following factors when deciding the order of which to execute each task:`}</p>\n    <ul>\n      <li parentName=\"ul\"><strong parentName=\"li\">{`Location`}</strong>{`: A task can be executed either at the start or end of the build pipeline. This can be explicitly configured by the task itself.`}</li>\n      <li parentName=\"ul\"><strong parentName=\"li\">{`Dependencies`}</strong>{`: A task can depend on other tasks. That means, the dependencies must be completed successfully for all envs before this task starts. The dependencies are applicable inside a location and not across locations. This is configured by the task itself.`}</li>\n      <li parentName=\"ul\"><strong parentName=\"li\">{`An environment's list of build tasks`}</strong>{`: This is the array of tasks as it is defined by an environment`}</li>\n    </ul>\n    <h2>{`Executing the pipelines`}</h2>\n    <p>{`Commands that trigger the build pipeline:`}</p>\n    <ul>\n      <li parentName=\"ul\"><inlineCode parentName=\"li\">{`bit build`}</inlineCode>{` - runs the build pipeline on your local machine, for the entire workspace. The output data will not persist. - That is most often used for testing and debugging the build process.`}</li>\n      <li parentName=\"ul\"><inlineCode parentName=\"li\">{`bit tag`}</inlineCode>{` - runs the tag pipeline in addition to the build pipeline, before creating a new component release version. The output data will persist.`}</li>\n      <li parentName=\"ul\"><inlineCode parentName=\"li\">{`bit snap`}</inlineCode>{` - runs the snap pipeline in addition to the build pipeline. The output data will persist.`}</li>\n    </ul>\n    <p>{`Build pipelines are determined by the environments in use. That means, in order to override the default pipeline, we need to create a new environment extension or modify an existing one.`}</p>\n    <p>{`The example task below, shown being used by a customized environment, prints out the component name of every component handled by it. In addition to that, the task returns the component name as custom metadata to be logged and/or stored in the component tagged version. `}<a parentName=\"p\" {...{\n        \"href\": \"https://github.com/teambit/harmony-build-examples\"\n      }}>{`See a demo project here`}</a>{`.`}</p>\n    <blockquote>\n      <p parentName=\"blockquote\">{`Information returned by a build task will only persist if the build-pipeline was triggered by the 'hard-tag' command (`}<inlineCode parentName=\"p\">{`bit tag <component-id>`}</inlineCode>{`).`}</p>\n    </blockquote>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-ts\",\n        \"metastring\": \"title=\\\"print-cmp-name-task.ts\\\"\",\n        \"title\": \"\\\"print-cmp-name-task.ts\\\"\"\n      }}>{`import { BuildTask, BuildContext, BuiltTaskResult, ComponentResult } from '@teambit/builder';\n\n// A task is an implementation of 'BuildTask' provided by the 'builder' aspect\nexport class PrintCmpNameTask implements BuildTask {\n  // The constructor leaves these properties up to the hands of the environment using this task\n  constructor(\n    readonly aspectId: string,\n    readonly name: string\n  ) {}\n\n  // This is where the task logic is placed. It will be executed by the build pipeline\n  async execute(context: BuildContext): Promise<BuiltTaskResult> {\n    const componentsResults: ComponentResult[] = [];\n\n    // Go through every isolated component instance\n    context.capsuleNetwork.seedersCapsules.forEach((capsule) => {\n      console.log(\\`The current component name is: \\${capsule.component.id.name}\\`);\n\n      componentsResults.push({\n        component: capsule.component,\n        metadata: { customProp: capsule.component.id.name },\n      });\n    });\n    return {\n      // An array of component objects, enriched with additional data produced by the task\n      componentsResults,\n    };\n  }\n}\n`}</code></pre>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-ts\",\n        \"metastring\": \"title=\\\"customized-react.extension.ts\\\"\",\n        \"title\": \"\\\"customized-react.extension.ts\\\"\"\n      }}>{`import { EnvsMain, EnvsAspect } from '@teambit/envs';\nimport { ReactAspect, ReactMain } from '@teambit/react';\n\n// Import the task\nimport { PrintCmpNameTask } from './print-cmp-name-task';\n\nexport class CustomReact {\n  constructor(private react: ReactMain) {}\n\n  static dependencies: any = [EnvsAspect, ReactAspect];\n\n  static async provider([envs, react]: [EnvsMain, ReactMain]) {\n    // Get the environment's default build pipeline\n    const reactPipe = react.env.getBuildPipe();\n\n    // Add the custom task to the end of the build tasks sequence.\n    // Provide the task with the component ID of the extension using it.\n    // Provide the ask with a name.\n    const tasks = [...reactPipe, new PrintCompTask('extensions/custom-react', 'PrintCmpNameTask')];\n\n    // Create a new environment by merging these configurations with the env's default ones\n    const customReactEnv = react.compose([react.overrideBuildPipe(tasks)]);\n\n    // register the extension as an environment\n    envs.registerEnv(customReactEnv);\n    return new CustomReact(react);\n  }\n}\n`}</code></pre>\n    <h2>{`Positioning a build task in the pipeline`}</h2>\n    <p>{`A build task is positioned in the build pipeline sequence either by overriding the entire `}<em parentName=\"p\">{`customizable`}</em>{` pipeline or, by registering it to a location in the pipeline using the designated builder slot.`}</p>\n    <h3>{`Override the build pipeline sequence`}</h3>\n    <p>{`This methodology leaves the task completely agnostic as to its position in the build pipeline. Instead, the task position is determined by the environment using the `}<inlineCode parentName=\"p\">{`getBuildPipe`}</inlineCode>{` Environment Handler.`}</p>\n    <p>{`The example above shows the React environment `}<inlineCode parentName=\"p\">{`overrideBuildPipe`}</inlineCode>{` method being used to override its default pipeline. This method uses the `}<inlineCode parentName=\"p\">{`getBuildPipe()`}</inlineCode>{` Environment Handler, internally.`}</p>\n    <h3>{`Append to the start or end of the pipeline, in relation to other tasks`}</h3>\n    <p>{`This methodology places the task at the start or end of the build pipeline sequence, and lists all other tasks needed to run successfully before it is executed.`}</p>\n    <p>{`Example:`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-ts\",\n        \"metastring\": \"title=\\\"print-cmp-name-task.ts\\\"\",\n        \"title\": \"\\\"print-cmp-name-task.ts\\\"\"\n      }}>{`import { BuildTask, BuildContext, BuiltTaskResult, ComponentResult } from '@teambit/builder';\n\nexport class PrintCmpNameTask implements BuildTask {\n  constructor(\n    readonly aspectId: string,\n    readonly name: string\n  ) {}\n\n  // Place the task at the end of the build pipeline\n  readonly location = 'end';\n\n  // Run this task only after the '@teambit/preview' task is completed successfully\n  readonly dependencies = ['@teambit/preview'];\n\n  async execute(context: BuildContext): Promise<BuiltTaskResult> {\n    const componentsResults: ComponentResult[] = [];\n    context.capsuleNetwork.seedersCapsules.forEach((capsule) => {\n      console.log(\\`The current component name is: \\${capsule.component.id.name}\\`);\n\n      componentsResults.push({\n        component: capsule.component,\n        metadata: { customProp: capsule.component.id.name },\n      });\n    });\n    return {\n      componentsResults,\n    };\n  }\n}\n`}</code></pre>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-ts\",\n        \"metastring\": \"title=\\\"customized-react.extension.ts\\\"\",\n        \"title\": \"\\\"customized-react.extension.ts\\\"\"\n      }}>{`import { EnvsMain, EnvsAspect } from '@teambit/envs';\nimport { ReactAspect, ReactMain } from '@teambit/react';\nimport { BuilderMain } from '@teambit/builder';\n\n// Import the task (in reality, it should be an independent component)\nimport { PrintCmpNameTask } from './print-cmp-name-task';\n\nexport class CustomReact {\n  constructor(private react: ReactMain) {}\n\n  static dependencies: any = [EnvsAspect, ReactAspect];\n\n  // Inject the builder\n  static async provider([envs, react, builder]: [EnvsMain, ReactMain, BuilderMain]) {\n    // Register this task using the registration slot, made available by the 'builder'.\n    // Here, the environment has no say in the positioning of the task\n    builder.registerBuildTasks([new ExampleTask('extensions/custom-react', 'PrintCmpNameTask')]);\n\n    const customReactEnv = react.compose([]);\n\n    envs.registerEnv(customReactEnv);\n    return new CustomReact(react);\n  }\n}\n`}</code></pre>\n    <h2>{`A build task anatomy`}</h2>\n    <ul>\n      <li parentName=\"ul\">\n        <p parentName=\"li\"><strong parentName=\"p\">{`aspectId`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`aspectId: string`}</inlineCode><br />{`\nThe component ID of the environment using this task.`}</p>\n      </li>\n      <li parentName=\"ul\">\n        <p parentName=\"li\"><strong parentName=\"p\">{`name`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`name: string`}</inlineCode>{` `}<br />{`\nA name for this task. Only alphanumerical characters are allowed. PascalCase should be used as a convention.`}</p>\n      </li>\n      <li parentName=\"ul\">\n        <p parentName=\"li\"><strong parentName=\"p\">{`location`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`location?: 'start' | 'end'`}</inlineCode>{` `}<br />{`\nThe section of the build-pipeline to which to append this task.`}</p>\n      </li>\n      <li parentName=\"ul\">\n        <p parentName=\"li\"><strong parentName=\"p\">{`dependencies`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`dependencies?: string[]`}</inlineCode>{` `}<br />{`\nAn list of tasks that must be completed before this task gets executed. `}<br />{`\nFor example `}<inlineCode parentName=\"p\">{`dependencies = ['@teambit/preview']`}</inlineCode>{`.`}</p>\n      </li>\n      <li parentName=\"ul\">\n        <p parentName=\"li\"><strong parentName=\"p\">{`execute`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`execute(context: BuildContext): Promise<BuiltTaskResult>`}</inlineCode>{` `}<br />{`\nThe execute method is where all the task logic is placed.`}</p>\n        <ul parentName=\"li\">\n          <li parentName=\"ul\">\n            <p parentName=\"li\"><strong parentName=\"p\">{`context`}</strong>{` (argument) `}<br />{`\n`}<inlineCode parentName=\"p\">{`context: BuildContext`}</inlineCode>{` `}<br />{`\nThe context of the build pipeline. Use this object (provided by the build pipeline) to get information regarding all components handled by the build pipeline. `}<br /><br />{`\nFor example, `}<inlineCode parentName=\"p\">{`context.capsuleNetwork.seedersCapsules`}</inlineCode>{` are models representing isolated instances of components handled by the build pipeline. These isolated instances are independent projects, generated in your local filesystem (by the build pipeline).`}</p>\n          </li>\n          <li parentName=\"ul\">\n            <p parentName=\"li\"><strong parentName=\"p\">{`return`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`Promise<BuiltTaskResult>`}</inlineCode>{` `}<br />{`\nA `}<inlineCode parentName=\"p\">{`context`}</inlineCode>{` method returns an object with data regarding the build task process, additional data regarding the components handled by the task and, if available, data regarding the different artifacts generated by this task.`}<br />{`\nThe returned object has the following attributes:`}</p>\n            <ul parentName=\"li\">\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`componentsResults`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`componentsResults: ComponentResult[]`}</inlineCode>{`\nAn array of objects, each containing an instance of an object handled the task and additional information regarding the process and the component itself.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`component`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`component: Component`}</inlineCode>{` `}<br />{`\nAn instance of the component handled by the task (see the above task example).`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`metadata`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`metadata?: { [key: string]: Serializable }`}</inlineCode>{` `}<br />{`\nComponent metadata generated during the build task.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`errors`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`errors?: Array<Error | string>`}</inlineCode>{` `}<br />{`\nBuild task errors. A task returning errors will abort the build pipeline and log the returned errors.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`warnings`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`warnings?: string[]`}</inlineCode>{` `}<br />{`\nwarnings generated throughout the build task.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`startTime`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`startTime?: number`}</inlineCode>{` `}<br />{`\nA timestamp (in milliseconds) of when the task started`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`endTime`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`endTime?: number`}</inlineCode>{` `}<br />{`\nA timestamp (in milliseconds) of when the task ended`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`artifacts`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`artifacts?: ArtifactDefinition[]`}</inlineCode>{` `}<br />{`\nAn array of artifact definitions to generate after a successful build`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`name`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`name: string`}</inlineCode>{` `}<br />{`\nThe name of the artifact. `}<br />{`\nFor example, a project might utilize two different artifacts for the same typescript compiler, one that generates ES5 files and another for ES6. This prop helps to distinguish between the two.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`generatedBy`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`generatedBy?: string;`}</inlineCode>{` `}<br />{`\nId of the component that generated this artifact.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`description`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`description?: string`}</inlineCode>{` `}<br />{`\nA description of the artifact. `}<br /></p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`globPatterns`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`globPatterns: string[]`}</inlineCode>{` `}<br />{`\nGlob patterns of files to include upon artifact creation. Minimatch is used to match the patterns. `}<br />{`\nFor example, `}<inlineCode parentName=\"p\">{`['*.ts', '!foo.ts']`}</inlineCode>{` matches all ts files but ignores `}<inlineCode parentName=\"p\">{`foo.ts`}</inlineCode>{`.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`rootDir`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`rootDir?: string`}</inlineCode>{` `}<br />{`\nDefines the root directory of the artifacts in the capsule file system. The rootDir must be unique for every artifact, otherwise data might be overridden.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`dirPrefix`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`dirPrefix?: string`}</inlineCode>{` `}<br />{`\nAdds a directory prefix for all artifact files.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`context`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`context?: 'component' | 'env'`}</inlineCode>{` `}<br />{`\nDetermine the context of the artifact. The default artifact context is `}<inlineCode parentName=\"p\">{`component`}</inlineCode>{`. `}<inlineCode parentName=\"p\">{`env`}</inlineCode>{` is useful when the same file is generated for all components, for example, a \"preview\" task may create the same webpack file for all components of that env.`}</p>\n              </li>\n              <li parentName=\"ul\">\n                <p parentName=\"li\"><strong parentName=\"p\">{`storageResolver`}</strong>{` `}<br />{`\n`}<inlineCode parentName=\"p\">{`storageResolver?: string`}</inlineCode>{` `}<br />{`\nUsed to replace the location of the stored artifacts. The default resolver persists artifacts on scope (that's not recommended for large files).`}</p>\n              </li>\n            </ul>\n          </li>\n        </ul>\n      </li>\n      <li parentName=\"ul\">\n        <p parentName=\"li\"><strong parentName=\"p\">{`preBuild`}</strong>{` (advanced) `}<br />{`\n`}<inlineCode parentName=\"p\">{`preBuild?(context: BuildContext): Promise<void>`}</inlineCode>{` `}<br />{`\nRuns before the build pipeline has started. This method should only be used when preparations are needed to be done on all environments before the build starts.`}</p>\n      </li>\n      <li parentName=\"ul\">\n        <p parentName=\"li\"><strong parentName=\"p\">{`postBuild`}</strong>{` (advanced) `}<br />{`\n`}<inlineCode parentName=\"p\">{`postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>`}</inlineCode>{` `}<br />{`\nRuns after the dependencies were completed for all environments.`}</p>\n      </li>\n    </ul>\n    </MDXLayout>;\n}\n;\nMDXContent.isMDXComponent = true;"],"mappings":";;;;;;AAEA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AAAmC,IAAAE,SAAA,mBAFnC;AAAA,SAAAH,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,gBAAAA,CAAA;AAAA,SAAAE,SAAA,WAAAA,QAAA,GAAAC,MAAA,CAAAC,MAAA,GAAAD,MAAA,CAAAC,MAAA,CAAAC,IAAA,eAAAC,CAAA,aAAAN,CAAA,MAAAA,CAAA,GAAAO,SAAA,CAAAC,MAAA,EAAAR,CAAA,UAAAS,CAAA,GAAAF,SAAA,CAAAP,CAAA,YAAAU,CAAA,IAAAD,CAAA,OAAAE,cAAA,CAAAC,IAAA,CAAAH,CAAA,EAAAC,CAAA,MAAAJ,CAAA,CAAAI,CAAA,IAAAD,CAAA,CAAAC,CAAA,aAAAJ,CAAA,KAAAJ,QAAA,CAAAW,KAAA,OAAAN,SAAA;AAAA,SAAAO,yBAAAd,CAAA,EAAAS,CAAA,gBAAAT,CAAA,iBAAAe,CAAA,EAAAL,CAAA,EAAAM,CAAA,GAAAC,6BAAA,CAAAjB,CAAA,EAAAS,CAAA,OAAAN,MAAA,CAAAe,qBAAA,QAAAZ,CAAA,GAAAH,MAAA,CAAAe,qBAAA,CAAAlB,CAAA,QAAAU,CAAA,MAAAA,CAAA,GAAAJ,CAAA,CAAAE,MAAA,EAAAE,CAAA,IAAAK,CAAA,GAAAT,CAAA,CAAAI,CAAA,UAAAD,CAAA,CAAAU,OAAA,CAAAJ,CAAA,QAAAK,oBAAA,CAAAR,IAAA,CAAAZ,CAAA,EAAAe,CAAA,MAAAC,CAAA,CAAAD,CAAA,IAAAf,CAAA,CAAAe,CAAA,aAAAC,CAAA;AAAA,SAAAC,8BAAAP,CAAA,EAAAV,CAAA,gBAAAU,CAAA,iBAAAD,CAAA,gBAAAH,CAAA,IAAAI,CAAA,SAAAC,cAAA,CAAAC,IAAA,CAAAF,CAAA,EAAAJ,CAAA,gBAAAN,CAAA,CAAAmB,OAAA,CAAAb,CAAA,aAAAG,CAAA,CAAAH,CAAA,IAAAI,CAAA,CAAAJ,CAAA,YAAAG,CAAA;AAIA;AACA;;AAKA,IAAMY,WAAW,GAAG,CAEpB,CAAC;AACD,IAAMC,SAAS,GAAG,SAAS;AACZ,SAASC,UAAUA,CAAAC,IAAA,EAG/B;EAAA,IAFDC,UAAU,GAAAD,IAAA,CAAVC,UAAU;IACPC,KAAK,GAAAZ,wBAAA,CAAAU,IAAA,EAAAzB,SAAA;EAER,OAAO,IAAAD,OAAA,CAAA6B,GAAA,EAACL,SAAS,EAAApB,QAAA,KAAKmB,WAAW,EAAMK,KAAK;IAAED,UAAU,EAAEA,UAAW;IAACG,OAAO,EAAC;EAAW,IACvF,IAAA9B,OAAA,CAAA6B,GAAA,0BAAsB,CAAC,EACvB,IAAA7B,OAAA,CAAA6B,GAAA,uTAAkT,CAAC,EACnT,IAAA7B,OAAA,CAAA6B,GAAA,4PAAuP,CAAC,EACxP,IAAA7B,OAAA,CAAA6B,GAAA,kHAA6G,CAAC,EAC9G,IAAA7B,OAAA,CAAA6B,GAAA,+BAA2B,CAAC,EAC5B,IAAA7B,OAAA,CAAA6B,GAAA,kSAA6R,CAAC,EAC9R,IAAA7B,OAAA,CAAA6B,GAAA,0cAAmc,CAAC,EACpc,IAAA7B,OAAA,CAAA6B,GAAA,kCAA8B,CAAC,EAC/B,IAAA7B,OAAA,CAAA6B,GAAA,0cAAic,CAAC,EAClc,IAAA7B,OAAA,CAAA6B,GAAA,2CAAuC,CAAC,EACxC,IAAA7B,OAAA,CAAA6B,GAAA,6lBAAwlB,CAAC,EACzlB,IAAA7B,OAAA,CAAA6B,GAAA,gGAA2F,CAAC,EAC5F,IAAA7B,OAAA,CAAA6B,GAAA,0BAAsB,CAAC,EACvB,IAAA7B,OAAA,CAAA6B,GAAA,+CAAqC,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,YAAwB,CAAC,wMAAsM,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,UAAsB,CAAC,4HAA+H,CAAC,EAC/c,IAAA/B,OAAA,CAAA6B,GAAA,yBAAqB,CAAC,EACtB,IAAA7B,OAAA,CAAA6B,GAAA,4CAAkC,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,UAAsB,CAAC,QAAM,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,QAAoB,CAAC,WAAS,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,SAAqB,CAAC,KAAQ,CAAC,EAC1M,IAAA/B,OAAA,CAAA6B,GAAA,cACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,cAA0B,CAAC,6BAAiC,CAAC,EAC5G,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,YAAwB,CAAC,uDAA2D,CAAC,EACpI,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,aAAyB,CAAC,wDAA4D,CACnI,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA,gCAA4B,CAAC,EAC7B,IAAA7B,OAAA,CAAA6B,GAAA,+GAAqG,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,gCAA4C,CAAC,+DACnH,CAAC,EAC1D,IAAA/B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC;EAAK,qgBAmBvB,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,wCAAoC,CAAC,EACrC,IAAA7B,OAAA,CAAA6B,GAAA,qBAAW,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,cAA0B,CAAC,kHACnC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,YAAwB,CAAC,+LACL,CAAC,EAC5E,IAAA/B,OAAA,CAAA6B,GAAA,+TACiN,CAAC,EAClN,IAAA7B,OAAA,CAAA6B,GAAA,0CAAsC,CAAC,EACvC,IAAA7B,OAAA,CAAA6B,GAAA,wEAAmE,CAAC,EACpE,IAAA7B,OAAA,CAAA6B,GAAA,cACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,mBAA+B,CAAC,8BAA4B,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,iBAA6B,CAAC,WAAS,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,kBAA8B,CAAC,KAAS,CAAC,EACjP,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,mCAAiC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,gCAA4C,CAAC,YAAU,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,sBAAkC,CAAC,WAAS,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,uBAAmC,CAAC,KAAS,CACnR,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA,8EAAoE,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,qDAAiE,CAAC,mJAElH,CAAC,EAC/C,IAAA/B,OAAA,CAAA6B,GAAA,0CAAsC,CAAC,EACvC,IAAA7B,OAAA,CAAA6B,GAAA,uIAAkI,CAAC,EACnI,IAAA7B,OAAA,CAAA6B,GAAA,cACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAI,aAAqB,CAAC,oIAAwI,CAAC,EAC1M,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAI,iBAAyB,CAAC,4PAAgQ,CAAC,EACtU,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAI,yCAAiD,CAAC,mEAAuE,CAClK,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA,uCAAmC,CAAC,EACpC,IAAA7B,OAAA,CAAA6B,GAAA,wDAAmD,CAAC,EACpD,IAAA7B,OAAA,CAAA6B,GAAA,cACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,cAA0B,CAAC,wLAA4L,CAAC,EACvQ,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,YAAwB,CAAC,8IAAkJ,CAAC,EAC3N,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,aAAyB,CAAC,8FAAkG,CACzK,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA,yMAAoM,CAAC,EACrM,IAAA7B,OAAA,CAAA6B,GAAA,+RAAqR,IAAA7B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC,GAAG;IAClS,MAAM,EAAE;EAAmD,4BAC5B,CAAC,KAAQ,CAAC,EAC7C,IAAA/B,OAAA,CAAA6B,GAAA,sBACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAY,6HAA2H,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,2BAAuC,CAAC,MAAS,CACtN,CAAC,EACb,IAAA/B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,kCAAkC;IAChD,OAAO,EAAE;EAA4B,gnCA8BrC,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,yCAAyC;IACvD,OAAO,EAAE;EAAmC,ikCA6B5C,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,wDAAoD,CAAC,EACrD,IAAA7B,OAAA,CAAA6B,GAAA,2GAAiG,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAG,iBAAqB,CAAC,oGAAuG,CAAC,EACjP,IAAA/B,OAAA,CAAA6B,GAAA,oDAAgD,CAAC,EACjD,IAAA7B,OAAA,CAAA6B,GAAA,sLAA4K,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,iBAA6B,CAAC,yBAA4B,CAAC,EACjQ,IAAA/B,OAAA,CAAA6B,GAAA,+DAAqD,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,sBAAkC,CAAC,gFAA8E,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,mBAA+B,CAAC,qCAAwC,CAAC,EACnS,IAAA/B,OAAA,CAAA6B,GAAA,sFAAkF,CAAC,EACnF,IAAA7B,OAAA,CAAA6B,GAAA,+KAA0K,CAAC,EAC3K,IAAA7B,OAAA,CAAA6B,GAAA,uBAAkB,CAAC,EACnB,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,kCAAkC;IAChD,OAAO,EAAE;EAA4B,k7BA8BrC,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,yCAAyC;IACvD,OAAO,EAAE;EAAmC,66BAyB5C,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,oCAAgC,CAAC,EACjC,IAAA7B,OAAA,CAAA6B,GAAA,cACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,aAAqB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAChF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,qBAAiC,CAAC,MAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,0DACX,CAC/C,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,SAAiB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAC5E,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,iBAA6B,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,kHAC4C,CACvG,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,aAAqB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAChF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,+BAA2C,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,qEACf,CAC1D,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,iBAAyB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACpF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,4BAAwC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,gFACN,IAAA7B,OAAA,CAAA6B,GAAA,YAAK,CAAC,oBAClE,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,wCAAoD,CAAC,KAAQ,CAC3F,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,YAAoB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAC/E,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,6DAAyE,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,+DACnD,CAAC,EACvD,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,YAAoB,CAAC,kBAAgB,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAC9F,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,0BAAsC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,uKACmF,IAAA7B,OAAA,CAAA6B,GAAA,YAAK,CAAC,MAAA7B,OAAA,CAAA6B,GAAA,YAAK,CAAC,qBAC9J,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,2CAAuD,CAAC,2MAA8M,CACjS,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,WAAmB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAClF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,6BAAyC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,UAC7E,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,YAAwB,CAAC,0NAAwN,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,uDAC/N,CAAC,EAC3C,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,sBAA8B,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACjG,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,yCAAqD,CAAC,+JAC4E,CAC5I,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,cAAsB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACzF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,yBAAqC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,oFACM,CACjE,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,aAAqB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACxF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,+CAA2D,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,yDAC3C,CACtC,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,WAAmB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACtF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,mCAA+C,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,2GACmB,CACxF,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,aAAqB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACxF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,wBAAoC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,mDAC1B,CAChC,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,cAAsB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACzF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,uBAAmC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,4DAChB,CACzC,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,YAAoB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACvF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,qBAAiC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,0DAChB,CACvC,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,cAAsB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACzF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,qCAAiD,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,2EACf,CACxD,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,SAAiB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACpF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,iBAA6B,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,kCACzC,IAAA7B,OAAA,CAAA6B,GAAA,YAAK,CAAC,sMACmK,CACnL,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,gBAAwB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAC3F,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,0BAAsC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,uDACxB,CACpC,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,gBAAwB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAC3F,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,yBAAqC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,uCAC5C,IAAA7B,OAAA,CAAA6B,GAAA,YAAK,CAAI,CACxB,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,iBAAyB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAC5F,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,2BAAuC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,2GACsB,IAAA7B,OAAA,CAAA6B,GAAA,YAAK,CAAC,qBAC5F,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,wBAAoC,CAAC,wCAAsC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,WAAuB,CAAC,KAAQ,CAC5J,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,YAAoB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACvF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,qBAAiC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,gKACsF,CAC7I,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,cAAsB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACzF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,uBAAmC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,qDACvB,CAClC,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,YAAoB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QACvF,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,kCAA8C,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,+EACb,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,cAA0B,CAAC,QAAM,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,QAAoB,CAAC,mKAAoK,CACrU,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,oBAA4B,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAC/F,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,6BAAyC,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,sJACoE,CACnI,CACF,CACF,CACF,CACF,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,aAAqB,CAAC,kBAAgB,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAC3F,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,oDAAgE,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,sKAC6D,CAC3J,CAAC,EACL,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GACjB,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,cAAsB,CAAC,kBAAgB,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,QAC5F,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,oFAAgG,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA,YAAK,CAAC,sEACnE,CAC3D,CACF,CACO,CAAC;AAChB;AACA;AACAJ,UAAU,CAACO,cAAc,GAAG,IAAI","ignoreList":[]}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { default as Builder } from './builder.mdx';

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Builder = void 0;
+var builder_mdx_1 = require("./builder.mdx");
+Object.defineProperty(exports, "Builder", { enumerable: true, get: function () { return __importDefault(builder_mdx_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;AAAA,6CAAmD;AAA1C,uHAAA,OAAO,OAAW"}

package/dist/preview-1763418476941.js

@@ -0,0 +1,7 @@
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.pipelines_aspect-docs_builder@02c7dcca80975692ca58bea9be10f787b9ea26ca/dist/builder.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.pipelines_aspect-docs_builder@02c7dcca80975692ca58bea9be10f787b9ea26ca/dist/builder.docs.mdx';
+
+export const compositions = [compositions_0];
+export const overview = [overview_0];
+
+export const compositions_metadata = {"compositions":[{"displayName":"Builder docs","identifier":"BuilderDocs"}]};

package/index.ts

@@ -0,0 +1 @@
+export { default as Builder } from './builder.mdx';

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@teambit/pipelines.aspect-docs.builder",
+  "version": "0.0.0-02c7dcca80975692ca58bea9be10f787b9ea26ca",
+  "homepage": "https://bit.cloud/teambit/pipelines/aspect-docs/builder",
+  "main": "dist/index.js",
+  "componentId": {
+    "scope": "teambit.pipelines",
+    "name": "aspect-docs/builder",
+    "version": "02c7dcca80975692ca58bea9be10f787b9ea26ca"
+  },
+  "dependencies": {
+    "core-js": "^3.0.0",
+    "@mdx-js/react": "1.6.22",
+    "@teambit/mdx.ui.mdx-scope-context": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^17.0.8",
+    "@types/mocha": "9.1.0",
+    "@types/node": "12.20.4",
+    "@types/react-dom": "^17.0.5",
+    "@types/jest": "^26.0.0",
+    "@babel/runtime": "7.20.0",
+    "@types/testing-library__jest-dom": "5.9.5",
+    "@teambit/documenter.theme.theme-compositions": "4.1.5",
+    "@teambit/mdx.ui.mdx-layout": "1.0.12"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0 || ^17.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0"
+  },
+  "license": "Apache-2.0",
+  "optionalDependencies": {},
+  "peerDependenciesMeta": {},
+  "private": false,
+  "engines": {
+    "node": ">=12.22.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teambit/bit"
+  },
+  "keywords": [
+    "bit",
+    "components",
+    "collaboration",
+    "web",
+    "react",
+    "react-components",
+    "angular",
+    "angular-components"
+  ]
+}

package/types/asset.d.ts

@@ -0,0 +1,29 @@
+declare module '*.png' {
+  const value: any;
+  export = value;
+}
+declare module '*.svg' {
+  import type { FunctionComponent, SVGProps } from 'react';
+
+  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  const src: string;
+  export default src;
+}
+
+// @TODO Gilad
+declare module '*.jpg' {
+  const value: any;
+  export = value;
+}
+declare module '*.jpeg' {
+  const value: any;
+  export = value;
+}
+declare module '*.gif' {
+  const value: any;
+  export = value;
+}
+declare module '*.bmp' {
+  const value: any;
+  export = value;
+}

package/types/style.d.ts

@@ -0,0 +1,42 @@
+declare module '*.module.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.module.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.mdx' {
+  const component: any;
+  export default component;
+}