@teambit/compiler 0.0.566 → 0.0.570

package/compiler.service.tsx

@@ -0,0 +1,47 @@
+import React from 'react';
+import { Text, Newline } from 'ink';
+import { EnvService, EnvDefinition } from '@teambit/envs';
+import highlight from 'cli-highlight';
+
+export type CompilerDescriptor = {
+  id: string;
+  icon?: string;
+  config?: string;
+};
+
+export class CompilerService implements EnvService<{}, CompilerDescriptor> {
+  name = 'Compile';
+
+  render(env: EnvDefinition) {
+    const descriptor = this.getDescriptor(env);
+
+    return (
+      <Text key={descriptor?.id}>
+        <Text color="cyan">configured compiler: </Text>
+        <Text>
+          {descriptor?.id} ({descriptor?.displayName} @ {descriptor?.version})
+        </Text>
+        <Newline />
+        <Text color="cyan">compiler config:</Text>
+        <Newline />
+        <Text>
+          {descriptor?.config && highlight(descriptor?.config, { language: 'javascript', ignoreIllegals: true })}
+        </Text>
+        <Newline />
+      </Text>
+    );
+  }
+
+  getDescriptor(env: EnvDefinition) {
+    if (!env.env.getCompiler) return undefined;
+    const compiler = env.env.getCompiler();
+
+    return {
+      id: compiler.id,
+      icon: compiler.icon,
+      config: compiler.displayConfig ? compiler.displayConfig() : undefined,
+      version: compiler.version ? compiler.version() : '?',
+      displayName: compiler.displayName ? compiler.displayName : '?',
+    };
+  }
+}

package/events/compiler-error.ts

@@ -0,0 +1,14 @@
+/* eslint-disable max-classes-per-file */
+import { BitBaseEvent } from '@teambit/pubsub';
+
+class CompilerErrorEventData {
+  constructor(readonly error: any) {}
+}
+
+export class CompilerErrorEvent extends BitBaseEvent<CompilerErrorEventData> {
+  static readonly TYPE = 'compiler-error';
+
+  constructor(readonly error, readonly timestamp = Date.now()) {
+    super(CompilerErrorEvent.TYPE, '0.0.1', timestamp, new CompilerErrorEventData(error));
+  }
+}

package/events/component-compilation-on-done.ts

@@ -0,0 +1,30 @@
+/* eslint-disable max-classes-per-file */
+import { BitBaseEvent } from '@teambit/pubsub';
+import type ConsumerComponent from '@teambit/legacy/dist/consumer/component';
+import { CompileError } from '../workspace-compiler';
+
+class ComponentCompilationOnDoneEventData {
+  constructor(
+    readonly errors: Array<CompileError>,
+    readonly component: ConsumerComponent,
+    readonly buildResults: string[]
+  ) {}
+}
+
+export class ComponentCompilationOnDoneEvent extends BitBaseEvent<ComponentCompilationOnDoneEventData> {
+  static readonly TYPE = 'component-compilation-on-done';
+
+  constructor(
+    readonly errors: Array<CompileError>,
+    readonly component: ConsumerComponent,
+    readonly buildResults: string[],
+    readonly timestamp = Date.now()
+  ) {
+    super(
+      ComponentCompilationOnDoneEvent.TYPE,
+      '0.0.1',
+      timestamp,
+      new ComponentCompilationOnDoneEventData(errors, component, buildResults)
+    );
+  }
+}

package/events/index.ts

@@ -0,0 +1,2 @@
+export * from './compiler-error';
+export * from './component-compilation-on-done';

package/exceptions/dist-artifact-not-found.ts

@@ -0,0 +1,8 @@
+import { ComponentID } from '@teambit/component';
+import { BitError } from '@teambit/bit-error';
+
+export class DistArtifactNotFound extends BitError {
+  constructor(readonly componentId: ComponentID) {
+    super(`dist artifact for component ${componentId.toString()} was not found`);
+  }
+}

package/exceptions/index.ts

@@ -0,0 +1 @@
+export { DistArtifactNotFound } from './dist-artifact-not-found';

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/compiler",
-  "version": "0.0.566",
+  "version": "0.0.570",
   "homepage": "https://bit.dev/teambit/compilation/compiler",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.compilation",
     "name": "compiler",
-    "version": "0.0.566"
+    "version": "0.0.570"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -18,19 +18,19 @@
     "p-map-series": "2.1.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/cli": "0.0.393",
-    "@teambit/logger": "0.0.478",
-    "@teambit/pubsub": "0.0.566",
-    "@teambit/aspect-loader": "0.0.566",
-    "@teambit/builder": "0.0.566",
-    "@teambit/component": "0.0.566",
-    "@teambit/envs": "0.0.566",
-    "@teambit/generator": "0.0.566",
-    "@teambit/legacy-bit-id": "0.0.382",
-    "@teambit/ui": "0.0.566",
-    "@teambit/workspace": "0.0.566",
-    "@teambit/isolator": "0.0.566",
-    "@teambit/bit-error": "0.0.379"
+    "@teambit/cli": "0.0.395",
+    "@teambit/logger": "0.0.482",
+    "@teambit/pubsub": "0.0.570",
+    "@teambit/aspect-loader": "0.0.570",
+    "@teambit/builder": "0.0.570",
+    "@teambit/component": "0.0.570",
+    "@teambit/envs": "0.0.570",
+    "@teambit/generator": "0.0.570",
+    "@teambit/legacy-bit-id": "0.0.384",
+    "@teambit/ui": "0.0.570",
+    "@teambit/workspace": "0.0.570",
+    "@teambit/isolator": "0.0.570",
+    "@teambit/bit-error": "0.0.381"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",
@@ -40,10 +40,10 @@
     "@types/jest": "^26.0.0",
     "@types/react-dom": "^17.0.5",
     "@types/node": "12.20.4",
-    "@teambit/compilation.aspect-docs.compiler": "0.0.112"
+    "@teambit/compilation.aspect-docs.compiler": "0.0.116"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.179",
+    "@teambit/legacy": "1.0.181",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -71,27 +71,12 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.179",
+        "@teambit/legacy": "1.0.181",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
-  "files": [
-    "dist",
-    "!dist/tsconfig.tsbuildinfo",
-    "**/*.md",
-    "**/*.mdx",
-    "**/*.js",
-    "**/*.json",
-    "**/*.sass",
-    "**/*.scss",
-    "**/*.less",
-    "**/*.css",
-    "**/*.css",
-    "**/*.jpeg",
-    "**/*.gif"
-  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/templates/compiler/files/aspect-file.ts

@@ -0,0 +1,10 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function aspectFile({ namePascalCase, componentId }: ComponentContext) {
+  return `import { Aspect } from '@teambit/harmony';
+
+export const ${namePascalCase}Aspect = Aspect.create({
+  id: '${componentId}',
+});
+  `;
+}

package/templates/compiler/files/compiler-file.ts

@@ -0,0 +1,75 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function compilerFile({ namePascalCase }: ComponentContext) {
+  return `import {
+  BuildContext,
+  BuiltTaskResult,
+  ComponentResult,
+} from '@teambit/builder';
+import {
+  Compiler,
+  CompilerMain,
+  TranspileFileParams,
+  TranspileFileOutput,
+} from '@teambit/compiler';
+
+export class ${namePascalCase} implements Compiler {
+
+    constructor(readonly id: string, readonly distDir, private compiler: CompilerMain) {}
+
+    /**
+     * Detemines whether unsupported files (such as assets)
+     * should be copied by Compiler aspect into the 'dist' directory
+     */
+    shouldCopyNonSupportedFiles = true;
+
+    /* The name of the compiler being used. For example, TypeScript, Babel, etc. */
+    displayName = '';
+
+    /* The version of the compiler being used. For example '1.0.0' */
+    version(): string {};
+
+    /**
+     * Use this for compilation in the workspace.
+     * This will compile one file content at a time (alternatively, use 'transpileComponent') */
+    transpileFile( fileContent: string, transpileFileParams: TranspileFileParams): TranspileFileOutput {}
+
+
+    async build(context: BuildContext): Promise<BuiltTaskResult> {
+        let componentsResults: ComponentResult[] = [];
+        return {
+            /* Sets the files to persist as the Component's artifacts,
+            and describes them. */
+            artifacts: [
+                {
+                    generatedBy: this.id,
+                    name: 'compilation output',
+                    globPatterns: [\`\${this.distDir}/**\`],
+                },
+            ],
+             componentsResults,
+        };
+    }
+
+    /* This is optional but recommended.
+    Not using it will require consumers of your compiler to use two APIs and have two depndencies
+    to their Envs - your compiler
+    */
+    createTask() {
+        return this.compiler.createTask('${namePascalCase}', this);
+    }
+
+    /**
+     * Given a source file, return its parallel in the dists. e.g. index.ts => dist/index.js.
+     * Needed by aspects such as Pkg to determine the main prop.
+     */
+    getDistPathBySrcPath(srcPath: string): string {}
+
+    /**
+     * Returns a boolean indicating whether a file is supported by the compiler or not.
+     * For example, this API is used by Compiler aspect to copy unsupported files to the dist directory.
+     */
+    isFileSupported(filePath: string): boolean {}
+}
+  `;
+}

package/templates/compiler/files/index-file.ts

@@ -0,0 +1,10 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function indexFile({ namePascalCase, name }: ComponentContext) {
+  return `import { ${namePascalCase}Aspect } from './${name}.aspect';
+
+export type { ${namePascalCase}Main } from './${name}.main.runtime';
+export default ${namePascalCase}Aspect;
+export { ${namePascalCase}Aspect };
+`;
+}

package/templates/compiler/files/main-runtime-file.ts

@@ -0,0 +1,37 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function mainRuntimeFile({ name, namePascalCase }: ComponentContext) {
+  return `import { MainRuntime } from '@teambit/cli';
+import { CompilerAspect, CompilerMain } from '@teambit/compiler';
+import { ${namePascalCase} } from './${name}.compiler';
+import { ${namePascalCase}Aspect } from './${name}.aspect';
+
+export class ${namePascalCase}Main {
+  constructor(private compiler: CompilerMain) {}
+
+  static slots = [];
+  static dependencies = [CompilerAspect];
+  static runtime = MainRuntime;
+
+  distDir = 'dist';
+
+  /* Set the main property of the component's package with
+  the relative output path for the main file */
+  getPackageJsonProps() {
+    return {
+      main: '\${this.distDir}/{main}.js',
+    };
+  }
+
+  createCompiler(): ${namePascalCase} {
+    return new ${namePascalCase}(${namePascalCase}Aspect.id, this.distDir, this.compiler);
+  }
+
+  static async provider([compiler]: [CompilerMain]) {
+    return new ${namePascalCase}Main(compiler);
+  }
+}
+
+${namePascalCase}Aspect.addRuntime(${namePascalCase}Main);
+`;
+}

package/templates/compiler/index.ts

@@ -0,0 +1,32 @@
+import { ComponentContext, ComponentTemplate } from '@teambit/generator';
+import { indexFile } from './files/index-file';
+import { aspectFile } from './files/aspect-file';
+import { mainRuntimeFile } from './files/main-runtime-file';
+import { compilerFile } from './files/compiler-file';
+
+export const compilerTemplate: ComponentTemplate = {
+  name: 'compiler',
+  description: 'A compiler implementation',
+  hidden: true,
+  generateFiles: (context: ComponentContext) => {
+    return [
+      {
+        relativePath: 'index.ts',
+        content: indexFile(context),
+        isMain: true,
+      },
+      {
+        relativePath: `${context.name}.aspect.ts`,
+        content: aspectFile(context),
+      },
+      {
+        relativePath: `${context.name}.compiler.ts`,
+        content: compilerFile(context),
+      },
+      {
+        relativePath: `${context.name}.main.runtime.ts`,
+        content: mainRuntimeFile(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;
+}