@teambit/doctor 0.0.1

package/core-diagnoses/broken-symlink-files.ts

@@ -0,0 +1,78 @@
+import fs from 'fs-extra';
+import glob from 'glob';
+import path from 'path';
+import { loadConsumer } from '@teambit/legacy/dist/consumer';
+import { Scope } from '@teambit/legacy/dist/scope';
+import Diagnosis, { ExamineBareResult } from '../diagnosis';
+import { uniq } from 'lodash';
+
+type BrokenSymlink = { symlinkPath: string; brokenPath: string; pathToDelete: string };
+export const DIAGNOSIS_NAME = 'check environment symlinks';
+
+export default class BrokenSymlinkFiles extends Diagnosis {
+  name = DIAGNOSIS_NAME;
+  description = 'validate generated symlinks for workspace environments';
+  category = 'local environments';
+
+  _formatSymptoms(bareResult: ExamineBareResult): string {
+    if (!bareResult.data) throw new Error('BrokenSymlinkFiles, bareResult.data is missing');
+    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+    const toString = bareResult.data.brokenSymlinks
+      .map(
+        (brokenSymlink) => `symlink path: "${brokenSymlink.symlinkPath}", broken link: "${brokenSymlink.brokenPath}"`
+      )
+      .join('\n');
+    return `the following symlinks points to non-existing paths\n${toString}`;
+  }
+
+  _formatManualTreat(bareResult: ExamineBareResult) {
+    if (!bareResult.data) throw new Error('BrokenSymlinkFiles, bareResult.data is missing');
+    const toString = uniq(bareResult.data.brokenSymlinks.map((b) => b.pathToDelete)).join('\n');
+    return `please delete the following paths:\n${toString}`;
+  }
+
+  async _runExamine(): Promise<ExamineBareResult> {
+    const consumer = await loadConsumer();
+    const envComponentsDir = path.join(consumer.scope.getPath(), Scope.getComponentsRelativePath());
+    const potentialSymlinks = glob.sync('**/node_modules/@bit/**', { cwd: envComponentsDir });
+    const potentialSymlinksAbs = potentialSymlinks.map((p) => path.join(envComponentsDir, p));
+    const brokenSymlinks: BrokenSymlink[] = [];
+    const results = potentialSymlinksAbs.map(async (potentialSymlink) => {
+      const link = await this._getLinkIfExist(potentialSymlink);
+      if (!link) return;
+      const exists = await fs.pathExists(link);
+      if (exists) return;
+      const brokenSymlink = {
+        symlinkPath: potentialSymlink,
+        brokenPath: link,
+        pathToDelete: this._getPathToDelete(potentialSymlink),
+      };
+      brokenSymlinks.push(brokenSymlink);
+    });
+    await Promise.all(results);
+    return {
+      valid: brokenSymlinks.length === 0,
+      data: {
+        brokenSymlinks,
+      },
+    };
+  }
+
+  async _getLinkIfExist(symlinkPath: string): Promise<string | null | undefined> {
+    try {
+      const link = await fs.readlink(symlinkPath);
+      return link;
+    } catch (err: any) {
+      // probably not a symlink
+      return null;
+    }
+  }
+
+  /**
+   * deleting the environment directory causes Bit to reinstall it next time
+   */
+  _getPathToDelete(symlinkPath: string): string {
+    const envDirectory = symlinkPath.split(path.join('node_modules', '@bit'))[0];
+    return envDirectory.slice(0, -1); // remove the last slash
+  }
+}

package/core-diagnoses/orphan-symlink-objects.ts

@@ -0,0 +1,51 @@
+import { ComponentIdList } from '@teambit/component-id';
+import { loadConsumer } from '@teambit/legacy/dist/consumer';
+import { ModelComponent, Symlink } from '@teambit/legacy/dist/scope/models';
+import Diagnosis, { ExamineBareResult } from '../diagnosis';
+
+export const DIAGNOSIS_NAME = 'check orphan refs';
+export default class OrphanSymlinkObjects extends Diagnosis {
+  name = DIAGNOSIS_NAME;
+  description = 'checks for empty internal refs in local workspace';
+  category = 'internal store';
+
+  _formatSymptoms(bareResult: ExamineBareResult): string {
+    if (!bareResult.data) throw new Error('OrphanSymlinkObjects, bareResult.data is missing');
+    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+    return `the following refs points to non-existing components "${bareResult.data.orphanSymlinks.toString()}"`;
+  }
+
+  _formatManualTreat(bareResult: ExamineBareResult) {
+    if (!bareResult.data) throw new Error('OrphanSymlinkObjects, bareResult.data is missing');
+    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+    return `please delete the following paths:\n${bareResult.data.objectsToDelete.join('\n')}`;
+  }
+
+  async _runExamine(): Promise<ExamineBareResult> {
+    const consumer = await loadConsumer();
+    const symlinks = await consumer.scope.objects.list([Symlink]);
+    const orphanSymlinks = new ComponentIdList();
+    const objectsToDelete = [];
+    await Promise.all(
+      symlinks.map(async (symlink) => {
+        // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+        const realComponentId: ComponentID = symlink.getRealComponentId();
+        const realModelComponent = ModelComponent.fromBitId(realComponentId);
+        const foundComponent = await consumer.scope.objects.load(realModelComponent.hash());
+        if (!foundComponent) {
+          orphanSymlinks.push(realComponentId);
+          // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+          objectsToDelete.push(consumer.scope.objects.objectPath(symlink.hash()));
+        }
+      })
+    );
+
+    return {
+      valid: orphanSymlinks.length === 0,
+      data: {
+        orphanSymlinks,
+        objectsToDelete,
+      },
+    };
+  }
+}

package/core-diagnoses/validate-bit-version.ts

@@ -0,0 +1,56 @@
+import semver from 'semver';
+import { listRemote } from '@teambit/bvm.list';
+import { getHarmonyVersion } from '@teambit/legacy/dist/bootstrap';
+import Diagnosis, { ExamineBareResult } from '../diagnosis';
+
+export default class ValidateBitVersion extends Diagnosis {
+  name = 'validate bit version';
+  description = 'validate that bit version is up to date';
+  category = 'core';
+
+  _formatSymptoms(bareResult: ExamineBareResult): string {
+    if (!bareResult.data) throw new Error('ValidateBitVersion, bareResult.data is missing');
+    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+    if (!bareResult.data.latestVersion) {
+      return 'could not fetch bit latest version';
+    }
+    return `bit is not up to date.
+  your version: ${bareResult.data.currentVersion}
+  latest version: ${bareResult.data.latestVersion}`;
+  }
+
+  _formatManualTreat(bareResult: ExamineBareResult) {
+    if (!bareResult.data) throw new Error('ValidateBitVersion, bareResult.data is missing');
+    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+    if (!bareResult.data.latestVersion) {
+      return 'please make sure you have an internet connection';
+    }
+    return 'please upgrade your bit version (bvm upgrade)';
+  }
+
+  async _runExamine(): Promise<ExamineBareResult> {
+    const bitRemoteVersionOnBvm = await listRemote({ limit: 1 });
+    const bitLatestVersion = bitRemoteVersionOnBvm.entries[0].version;
+    const bitCurrentVersion = getHarmonyVersion(true);
+    if (bitLatestVersion) {
+      if (semver.lt(bitCurrentVersion, bitLatestVersion)) {
+        return {
+          valid: false,
+          data: {
+            latestVersion: bitLatestVersion,
+            currentVersion: bitCurrentVersion,
+          },
+        };
+      }
+      return {
+        valid: true,
+      };
+    }
+    return {
+      valid: false,
+      data: {
+        latestVersion: null,
+      },
+    };
+  }
+}

package/core-diagnoses/validate-git-exec.ts

@@ -0,0 +1,38 @@
+import execa from 'execa';
+import getGitExecutablePath from '@teambit/legacy/dist/utils/git/git-executable';
+import Diagnosis, { ExamineBareResult } from '../diagnosis';
+
+export const DIAGNOSIS_NAME_VALIDATE_GIT_EXEC = 'validate git exec';
+export default class ValidateGitExec extends Diagnosis {
+  name = DIAGNOSIS_NAME_VALIDATE_GIT_EXEC;
+  description = 'validate that git executable found';
+  category = 'vendors';
+
+  _formatSymptoms(bareResult: ExamineBareResult): string {
+    const gitExecutablePath = bareResult?.data?.gitExecutablePath;
+    return `git executable not found (path '${gitExecutablePath}')`;
+  }
+
+  _formatManualTreat() {
+    return "please ensure that git is installed and/or git_path is configured correctly - 'bit config set git_path <GIT_PATH>'";
+  }
+
+  async _runExamine(): Promise<ExamineBareResult> {
+    const gitExecutablePath = getGitExecutablePath();
+    try {
+      await execa(gitExecutablePath, ['--version']);
+      return {
+        valid: true,
+      };
+    } catch (err: any) {
+      // if (err.code === 'ENOENT') {
+      // }
+      return {
+        valid: false,
+        data: {
+          gitExecutablePath,
+        },
+      };
+    }
+  }
+}

package/core-diagnoses/validate-npm-exec.ts

@@ -0,0 +1,40 @@
+import execa from 'execa';
+import logger from '@teambit/legacy/dist/logger/logger';
+import Diagnosis, { ExamineBareResult } from '../diagnosis';
+
+export default class ValidateNpmExec extends Diagnosis {
+  name = 'validate npm exec';
+  description = 'validate that npm executable found';
+  category = 'vendors';
+
+  _formatSymptoms(): string {
+    return 'npm executable not found';
+  }
+
+  _formatManualTreat() {
+    return 'please ensure npm is installed';
+  }
+
+  async _runExamine(): Promise<ExamineBareResult> {
+    const npmVersion = await getNpmVersion();
+    if (npmVersion) {
+      return {
+        valid: true,
+      };
+    }
+    return {
+      valid: false,
+      data: {},
+    };
+  }
+}
+
+export async function getNpmVersion(): Promise<string | null | undefined> {
+  try {
+    const { stdout, stderr } = await execa('npm', ['--version']);
+    if (stdout && !stderr) return stdout;
+  } catch (err: any) {
+    logger.debugAndAddBreadCrumb('npm-client', `got an error when executing "npm --version". ${err.message}`);
+  }
+  return null;
+}

package/core-diagnoses/validate-workspace-bit-json-syntax.ts

@@ -0,0 +1,35 @@
+import { loadConsumer } from '@teambit/legacy/dist/consumer';
+import WorkspaceConfig from '@teambit/legacy/dist/consumer/config/workspace-config';
+import Diagnosis, { ExamineBareResult } from '../diagnosis';
+
+export default class ValidateWorkspaceBitJsonSyntax extends Diagnosis {
+  name = "validate workspace's bit config";
+  description = 'validate workspace configuration object';
+  category = 'configuration';
+
+  _formatSymptoms(bareResult: ExamineBareResult): string {
+    const bitJsonPath = bareResult?.data?.bitJsonPath;
+    return `invalid workspace.jsonc: ${bitJsonPath} is not a valid JSON file.`;
+  }
+
+  _formatManualTreat() {
+    return 'manually fix the workspace.jsonc or consider running bit init --reset to recreate the file';
+  }
+
+  // TODO: support configuration from package.json
+  async _runExamine(): Promise<ExamineBareResult> {
+    const consumer = await loadConsumer();
+    const consumerPath = consumer.getPath();
+    try {
+      await WorkspaceConfig.loadIfExist(consumerPath, consumer.scope.path);
+      return {
+        valid: true,
+      };
+    } catch (e: any) {
+      return {
+        valid: false,
+        data: {},
+      };
+    }
+  }
+}

package/core-diagnoses/validate-yarn-exec.ts

@@ -0,0 +1,40 @@
+import execa from 'execa';
+import logger from '@teambit/legacy/dist/logger/logger';
+import Diagnosis, { ExamineBareResult } from '../diagnosis';
+
+export default class ValidateYarnExec extends Diagnosis {
+  name = 'validate yarn exec';
+  description = 'validate that yarn executable found';
+  category = 'vendors';
+
+  _formatSymptoms(): string {
+    return 'yarn executable not found';
+  }
+
+  _formatManualTreat() {
+    return 'please ensure yarn is installed';
+  }
+
+  async _runExamine(): Promise<ExamineBareResult> {
+    const yarnVersion = await getYarnVersion();
+    if (yarnVersion) {
+      return {
+        valid: true,
+      };
+    }
+    return {
+      valid: false,
+      data: {},
+    };
+  }
+}
+
+export async function getYarnVersion(): Promise<string | null | undefined> {
+  try {
+    const { stdout } = await execa('yarn', ['-v']);
+    return stdout;
+  } catch (e: any) {
+    logger.debugAndAddBreadCrumb('npm-client', `can't find yarn version by running yarn -v. ${e.message}`);
+  }
+  return null;
+}

package/diagnosis-list-template.ts

@@ -0,0 +1,28 @@
+import chalk from 'chalk';
+import { table } from 'table';
+
+import Diagnosis from './diagnosis';
+
+// const NAME_COLUMN_WIDTH = 100;
+// const DESCRIPTION_COLUMN_WIDTH = 30;
+
+const tableColumnConfig = {
+  columnDefault: {
+    alignment: 'left',
+  },
+};
+
+type DiagnosisRow = [string, string, string];
+
+function createRow(diagnosis: Diagnosis): DiagnosisRow {
+  return [diagnosis.category, diagnosis.name, diagnosis.description];
+}
+
+export default function formatDiagnosesList(diagnosesList: Diagnosis[]): string {
+  const header = [chalk.bold('category'), chalk.bold('name'), chalk.bold('description')];
+  const rows = diagnosesList.map(createRow);
+  // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  rows.unshift(header);
+  const output = table(rows, tableColumnConfig);
+  return output;
+}

package/diagnosis.ts

@@ -0,0 +1,81 @@
+export type ExamineBareResult = {
+  valid: boolean;
+  data?: Record<string, any>;
+};
+
+export type DiagnosisMetaData = {
+  name: string;
+  description: string;
+  category: string;
+};
+
+export type ExamineResult = {
+  diagnosisMetaData: DiagnosisMetaData;
+  bareResult: ExamineBareResult;
+  formattedSymptoms: string; // A human readable of the found issues
+  formattedManualTreat: string; // human readable steps to fix
+};
+
+export default class Diagnosis {
+  // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  name: string;
+  // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  description: string;
+  // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  category: string;
+  // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  result: Record<string, any>;
+
+  /**
+   * A function that actually runs the examination
+   */
+  async _runExamine(): Promise<ExamineBareResult> {
+    throw new Error('You must implement this method');
+  }
+
+  /**
+   * Returns a descriptive symptoms message which might include specific data from the examination
+   * @param bareResult ExamineBareResult
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _formatSymptoms(bareResult: ExamineBareResult): string {
+    throw new Error('You must implement this method');
+  }
+
+  /**
+   * Returns a descriptive instruction to handle the issue (might include specific data from the examination)
+   * @param bareResult ExamineBareResult
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _formatManualTreat(bareResult: ExamineBareResult): string {
+    throw new Error('You must implement this method');
+  }
+
+  getMeta() {
+    return {
+      category: this.category,
+      name: this.name,
+      description: this.description,
+    };
+  }
+
+  async examine(): Promise<ExamineResult> {
+    const bareResult = await this._runExamine();
+    if (bareResult.valid) {
+      return {
+        diagnosisMetaData: this.getMeta(),
+        bareResult,
+        formattedSymptoms: '',
+        formattedManualTreat: '',
+      };
+    }
+    const formattedSymptoms = this._formatSymptoms(bareResult);
+    const formattedManualTreat = this._formatManualTreat(bareResult);
+    return {
+      diagnosisMetaData: this.getMeta(),
+      bareResult,
+      formattedSymptoms,
+      formattedManualTreat,
+    };
+  }
+}

package/dist/core-diagnoses/broken-symlink-files.d.ts

@@ -0,0 +1,15 @@
+import Diagnosis, { ExamineBareResult } from '../diagnosis';
+export declare const DIAGNOSIS_NAME = "check environment symlinks";
+export default class BrokenSymlinkFiles extends Diagnosis {
+    name: string;
+    description: string;
+    category: string;
+    _formatSymptoms(bareResult: ExamineBareResult): string;
+    _formatManualTreat(bareResult: ExamineBareResult): string;
+    _runExamine(): Promise<ExamineBareResult>;
+    _getLinkIfExist(symlinkPath: string): Promise<string | null | undefined>;
+    /**
+     * deleting the environment directory causes Bit to reinstall it next time
+     */
+    _getPathToDelete(symlinkPath: string): string;
+}

package/dist/core-diagnoses/broken-symlink-files.js

@@ -0,0 +1,127 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.DIAGNOSIS_NAME = void 0;
+function _fsExtra() {
+  const data = _interopRequireDefault(require("fs-extra"));
+  _fsExtra = function () {
+    return data;
+  };
+  return data;
+}
+function _glob() {
+  const data = _interopRequireDefault(require("glob"));
+  _glob = function () {
+    return data;
+  };
+  return data;
+}
+function _path() {
+  const data = _interopRequireDefault(require("path"));
+  _path = function () {
+    return data;
+  };
+  return data;
+}
+function _consumer() {
+  const data = require("@teambit/legacy/dist/consumer");
+  _consumer = function () {
+    return data;
+  };
+  return data;
+}
+function _scope() {
+  const data = require("@teambit/legacy/dist/scope");
+  _scope = function () {
+    return data;
+  };
+  return data;
+}
+function _diagnosis() {
+  const data = _interopRequireDefault(require("../diagnosis"));
+  _diagnosis = function () {
+    return data;
+  };
+  return data;
+}
+function _lodash() {
+  const data = require("lodash");
+  _lodash = function () {
+    return data;
+  };
+  return data;
+}
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+const DIAGNOSIS_NAME = exports.DIAGNOSIS_NAME = 'check environment symlinks';
+class BrokenSymlinkFiles extends _diagnosis().default {
+  constructor(...args) {
+    super(...args);
+    _defineProperty(this, "name", DIAGNOSIS_NAME);
+    _defineProperty(this, "description", 'validate generated symlinks for workspace environments');
+    _defineProperty(this, "category", 'local environments');
+  }
+  _formatSymptoms(bareResult) {
+    if (!bareResult.data) throw new Error('BrokenSymlinkFiles, bareResult.data is missing');
+    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+    const toString = bareResult.data.brokenSymlinks.map(brokenSymlink => `symlink path: "${brokenSymlink.symlinkPath}", broken link: "${brokenSymlink.brokenPath}"`).join('\n');
+    return `the following symlinks points to non-existing paths\n${toString}`;
+  }
+  _formatManualTreat(bareResult) {
+    if (!bareResult.data) throw new Error('BrokenSymlinkFiles, bareResult.data is missing');
+    const toString = (0, _lodash().uniq)(bareResult.data.brokenSymlinks.map(b => b.pathToDelete)).join('\n');
+    return `please delete the following paths:\n${toString}`;
+  }
+  async _runExamine() {
+    const consumer = await (0, _consumer().loadConsumer)();
+    const envComponentsDir = _path().default.join(consumer.scope.getPath(), _scope().Scope.getComponentsRelativePath());
+    const potentialSymlinks = _glob().default.sync('**/node_modules/@bit/**', {
+      cwd: envComponentsDir
+    });
+    const potentialSymlinksAbs = potentialSymlinks.map(p => _path().default.join(envComponentsDir, p));
+    const brokenSymlinks = [];
+    const results = potentialSymlinksAbs.map(async potentialSymlink => {
+      const link = await this._getLinkIfExist(potentialSymlink);
+      if (!link) return;
+      const exists = await _fsExtra().default.pathExists(link);
+      if (exists) return;
+      const brokenSymlink = {
+        symlinkPath: potentialSymlink,
+        brokenPath: link,
+        pathToDelete: this._getPathToDelete(potentialSymlink)
+      };
+      brokenSymlinks.push(brokenSymlink);
+    });
+    await Promise.all(results);
+    return {
+      valid: brokenSymlinks.length === 0,
+      data: {
+        brokenSymlinks
+      }
+    };
+  }
+  async _getLinkIfExist(symlinkPath) {
+    try {
+      const link = await _fsExtra().default.readlink(symlinkPath);
+      return link;
+    } catch (err) {
+      // probably not a symlink
+      return null;
+    }
+  }
+
+  /**
+   * deleting the environment directory causes Bit to reinstall it next time
+   */
+  _getPathToDelete(symlinkPath) {
+    const envDirectory = symlinkPath.split(_path().default.join('node_modules', '@bit'))[0];
+    return envDirectory.slice(0, -1); // remove the last slash
+  }
+}
+exports.default = BrokenSymlinkFiles;
+
+//# sourceMappingURL=broken-symlink-files.js.map

package/dist/core-diagnoses/broken-symlink-files.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_fsExtra","data","_interopRequireDefault","require","_glob","_path","_consumer","_scope","_diagnosis","_lodash","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","DIAGNOSIS_NAME","exports","BrokenSymlinkFiles","Diagnosis","constructor","args","_formatSymptoms","bareResult","Error","toString","brokenSymlinks","map","brokenSymlink","symlinkPath","brokenPath","join","_formatManualTreat","uniq","b","pathToDelete","_runExamine","consumer","loadConsumer","envComponentsDir","path","scope","getPath","Scope","getComponentsRelativePath","potentialSymlinks","glob","sync","cwd","potentialSymlinksAbs","p","results","potentialSymlink","link","_getLinkIfExist","exists","fs","pathExists","_getPathToDelete","push","Promise","all","valid","length","readlink","err","envDirectory","split","slice"],"sources":["broken-symlink-files.ts"],"sourcesContent":["import fs from 'fs-extra';\nimport glob from 'glob';\nimport path from 'path';\nimport { loadConsumer } from '@teambit/legacy/dist/consumer';\nimport { Scope } from '@teambit/legacy/dist/scope';\nimport Diagnosis, { ExamineBareResult } from '../diagnosis';\nimport { uniq } from 'lodash';\n\ntype BrokenSymlink = { symlinkPath: string; brokenPath: string; pathToDelete: string };\nexport const DIAGNOSIS_NAME = 'check environment symlinks';\n\nexport default class BrokenSymlinkFiles extends Diagnosis {\n  name = DIAGNOSIS_NAME;\n  description = 'validate generated symlinks for workspace environments';\n  category = 'local environments';\n\n  _formatSymptoms(bareResult: ExamineBareResult): string {\n    if (!bareResult.data) throw new Error('BrokenSymlinkFiles, bareResult.data is missing');\n    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!\n    const toString = bareResult.data.brokenSymlinks\n      .map(\n        (brokenSymlink) => `symlink path: \"${brokenSymlink.symlinkPath}\", broken link: \"${brokenSymlink.brokenPath}\"`\n      )\n      .join('\\n');\n    return `the following symlinks points to non-existing paths\\n${toString}`;\n  }\n\n  _formatManualTreat(bareResult: ExamineBareResult) {\n    if (!bareResult.data) throw new Error('BrokenSymlinkFiles, bareResult.data is missing');\n    const toString = uniq(bareResult.data.brokenSymlinks.map((b) => b.pathToDelete)).join('\\n');\n    return `please delete the following paths:\\n${toString}`;\n  }\n\n  async _runExamine(): Promise<ExamineBareResult> {\n    const consumer = await loadConsumer();\n    const envComponentsDir = path.join(consumer.scope.getPath(), Scope.getComponentsRelativePath());\n    const potentialSymlinks = glob.sync('**/node_modules/@bit/**', { cwd: envComponentsDir });\n    const potentialSymlinksAbs = potentialSymlinks.map((p) => path.join(envComponentsDir, p));\n    const brokenSymlinks: BrokenSymlink[] = [];\n    const results = potentialSymlinksAbs.map(async (potentialSymlink) => {\n      const link = await this._getLinkIfExist(potentialSymlink);\n      if (!link) return;\n      const exists = await fs.pathExists(link);\n      if (exists) return;\n      const brokenSymlink = {\n        symlinkPath: potentialSymlink,\n        brokenPath: link,\n        pathToDelete: this._getPathToDelete(potentialSymlink),\n      };\n      brokenSymlinks.push(brokenSymlink);\n    });\n    await Promise.all(results);\n    return {\n      valid: brokenSymlinks.length === 0,\n      data: {\n        brokenSymlinks,\n      },\n    };\n  }\n\n  async _getLinkIfExist(symlinkPath: string): Promise<string | null | undefined> {\n    try {\n      const link = await fs.readlink(symlinkPath);\n      return link;\n    } catch (err: any) {\n      // probably not a symlink\n      return null;\n    }\n  }\n\n  /**\n   * deleting the environment directory causes Bit to reinstall it next time\n   */\n  _getPathToDelete(symlinkPath: string): string {\n    const envDirectory = symlinkPath.split(path.join('node_modules', '@bit'))[0];\n    return envDirectory.slice(0, -1); // remove the last slash\n  }\n}\n"],"mappings":";;;;;;AAAA,SAAAA,SAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,QAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,MAAA;EAAA,MAAAH,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAC,KAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,MAAA;EAAA,MAAAJ,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAE,KAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,UAAA;EAAA,MAAAL,IAAA,GAAAE,OAAA;EAAAG,SAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAM,OAAA;EAAA,MAAAN,IAAA,GAAAE,OAAA;EAAAI,MAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAO,WAAA;EAAA,MAAAP,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAK,UAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,QAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,OAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA8B,SAAAC,uBAAAQ,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAG,gBAAAH,CAAA,EAAAI,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAJ,CAAA,GAAAO,MAAA,CAAAC,cAAA,CAAAR,CAAA,EAAAI,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAZ,CAAA,CAAAI,CAAA,IAAAC,CAAA,EAAAL,CAAA;AAAA,SAAAM,eAAAD,CAAA,QAAAQ,CAAA,GAAAC,YAAA,CAAAT,CAAA,uCAAAQ,CAAA,GAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAT,CAAA,EAAAD,CAAA,2BAAAC,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAL,CAAA,GAAAK,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAhB,CAAA,QAAAa,CAAA,GAAAb,CAAA,CAAAiB,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA;AAGvB,MAAMgB,cAAc,GAAAC,OAAA,CAAAD,cAAA,GAAG,4BAA4B;AAE3C,MAAME,kBAAkB,SAASC,oBAAS,CAAC;EAAAC,YAAA,GAAAC,IAAA;IAAA,SAAAA,IAAA;IAAAvB,eAAA,eACjDkB,cAAc;IAAAlB,eAAA,sBACP,wDAAwD;IAAAA,eAAA,mBAC3D,oBAAoB;EAAA;EAE/BwB,eAAeA,CAACC,UAA6B,EAAU;IACrD,IAAI,CAACA,UAAU,CAACrC,IAAI,EAAE,MAAM,IAAIsC,KAAK,CAAC,gDAAgD,CAAC;IACvF;IACA,MAAMC,QAAQ,GAAGF,UAAU,CAACrC,IAAI,CAACwC,cAAc,CAC5CC,GAAG,CACDC,aAAa,IAAK,kBAAkBA,aAAa,CAACC,WAAW,oBAAoBD,aAAa,CAACE,UAAU,GAC5G,CAAC,CACAC,IAAI,CAAC,IAAI,CAAC;IACb,OAAO,wDAAwDN,QAAQ,EAAE;EAC3E;EAEAO,kBAAkBA,CAACT,UAA6B,EAAE;IAChD,IAAI,CAACA,UAAU,CAACrC,IAAI,EAAE,MAAM,IAAIsC,KAAK,CAAC,gDAAgD,CAAC;IACvF,MAAMC,QAAQ,GAAG,IAAAQ,cAAI,EAACV,UAAU,CAACrC,IAAI,CAACwC,cAAc,CAACC,GAAG,CAAEO,CAAC,IAAKA,CAAC,CAACC,YAAY,CAAC,CAAC,CAACJ,IAAI,CAAC,IAAI,CAAC;IAC3F,OAAO,uCAAuCN,QAAQ,EAAE;EAC1D;EAEA,MAAMW,WAAWA,CAAA,EAA+B;IAC9C,MAAMC,QAAQ,GAAG,MAAM,IAAAC,wBAAY,EAAC,CAAC;IACrC,MAAMC,gBAAgB,GAAGC,eAAI,CAACT,IAAI,CAACM,QAAQ,CAACI,KAAK,CAACC,OAAO,CAAC,CAAC,EAAEC,cAAK,CAACC,yBAAyB,CAAC,CAAC,CAAC;IAC/F,MAAMC,iBAAiB,GAAGC,eAAI,CAACC,IAAI,CAAC,yBAAyB,EAAE;MAAEC,GAAG,EAAET;IAAiB,CAAC,CAAC;IACzF,MAAMU,oBAAoB,GAAGJ,iBAAiB,CAAClB,GAAG,CAAEuB,CAAC,IAAKV,eAAI,CAACT,IAAI,CAACQ,gBAAgB,EAAEW,CAAC,CAAC,CAAC;IACzF,MAAMxB,cAA+B,GAAG,EAAE;IAC1C,MAAMyB,OAAO,GAAGF,oBAAoB,CAACtB,GAAG,CAAC,MAAOyB,gBAAgB,IAAK;MACnE,MAAMC,IAAI,GAAG,MAAM,IAAI,CAACC,eAAe,CAACF,gBAAgB,CAAC;MACzD,IAAI,CAACC,IAAI,EAAE;MACX,MAAME,MAAM,GAAG,MAAMC,kBAAE,CAACC,UAAU,CAACJ,IAAI,CAAC;MACxC,IAAIE,MAAM,EAAE;MACZ,MAAM3B,aAAa,GAAG;QACpBC,WAAW,EAAEuB,gBAAgB;QAC7BtB,UAAU,EAAEuB,IAAI;QAChBlB,YAAY,EAAE,IAAI,CAACuB,gBAAgB,CAACN,gBAAgB;MACtD,CAAC;MACD1B,cAAc,CAACiC,IAAI,CAAC/B,aAAa,CAAC;IACpC,CAAC,CAAC;IACF,MAAMgC,OAAO,CAACC,GAAG,CAACV,OAAO,CAAC;IAC1B,OAAO;MACLW,KAAK,EAAEpC,cAAc,CAACqC,MAAM,KAAK,CAAC;MAClC7E,IAAI,EAAE;QACJwC;MACF;IACF,CAAC;EACH;EAEA,MAAM4B,eAAeA,CAACzB,WAAmB,EAAsC;IAC7E,IAAI;MACF,MAAMwB,IAAI,GAAG,MAAMG,kBAAE,CAACQ,QAAQ,CAACnC,WAAW,CAAC;MAC3C,OAAOwB,IAAI;IACb,CAAC,CAAC,OAAOY,GAAQ,EAAE;MACjB;MACA,OAAO,IAAI;IACb;EACF;;EAEA;AACF;AACA;EACEP,gBAAgBA,CAAC7B,WAAmB,EAAU;IAC5C,MAAMqC,YAAY,GAAGrC,WAAW,CAACsC,KAAK,CAAC3B,eAAI,CAACT,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5E,OAAOmC,YAAY,CAACE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;EACpC;AACF;AAACnD,OAAA,CAAApB,OAAA,GAAAqB,kBAAA","ignoreList":[]}

package/dist/core-diagnoses/orphan-symlink-objects.d.ts

@@ -0,0 +1,10 @@
+import Diagnosis, { ExamineBareResult } from '../diagnosis';
+export declare const DIAGNOSIS_NAME = "check orphan refs";
+export default class OrphanSymlinkObjects extends Diagnosis {
+    name: string;
+    description: string;
+    category: string;
+    _formatSymptoms(bareResult: ExamineBareResult): string;
+    _formatManualTreat(bareResult: ExamineBareResult): string;
+    _runExamine(): Promise<ExamineBareResult>;
+}