@teambit/builder 0.0.568 → 0.0.572

package/templates/build-task/files/task-file.ts

@@ -0,0 +1,58 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function taskFile({ namePascalCase }: ComponentContext) {
+  return `import {
+  BuildTask,
+  BuildContext,
+  BuiltTaskResult,
+  ComponentResult,
+} from '@teambit/builder';
+import path from 'path';
+import fs from 'fs';
+
+export class ${namePascalCase} implements BuildTask {
+  constructor(readonly aspectId: string) {}
+  readonly name = '${namePascalCase}';
+
+  async execute(context: BuildContext): Promise<BuiltTaskResult> {
+    // Prepare the component results array which will be used to report back the components proccessed
+    // as well as any additional data regarding this build task execution
+    const componentsResults: ComponentResult[] = [];
+    // The 'seeder capsules' are capsules for components that are built for their own sake - 
+    // not for the sake of other components that have them as their dependencies
+    const capsules = context.capsuleNetwork.seedersCapsules;
+    capsules.forEach((capsule) => {
+      // Preprate an 'errors' array to report back of any erros during execution (this will be part of the 'Component Results' data)
+      const errors: Error[] = [];
+      // Each 'capsule' provides data regarding the component as well as the capsule itself
+      const componentName = capsule.component.id.name;
+      const capsuleDir = capsule.path;
+
+      const artifactContent = \`The component name is \${componentName}\`
+
+      try {
+        // Generate the artifact inside the capsule's diretory
+        fs.writeFileSync(
+          path.join(capsuleDir, 'output.my-artifact.txt'),
+          artifactContent
+        );
+      } catch (err: any) {
+        errors.push(err);
+      }
+      componentsResults.push({ component: capsule.component, errors });
+    });
+
+    return {
+      artifacts: [
+        {
+          generatedBy: this.aspectId,
+          name: this.name,
+          // The glob pattern for artifacts to include in the comoponent version
+          globPatterns: ['**/*.my-artifact.txt'],
+        },
+      ],
+      componentsResults,
+    };
+  }
+}`;
+}

package/templates/build-task/index.ts

@@ -0,0 +1,22 @@
+import { ComponentContext, ComponentTemplate } from '@teambit/generator';
+import { indexFile } from './files/index-file';
+import { taskFile } from './files/task-file';
+
+export const buildTaskTemplate: ComponentTemplate = {
+  name: 'build-task',
+  description: 'create a custom build task for your component pipelines',
+  hidden: false,
+  generateFiles: (context: ComponentContext) => {
+    return [
+      {
+        relativePath: 'index.ts',
+        content: indexFile(context),
+        isMain: true,
+      },
+      {
+        relativePath: `${context.name}.task.ts`,
+        content: taskFile(context),
+      },
+    ];
+  },
+};

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;
+}