@teambit/workspace 0.0.531 → 0.0.535

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/workspace",
-  "version": "0.0.531",
+  "version": "0.0.535",
   "homepage": "https://bit.dev/teambit/workspace/workspace",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace",
-    "version": "0.0.531"
+    "version": "0.0.535"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -33,53 +33,53 @@
     "@teambit/base-ui.surfaces.split-pane.split-pane": "1.0.0",
     "@teambit/base-ui.graph.tree.recursive-tree": "1.0.0",
     "@teambit/cli": "0.0.380",
-    "@teambit/isolator": "0.0.531",
+    "@teambit/isolator": "0.0.535",
     "@teambit/component-tree": "0.0.366",
-    "@teambit/component.ui.component-status-resolver": "0.0.453",
-    "@teambit/harmony.modules.resolved-component": "0.0.447",
-    "@teambit/dependency-resolver": "0.0.531",
-    "@teambit/logger": "0.0.455",
-    "@teambit/compiler": "0.0.531",
-    "@teambit/component": "0.0.531",
-    "@teambit/graphql": "0.0.531",
-    "@teambit/aspect-loader": "0.0.531",
-    "@teambit/bundler": "0.0.531",
-    "@teambit/envs": "0.0.531",
-    "@teambit/pubsub": "0.0.531",
-    "@teambit/scope": "0.0.531",
-    "@teambit/ui": "0.0.531",
-    "@teambit/variants": "0.0.457",
+    "@teambit/component.ui.component-status-resolver": "0.0.455",
+    "@teambit/harmony.modules.resolved-component": "0.0.449",
+    "@teambit/dependency-resolver": "0.0.535",
+    "@teambit/logger": "0.0.457",
+    "@teambit/compiler": "0.0.535",
+    "@teambit/component": "0.0.535",
+    "@teambit/graphql": "0.0.535",
+    "@teambit/aspect-loader": "0.0.535",
+    "@teambit/bundler": "0.0.535",
+    "@teambit/envs": "0.0.535",
+    "@teambit/pubsub": "0.0.535",
+    "@teambit/scope": "0.0.535",
+    "@teambit/ui": "0.0.535",
+    "@teambit/variants": "0.0.459",
     "@teambit/legacy-bit-id": "0.0.369",
     "@teambit/bit-error": "0.0.366",
     "@teambit/component-issues": "0.0.15",
     "@teambit/config": "0.0.391",
-    "@teambit/harmony.modules.requireable-component": "0.0.447",
-    "@teambit/workspace.modules.match-pattern": "0.0.449",
-    "@teambit/command-bar": "0.0.531",
+    "@teambit/harmony.modules.requireable-component": "0.0.449",
+    "@teambit/workspace.modules.match-pattern": "0.0.451",
+    "@teambit/command-bar": "0.0.535",
     "@teambit/design.ui.surfaces.menu.link-item": "0.0.374",
-    "@teambit/graph": "0.0.531",
-    "@teambit/react-router": "0.0.531",
-    "@teambit/sidebar": "0.0.531",
-    "@teambit/ui-foundation.ui.main-dropdown": "0.0.449",
-    "@teambit/ui-foundation.ui.menu": "0.0.449",
-    "@teambit/ui-foundation.ui.react-router.slot-router": "0.0.451",
-    "@teambit/toolbox.time.time-format": "0.0.446",
+    "@teambit/graph": "0.0.535",
+    "@teambit/react-router": "0.0.535",
+    "@teambit/sidebar": "0.0.535",
+    "@teambit/ui-foundation.ui.main-dropdown": "0.0.451",
+    "@teambit/ui-foundation.ui.menu": "0.0.451",
+    "@teambit/ui-foundation.ui.react-router.slot-router": "0.0.453",
+    "@teambit/toolbox.time.time-format": "0.0.448",
     "@teambit/component-id": "0.0.370",
-    "@teambit/ui-foundation.ui.hooks.use-data-query": "0.0.450",
-    "@teambit/deprecation": "0.0.531",
-    "@teambit/ui-foundation.ui.constants.z-indexes": "0.0.449",
-    "@teambit/ui-foundation.ui.buttons.collapser": "0.0.154",
-    "@teambit/ui-foundation.ui.corner": "0.0.456",
-    "@teambit/ui-foundation.ui.notifications.notification-context": "0.0.450",
-    "@teambit/ui-foundation.ui.top-bar": "0.0.451",
+    "@teambit/ui-foundation.ui.hooks.use-data-query": "0.0.452",
+    "@teambit/deprecation": "0.0.535",
+    "@teambit/ui-foundation.ui.constants.z-indexes": "0.0.451",
+    "@teambit/ui-foundation.ui.buttons.collapser": "0.0.156",
+    "@teambit/ui-foundation.ui.corner": "0.0.458",
+    "@teambit/ui-foundation.ui.notifications.notification-context": "0.0.452",
+    "@teambit/ui-foundation.ui.top-bar": "0.0.453",
     "@teambit/design.ui.styles.ellipsis": "0.0.346",
     "@teambit/design.ui.styles.muted-italic": "0.0.35",
-    "@teambit/ui-foundation.ui.full-loader": "0.0.449",
-    "@teambit/ui-foundation.ui.side-bar": "0.0.453",
-    "@teambit/ui-foundation.ui.tree.drawer": "0.0.449",
-    "@teambit/explorer.ui.gallery.component-grid": "0.0.449",
-    "@teambit/workspace.ui.empty-workspace": "0.0.451",
-    "@teambit/workspace.ui.workspace-component-card": "0.0.452"
+    "@teambit/ui-foundation.ui.full-loader": "0.0.451",
+    "@teambit/ui-foundation.ui.side-bar": "0.0.455",
+    "@teambit/ui-foundation.ui.tree.drawer": "0.0.451",
+    "@teambit/explorer.ui.gallery.component-grid": "0.0.451",
+    "@teambit/workspace.ui.empty-workspace": "0.0.453",
+    "@teambit/workspace.ui.workspace-component-card": "0.0.454"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",

package/watch/check-types.ts

@@ -0,0 +1,5 @@
+export enum CheckTypes {
+  None, // keep this. it equals zero. this way we can do "if checkTypes() ... "
+  EntireProject,
+  ChangedFile,
+}

package/watch/watch.cmd.tsx

@@ -1,6 +1,5 @@
 import chalk from 'chalk';
 import moment from 'moment';
-
 import { Command, CommandOptions } from '@teambit/cli';
 import type { Logger } from '@teambit/logger';
 import type { BitBaseEvent, PubsubMain } from '@teambit/pubsub';
@@ -11,14 +10,20 @@ import { CompilerAspect, CompilerErrorEvent } from '@teambit/compiler';
 import { Watcher, WatchOptions } from './watcher';
 import { formatCompileResults, formatWatchPathsSortByComponent } from './output-formatter';
 import { OnComponentEventResult } from '../on-component-events';
+import { CheckTypes } from './check-types';
+
+export type WatchCmdOpts = {
+  verbose?: boolean;
+  skipPreCompilation?: boolean;
+  checkTypes?: string | boolean;
+};
 
 export class WatchCommand implements Command {
   msgs = {
     onAll: (event, path) => this.logger.console(`Event: "${event}". Path: ${path}`),
     onStart: () => {},
     onReady: (workspace, watchPathsSortByComponent, verbose) => {
-      // eslint-disable-next-line no-console
-      console.clear();
+      clearOutdatedData();
       if (verbose) {
         this.logger.console(formatWatchPathsSortByComponent(watchPathsSortByComponent));
       }
@@ -29,8 +34,7 @@ export class WatchCommand implements Command {
       );
     },
     onChange: (filePath: string, buildResults: OnComponentEventResult[], verbose: boolean, duration) => {
-      // eslint-disable-next-line no-console
-      console.clear();
+      clearOutdatedData();
       if (!buildResults.length) {
         this.logger.console(`The file ${filePath} has been changed, but nothing to compile.\n\n`);
         return;
@@ -41,8 +45,7 @@ export class WatchCommand implements Command {
       this.logger.console(chalk.yellow(`Watching for component changes (${moment().format('HH:mm:ss')})...`));
     },
     onAdd: (filePath: string, buildResults: OnComponentEventResult[], verbose: boolean, duration) => {
-      // eslint-disable-next-line no-console
-      console.clear();
+      clearOutdatedData();
       this.logger.console(`The file ${filePath} has been added.\n\n`);
       this.logger.console(formatCompileResults(buildResults, verbose));
       this.logger.console(`Finished. (${duration}ms)`);
@@ -64,7 +67,11 @@ export class WatchCommand implements Command {
   options = [
     ['v', 'verbose', 'showing npm verbose output for inspection and prints stack trace'],
     ['', 'skip-pre-compilation', 'skip the compilation step before starting to watch'],
-    ['t', 'check-types', 'EXPERIMENTAL. for typescript files, load an tsserver instance to check types'],
+    [
+      't',
+      'check-types [string]',
+      'EXPERIMENTAL. show errors/warnings for types. options are [file, project] to investigate only changed file or entire project. defaults to project',
+    ],
   ] as CommandOptions;
 
   constructor(
@@ -99,8 +106,37 @@ export class WatchCommand implements Command {
     }
   };
 
-  async report(cliArgs: [], watchOpts: WatchOptions) {
-    await this.watcher.watch({ msgs: this.msgs, ...watchOpts });
+  async report(cliArgs: [], watchCmdOpts: WatchCmdOpts) {
+    const { verbose, checkTypes } = watchCmdOpts;
+    const getCheckTypesEnum = () => {
+      switch (checkTypes) {
+        case undefined:
+        case false:
+          return CheckTypes.None;
+        case 'project':
+        case true: // project is the default
+          return CheckTypes.EntireProject;
+        case 'file':
+          return CheckTypes.ChangedFile;
+        default:
+          throw new Error(`check-types can be either "file" or "project". got "${checkTypes}"`);
+      }
+    };
+    const watchOpts: WatchOptions = {
+      msgs: this.msgs,
+      verbose,
+      preCompile: !watchCmdOpts.skipPreCompilation,
+      spawnTSServer: Boolean(checkTypes), // if check-types is enabled, it must spawn the tsserver.
+      checkTypes: getCheckTypesEnum(),
+    };
+    await this.watcher.watchAll(watchOpts);
     return 'watcher terminated';
   }
 }
+
+/**
+ * with console.clear() all history is deleted from the console. this function preserver the history.
+ */
+function clearOutdatedData() {
+  process.stdout.write('\x1Bc');
+}

package/watch/watcher.ts

@@ -19,10 +19,18 @@ import { WorkspaceAspect } from '../';
 import { OnComponentChangeEvent, OnComponentAddEvent, OnComponentRemovedEvent } from '../events';
 import { Workspace } from '../workspace';
 import { OnComponentEventResult } from '../on-component-events';
+import { CheckTypes } from './check-types';
 
 export type WatcherProcessData = { watchProcess: ChildProcess; compilerId: BitId; componentIds: BitId[] };
 
-export type WatchOptions = { verbose?: boolean; checkTypes?: boolean; skipPreCompilation?: boolean };
+export type WatchOptions = {
+  msgs?: any;
+  initiator?: CompilationInitiator;
+  verbose?: boolean; // print watch events to the console. (also ts-server events if spawnTSServer is true)
+  spawnTSServer?: boolean; // needed for check types and extract API/docs.
+  checkTypes?: CheckTypes; // if enabled, the spawnTSServer becomes true.
+  preCompile?: boolean; // whether compile all components before start watching
+};
 
 export class Watcher {
   private fsWatcher: FSWatcher;
@@ -34,16 +42,11 @@ export class Watcher {
     private multipleWatchers: WatcherProcessData[] = []
   ) {}
 
-  async watch(opts: { msgs } & WatchOptions) {
-    this.verbose = Boolean(opts.verbose);
-    await this.watchAll(opts);
-  }
-
   get consumer(): Consumer {
     return this.workspace.consumer;
   }
 
-  async watchAll(opts: { msgs; initiator?: CompilationInitiator } & WatchOptions) {
+  async watchAll(opts: WatchOptions) {
     const { msgs, ...watchOpts } = opts;
     // TODO: run build in the beginning of process (it's work like this in other envs)
     const pathsToWatch = await this.getPathsToWatch();

package/workspace.ts

@@ -631,7 +631,7 @@ export class Workspace implements ComponentFactory {
     const addResults = await addComponent.add();
     // @todo: the legacy commands have `consumer.onDestroy()` on command completion, it writes the
     //  .bitmap file. workspace needs a similar mechanism. once done, remove the next line.
-    await this.consumer.bitMap.write(this.consumer.componentFsCache);
+    await this.writeBitMap();
     return addResults;
   }
 
@@ -1287,17 +1287,15 @@ your workspace.jsonc has this component-id set. you might want to remove/change
       verbose: false,
       merge: false,
       objectsOnly: true,
-      withEnvironments: false,
       override: false,
       writeDists: false,
       writeConfig: false,
       installNpmPackages: false,
-      writePackageJson: false,
       importDependenciesDirectly: false,
       importDependents: false,
     };
     try {
-      const res = await importAction({ tester: false, compiler: false }, importOptions, []);
+      const res = await importAction(importOptions, []);
       return res;
     } catch (err: any) {
       // TODO: this is a hack since the legacy throw an error, we should provide a way to not throw this error from the legacy