@teambit/insights 1.0.108 → 1.0.109

package/artifacts/preview/teambit_explorer_insights-preview.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["teambit.explorer/insights-preview"]=t():e["teambit.explorer/insights-preview"]=t()}(self,(()=>(()=>{"use strict";var e={d:(t,o)=>{for(var r in o)e.o(o,r)&&!e.o(t,r)&&Object.defineProperty(t,r,{enumerable:!0,get:o[r]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{compositions:()=>d,compositions_metadata:()=>u,overview:()=>l});var o={};e.r(o),e.d(o,{default:()=>s}),React;const r=MdxJsReact,n=TeambitMdxUiMdxScopeContext;var i=["components"];function p(){return p=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var o=arguments[t];for(var r in o)Object.prototype.hasOwnProperty.call(o,r)&&(e[r]=o[r])}return e},p.apply(this,arguments)}var a={},c="wrapper";function s(e){var t=e.components,o=function(e,t){if(null==e)return{};var o,r,n=function(e,t){if(null==e)return{};var o,r,n={},i=Object.keys(e);for(r=0;r<i.length;r++)o=i[r],t.indexOf(o)>=0||(n[o]=e[o]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)o=i[r],t.indexOf(o)>=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(n[o]=e[o])}return n}(e,i);return(0,r.mdx)(c,p({},a,o,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)(n.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,r.mdx)("p",null,"Reveals circular and outdated dependencies.")))}s.isMDXComponent=!0;const d=[],l=[o],u={compositions:[]};return t})()));

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

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

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/insights",
-  "version": "1.0.108",
+  "version": "1.0.109",
   "homepage": "https://bit.cloud/teambit/explorer/insights",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.explorer",
     "name": "insights",
-    "version": "1.0.108"
+    "version": "1.0.109"
   },
   "dependencies": {
     "p-map-series": "2.1.0",
@@ -16,11 +16,11 @@
     "@teambit/component-id": "1.2.0",
     "@teambit/harmony": "0.4.6",
     "@teambit/bit-error": "0.0.404",
-    "@teambit/graph": "1.0.108",
-    "@teambit/component": "1.0.108",
-    "@teambit/cli": "0.0.840",
+    "@teambit/graph": "1.0.109",
+    "@teambit/component": "1.0.109",
+    "@teambit/cli": "0.0.841",
     "@teambit/component-issues": "0.0.138",
-    "@teambit/issues": "1.0.108"
+    "@teambit/issues": "1.0.109"
   },
   "devDependencies": {
     "@types/semver": "7.3.4",
@@ -28,7 +28,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": {
     "react": "^17.0.0 || ^18.0.0",

package/core-insights-getter.ts

@@ -1,9 +0,0 @@
-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/index.ts

@@ -1,5 +0,0 @@
-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

@@ -1,90 +0,0 @@
-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

@@ -1,35 +0,0 @@
-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

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

package/insights.cmd.ts

@@ -1,44 +0,0 @@
-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

@@ -1,63 +0,0 @@
-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);