@teambit/insights 1.0.106 → 1.0.108

package/core-insights-getter.ts

@@ -0,0 +1,9 @@
+import { GraphMain } from '@teambit/graph';
+
+import DuplicateDependencies from './all-insights/duplicate-dependencies';
+import FindCycles from './all-insights/find-circulars';
+
+export default function getCoreInsights(graphBuilder: GraphMain) {
+  const coreInsights = [new FindCycles(graphBuilder), new DuplicateDependencies(graphBuilder)];
+  return coreInsights;
+}

package/dist/all-insights/duplicate-dependencies.d.ts

@@ -1,11 +1,11 @@
 import { GraphMain } from '@teambit/graph';
 import { Insight, InsightResult } from '../insight';
 export declare const INSIGHT_NAME = "duplicate dependencies";
-declare type Dependent = {
+type Dependent = {
     id: string;
     usedVersion: string;
 };
-declare type VersionWithDependents = {
+type VersionWithDependents = {
     version: string;
     compId: string;
     dependents: Dependent[];

package/dist/all-insights/find-circulars.js

@@ -30,14 +30,14 @@ class FindCycles {
     this.graphBuilder = graphBuilder;
   }
   async runInsight(opts) {
-    const graph = await this.graphBuilder.getGraphIds(opts === null || opts === void 0 ? void 0 : opts.ids);
+    const graph = await this.graphBuilder.getGraphIds(opts?.ids);
     if (!graph) {
       return {
         message: '',
         data: undefined
       };
     }
-    const cycles = graph.findCycles(undefined, opts === null || opts === void 0 ? void 0 : opts.includeDeps);
+    const cycles = graph.findCycles(undefined, opts?.includeDeps);
     if (cycles.length === 1) {
       return {
         message: `Found ${cycles.length} cycle.`,

package/dist/all-insights/find-circulars.js.map

@@ -1 +1 @@
-{"version":3,"names":["_componentIssues","data","require","_lodash","_defineProperty","obj","key","value","_toPropertyKey","Object","defineProperty","enumerable","configurable","writable","t","i","_toPrimitive","String","r","e","Symbol","toPrimitive","call","TypeError","Number","INSIGHT_CIRCULAR_DEPS_NAME","exports","FindCycles","constructor","graphBuilder","runInsight","opts","graph","getGraphIds","ids","message","undefined","cycles","findCycles","includeDeps","length","renderData","string","map","cycle","join","run","bareResult","renderedData","result","metaData","name","description","addAsComponentIssue","components","c","id","allIds","uniq","flat","componentsWithCircular","filter","component","includes","toString","forEach","state","issues","getOrCreate","IssuesClasses","CircularDependencies","default"],"sources":["find-circulars.ts"],"sourcesContent":["import { Component } from '@teambit/component';\nimport { IssuesClasses } from '@teambit/component-issues';\nimport { GraphMain } from '@teambit/graph';\nimport { uniq } from 'lodash';\nimport { Insight, InsightResult, RawResult } from '../insight';\nimport { RunInsightOptions } from '../insight-manager';\n\nexport const INSIGHT_CIRCULAR_DEPS_NAME = 'circular';\n\nexport default class FindCycles implements Insight {\n  name = INSIGHT_CIRCULAR_DEPS_NAME;\n  description = 'Get all circular dependencies in component graph';\n  graphBuilder: GraphMain;\n  constructor(graphBuilder: GraphMain) {\n    this.graphBuilder = graphBuilder;\n  }\n  private async runInsight(opts?: RunInsightOptions): Promise<RawResult> {\n    const graph = await this.graphBuilder.getGraphIds(opts?.ids);\n    if (!graph) {\n      return {\n        message: '',\n        data: undefined,\n      };\n    }\n    const cycles = graph.findCycles(undefined, opts?.includeDeps);\n    if (cycles.length === 1) {\n      return {\n        message: `Found ${cycles.length} cycle.`,\n        data: cycles,\n      };\n    }\n    return {\n      message: `Found ${cycles.length} cycles.`,\n      data: cycles,\n    };\n  }\n\n  private renderData(data: RawResult) {\n    if (data.data.length === 0) {\n      return 'No cyclic dependencies';\n    }\n    const string = data.data\n      .map((cycle) => {\n        return `\\nCyclic dependency\n-----------------\n- ${cycle.join('\\n- ')}`;\n      })\n      .join('\\n');\n    return string;\n  }\n\n  async run(opts?: RunInsightOptions): Promise<InsightResult> {\n    const bareResult = await this.runInsight(opts);\n    const renderedData = this.renderData(bareResult);\n    const result: InsightResult = {\n      metaData: {\n        name: this.name,\n        description: this.description,\n      },\n      data: bareResult.data,\n      message: bareResult.message,\n      renderedData,\n    };\n\n    if (bareResult.message) {\n      result.message = bareResult.message;\n    }\n    return result;\n  }\n\n  async addAsComponentIssue(components: Component[]) {\n    const result = await this.runInsight({ ids: components.map((c) => c.id) });\n    if (!result.data.length) {\n      return; // no circulars\n    }\n    const allIds = uniq(result.data.flat());\n    const componentsWithCircular = components.filter((component) => allIds.includes(component.id.toString()));\n    componentsWithCircular.forEach((component) => {\n      component.state.issues.getOrCreate(IssuesClasses.CircularDependencies).data = true;\n    });\n  }\n}\n"],"mappings":";;;;;;AACA,SAAAA,iBAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,gBAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAE,QAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,OAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA8B,SAAAG,gBAAAC,GAAA,EAAAC,GAAA,EAAAC,KAAA,IAAAD,GAAA,GAAAE,cAAA,CAAAF,GAAA,OAAAA,GAAA,IAAAD,GAAA,IAAAI,MAAA,CAAAC,cAAA,CAAAL,GAAA,EAAAC,GAAA,IAAAC,KAAA,EAAAA,KAAA,EAAAI,UAAA,QAAAC,YAAA,QAAAC,QAAA,oBAAAR,GAAA,CAAAC,GAAA,IAAAC,KAAA,WAAAF,GAAA;AAAA,SAAAG,eAAAM,CAAA,QAAAC,CAAA,GAAAC,YAAA,CAAAF,CAAA,uCAAAC,CAAA,GAAAA,CAAA,GAAAE,MAAA,CAAAF,CAAA;AAAA,SAAAC,aAAAF,CAAA,EAAAI,CAAA,2BAAAJ,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAK,CAAA,GAAAL,CAAA,CAAAM,MAAA,CAAAC,WAAA,kBAAAF,CAAA,QAAAJ,CAAA,GAAAI,CAAA,CAAAG,IAAA,CAAAR,CAAA,EAAAI,CAAA,uCAAAH,CAAA,SAAAA,CAAA,YAAAQ,SAAA,yEAAAL,CAAA,GAAAD,MAAA,GAAAO,MAAA,EAAAV,CAAA;AAIvB,MAAMW,0BAA0B,GAAAC,OAAA,CAAAD,0BAAA,GAAG,UAAU;AAErC,MAAME,UAAU,CAAoB;EAIjDC,WAAWA,CAACC,YAAuB,EAAE;IAAAzB,eAAA,eAH9BqB,0BAA0B;IAAArB,eAAA,sBACnB,kDAAkD;IAAAA,eAAA;IAG9D,IAAI,CAACyB,YAAY,GAAGA,YAAY;EAClC;EACA,MAAcC,UAAUA,CAACC,IAAwB,EAAsB;IACrE,MAAMC,KAAK,GAAG,MAAM,IAAI,CAACH,YAAY,CAACI,WAAW,CAACF,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAEG,GAAG,CAAC;IAC5D,IAAI,CAACF,KAAK,EAAE;MACV,OAAO;QACLG,OAAO,EAAE,EAAE;QACXlC,IAAI,EAAEmC;MACR,CAAC;IACH;IACA,MAAMC,MAAM,GAAGL,KAAK,CAACM,UAAU,CAACF,SAAS,EAAEL,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAEQ,WAAW,CAAC;IAC7D,IAAIF,MAAM,CAACG,MAAM,KAAK,CAAC,EAAE;MACvB,OAAO;QACLL,OAAO,EAAG,SAAQE,MAAM,CAACG,MAAO,SAAQ;QACxCvC,IAAI,EAAEoC;MACR,CAAC;IACH;IACA,OAAO;MACLF,OAAO,EAAG,SAAQE,MAAM,CAACG,MAAO,UAAS;MACzCvC,IAAI,EAAEoC;IACR,CAAC;EACH;EAEQI,UAAUA,CAACxC,IAAe,EAAE;IAClC,IAAIA,IAAI,CAACA,IAAI,CAACuC,MAAM,KAAK,CAAC,EAAE;MAC1B,OAAO,wBAAwB;IACjC;IACA,MAAME,MAAM,GAAGzC,IAAI,CAACA,IAAI,CACrB0C,GAAG,CAAEC,KAAK,IAAK;MACd,OAAQ;AAChB;AACA,IAAIA,KAAK,CAACC,IAAI,CAAC,MAAM,CAAE,EAAC;IAClB,CAAC,CAAC,CACDA,IAAI,CAAC,IAAI,CAAC;IACb,OAAOH,MAAM;EACf;EAEA,MAAMI,GAAGA,CAACf,IAAwB,EAA0B;IAC1D,MAAMgB,UAAU,GAAG,MAAM,IAAI,CAACjB,UAAU,CAACC,IAAI,CAAC;IAC9C,MAAMiB,YAAY,GAAG,IAAI,CAACP,UAAU,CAACM,UAAU,CAAC;IAChD,MAAME,MAAqB,GAAG;MAC5BC,QAAQ,EAAE;QACRC,IAAI,EAAE,IAAI,CAACA,IAAI;QACfC,WAAW,EAAE,IAAI,CAACA;MACpB,CAAC;MACDnD,IAAI,EAAE8C,UAAU,CAAC9C,IAAI;MACrBkC,OAAO,EAAEY,UAAU,CAACZ,OAAO;MAC3Ba;IACF,CAAC;IAED,IAAID,UAAU,CAACZ,OAAO,EAAE;MACtBc,MAAM,CAACd,OAAO,GAAGY,UAAU,CAACZ,OAAO;IACrC;IACA,OAAOc,MAAM;EACf;EAEA,MAAMI,mBAAmBA,CAACC,UAAuB,EAAE;IACjD,MAAML,MAAM,GAAG,MAAM,IAAI,CAACnB,UAAU,CAAC;MAAEI,GAAG,EAAEoB,UAAU,CAACX,GAAG,CAAEY,CAAC,IAAKA,CAAC,CAACC,EAAE;IAAE,CAAC,CAAC;IAC1E,IAAI,CAACP,MAAM,CAAChD,IAAI,CAACuC,MAAM,EAAE;MACvB,OAAO,CAAC;IACV;IACA,MAAMiB,MAAM,GAAG,IAAAC,cAAI,EAACT,MAAM,CAAChD,IAAI,CAAC0D,IAAI,CAAC,CAAC,CAAC;IACvC,MAAMC,sBAAsB,GAAGN,UAAU,CAACO,MAAM,CAAEC,SAAS,IAAKL,MAAM,CAACM,QAAQ,CAACD,SAAS,CAACN,EAAE,CAACQ,QAAQ,CAAC,CAAC,CAAC,CAAC;IACzGJ,sBAAsB,CAACK,OAAO,CAAEH,SAAS,IAAK;MAC5CA,SAAS,CAACI,KAAK,CAACC,MAAM,CAACC,WAAW,CAACC,gCAAa,CAACC,oBAAoB,CAAC,CAACrE,IAAI,GAAG,IAAI;IACpF,CAAC,CAAC;EACJ;AACF;AAACyB,OAAA,CAAA6C,OAAA,GAAA5C,UAAA"}
+{"version":3,"names":["_componentIssues","data","require","_lodash","_defineProperty","obj","key","value","_toPropertyKey","Object","defineProperty","enumerable","configurable","writable","t","i","_toPrimitive","String","r","e","Symbol","toPrimitive","call","TypeError","Number","INSIGHT_CIRCULAR_DEPS_NAME","exports","FindCycles","constructor","graphBuilder","runInsight","opts","graph","getGraphIds","ids","message","undefined","cycles","findCycles","includeDeps","length","renderData","string","map","cycle","join","run","bareResult","renderedData","result","metaData","name","description","addAsComponentIssue","components","c","id","allIds","uniq","flat","componentsWithCircular","filter","component","includes","toString","forEach","state","issues","getOrCreate","IssuesClasses","CircularDependencies","default"],"sources":["find-circulars.ts"],"sourcesContent":["import { Component } from '@teambit/component';\nimport { IssuesClasses } from '@teambit/component-issues';\nimport { GraphMain } from '@teambit/graph';\nimport { uniq } from 'lodash';\nimport { Insight, InsightResult, RawResult } from '../insight';\nimport { RunInsightOptions } from '../insight-manager';\n\nexport const INSIGHT_CIRCULAR_DEPS_NAME = 'circular';\n\nexport default class FindCycles implements Insight {\n  name = INSIGHT_CIRCULAR_DEPS_NAME;\n  description = 'Get all circular dependencies in component graph';\n  graphBuilder: GraphMain;\n  constructor(graphBuilder: GraphMain) {\n    this.graphBuilder = graphBuilder;\n  }\n  private async runInsight(opts?: RunInsightOptions): Promise<RawResult> {\n    const graph = await this.graphBuilder.getGraphIds(opts?.ids);\n    if (!graph) {\n      return {\n        message: '',\n        data: undefined,\n      };\n    }\n    const cycles = graph.findCycles(undefined, opts?.includeDeps);\n    if (cycles.length === 1) {\n      return {\n        message: `Found ${cycles.length} cycle.`,\n        data: cycles,\n      };\n    }\n    return {\n      message: `Found ${cycles.length} cycles.`,\n      data: cycles,\n    };\n  }\n\n  private renderData(data: RawResult) {\n    if (data.data.length === 0) {\n      return 'No cyclic dependencies';\n    }\n    const string = data.data\n      .map((cycle) => {\n        return `\\nCyclic dependency\n-----------------\n- ${cycle.join('\\n- ')}`;\n      })\n      .join('\\n');\n    return string;\n  }\n\n  async run(opts?: RunInsightOptions): Promise<InsightResult> {\n    const bareResult = await this.runInsight(opts);\n    const renderedData = this.renderData(bareResult);\n    const result: InsightResult = {\n      metaData: {\n        name: this.name,\n        description: this.description,\n      },\n      data: bareResult.data,\n      message: bareResult.message,\n      renderedData,\n    };\n\n    if (bareResult.message) {\n      result.message = bareResult.message;\n    }\n    return result;\n  }\n\n  async addAsComponentIssue(components: Component[]) {\n    const result = await this.runInsight({ ids: components.map((c) => c.id) });\n    if (!result.data.length) {\n      return; // no circulars\n    }\n    const allIds = uniq(result.data.flat());\n    const componentsWithCircular = components.filter((component) => allIds.includes(component.id.toString()));\n    componentsWithCircular.forEach((component) => {\n      component.state.issues.getOrCreate(IssuesClasses.CircularDependencies).data = true;\n    });\n  }\n}\n"],"mappings":";;;;;;AACA,SAAAA,iBAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,gBAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAE,QAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,OAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA8B,SAAAG,gBAAAC,GAAA,EAAAC,GAAA,EAAAC,KAAA,IAAAD,GAAA,GAAAE,cAAA,CAAAF,GAAA,OAAAA,GAAA,IAAAD,GAAA,IAAAI,MAAA,CAAAC,cAAA,CAAAL,GAAA,EAAAC,GAAA,IAAAC,KAAA,EAAAA,KAAA,EAAAI,UAAA,QAAAC,YAAA,QAAAC,QAAA,oBAAAR,GAAA,CAAAC,GAAA,IAAAC,KAAA,WAAAF,GAAA;AAAA,SAAAG,eAAAM,CAAA,QAAAC,CAAA,GAAAC,YAAA,CAAAF,CAAA,uCAAAC,CAAA,GAAAA,CAAA,GAAAE,MAAA,CAAAF,CAAA;AAAA,SAAAC,aAAAF,CAAA,EAAAI,CAAA,2BAAAJ,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAK,CAAA,GAAAL,CAAA,CAAAM,MAAA,CAAAC,WAAA,kBAAAF,CAAA,QAAAJ,CAAA,GAAAI,CAAA,CAAAG,IAAA,CAAAR,CAAA,EAAAI,CAAA,uCAAAH,CAAA,SAAAA,CAAA,YAAAQ,SAAA,yEAAAL,CAAA,GAAAD,MAAA,GAAAO,MAAA,EAAAV,CAAA;AAIvB,MAAMW,0BAA0B,GAAAC,OAAA,CAAAD,0BAAA,GAAG,UAAU;AAErC,MAAME,UAAU,CAAoB;EAIjDC,WAAWA,CAACC,YAAuB,EAAE;IAAAzB,eAAA,eAH9BqB,0BAA0B;IAAArB,eAAA,sBACnB,kDAAkD;IAAAA,eAAA;IAG9D,IAAI,CAACyB,YAAY,GAAGA,YAAY;EAClC;EACA,MAAcC,UAAUA,CAACC,IAAwB,EAAsB;IACrE,MAAMC,KAAK,GAAG,MAAM,IAAI,CAACH,YAAY,CAACI,WAAW,CAACF,IAAI,EAAEG,GAAG,CAAC;IAC5D,IAAI,CAACF,KAAK,EAAE;MACV,OAAO;QACLG,OAAO,EAAE,EAAE;QACXlC,IAAI,EAAEmC;MACR,CAAC;IACH;IACA,MAAMC,MAAM,GAAGL,KAAK,CAACM,UAAU,CAACF,SAAS,EAAEL,IAAI,EAAEQ,WAAW,CAAC;IAC7D,IAAIF,MAAM,CAACG,MAAM,KAAK,CAAC,EAAE;MACvB,OAAO;QACLL,OAAO,EAAG,SAAQE,MAAM,CAACG,MAAO,SAAQ;QACxCvC,IAAI,EAAEoC;MACR,CAAC;IACH;IACA,OAAO;MACLF,OAAO,EAAG,SAAQE,MAAM,CAACG,MAAO,UAAS;MACzCvC,IAAI,EAAEoC;IACR,CAAC;EACH;EAEQI,UAAUA,CAACxC,IAAe,EAAE;IAClC,IAAIA,IAAI,CAACA,IAAI,CAACuC,MAAM,KAAK,CAAC,EAAE;MAC1B,OAAO,wBAAwB;IACjC;IACA,MAAME,MAAM,GAAGzC,IAAI,CAACA,IAAI,CACrB0C,GAAG,CAAEC,KAAK,IAAK;MACd,OAAQ;AAChB;AACA,IAAIA,KAAK,CAACC,IAAI,CAAC,MAAM,CAAE,EAAC;IAClB,CAAC,CAAC,CACDA,IAAI,CAAC,IAAI,CAAC;IACb,OAAOH,MAAM;EACf;EAEA,MAAMI,GAAGA,CAACf,IAAwB,EAA0B;IAC1D,MAAMgB,UAAU,GAAG,MAAM,IAAI,CAACjB,UAAU,CAACC,IAAI,CAAC;IAC9C,MAAMiB,YAAY,GAAG,IAAI,CAACP,UAAU,CAACM,UAAU,CAAC;IAChD,MAAME,MAAqB,GAAG;MAC5BC,QAAQ,EAAE;QACRC,IAAI,EAAE,IAAI,CAACA,IAAI;QACfC,WAAW,EAAE,IAAI,CAACA;MACpB,CAAC;MACDnD,IAAI,EAAE8C,UAAU,CAAC9C,IAAI;MACrBkC,OAAO,EAAEY,UAAU,CAACZ,OAAO;MAC3Ba;IACF,CAAC;IAED,IAAID,UAAU,CAACZ,OAAO,EAAE;MACtBc,MAAM,CAACd,OAAO,GAAGY,UAAU,CAACZ,OAAO;IACrC;IACA,OAAOc,MAAM;EACf;EAEA,MAAMI,mBAAmBA,CAACC,UAAuB,EAAE;IACjD,MAAML,MAAM,GAAG,MAAM,IAAI,CAACnB,UAAU,CAAC;MAAEI,GAAG,EAAEoB,UAAU,CAACX,GAAG,CAAEY,CAAC,IAAKA,CAAC,CAACC,EAAE;IAAE,CAAC,CAAC;IAC1E,IAAI,CAACP,MAAM,CAAChD,IAAI,CAACuC,MAAM,EAAE;MACvB,OAAO,CAAC;IACV;IACA,MAAMiB,MAAM,GAAG,IAAAC,cAAI,EAACT,MAAM,CAAChD,IAAI,CAAC0D,IAAI,CAAC,CAAC,CAAC;IACvC,MAAMC,sBAAsB,GAAGN,UAAU,CAACO,MAAM,CAAEC,SAAS,IAAKL,MAAM,CAACM,QAAQ,CAACD,SAAS,CAACN,EAAE,CAACQ,QAAQ,CAAC,CAAC,CAAC,CAAC;IACzGJ,sBAAsB,CAACK,OAAO,CAAEH,SAAS,IAAK;MAC5CA,SAAS,CAACI,KAAK,CAACC,MAAM,CAACC,WAAW,CAACC,gCAAa,CAACC,oBAAoB,CAAC,CAACrE,IAAI,GAAG,IAAI;IACpF,CAAC,CAAC;EACJ;AACF;AAACyB,OAAA,CAAA6C,OAAA,GAAA5C,UAAA"}

package/dist/insight-manager.d.ts

@@ -1,6 +1,6 @@
 import { ComponentID } from '@teambit/component-id';
 import { Insight, InsightResult } from './insight';
-export declare type RunInsightOptions = {
+export type RunInsightOptions = {
     renderData?: boolean;
     includeDeps?: boolean;
     ids?: ComponentID[];

package/dist/insight.d.ts

@@ -1,16 +1,16 @@
 import { Component } from '@teambit/component';
 import { RunInsightOptions } from './insight-manager';
-export declare type InsightMetaData = {
+export type InsightMetaData = {
     name: string;
     description: string;
 };
-export declare type InsightResult = {
+export type InsightResult = {
     metaData: InsightMetaData;
     message: string;
     data: any;
     renderedData?: string;
 };
-export declare type RawResult = {
+export type RawResult = {
     message: string;
     data: any;
 };

package/dist/insights.compositon.d.ts

@@ -1,2 +1,2 @@
-import React from 'react';
-export declare const Logo: () => React.JSX.Element;
+/// <reference types="react" />
+export declare const Logo: () => JSX.Element;

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

@@ -10,7 +10,7 @@ export declare class InsightsMain {
     runInsights(names: string[], opts: RunInsightOptions): Promise<InsightResult[]>;
     listInsights(): string[];
     addInsightsAsComponentIssues(components: Component[], issuesToIgnore: string[]): Promise<void>;
-    static slots: never[];
+    static slots: any[];
     static dependencies: import("@teambit/harmony").Aspect[];
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     static config: {

package/dist/{preview-1703505948637.js → preview-1703647408454.js}

@@ -1,5 +1,5 @@
 ;
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.explorer_insights@1.0.106/dist/insights.docs.mdx';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.explorer_insights@1.0.108/dist/insights.docs.mdx';
 
 export const compositions = [];
 export const overview = [overview_0];

package/index.ts

@@ -0,0 +1,5 @@
+export { InsightManager } from './insight-manager';
+export type { Insight } from './insight';
+export type { InsightsMain } from './insights.main.runtime';
+export { InsightsAspect } from './insights.aspect';
+export { INSIGHT_CIRCULAR_DEPS_NAME } from './all-insights/find-circulars';

package/insight-manager.ts

@@ -0,0 +1,90 @@
+import pMapSeries from 'p-map-series';
+import { ComponentID } from '@teambit/component-id';
+import InsightAlreadyExists from './exceptions/insight-already-exists';
+import InsightNotFound from './exceptions/insight-not-found';
+import { Insight, InsightResult } from './insight';
+
+export type RunInsightOptions = {
+  renderData?: boolean;
+  includeDeps?: boolean;
+  ids?: ComponentID[];
+};
+export class InsightManager {
+  /** insights is an insight registry */
+  readonly insights: Map<string, Insight> = new Map();
+  constructor(
+    /**
+     * array of registered insights
+     */
+    insights: Insight[]
+  ) {
+    insights.forEach((insight) => {
+      this.register(insight);
+    });
+  }
+
+  /**
+   * registers a new insight and returns the updated insight registry map
+   */
+  register(insight: Insight) {
+    const name = insight.name;
+    if (this.insights.has(name)) {
+      throw new InsightAlreadyExists(name);
+    }
+    this.insights.set(name, insight);
+  }
+  /**
+   * list of all registered insights
+   */
+  listInsights(): string[] {
+    return [...this.insights.keys()];
+  }
+
+  /**
+   * gets a specific insight by its name or undefined if doesn't exist
+   */
+  getByName(insightName: string): Insight | undefined {
+    return this.insights.get(insightName);
+  }
+
+  /**
+   * deletes a specific insight by its name if exists
+   */
+  delete(insightName: string) {
+    if (!this.insights.has(insightName)) {
+      throw new InsightNotFound(insightName);
+    }
+    this.insights.delete(insightName);
+  }
+
+  /**
+   * execute an array of insights
+   *
+   */
+  async run(insightNames: string[], opts: RunInsightOptions): Promise<InsightResult[]> {
+    const res: InsightResult[] = [];
+    // the reason for not using Promise.all here is that the current both insights building the graph.
+    // if it happens at the same time, some props are not populated in one of the instances. it obviously
+    // should be fixed in the GraphBuilder class. see "todo" there.
+    await pMapSeries(insightNames, async (insightName) => {
+      const insight = this.getByName(insightName);
+      if (insight) {
+        const insightRes: InsightResult = await insight.run(opts);
+        if (!opts.renderData) {
+          delete insightRes.renderedData;
+        }
+        res.push(insightRes);
+      }
+    });
+    return res;
+  }
+
+  /**
+   * execute all insights in the registry
+   *
+   */
+  async runAll(opts: RunInsightOptions): Promise<InsightResult[]> {
+    const allInsightNames = this.listInsights();
+    return this.run(allInsightNames, opts);
+  }
+}

package/insight.ts

@@ -0,0 +1,35 @@
+import { Component } from '@teambit/component';
+import { RunInsightOptions } from './insight-manager';
+
+export type InsightMetaData = {
+  name: string;
+  description: string;
+};
+
+export type InsightResult = {
+  metaData: InsightMetaData;
+  message: string;
+  data: any;
+  renderedData?: string;
+};
+
+export type RawResult = {
+  message: string;
+  data: any;
+};
+
+export interface Insight {
+  name: string;
+  description: string;
+
+  /**
+   * runs a specific insight using _runInsight, gets a RawResult, and uses _formatData to transform the output to InsightResult.
+   */
+  run(opts?: RunInsightOptions): Promise<InsightResult>;
+
+  /**
+   * add the results from the insights as a component-issue so then bit-status could show them and bit-tag could block
+   * them.
+   */
+  addAsComponentIssue?(components: Component[]): Promise<void>;
+}

package/insights.aspect.ts

@@ -0,0 +1,7 @@
+import { Aspect } from '@teambit/harmony';
+
+export const InsightsAspect = Aspect.create({
+  id: 'teambit.explorer/insights',
+  dependencies: [],
+  defaultConfig: {},
+});

package/insights.cmd.ts

@@ -0,0 +1,44 @@
+import chalk from 'chalk';
+import { Command, CommandOptions } from '@teambit/cli';
+import { InsightResult } from './insight';
+import { InsightsMain } from './insights.main.runtime';
+
+export default class InsightsCmd implements Command {
+  name = 'insights [names...]';
+  description = 'Insights on component graph';
+  group = 'development';
+  private = true;
+  options = [
+    ['l', 'list', 'list all insights'],
+    ['j', 'json', 'return the insights in json format'],
+    ['', 'include-deps', 'include component dependencies that are not in this workspace'],
+  ] as CommandOptions;
+  constructor(private insights: InsightsMain) {}
+
+  async report([names]: [string[]], options: { list: boolean; includeDeps: boolean }): Promise<string> {
+    if (options.list) {
+      const results = await this.json([names], options);
+      return JSON.stringify(results, null, 2);
+    }
+    const results = await this.insights.runInsights(names, { renderData: true, includeDeps: options.includeDeps });
+    return template(results);
+  }
+
+  async json([names]: [string[]], { list, includeDeps }: { list: boolean; includeDeps: boolean }) {
+    if (list) {
+      const results = this.insights.listInsights();
+      return results;
+    }
+    return this.insights.runInsights(names, { renderData: false, includeDeps });
+  }
+}
+
+function template(results: InsightResult[]): string {
+  const elements = results
+    .map((result) => {
+      return `\n${chalk.cyan.bold(result.message)}
+  ${result.renderedData}`;
+    })
+    .join('\n');
+  return elements;
+}

package/insights.main.runtime.ts

@@ -0,0 +1,63 @@
+import { CLIAspect, MainRuntime, CLIMain } from '@teambit/cli';
+import { GraphAspect, GraphMain } from '@teambit/graph';
+import { IssuesClasses } from '@teambit/component-issues';
+import IssuesAspect, { IssuesMain } from '@teambit/issues';
+import pMapSeries from 'p-map-series';
+import { Component } from '@teambit/component';
+import { InsightsAspect } from './insights.aspect';
+import getCoreInsights from './core-insights-getter';
+import { Insight, InsightResult } from './insight';
+import { InsightManager, RunInsightOptions } from './insight-manager';
+import InsightsCmd from './insights.cmd';
+
+export class InsightsMain {
+  constructor(private insightManager: InsightManager) {}
+
+  async runInsights(names: string[], opts: RunInsightOptions) {
+    if (names) {
+      let results: InsightResult[] = [];
+      const namesArr = typeof names === 'string' ? [names] : names;
+      results = await this.insightManager.run(namesArr, opts);
+      return results;
+    }
+    const results = await this.insightManager.runAll(opts);
+    return results;
+  }
+
+  listInsights() {
+    return this.insightManager.listInsights();
+  }
+
+  async addInsightsAsComponentIssues(components: Component[], issuesToIgnore: string[]) {
+    const insightNames: string[] = this.listInsights();
+    const insights = insightNames.map((name) => this.insightManager.getByName(name));
+    if (!issuesToIgnore.includes(IssuesClasses.CircularDependencies.name)) {
+      await pMapSeries(insights, async (insight) => {
+        if (insight && insight.addAsComponentIssue) {
+          await insight.addAsComponentIssue(components);
+        }
+      });
+    }
+  }
+
+  static slots = [];
+  static dependencies = [GraphAspect, CLIAspect, IssuesAspect];
+  static runtime = MainRuntime;
+  static config = {
+    silence: false,
+  };
+  static async provider([graphMain, cli, issues]: [GraphMain, CLIMain, IssuesMain]) {
+    // get all insights from registry
+    const initialInsights: Insight[] = getCoreInsights(graphMain);
+    // register all insights in cli
+    // TODO - get user-defined insights as well, and use them when instantiating InsightManager and InsightsCmd
+    const insightManager = new InsightManager(initialInsights);
+    const insightsMain = new InsightsMain(insightManager);
+    if (issues) issues.registerAddComponentsIssues(insightsMain.addInsightsAsComponentIssues.bind(insightsMain));
+    const insightsCmd = new InsightsCmd(insightsMain);
+    cli.register(insightsCmd);
+    return insightsMain;
+  }
+}
+
+InsightsAspect.addRuntime(InsightsMain);

package/package.json

@@ -1,43 +1,39 @@
 {
   "name": "@teambit/insights",
-  "version": "1.0.106",
+  "version": "1.0.108",
   "homepage": "https://bit.cloud/teambit/explorer/insights",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.explorer",
     "name": "insights",
-    "version": "1.0.106"
+    "version": "1.0.108"
   },
   "dependencies": {
     "p-map-series": "2.1.0",
     "chalk": "2.4.2",
     "semver": "7.5.2",
     "lodash": "4.17.21",
-    "core-js": "^3.0.0",
-    "@babel/runtime": "7.20.0",
     "@teambit/component-id": "1.2.0",
     "@teambit/harmony": "0.4.6",
     "@teambit/bit-error": "0.0.404",
-    "@teambit/graph": "1.0.106",
-    "@teambit/component": "1.0.106",
-    "@teambit/cli": "0.0.839",
-    "@teambit/component-issues": "0.0.137",
-    "@teambit/issues": "1.0.106"
+    "@teambit/graph": "1.0.108",
+    "@teambit/component": "1.0.108",
+    "@teambit/cli": "0.0.840",
+    "@teambit/component-issues": "0.0.138",
+    "@teambit/issues": "1.0.108"
   },
   "devDependencies": {
-    "@types/react": "^17.0.8",
     "@types/semver": "7.3.4",
     "@types/lodash": "4.14.165",
     "@types/mocha": "9.1.0",
-    "@types/node": "12.20.4",
-    "@types/react-dom": "^17.0.5",
-    "@types/jest": "^26.0.0",
-    "@types/testing-library__jest-dom": "5.9.5"
+    "@types/jest": "^29.2.2",
+    "@types/testing-library__jest-dom": "^5.9.5",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.13"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.624",
-    "react": "^16.8.0 || ^17.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0"
+    "react": "^17.0.0 || ^18.0.0",
+    "@types/react": "^18.2.12",
+    "@teambit/legacy": "1.0.624"
   },
   "license": "Apache-2.0",
   "optionalDependencies": {},
@@ -51,7 +47,7 @@
   },
   "private": false,
   "engines": {
-    "node": ">=12.22.0"
+    "node": ">=16.0.0"
   },
   "repository": {
     "type": "git",
@@ -60,12 +56,9 @@
   "keywords": [
     "bit",
     "bit-aspect",
+    "bit-core-aspect",
     "components",
     "collaboration",
-    "web",
-    "react",
-    "react-components",
-    "angular",
-    "angular-components"
+    "web"
   ]
 }

package/tsconfig.json

@@ -1,38 +1,33 @@
 {
   "compilerOptions": {
     "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
+      "esnext",
+      "dom",
+      "dom.Iterable"
     ],
-    "target": "es2015",
-    "module": "CommonJS",
-    "jsx": "react",
-    "allowJs": true,
-    "composite": true,
+    "target": "es2020",
+    "module": "es2020",
+    "jsx": "react-jsx",
     "declaration": true,
     "sourceMap": true,
-    "skipLibCheck": true,
     "experimentalDecorators": true,
-    "outDir": "dist",
+    "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "rootDir": ".",
     "resolveJsonModule": true,
-    "emitDeclarationOnly": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "preserveConstEnums": true
+    "allowJs": true,
+    "outDir": "dist",
+    "emitDeclarationOnly": true
   },
   "exclude": [
+    "artifacts",
+    "public",
     "dist",
+    "node_modules",
+    "package.json",
     "esm.mjs",
-    "package.json"
+    "**/*.cjs",
+    "./dist"
   ],
   "include": [
     "**/*",

package/types/asset.d.ts

@@ -5,12 +5,12 @@ declare module '*.png' {
 declare module '*.svg' {
   import type { FunctionComponent, SVGProps } from 'react';
 
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  export const ReactComponent: FunctionComponent<
+    SVGProps<SVGSVGElement> & { title?: string }
+  >;
   const src: string;
   export default src;
 }
-
-// @TODO Gilad
 declare module '*.jpg' {
   const value: any;
   export = value;
@@ -27,3 +27,15 @@ declare module '*.bmp' {
   const value: any;
   export = value;
 }
+declare module '*.otf' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff2' {
+  const value: any;
+  export = value;
+}