@teambit/compiler 0.0.554 → 0.0.555

package/dist/compiler.main.runtime.d.ts

@@ -18,8 +18,19 @@ export declare class CompilerMain {
     private envs;
     private builder;
     constructor(pubsub: PubsubMain, workspaceCompiler: WorkspaceCompiler, envs: EnvsMain, builder: BuilderMain);
-    compileOnWorkspace(componentsIds?: string[] | BitId[], options?: CompileOptions): Promise<import("./workspace-compiler").BuildResult[]>;
+    /**
+     * Run compilation on `bit new` and when new components are imported
+     */
+    compileOnWorkspace(componentsIds?: string[] | BitId[], // when empty, it compiles all
+    options?: CompileOptions): Promise<import("./workspace-compiler").BuildResult[]>;
+    /**
+     * 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;
+    /**
+     * find the compiler configured on the workspace and ask for the dist path.
+     */
     getDistPathBySrcPath(component: Component, srcPath: string): string | null;
     getDistsFiles(component: Component): Promise<DistArtifact>;
     static runtime: import("@teambit/harmony").RuntimeDefinition;

package/dist/compiler.task.d.ts

@@ -1,6 +1,9 @@
 import { BuildContext, BuiltTaskResult, BuildTask, TaskResultsList } from '@teambit/builder';
 import { Capsule } from '@teambit/isolator';
 import { Compiler } from './types';
+/**
+ * compiler build task. Allows to compile components during component build.
+ */
 export declare class CompilerTask implements BuildTask {
     readonly aspectId: string;
     readonly name: string;

package/dist/types.d.ts

@@ -26,24 +26,88 @@ export declare type TranspileFileOutput = {
     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;
 }

package/dist/workspace-compiler.d.ts

@@ -17,6 +17,11 @@ export declare type BuildResult = {
 export declare type CompileOptions = {
     changed?: boolean;
     verbose?: boolean;
+    /**
+     * whether the dist root dir should be deleted before writing new dists.
+     * defaults to true for `bit compile` and false everywhere else, such as `bit watch` and `bit
+     * start` to avoid webpack "EINTR" error.
+     */
     deleteDistDir?: boolean;
     initiator: CompilationInitiator;
 };
@@ -55,6 +60,7 @@ export declare class WorkspaceCompiler {
     }, id: ComponentID): Promise<boolean>;
     onComponentChange(component: Component, files: string[], initiator?: CompilationInitiator): Promise<SerializableResults>;
     onPreWatch(components: Component[], watchOpts: WatchOptions): Promise<void>;
-    compileComponents(componentsIds: string[] | BitId[], options: CompileOptions, noThrow?: boolean): Promise<BuildResult[]>;
+    compileComponents(componentsIds: string[] | BitId[], // when empty, it compiles new+modified (unless options.all is set),
+    options: CompileOptions, noThrow?: boolean): Promise<BuildResult[]>;
     private getIdsToCompile;
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/compiler",
-  "version": "0.0.554",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/compilation/compiler",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.compilation",
     "name": "compiler",
-    "version": "0.0.554"
+    "version": "0.0.555"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -18,18 +18,18 @@
     "p-map-series": "2.1.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/cli": "0.0.385",
-    "@teambit/logger": "0.0.470",
-    "@teambit/pubsub": "0.0.554",
-    "@teambit/aspect-loader": "0.0.554",
-    "@teambit/builder": "0.0.554",
-    "@teambit/component": "0.0.554",
-    "@teambit/envs": "0.0.554",
-    "@teambit/legacy-bit-id": "0.0.374",
-    "@teambit/ui": "0.0.554",
-    "@teambit/workspace": "0.0.554",
-    "@teambit/isolator": "0.0.554",
-    "@teambit/bit-error": "0.0.371"
+    "@teambit/cli": "0.0.386",
+    "@teambit/logger": "0.0.471",
+    "@teambit/pubsub": "0.0.555",
+    "@teambit/aspect-loader": "0.0.555",
+    "@teambit/builder": "0.0.555",
+    "@teambit/component": "0.0.555",
+    "@teambit/envs": "0.0.555",
+    "@teambit/legacy-bit-id": "0.0.375",
+    "@teambit/ui": "0.0.555",
+    "@teambit/workspace": "0.0.555",
+    "@teambit/isolator": "0.0.555",
+    "@teambit/bit-error": "0.0.372"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",
@@ -39,10 +39,10 @@
     "@types/jest": "^26.0.0",
     "@types/react-dom": "^17.0.5",
     "@types/node": "12.20.4",
-    "@teambit/compilation.aspect-docs.compiler": "0.0.104"
+    "@teambit/compilation.aspect-docs.compiler": "0.0.105"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.171",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -70,7 +70,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.171",
+        "@teambit/legacy": "1.0.172",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },