@teambit/watcher 1.0.108 → 1.0.109

package/artifacts/preview/teambit_workspace_watcher-preview.js

@@ -0,0 +1 @@
+!function(e,o){"object"==typeof exports&&"object"==typeof module?module.exports=o():"function"==typeof define&&define.amd?define([],o):"object"==typeof exports?exports["teambit.workspace/watcher-preview"]=o():e["teambit.workspace/watcher-preview"]=o()}(self,(()=>(()=>{"use strict";var e={d:(o,t)=>{for(var r in t)e.o(t,r)&&!e.o(o,r)&&Object.defineProperty(o,r,{enumerable:!0,get:t[r]})},o:(e,o)=>Object.prototype.hasOwnProperty.call(e,o),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},o={};e.r(o),e.d(o,{compositions:()=>t,compositions_metadata:()=>i,overview:()=>r});const t=[],r=[],i={compositions:[]};return o})()));

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/watcher",
-  "version": "1.0.108",
+  "version": "1.0.109",
   "homepage": "https://bit.cloud/teambit/workspace/watcher",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.workspace",
     "name": "watcher",
-    "version": "1.0.108"
+    "version": "1.0.109"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -18,14 +18,14 @@
     "lodash": "4.17.21",
     "@teambit/harmony": "0.4.6",
     "@teambit/component-id": "1.2.0",
-    "@teambit/workspace": "1.0.108",
-    "@teambit/cli": "0.0.840",
-    "@teambit/compiler": "1.0.108",
-    "@teambit/logger": "0.0.933",
-    "@teambit/pubsub": "1.0.108",
-    "@teambit/global-config": "0.0.842",
-    "@teambit/ipc-events": "1.0.108",
-    "@teambit/scope": "1.0.108"
+    "@teambit/workspace": "1.0.109",
+    "@teambit/cli": "0.0.841",
+    "@teambit/compiler": "1.0.109",
+    "@teambit/logger": "0.0.934",
+    "@teambit/pubsub": "1.0.109",
+    "@teambit/global-config": "0.0.843",
+    "@teambit/ipc-events": "1.0.109",
+    "@teambit/scope": "1.0.109"
   },
   "devDependencies": {
     "@types/fs-extra": "9.0.7",
@@ -33,7 +33,7 @@
     "@types/mocha": "9.1.0",
     "@types/jest": "^29.2.2",
     "@types/testing-library__jest-dom": "^5.9.5",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.13"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.14"
   },
   "peerDependencies": {
     "@teambit/legacy": "1.0.624"

package/check-types.ts

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

package/index.ts

@@ -1,7 +0,0 @@
-import { WatcherAspect } from './watcher.aspect';
-
-export type { WatchOptions } from './watcher';
-export { CheckTypes } from './check-types';
-export type { WatcherMain } from './watcher.main.runtime';
-export default WatcherAspect;
-export { WatcherAspect };

package/output-formatter.ts

@@ -1,50 +0,0 @@
-import { OnComponentEventResult } from '@teambit/workspace';
-import chalk from 'chalk';
-
-const verboseComponentFilesArrayToString = (componentFiles = []) => {
-  return componentFiles.reduce((outputString, filePath) => `${outputString} \t - ${filePath}\n`, ``);
-};
-
-const resultsForExtensionArrayToString = (resultsForExtension, verbose) => {
-  return resultsForExtension.reduce(
-    (outputString, resultForExtension) =>
-      `${outputString}${chalk.green('√')}SUCCESS\t${resultForExtension.component}\n
-     ${verbose ? resultForExtension.componentFilesAsString : ''}\n`,
-    ''
-  );
-};
-
-export const formatWatchPathsSortByComponent = (trackDirs) => {
-  return Object.keys(trackDirs).reduce(
-    (outputString, watchPath) =>
-      `${outputString}
-    ${chalk.green('√')} SUCCESS\t${trackDirs[watchPath]}\n
-    \t - ${watchPath}\n\n`,
-    ` ${chalk.underline('STATUS\t\tCOMPONENT ID')}\n`
-  );
-};
-
-/**
- * todo: this was implemented incorrectly.
- * the original idea of `SerializableResults` was to have each one of the aspects registered to the slot, the
- * ability to have their own formatting to their results, and then `toString()` method to print them.
- * Here, the printing is specifically to the Compiler aspect. It should move to where it belongs.
- */
-export function formatCompileResults(compileResults: OnComponentEventResult[], verbose: boolean) {
-  if (!compileResults.length || !Array.isArray(compileResults)) return '';
-  return compileResults
-    .filter((compileResult) => compileResult.results?.results && Array.isArray(compileResult.results?.results))
-    .map((compileResult) => ({
-      extensionId: compileResult.extensionId,
-      resultsForExtension: compileResult.results?.results?.map((resultForExtension) => ({
-        component: resultForExtension.component,
-        componentFilesAsString: verboseComponentFilesArrayToString(resultForExtension.buildResults),
-      })),
-    }))
-    .reduce(
-      (outputString, compileResult) =>
-        `${outputString}
-  ${resultsForExtensionArrayToString(compileResult.resultsForExtension, verbose)}`,
-      ` ${chalk.underline('STATUS\tCOMPONENT ID')}`
-    );
-}

package/watch-queue.ts

@@ -1,17 +0,0 @@
-import PQueue from 'p-queue';
-
-export class WatchQueue {
-  private queue: PQueue;
-  constructor(concurrency = 1) {
-    this.queue = new PQueue({ concurrency, autoStart: true });
-  }
-  getQueue() {
-    return this.queue;
-  }
-  add<T>(fn: () => T, priority?: number): Promise<T> {
-    return this.queue.add(fn, { priority });
-  }
-  onIdle(): Promise<void> {
-    return this.queue.onIdle();
-  }
-}

package/watch.cmd.ts

@@ -1,160 +0,0 @@
-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';
-import { OnComponentEventResult } from '@teambit/workspace';
-
-// import IDs and events
-import { CompilerAspect, CompilerErrorEvent } from '@teambit/compiler';
-
-import { EventMessages, WatchOptions } from './watcher';
-import { formatCompileResults, formatWatchPathsSortByComponent } from './output-formatter';
-import { CheckTypes } from './check-types';
-import { WatcherMain } from './watcher.main.runtime';
-
-export type WatchCmdOpts = {
-  verbose?: boolean;
-  skipPreCompilation?: boolean;
-  checkTypes?: string | boolean;
-};
-
-export class WatchCommand implements Command {
-  name = 'watch';
-  description = 'automatically recompile modified components (on save)';
-  extendedDescription = `by default, the watcher doesn't use polling, to keep the CPU idle.
-if this doesn't work well for you, run "bit config set watch_use_polling true" to use polling.`;
-  helpUrl = 'reference/compiling/compiler-overview';
-  alias = '';
-  group = 'development';
-  options = [
-    ['v', 'verbose', 'show all watch events and compiler verbose output'],
-    ['', 'skip-pre-compilation', 'skip compilation step before starting to watch'],
-    [
-      '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(
-    /**
-     * logger extension.
-     */
-    private pubsub: PubsubMain,
-
-    /**
-     * logger extension.
-     */
-    private logger: Logger,
-
-    /**
-     * watcher extension.
-     */
-    private watcher: WatcherMain
-  ) {
-    this.registerToEvents();
-  }
-
-  private registerToEvents() {
-    this.pubsub.sub(CompilerAspect.id, this.eventsListener);
-  }
-
-  private eventsListener = (event: BitBaseEvent<any>) => {
-    switch (event.type) {
-      case CompilerErrorEvent.TYPE:
-        this.logger.console(`Watcher error ${event.data.error}, 'error'`);
-        break;
-      default:
-    }
-  };
-
-  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: getMessages(this.logger),
-      verbose,
-      compile: true,
-      preCompile: !watchCmdOpts.skipPreCompilation,
-      spawnTSServer: Boolean(checkTypes), // if check-types is enabled, it must spawn the tsserver.
-      checkTypes: getCheckTypesEnum(),
-    };
-    await this.watcher.watch(watchOpts);
-    return 'watcher terminated';
-  }
-}
-
-function getMessages(logger: Logger): EventMessages {
-  return {
-    onAll: (event: string, path: string) => logger.console(`Event: "${event}". Path: ${path}`),
-    onStart: () => {},
-    onReady: (workspace, watchPathsSortByComponent, verbose?: boolean) => {
-      clearOutdatedData();
-      if (verbose) {
-        logger.console(formatWatchPathsSortByComponent(watchPathsSortByComponent));
-      }
-      logger.console(
-        chalk.yellow(
-          `Watching for component changes in workspace ${workspace.config.name} (${moment().format('HH:mm:ss')})...\n`
-        )
-      );
-    },
-    onChange: (...args) => {
-      printOnFileEvent(logger, 'changed', ...args);
-    },
-    onAdd: (...args) => {
-      printOnFileEvent(logger, 'added', ...args);
-    },
-    onUnlink: (...args) => {
-      printOnFileEvent(logger, 'removed', ...args);
-    },
-    onError: (err) => {
-      logger.console(`Watcher error ${err}`);
-    },
-  };
-}
-
-function printOnFileEvent(
-  logger: Logger,
-  eventMsgPlaceholder: 'changed' | 'added' | 'removed',
-  filePaths: string[],
-  buildResults: OnComponentEventResult[],
-  verbose: boolean,
-  duration: number,
-  failureMsg?: string
-) {
-  const files = filePaths.join(', ');
-  if (!buildResults.length) {
-    if (!failureMsg) {
-      if (verbose) logger.console(`The files ${files} have been ${eventMsgPlaceholder}, but nothing to compile\n\n`);
-      return;
-    }
-    logger.console(`${failureMsg}\n\n`);
-    return;
-  }
-  logger.console(`The file(s) ${files} have been ${eventMsgPlaceholder}.\n\n`);
-  logger.console(formatCompileResults(buildResults, verbose));
-  logger.console(`Finished. (${duration}ms)`);
-  logger.console(chalk.yellow(`Watching for component changes (${moment().format('HH:mm:ss')})...`));
-}
-
-/**
- * with console.clear() all history is deleted from the console. this function preserver the history.
- */
-function clearOutdatedData() {
-  process.stdout.write('\x1Bc');
-}

package/watcher.aspect.ts

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

package/watcher.main.runtime.ts

@@ -1,85 +0,0 @@
-import { CLIAspect, CLIMain, MainRuntime } from '@teambit/cli';
-import { SlotRegistry, Slot } from '@teambit/harmony';
-import GlobalConfigAspect, { GlobalConfigMain } from '@teambit/global-config';
-import ScopeAspect, { ScopeMain } from '@teambit/scope';
-import { ComponentID } from '@teambit/component-id';
-import IpcEventsAspect, { IpcEventsMain } from '@teambit/ipc-events';
-import { Logger, LoggerAspect, LoggerMain } from '@teambit/logger';
-import { PubsubAspect, PubsubMain } from '@teambit/pubsub';
-import WorkspaceAspect, { Workspace } from '@teambit/workspace';
-import pMapSeries from 'p-map-series';
-import { WatchCommand } from './watch.cmd';
-import { Watcher, WatchOptions } from './watcher';
-import { WatcherAspect } from './watcher.aspect';
-
-export type OnPreWatch = (componentIds: ComponentID[], watchOpts: WatchOptions) => Promise<void>;
-export type OnPreWatchSlot = SlotRegistry<OnPreWatch>;
-
-export class WatcherMain {
-  constructor(
-    private workspace: Workspace,
-    private scope: ScopeMain,
-    private pubsub: PubsubMain,
-    private onPreWatchSlot: OnPreWatchSlot,
-    readonly ipcEvents: IpcEventsMain,
-    readonly logger: Logger,
-    readonly globalConfig: GlobalConfigMain
-  ) {}
-
-  async watch(opts: WatchOptions) {
-    const watcher = new Watcher(this.workspace, this.pubsub, this, opts);
-    await watcher.watch();
-  }
-
-  async watchScopeInternalFiles() {
-    await this.scope.watchScopeInternalFiles();
-  }
-
-  async triggerOnPreWatch(componentIds: ComponentID[], watchOpts: WatchOptions) {
-    const preWatchFunctions = this.onPreWatchSlot.values();
-    await pMapSeries(preWatchFunctions, async (func) => {
-      await func(componentIds, watchOpts);
-    });
-  }
-
-  registerOnPreWatch(onPreWatchFunc: OnPreWatch) {
-    this.onPreWatchSlot.register(onPreWatchFunc);
-    return this;
-  }
-
-  static slots = [Slot.withType<OnPreWatch>()];
-  static dependencies = [
-    CLIAspect,
-    WorkspaceAspect,
-    ScopeAspect,
-    PubsubAspect,
-    LoggerAspect,
-    IpcEventsAspect,
-    GlobalConfigAspect,
-  ];
-  static runtime = MainRuntime;
-
-  static async provider(
-    [cli, workspace, scope, pubsub, loggerMain, ipcEvents, globalConfig]: [
-      CLIMain,
-      Workspace,
-      ScopeMain,
-      PubsubMain,
-      LoggerMain,
-      IpcEventsMain,
-      GlobalConfigMain
-    ],
-    _,
-    [onPreWatchSlot]: [OnPreWatchSlot]
-  ) {
-    const logger = loggerMain.createLogger(WatcherAspect.id);
-    const watcherMain = new WatcherMain(workspace, scope, pubsub, onPreWatchSlot, ipcEvents, logger, globalConfig);
-    const watchCmd = new WatchCommand(pubsub, logger, watcherMain);
-    cli.register(watchCmd);
-    return watcherMain;
-  }
-}
-
-WatcherAspect.addRuntime(WatcherMain);
-
-export default WatcherMain;

package/watcher.ts

@@ -1,426 +0,0 @@
-import { PubsubMain } from '@teambit/pubsub';
-import fs from 'fs-extra';
-import { dirname, basename } from 'path';
-import { compact, difference, partition } from 'lodash';
-import { ComponentID } from '@teambit/component-id';
-import loader from '@teambit/legacy/dist/cli/loader';
-import { BIT_MAP, CFG_WATCH_USE_POLLING, WORKSPACE_JSONC } from '@teambit/legacy/dist/constants';
-import { Consumer } from '@teambit/legacy/dist/consumer';
-import logger from '@teambit/legacy/dist/logger/logger';
-import { pathNormalizeToLinux } from '@teambit/legacy/dist/utils';
-import mapSeries from 'p-map-series';
-import chalk from 'chalk';
-import { ChildProcess } from 'child_process';
-import chokidar, { FSWatcher } from '@teambit/chokidar';
-import ComponentMap from '@teambit/legacy/dist/consumer/bit-map/component-map';
-import { PathOsBasedAbsolute } from '@teambit/legacy/dist/utils/path';
-import { CompilationInitiator } from '@teambit/compiler';
-import {
-  WorkspaceAspect,
-  Workspace,
-  OnComponentEventResult,
-  OnComponentChangeEvent,
-  OnComponentAddEvent,
-  OnComponentRemovedEvent,
-} from '@teambit/workspace';
-import { CheckTypes } from './check-types';
-import { WatcherMain } from './watcher.main.runtime';
-import { WatchQueue } from './watch-queue';
-
-export type WatcherProcessData = { watchProcess: ChildProcess; compilerId: ComponentID; componentIds: ComponentID[] };
-
-export type EventMessages = {
-  onAll: Function;
-  onStart: Function;
-  onReady: Function;
-  onChange: OnFileEventFunc;
-  onAdd: OnFileEventFunc;
-  onUnlink: OnFileEventFunc;
-  onError: Function;
-};
-
-export type OnFileEventFunc = (
-  filePaths: string[],
-  buildResults: OnComponentEventResult[],
-  verbose: boolean,
-  duration: number,
-  failureMsg?: string
-) => void;
-
-export type WatchOptions = {
-  msgs?: EventMessages;
-  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
-  compile?: boolean; // whether compile modified/added components during watch process
-};
-
-const DEBOUNCE_WAIT_MS = 100;
-type PathLinux = string; // ts fails when importing it from @teambit/legacy/dist/utils/path.
-
-export class Watcher {
-  private fsWatcher: FSWatcher;
-  private changedFilesPerComponent: { [componentId: string]: string[] } = {};
-  private watchQueue = new WatchQueue();
-  private bitMapChangesInProgress = false;
-  private ipcEventsDir: string;
-  private trackDirs: { [dir: PathLinux]: ComponentID } = {};
-  private verbose = false;
-  private multipleWatchers: WatcherProcessData[] = [];
-  constructor(
-    private workspace: Workspace,
-    private pubsub: PubsubMain,
-    private watcherMain: WatcherMain,
-    private options: WatchOptions
-  ) {
-    this.ipcEventsDir = this.watcherMain.ipcEvents.eventsDir;
-    this.verbose = this.options.verbose || false;
-  }
-
-  get consumer(): Consumer {
-    return this.workspace.consumer;
-  }
-
-  async watch() {
-    const { msgs, ...watchOpts } = this.options;
-    await this.setTrackDirs();
-    const componentIds = Object.values(this.trackDirs);
-    await this.watcherMain.triggerOnPreWatch(componentIds, watchOpts);
-    await this.createWatcher();
-    const watcher = this.fsWatcher;
-    msgs?.onStart(this.workspace);
-
-    await this.workspace.scope.watchScopeInternalFiles();
-
-    return new Promise((resolve, reject) => {
-      if (this.verbose) {
-        // @ts-ignore
-        if (msgs?.onAll) watcher.on('all', msgs?.onAll);
-      }
-      watcher.on('ready', () => {
-        msgs?.onReady(this.workspace, this.trackDirs, this.verbose);
-        // console.log(this.fsWatcher.getWatched());
-        loader.stop();
-      });
-      // eslint-disable-next-line @typescript-eslint/no-misused-promises
-      watcher.on('all', async (event, filePath) => {
-        if (event !== 'change' && event !== 'add' && event !== 'unlink') return;
-        const startTime = new Date().getTime();
-        const { files, results, debounced, irrelevant, failureMsg } = await this.handleChange(filePath);
-        if (debounced || irrelevant) {
-          return;
-        }
-        const duration = new Date().getTime() - startTime;
-        msgs?.onChange(files, results, this.verbose, duration, failureMsg);
-      });
-      watcher.on('error', (err) => {
-        msgs?.onError(err);
-        reject(err);
-      });
-    });
-  }
-
-  /**
-   * *** DEBOUNCING ***
-   * some actions trigger multiple files changes at (almost) the same time. e.g. "git pull".
-   * this causes some performance and instability issues. a debouncing mechanism was implemented to help with this.
-   * the way how it works is that the first file of the same component starts the execution with a delay (e.g. 200ms).
-   * if, in the meanwhile, another file of the same component was changed, it won't start a new execution, instead,
-   * it'll only add the file to `this.changedFilesPerComponent` prop.
-   * once the execution starts, it'll delete this component-id from the `this.changedFilesPerComponent` array,
-   * indicating the next file-change to start a new execution.
-   *
-   * implementation wise, `lodash.debounce` doesn't help here, because:
-   * A) it doesn't return the results, unless "leading" option is true. here, it must be false, otherwise, it'll start
-   * the execution immediately.
-   * B) it debounces the method regardless the param passes to it. so it'll disregard the component-id and will delay
-   * other components undesirably.
-   *
-   * *** QUEUE ***
-   * the debouncing helps to not execute the same component multiple times concurrently. however, multiple components
-   * and .bitmap changes execution can still be processed concurrently.
-   * the following example explains why this is an issue.
-   * compA is changed in the .bitmap file from version 0.0.1 to 0.0.2. its files were changed as well.
-   * all these changes get pulled at the same time by "git pull", as a result, the execution of compA and the .bitmap
-   * happen at the same time.
-   * during the execution of compA, the component id is parsed as compA@0.0.1, later, it asks for the Workspace for this
-   * id. while the workspace is looking for this id, the .bitmap execution reloaded the consumer and changed all versions.
-   * after this change, the workspace doesn't have this id anymore, which will trigger an error.
-   * to ensure this won't happen, we keep a flag to indicate whether the .bitmap execution is running, and if so, all
-   * other executions are paused until the queue is empty (this is done by awaiting for queue.onIdle).
-   * once the queue is empty, we know the .bitmap process was done and the workspace has all new ids.
-   * in the example above, at this stage, the id will be resolved to compA@0.0.2.
-   * one more thing, the queue is configured to have concurrency of 1. to make sure two components are not processed at
-   * the same time. (the same way is done when loading all components from the filesystem/scope).
-   * this way we can also ensure that if compA was started before the .bitmap execution, it will complete before the
-   * .bitmap execution starts.
-   */
-  private async handleChange(filePath: string): Promise<{
-    results: OnComponentEventResult[];
-    files: string[];
-    failureMsg?: string;
-    debounced?: boolean;
-    irrelevant?: boolean; // file/dir is not part of any component
-  }> {
-    try {
-      if (filePath.endsWith(BIT_MAP)) {
-        this.bitMapChangesInProgress = true;
-        const buildResults = await this.watchQueue.add(() => this.handleBitmapChanges());
-        this.bitMapChangesInProgress = false;
-        loader.stop();
-        return { results: buildResults, files: [filePath] };
-      }
-      if (this.bitMapChangesInProgress) {
-        await this.watchQueue.onIdle();
-      }
-      if (dirname(filePath) === this.ipcEventsDir) {
-        const eventName = basename(filePath);
-        if (eventName !== 'onPostInstall') {
-          this.watcherMain.logger.warn(`eventName ${eventName} is not recognized, please handle it`);
-        }
-        await this.watcherMain.ipcEvents.triggerGotEvent(eventName as 'onPostInstall');
-        return { results: [], files: [filePath] };
-      }
-      if (filePath.endsWith(WORKSPACE_JSONC)) {
-        await this.workspace.triggerOnWorkspaceConfigChange();
-        return { results: [], files: [filePath] };
-      }
-      const componentId = this.getComponentIdByPath(filePath);
-      if (!componentId) {
-        loader.stop();
-        return { results: [], files: [], irrelevant: true };
-      }
-      const compIdStr = componentId.toString();
-      if (this.changedFilesPerComponent[compIdStr]) {
-        this.changedFilesPerComponent[compIdStr].push(filePath);
-        loader.stop();
-        return { results: [], files: [], debounced: true };
-      }
-      this.changedFilesPerComponent[compIdStr] = [filePath];
-      await this.sleep(DEBOUNCE_WAIT_MS);
-      const files = this.changedFilesPerComponent[compIdStr];
-      delete this.changedFilesPerComponent[compIdStr];
-
-      const buildResults = await this.watchQueue.add(() => this.triggerCompChanges(componentId, files));
-      const failureMsg = buildResults.length
-        ? undefined
-        : `files ${files.join(', ')} are inside the component ${compIdStr} but configured to be ignored`;
-      loader.stop();
-      return { results: buildResults, files, failureMsg };
-    } catch (err: any) {
-      const msg = `watcher found an error while handling ${filePath}`;
-      logger.error(msg, err);
-      logger.console(`${msg}, ${err.message}`);
-      loader.stop();
-      return { results: [], files: [filePath], failureMsg: err.message };
-    }
-  }
-
-  private async sleep(ms: number) {
-    return new Promise((resolve) => setTimeout(resolve, ms));
-  }
-
-  private async triggerCompChanges(
-    componentId: ComponentID,
-    files: PathOsBasedAbsolute[]
-  ): Promise<OnComponentEventResult[]> {
-    let updatedComponentId: ComponentID | undefined = componentId;
-    if (!(await this.workspace.hasId(componentId))) {
-      // bitmap has changed meanwhile, which triggered `handleBitmapChanges`, which re-loaded consumer and updated versions
-      // so the original componentId might not be in the workspace now, and we need to find the updated one
-      const ids = await this.workspace.listIds();
-      updatedComponentId = ids.find((id) => id.isEqual(componentId, { ignoreVersion: true }));
-      if (!updatedComponentId) {
-        logger.debug(`triggerCompChanges, the component ${componentId.toString()} was probably removed from .bitmap`);
-        return [];
-      }
-    }
-    this.workspace.clearComponentCache(updatedComponentId);
-    const component = await this.workspace.get(updatedComponentId);
-    const componentMap: ComponentMap = component.state._consumer.componentMap;
-    if (!componentMap) {
-      throw new Error(
-        `unable to find componentMap for ${updatedComponentId.toString()}, make sure this component is in .bitmap`
-      );
-    }
-    const compFilesRelativeToWorkspace = componentMap.getFilesRelativeToConsumer();
-    const [compFiles, nonCompFiles] = partition(files, (filePath) => {
-      const relativeFile = this.getRelativePathLinux(filePath);
-      return Boolean(compFilesRelativeToWorkspace.find((p) => p === relativeFile));
-    });
-    // nonCompFiles are either, files that were removed from the filesystem or existing files that are ignored.
-    // the compiler takes care of removedFiles differently, e.g. removes dists dir and old symlinks.
-    const removedFiles = compact(
-      await Promise.all(nonCompFiles.map(async (filePath) => ((await fs.pathExists(filePath)) ? null : filePath)))
-    );
-
-    if (!compFiles.length && !removedFiles.length) {
-      logger.debug(
-        `the following files are part of the component ${componentId.toStringWithoutVersion()} but configured to be ignored:\n${files.join(
-          '\n'
-        )}'`
-      );
-      return [];
-    }
-    this.consumer.bitMap.updateComponentPaths(
-      componentId,
-      compFiles.map((f) => this.consumer.getPathRelativeToConsumer(f)),
-      removedFiles.map((f) => this.consumer.getPathRelativeToConsumer(f))
-    );
-    const buildResults = await this.executeWatchOperationsOnComponent(
-      updatedComponentId,
-      compFiles,
-      removedFiles,
-      true
-    );
-    return buildResults;
-  }
-
-  /**
-   * if .bitmap changed, it's possible that a new component has been added. trigger onComponentAdd.
-   */
-  private async handleBitmapChanges(): Promise<OnComponentEventResult[]> {
-    const previewsTrackDirs = { ...this.trackDirs };
-    await this.workspace._reloadConsumer();
-    await this.setTrackDirs();
-    await this.workspace.triggerOnBitmapChange();
-    const newDirs: string[] = difference(Object.keys(this.trackDirs), Object.keys(previewsTrackDirs));
-    const removedDirs: string[] = difference(Object.keys(previewsTrackDirs), Object.keys(this.trackDirs));
-    const results: OnComponentEventResult[] = [];
-    if (newDirs.length) {
-      const addResults = await mapSeries(newDirs, async (dir) =>
-        this.executeWatchOperationsOnComponent(this.trackDirs[dir], [], [], false)
-      );
-      results.push(...addResults.flat());
-    }
-    if (removedDirs.length) {
-      await mapSeries(removedDirs, (dir) => this.executeWatchOperationsOnRemove(previewsTrackDirs[dir]));
-    }
-
-    return results;
-  }
-
-  private async executeWatchOperationsOnRemove(componentId: ComponentID) {
-    logger.debug(`running OnComponentRemove hook for ${chalk.bold(componentId.toString())}`);
-    this.pubsub.pub(WorkspaceAspect.id, this.createOnComponentRemovedEvent(componentId.toString()));
-    await this.workspace.triggerOnComponentRemove(componentId);
-  }
-
-  private async executeWatchOperationsOnComponent(
-    componentId: ComponentID,
-    files: PathOsBasedAbsolute[],
-    removedFiles: PathOsBasedAbsolute[] = [],
-    isChange = true
-  ): Promise<OnComponentEventResult[]> {
-    if (this.isComponentWatchedExternally(componentId)) {
-      // update capsule, once done, it automatically triggers the external watcher
-      await this.workspace.get(componentId);
-      return [];
-    }
-    const idStr = componentId.toString();
-
-    if (isChange) {
-      logger.debug(`running OnComponentChange hook for ${chalk.bold(idStr)}`);
-      this.pubsub.pub(WorkspaceAspect.id, this.createOnComponentChangeEvent(idStr, 'OnComponentChange'));
-    } else {
-      logger.debug(`running OnComponentAdd hook for ${chalk.bold(idStr)}`);
-      this.pubsub.pub(WorkspaceAspect.id, this.createOnComponentAddEvent(idStr, 'OnComponentAdd'));
-    }
-
-    const buildResults = isChange
-      ? await this.workspace.triggerOnComponentChange(componentId, files, removedFiles, this.options)
-      : await this.workspace.triggerOnComponentAdd(componentId, this.options);
-
-    return buildResults;
-  }
-
-  private createOnComponentRemovedEvent(idStr) {
-    return new OnComponentRemovedEvent(Date.now(), idStr);
-  }
-
-  private createOnComponentChangeEvent(idStr, hook) {
-    return new OnComponentChangeEvent(Date.now(), idStr, hook);
-  }
-
-  private createOnComponentAddEvent(idStr, hook) {
-    return new OnComponentAddEvent(Date.now(), idStr, hook);
-  }
-
-  private isComponentWatchedExternally(componentId: ComponentID) {
-    const watcherData = this.multipleWatchers.find((m) => m.componentIds.find((id) => id.isEqual(componentId)));
-    if (watcherData) {
-      logger.debug(`${componentId.toString()} is watched by ${watcherData.compilerId.toString()}`);
-      return true;
-    }
-    return false;
-  }
-
-  private getComponentIdByPath(filePath: string): ComponentID | null {
-    const relativeFile = this.getRelativePathLinux(filePath);
-    const trackDir = this.findTrackDirByFilePathRecursively(relativeFile);
-    if (!trackDir) {
-      // the file is not part of any component. If it was a new component, or a new file of
-      // existing component, then, handleBitmapChanges() should deal with it.
-      return null;
-    }
-    return this.trackDirs[trackDir];
-  }
-
-  private getRelativePathLinux(filePath: string) {
-    return pathNormalizeToLinux(this.consumer.getPathRelativeToConsumer(filePath));
-  }
-
-  private findTrackDirByFilePathRecursively(filePath: string): string | null {
-    if (this.trackDirs[filePath]) return filePath;
-    const parentDir = dirname(filePath);
-    if (parentDir === filePath) return null;
-    return this.findTrackDirByFilePathRecursively(parentDir);
-  }
-
-  private async createWatcher() {
-    const usePollingConf = await this.watcherMain.globalConfig.get(CFG_WATCH_USE_POLLING);
-    const usePolling = usePollingConf === 'true';
-    // const useFsEventsConf = await this.watcherMain.globalConfig.get(CFG_WATCH_USE_FS_EVENTS);
-    // const useFsEvents = useFsEventsConf === 'true';
-    const ignoreLocalScope = (pathToCheck: string) => {
-      if (pathToCheck.startsWith(this.ipcEventsDir)) return false;
-      return (
-        pathToCheck.startsWith(`${this.workspace.path}/.git/`) || pathToCheck.startsWith(`${this.workspace.path}/.bit/`)
-      );
-    };
-    this.fsWatcher = chokidar.watch(this.workspace.path, {
-      ignoreInitial: true,
-      // `chokidar` matchers have Bash-parity, so Windows-style backslashes are not supported as separators.
-      // (windows-style backslashes are converted to forward slashes)
-      ignored: ['**/node_modules/**', '**/package.json', ignoreLocalScope],
-      /**
-       * default to false, although it causes high CPU usage.
-       * see: https://github.com/paulmillr/chokidar/issues/1196#issuecomment-1711033539
-       * there is a fix for this in master. once a new version of Chokidar is released, we can upgrade it and then
-       * default to true.
-       */
-      usePolling,
-      // useFsEvents,
-      persistent: true,
-    });
-    if (this.verbose) {
-      logger.console(`chokidar.options ${JSON.stringify(this.fsWatcher.options, undefined, 2)}`);
-    }
-  }
-
-  private async setTrackDirs() {
-    this.trackDirs = {};
-    const componentsFromBitMap = this.consumer.bitMap.getAllComponents();
-    await Promise.all(
-      componentsFromBitMap.map(async (componentMap) => {
-        const bitId = componentMap.id;
-        const rootDir = componentMap.getRootDir();
-        if (!rootDir) throw new Error(`${bitId.toString()} has no rootDir, which is invalid in Harmony`);
-        const componentId = await this.workspace.resolveComponentId(bitId);
-        this.trackDirs[rootDir] = componentId;
-      })
-    );
-  }
-}