@teambit/compiler 0.0.554 → 0.0.558

package/tsconfig.json

@@ -15,9 +15,9 @@
     "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "outDir": "dist",
     "composite": true,
     "emitDeclarationOnly": true,
+    "outDir": "dist",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "allowSyntheticDefaultImports": true,
@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },

package/compiler.aspect.ts

@@ -1,5 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const CompilerAspect = Aspect.create({
-  id: 'teambit.compilation/compiler',
-});

package/compiler.cmd.ts

@@ -1,115 +0,0 @@
-import { Command, CommandOptions } from '@teambit/cli';
-import { Logger } from '@teambit/logger';
-import type { PubsubMain, BitBaseEvent } from '@teambit/pubsub';
-import chalk from 'chalk';
-import prettyTime from 'pretty-time';
-import type ConsumerComponent from '@teambit/legacy/dist/consumer/component';
-import { formatCompileResults } from './output-formatter';
-import { CompileError, WorkspaceCompiler, CompileOptions } from './workspace-compiler';
-import { CompilationInitiator } from './types';
-
-// IDs & events
-import { CompilerAspect } from './compiler.aspect';
-import { ComponentCompilationOnDoneEvent } from './events';
-
-type ComponentsStatus = {
-  buildResults: string[];
-  component: Array<ConsumerComponent>;
-  errors: Array<CompileError>;
-};
-
-export class CompileCmd implements Command {
-  componentsStatus: Array<ComponentsStatus> = [];
-  name = 'compile [component...]';
-  description = 'compile components in the development workspace';
-  alias = '';
-  group = 'development';
-  options = [
-    ['c', 'changed', 'compile only new and modified components'],
-    ['v', 'verbose', 'show more data, such as, dist paths'],
-    ['j', 'json', 'return the compile results in json format'],
-  ] as CommandOptions;
-
-  constructor(private compile: WorkspaceCompiler, private logger: Logger, private pubsub: PubsubMain) {}
-
-  async report([components = []]: [string[]], compilerOptions: CompileOptions) {
-    const startTimestamp = process.hrtime();
-    this.logger.setStatusLine('Compiling your components, hold tight.');
-    this.pubsub.sub(CompilerAspect.id, this.onComponentCompilationDone.bind(this));
-
-    let outputString = '';
-    await this.compile.compileComponents(components, {
-      ...compilerOptions,
-      initiator: CompilationInitiator.CmdReport,
-      deleteDistDir: true,
-    });
-    const compileTimeLength = process.hrtime(startTimestamp);
-
-    outputString += '\n';
-    outputString += `  ${chalk.underline('STATUS')}\t${chalk.underline('COMPONENT ID')}\n`;
-    outputString += formatCompileResults(this.componentsStatus, compilerOptions.verbose);
-    outputString += '\n';
-
-    outputString += this.getStatusLine(this.componentsStatus, compileTimeLength);
-
-    this.logger.clearStatusLine();
-
-    return {
-      data: outputString,
-      code: this.getExitCode(this.componentsStatus),
-    };
-  }
-
-  async json([components]: [string[]], compilerOptions: CompileOptions) {
-    compilerOptions.deleteDistDir = true;
-    // @ts-ignore
-    const compileResults = await this.compile.compileComponents(components, {
-      ...compilerOptions,
-      initiator: CompilationInitiator.CmdJson,
-      deleteDistDir: true,
-    });
-    return {
-      data: compileResults,
-      // @todo: fix the code once compile is ready.
-      code: 0,
-    };
-  }
-
-  private failedComponents(componentsStatus: ComponentsStatus[]): ComponentsStatus[] {
-    return componentsStatus.filter((component) => component.errors.length);
-  }
-
-  private getSummaryIcon(componentsStatus: ComponentsStatus[]) {
-    switch (this.failedComponents(componentsStatus).length) {
-      case 0:
-        return chalk.green('✔');
-      case componentsStatus.length:
-        return chalk.red('✗');
-      default:
-        return chalk.yellow('⍻');
-    }
-  }
-
-  private getExitCode(componentsStatus: ComponentsStatus[]) {
-    return this.failedComponents(componentsStatus).length ? 1 : 0;
-  }
-
-  private getStatusLine(componentsStatus: ComponentsStatus[], compileTimeLength) {
-    const numberOfComponents = componentsStatus.length;
-    const numberOfFailingComponents = this.failedComponents(componentsStatus).length;
-    const numberOfSuccessfulComponents = componentsStatus.filter((component) => !component.errors.length).length;
-
-    const icon = this.getSummaryIcon(componentsStatus);
-    const summaryLine = numberOfFailingComponents
-      ? `${icon} ${numberOfFailingComponents}/${numberOfComponents} components failed to compile.`
-      : `${icon} ${numberOfSuccessfulComponents}/${numberOfComponents} components compiled successfully.`;
-
-    return `${summaryLine}\nFinished. (${prettyTime(compileTimeLength)})`;
-  }
-
-  private onComponentCompilationDone(event: BitBaseEvent<any>) {
-    if (event.type === ComponentCompilationOnDoneEvent.TYPE) {
-      this.componentsStatus.push(event.data);
-    }
-  }
-}

package/compiler.docs.mdx

@@ -1,8 +0,0 @@
----
-description: Compiler compilation for Bit components
-labels: ['compiler', 'bit', 'extension', 'aspect']
----
-
-import { Compiler } from '@teambit/compilation.aspect-docs.compiler';
-
-<Compiler />

package/compiler.main.runtime.ts

@@ -1,99 +0,0 @@
-import AspectLoaderAspect, { AspectLoaderMain } from '@teambit/aspect-loader';
-import { BuilderAspect, BuilderMain } from '@teambit/builder';
-import { CLIAspect, CLIMain, MainRuntime } from '@teambit/cli';
-import { Component } from '@teambit/component';
-import { EnvsAspect, EnvsMain } from '@teambit/envs';
-import { BitId } from '@teambit/legacy-bit-id';
-
-import ManyComponentsWriter from '@teambit/legacy/dist/consumer/component-ops/many-components-writer';
-import { LoggerAspect, LoggerMain } from '@teambit/logger';
-import { PubsubAspect, PubsubMain } from '@teambit/pubsub';
-import UIAspect, { UiMain } from '@teambit/ui';
-import { Workspace, WorkspaceAspect } from '@teambit/workspace';
-import { CompilerAspect } from './compiler.aspect';
-import { CompileCmd } from './compiler.cmd';
-import { CompilerService } from './compiler.service';
-import { CompilerTask } from './compiler.task';
-import { DistArtifact } from './dist-artifact';
-import { DistArtifactNotFound } from './exceptions';
-import { CompilationInitiator, Compiler } from './types';
-import { CompileOptions, WorkspaceCompiler } from './workspace-compiler';
-
-export class CompilerMain {
-  constructor(
-    private pubsub: PubsubMain,
-    private workspaceCompiler: WorkspaceCompiler,
-    private envs: EnvsMain,
-    private builder: BuilderMain
-  ) {}
-
-  /**
-   * Run compilation on `bit new` and when new components are imported
-   */
-  compileOnWorkspace(
-    componentsIds: string[] | BitId[] = [], // when empty, it compiles all
-    options: CompileOptions = { initiator: CompilationInitiator.ComponentAdded }
-  ) {
-    return this.workspaceCompiler.compileComponents(componentsIds, options);
-  }
-  /**
-   * API to create a new compiler task, it facilitates the usage of multiple compilers.
-   * with this method you can create any number of compilers and add them to the buildPipeline.
-   */
-  createTask(name: string, compiler: Compiler): CompilerTask {
-    return new CompilerTask(CompilerAspect.id, name, compiler);
-  }
-
-  /**
-   * find the compiler configured on the workspace and ask for the dist path.
-   */
-  getDistPathBySrcPath(component: Component, srcPath: string): string | null {
-    const environment = this.envs.getEnv(component).env;
-    const compilerInstance = environment.getCompiler?.();
-    if (!compilerInstance) return null;
-    return compilerInstance.getDistPathBySrcPath(srcPath);
-  }
-
-  async getDistsFiles(component: Component): Promise<DistArtifact> {
-    const artifacts = await this.builder.getArtifactsVinylByExtension(component, CompilerAspect.id);
-    if (!artifacts.length) throw new DistArtifactNotFound(component.id);
-
-    return new DistArtifact(artifacts);
-  }
-
-  static runtime = MainRuntime;
-
-  static dependencies = [
-    CLIAspect,
-    WorkspaceAspect,
-    EnvsAspect,
-    LoggerAspect,
-    PubsubAspect,
-    AspectLoaderAspect,
-    BuilderAspect,
-    UIAspect,
-  ];
-
-  static async provider([cli, workspace, envs, loggerMain, pubsub, aspectLoader, builder, ui]: [
-    CLIMain,
-    Workspace,
-    EnvsMain,
-    LoggerMain,
-    PubsubMain,
-    AspectLoaderMain,
-    BuilderMain,
-    UiMain
-  ]) {
-    const logger = loggerMain.createLogger(CompilerAspect.id);
-    const workspaceCompiler = new WorkspaceCompiler(workspace, envs, pubsub, aspectLoader, ui, logger);
-    envs.registerService(new CompilerService());
-    const compilerMain = new CompilerMain(pubsub, workspaceCompiler, envs, builder);
-    cli.register(new CompileCmd(workspaceCompiler, logger, pubsub));
-
-    ManyComponentsWriter.externalCompiler = compilerMain.compileOnWorkspace.bind(compilerMain);
-
-    return compilerMain;
-  }
-}
-
-CompilerAspect.addRuntime(CompilerMain);

package/compiler.service.tsx

@@ -1,47 +0,0 @@
-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/compiler.task.ts

@@ -1,52 +0,0 @@
-import { BuildContext, BuiltTaskResult, BuildTask, TaskResultsList } from '@teambit/builder';
-import { Capsule } from '@teambit/isolator';
-import fs from 'fs-extra';
-import path from 'path';
-
-import { Compiler } from './types';
-
-/**
- * compiler build task. Allows to compile components during component build.
- */
-export class CompilerTask implements BuildTask {
-  readonly description = 'compile components';
-  constructor(readonly aspectId: string, readonly name: string, private compilerInstance: Compiler) {
-    if (compilerInstance.artifactName) {
-      this.description += ` for artifact ${compilerInstance.artifactName}`;
-    }
-  }
-
-  async preBuild(context: BuildContext) {
-    await Promise.all(
-      context.capsuleNetwork.seedersCapsules.map((capsule) =>
-        this.copyNonSupportedFiles(capsule, this.compilerInstance)
-      )
-    );
-    if (!this.compilerInstance.preBuild) return;
-    await this.compilerInstance.preBuild(context);
-  }
-
-  async execute(context: BuildContext): Promise<BuiltTaskResult> {
-    const buildResults = await this.compilerInstance.build(context);
-    return buildResults;
-  }
-
-  async postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void> {
-    if (!this.compilerInstance.postBuild) return;
-    await this.compilerInstance.postBuild(context, tasksResults);
-  }
-
-  async copyNonSupportedFiles(capsule: Capsule, compiler: Compiler) {
-    if (!compiler.shouldCopyNonSupportedFiles) {
-      return;
-    }
-    const component = capsule.component;
-    await Promise.all(
-      component.filesystem.files.map(async (file) => {
-        if (compiler.isFileSupported(file.path)) return;
-        const content = file.contents;
-        await fs.outputFile(path.join(capsule.path, compiler.distDir, file.relative), content);
-      })
-    );
-  }
-}

package/dist-artifact.ts

@@ -1,12 +0,0 @@
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import { pathNormalizeToLinux } from '@teambit/legacy/dist/utils';
-
-export class DistArtifact {
-  constructor(private artifacts: AbstractVinyl[]) {}
-
-  getFile(path: string) {
-    return this.artifacts.find((file) => {
-      return pathNormalizeToLinux(file.relative) === path;
-    });
-  }
-}

package/events/compiler-error.ts

@@ -1,14 +0,0 @@
-/* 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

@@ -1,30 +0,0 @@
-/* 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

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

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

@@ -1,8 +0,0 @@
-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

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

package/index.ts

@@ -1,11 +0,0 @@
-export type { CompilerMain } from './compiler.main.runtime';
-export { CompilerAspect } from './compiler.aspect';
-export {
-  Compiler,
-  CompilerOptions,
-  CompilationInitiator,
-  TranspileFileOutput,
-  TranspileFileParams,
-  TranspileComponentParams,
-} from './types';
-export * from './events';

package/output-formatter.ts

@@ -1,19 +0,0 @@
-import chalk from 'chalk';
-
-export const formatCompileResults = (compileResults, verbose) =>
-  compileResults
-    .map((componentResult) => ({
-      componentId: componentResult.component.name,
-      files: componentResult.buildResults,
-      status: componentResult.errors.length ? 'FAILURE' : 'SUCCESS',
-      icon: componentResult.errors.length ? chalk.red('✗') : chalk.green('✔'),
-    }))
-    .reduce((outputString, result) => {
-      outputString += `${result.icon} ${result.status}\t${result.componentId}`;
-      if (verbose) {
-        outputString += ':';
-        outputString += result?.files?.reduce((fileList, file) => `${fileList}\t\t - ${file}\n`, '\n');
-      }
-      outputString += '\n';
-      return outputString;
-    }, '');

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-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

@@ -1,42 +0,0 @@
-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;
-}

package/types.ts

@@ -1,137 +0,0 @@
-import { BuildContext, BuildTask, BuiltTaskResult, TaskResultsList } from '@teambit/builder';
-import ConsumerComponent from '@teambit/legacy/dist/consumer/component';
-import type { Component } from '@teambit/component';
-
-export type TranspileFileParams = {
-  componentDir: string; // absolute path of the component's root directory
-  filePath: string; // relative path of the file inside the component directory
-};
-
-export enum CompilationInitiator {
-  CmdReport,
-  CmdJson,
-  PreStart,
-  PreWatch,
-  Start,
-  ComponentChanged,
-  AspectLoadFail,
-  ComponentAdded,
-}
-
-export type TranspileComponentParams = {
-  component: ConsumerComponent;
-  componentDir: string; // absolute path of the component's root directory
-  outputDir: string; // absolute path of the component's output directory
-  initiator: CompilationInitiator; // origin of the compilation's request
-};
-
-export type TranspileFileOutput =
-  | {
-      outputText: string;
-      outputPath: string;
-    }[]
-  | null;
-
-export interface CompilerOptions {
-  /**
-   * name of the compiler.
-   */
-  name?: string;
-
-  /**
-   * relative path of the dist directory inside the capsule. e.g. "dist".
-   */
-  distDir: string;
-
-  /**
-   * determines which ones of the generated files will be saved in the bit objects when tagging.
-   * e.g. distGlobPatterns = [`${this.distDir}/**`, `!${this.distDir}/tsconfig.tsbuildinfo`];
-   * see https://github.com/mrmlnc/fast-glob for the supported glob patters syntax.
-   */
-  distGlobPatterns?: string[];
-
-  /**
-   * whether or not unsupported files (such as assets) should be copied into the dist directory
-   */
-  shouldCopyNonSupportedFiles?: boolean;
-
-  /**
-   * optional. default to "dist".
-   * useful when the build pipeline has multiple compiler tasks of the same compiler.
-   * e.g. using the same Babel compiler for two different tasks, one for creating "es5" files, and
-   * the second for creating "esm". the artifact names would be "es5" and "esm" accordingly.
-   */
-  artifactName?: string;
-}
-
-export interface Compiler extends CompilerOptions {
-  /**
-   * id of the compiler.
-   */
-  id: string;
-
-  /**
-   * serialized config of the compiler.
-   */
-  displayConfig?(): string;
-
-  /**
-   * transpile a single file that gets saved into the workspace, used by `bit compile` and during
-   * development
-   */
-  transpileFile?: (fileContent: string, params: TranspileFileParams) => TranspileFileOutput;
-
-  /**
-   * transpile all the files of a component, use this when you can't use `transpileFile`
-   */
-  transpileComponent?: (params: TranspileComponentParams) => Promise<void>;
-
-  /**
-   * compile components inside isolated capsules. this being used during tag for the release.
-   * meaning, the final package of the component has the dists generated by this method.
-   */
-  build(context: BuildContext): Promise<BuiltTaskResult>;
-
-  /**
-   * given a source file, return its parallel in the dists. e.g. "index.ts" => "dist/index.js"
-   * both, the return path and the given path are relative paths.
-   */
-  getDistPathBySrcPath(srcPath: string): string;
-
-  /**
-   * given a component, returns the path to the source folder to use for the preview, uses the one
-   * in node_modules by default
-   */
-  getPreviewComponentRootPath?(component: Component): string;
-
-  /**
-   * only supported files matching get compiled. others, are copied to the dist dir.
-   */
-  isFileSupported(filePath: string): boolean;
-
-  /**
-   * sugar to create a Compiler task via the concrete compiler
-   */
-  createTask?(name?: string): BuildTask;
-
-  /**
-   * run before the build pipeline has started. this is useful when some preparation are needed to
-   * be done on all envs before the build starts.
-   */
-  preBuild?(context: BuildContext): Promise<void>;
-
-  /**
-   * run after the build pipeline completed for all envs. useful for some cleanups
-   */
-  postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>;
-
-  /**
-   * returns the version of the current compiler instance (e.g. '4.0.1').
-   */
-  version(): string;
-
-  /**
-   * returns the display name of the current compiler instance (e.g. 'TypeScript')
-   */
-  displayName: string;
-}