@teambit/typescript 0.0.549 → 0.0.555

package/dist/compiler-options.d.ts

@@ -1,8 +1,22 @@
 import type { CompilerOptions } from '@teambit/compiler';
 export declare type TypeScriptCompilerOptions = {
+    /**
+     * tsconfig to use during compilation.
+     */
     tsconfig: Record<string, any>;
+    /**
+     * path for .d.ts files to include during build.
+     */
     types: string[];
+    /**
+     * Run the compiler for .js files. this will only affect whether to run the compiler on the files
+     * or not. It won't change the tsconfig to support or not support js files.
+     */
     compileJs?: boolean;
+    /**
+     * Run the compiler for .js files. this will only affect whether to run the compiler on the files
+     * or not. It won't change the tsconfig to support or not support jsx files.
+     */
     compileJsx?: boolean;
 } & Partial<CompilerOptions>;
 export declare type TsCompilerOptionsWithoutTsConfig = Omit<TypeScriptCompilerOptions, 'tsconfig'>;

package/dist/typescript.compiler.d.ts

@@ -15,8 +15,14 @@ export declare class TypescriptCompiler implements Compiler {
     constructor(id: string, logger: Logger, options: TypeScriptCompilerOptions, tsModule: typeof ts);
     displayName: string;
     displayConfig(): string;
+    /**
+     * compile one file on the workspace
+     */
     transpileFile(fileContent: string, options: TranspileFileParams): TranspileFileOutput;
     preBuild(context: BuildContext): Promise<void>;
+    /**
+     * compile multiple components on the capsules
+     */
     build(context: BuildContext): Promise<BuiltTaskResult>;
     postBuild(context: BuildContext): Promise<void>;
     getArtifactDefinition(): {
@@ -24,11 +30,29 @@ export declare class TypescriptCompiler implements Compiler {
         name: string;
         globPatterns: string[];
     }[];
+    /**
+     * given a source file, return its parallel in the dists. e.g. index.ts => dist/index.js
+     */
     getDistPathBySrcPath(srcPath: string): string;
+    /**
+     * whether typescript is able to compile the given path
+     */
     isFileSupported(filePath: string): boolean;
+    /**
+     * we have two options here:
+     * 1. pass all capsules-dir at the second parameter of createSolutionBuilder and then no
+     * need to write the main tsconfig.json with all the references.
+     * 2. write main tsconfig.json and pass the capsules root-dir.
+     * we went with option #2 because it'll be easier for users to go to the capsule-root and run
+     * `tsc --build` to debug issues.
+     */
     private runTscBuild;
     private getFormatDiagnosticsHost;
     private writeTypes;
+    /**
+     * when using project-references, typescript adds a file "tsconfig.tsbuildinfo" which is not
+     * needed for the package.
+     */
     private writeNpmIgnore;
     private writeProjectReferencesTsConfig;
     private writeTsConfig;

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

@@ -15,11 +15,37 @@ export declare class TypescriptMain {
     private workspace?;
     private tsServer;
     constructor(logger: Logger, workspace?: Workspace | undefined);
+    /**
+     * create a new compiler.
+     */
     createCompiler(options: TypeScriptCompilerOptions, transformers?: TsConfigTransformer[], tsModule?: typeof ts): Compiler;
+    /**
+     * get TsserverClient instance if initiated already, otherwise, return undefined.
+     */
     getTsserverClient(): TsserverClient | undefined;
+    /**
+     * starts a tsserver process to communicate with its API.
+     * @param projectPath absolute path of the project root directory
+     * @param options TsserverClientOpts
+     * @param files optionally, if check-types is enabled, provide files to open and type check.
+     * @returns TsserverClient
+     */
     initTsserverClient(projectPath: string, options?: TsserverClientOpts, files?: string[]): Promise<TsserverClient>;
+    /**
+     * starts a tsserver process to communicate with its API. use only when running on the workspace.
+     * @param options TsserverClientOpts
+     * @param files optionally, if check-types is enabled, provide files to open and type check.
+     * @returns TsserverClient
+     */
     initTsserverClientFromWorkspace(options?: TsserverClientOpts, files?: string[]): Promise<TsserverClient>;
+    /**
+     * create an instance of a typescript semantic schema extractor.
+     */
     createSchemaExtractor(tsconfig: TsConfigSourceFile): SchemaExtractor;
+    /**
+     * add the default package json properties to the component
+     * :TODO @gilad why do we need this DSL? can't I just get the args here.
+     */
     getPackageJsonProps(): PackageJsonProps;
     private getAllFilesForTsserver;
     private onPreWatch;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/typescript",
-  "version": "0.0.549",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/typescript/typescript",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.typescript",
     "name": "typescript",
-    "version": "0.0.549"
+    "version": "0.0.555"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -16,18 +16,18 @@
     "p-map-series": "2.1.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/compiler": "0.0.549",
-    "@teambit/typescript.modules.ts-config-mutator": "0.0.39",
-    "@teambit/bit-error": "0.0.366",
-    "@teambit/builder": "0.0.549",
-    "@teambit/isolator": "0.0.549",
-    "@teambit/logger": "0.0.465",
-    "@teambit/component": "0.0.549",
-    "@teambit/schema": "0.0.549",
-    "@teambit/cli": "0.0.380",
-    "@teambit/pkg": "0.0.549",
-    "@teambit/ts-server": "0.0.3",
-    "@teambit/workspace": "0.0.549"
+    "@teambit/compiler": "0.0.555",
+    "@teambit/typescript.modules.ts-config-mutator": "0.0.43",
+    "@teambit/bit-error": "0.0.372",
+    "@teambit/builder": "0.0.555",
+    "@teambit/isolator": "0.0.555",
+    "@teambit/logger": "0.0.471",
+    "@teambit/component": "0.0.555",
+    "@teambit/schema": "0.0.555",
+    "@teambit/cli": "0.0.386",
+    "@teambit/pkg": "0.0.555",
+    "@teambit/ts-server": "0.0.9",
+    "@teambit/workspace": "0.0.555"
   },
   "devDependencies": {
     "chai": "4.3.0",
@@ -39,10 +39,10 @@
     "@types/jest": "^26.0.0",
     "@types/react-dom": "^17.0.5",
     "@types/node": "12.20.4",
-    "@teambit/typescript.aspect-docs.typescript": "0.0.101"
+    "@teambit/typescript.aspect-docs.typescript": "0.0.105"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.76",
+    "@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.76",
+        "@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
   },