@teambit/insights 0.0.555 → 0.0.556

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/insights",
-  "version": "0.0.555",
+  "version": "0.0.556",
   "homepage": "https://bit.dev/teambit/explorer/insights",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.explorer",
     "name": "insights",
-    "version": "0.0.555"
+    "version": "0.0.556"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -14,10 +14,10 @@
     "semver": "7.3.4",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/graph": "0.0.555",
-    "@teambit/cli": "0.0.386",
-    "@teambit/component": "0.0.555",
-    "@teambit/bit-error": "0.0.372"
+    "@teambit/graph": "0.0.556",
+    "@teambit/cli": "0.0.387",
+    "@teambit/component": "0.0.556",
+    "@teambit/bit-error": "0.0.373"
   },
   "devDependencies": {
     "@types/semver": "7.3.4",
@@ -29,7 +29,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.172",
+    "@teambit/legacy": "1.0.173",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -57,12 +57,18 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.172",
+        "@teambit/legacy": "1.0.173",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/all-insights/duplicate-dependencies.ts

@@ -1,149 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import { GraphBuilder, VersionSubgraph } from '@teambit/graph';
-import { rcompare } from 'semver';
-// import { ComponentID } from '../../../component/component-id';
-import { ComponentID } from '@teambit/component';
-import { Insight, InsightResult, RawResult } from '../insight';
-// import NoDataForInsight from '../exceptions/no-data-for-insight';
-
-export const INSIGHT_NAME = 'duplicate dependencies';
-
-type Dependent = {
-  id: string;
-  usedVersion: string;
-};
-
-type VersionWithDependents = {
-  version: string;
-  compId: string;
-  dependents: Dependent[];
-};
-
-type FormattedEntry = {
-  dependencyId: string;
-  latestVersion: string;
-  totalOutdatedDependents: string;
-  dependentsByVersion: VersionWithDependents[];
-};
-export default class DuplicateDependencies implements Insight {
-  name = INSIGHT_NAME;
-  description = 'Get all duplicate dependencies in component graph';
-  graphBuilder: GraphBuilder;
-  constructor(graphBuilder: GraphBuilder) {
-    this.graphBuilder = graphBuilder;
-  }
-  private async runInsight(): Promise<RawResult> {
-    const graph = await this.graphBuilder.getGraph();
-    if (!graph) {
-      return {
-        message: 'No graph found',
-        data: undefined,
-      };
-    }
-    const duplicates = graph.findDuplicateDependencies();
-    const lenDependencies = [...duplicates.keys()].length;
-    if (lenDependencies === 1) {
-      return {
-        message: `Found ${lenDependencies} duplicate dependency.`,
-        data: duplicates,
-      };
-    }
-    return {
-      message: `Found ${lenDependencies} duplicate dependencies.`,
-      data: duplicates,
-    };
-  }
-
-  private formatData(data: any): FormattedEntry[] {
-    const formatted: FormattedEntry[] = [];
-    for (const [dependency, depData] of data.entries()) {
-      const { totalOutdatedDependents, dependentsByVersion } = this.getDependents(depData.priorVersions);
-      formatted.push({
-        dependencyId: dependency,
-        latestVersion: depData.latestVersionId,
-        totalOutdatedDependents: totalOutdatedDependents.toString(),
-        dependentsByVersion,
-      });
-    }
-    return formatted;
-  }
-
-  private getDependents(
-    priorVersions: VersionSubgraph[]
-  ): { totalOutdatedDependents: number; dependentsByVersion: VersionWithDependents[] } {
-    let totalOutdatedDependents = 0;
-    const dependentsByVersion: VersionWithDependents[] = [];
-    priorVersions.forEach((pVersion: VersionSubgraph) => {
-      const dependents: Dependent[] = [];
-      const version = ComponentID.fromString(pVersion.versionId).version || pVersion.versionId.split('@')[1];
-      pVersion.immediateDependents.forEach((dependent: string) => {
-        dependents.push({
-          id: dependent,
-          usedVersion: pVersion.versionId,
-        });
-      });
-      dependentsByVersion.push({
-        compId: pVersion.versionId,
-        version,
-        dependents,
-      });
-      totalOutdatedDependents += pVersion.immediateDependents.length;
-    });
-    dependentsByVersion.sort(this.revreseCompareVersions);
-    return { totalOutdatedDependents, dependentsByVersion };
-  }
-
-  revreseCompareVersions(v1: VersionWithDependents, v2: VersionWithDependents) {
-    return rcompare(v1.version, v2.version);
-  }
-
-  private stringifyDependents(dependents: Dependent[]): string {
-    const string = dependents
-      .map((dependent) => {
-        return `- ${dependent.id} => ${dependent.usedVersion}`;
-      })
-      .join('\n');
-    return string;
-  }
-
-  private stringifyDependentsByVersion(versions: VersionWithDependents[]): string {
-    const string = versions
-      .map((version) => {
-        return `- ${version.compId} has ${version.dependents.length} dependents`;
-      })
-      .join('\n');
-    return string;
-  }
-
-  private renderData(data: FormattedEntry[]) {
-    const string = data
-      .map((obj) => {
-        return `\n\nFound ${obj.totalOutdatedDependents} outdated dependents for ${obj.dependencyId}
-The latest version is "${obj.latestVersion}"
-Outdated dependents:
-${this.stringifyDependentsByVersion(obj.dependentsByVersion)}`;
-      })
-      .join('\n');
-    return string;
-  }
-
-  async run(): Promise<InsightResult> {
-    const bareResult = await this.runInsight();
-    const formattedData = this.formatData(bareResult.data);
-    const renderedData = this.renderData(formattedData);
-    const result: InsightResult = {
-      metaData: {
-        name: this.name,
-        description: this.description,
-      },
-      data: formattedData,
-      message: bareResult.message,
-      renderedData,
-    };
-
-    if (bareResult.message) {
-      result.message = bareResult.message;
-    }
-    return result;
-  }
-}

package/all-insights/find-cycles.ts

@@ -1,66 +0,0 @@
-import { GraphBuilder } from '@teambit/graph';
-import { Insight, InsightResult, RawResult } from '../insight';
-
-export const INSIGHT_NAME = 'cyclic dependencies';
-
-export default class FindCycles implements Insight {
-  name = INSIGHT_NAME;
-  description = 'Get all cyclic dependencies in component graph';
-  graphBuilder: GraphBuilder;
-  constructor(graphBuilder: GraphBuilder) {
-    this.graphBuilder = graphBuilder;
-  }
-  private async runInsight(): Promise<RawResult> {
-    const graph = await this.graphBuilder.getGraph();
-    if (!graph) {
-      return {
-        message: '',
-        data: undefined,
-      };
-    }
-    const cycles = graph.findCycles();
-    if (cycles.length === 1) {
-      return {
-        message: `Found ${cycles.length} cycle.`,
-        data: cycles,
-      };
-    }
-    return {
-      message: `Found ${cycles.length} cycles.`,
-      data: cycles,
-    };
-  }
-
-  private renderData(data: RawResult) {
-    if (data.data.length === 0) {
-      return 'No cyclic dependencies';
-    }
-    const string = data.data
-      .map((cycle) => {
-        return `\nCyclic dependency
------------------
-- ${cycle.join('\n- ')}`;
-      })
-      .join('\n');
-    return string;
-  }
-
-  async run(): Promise<InsightResult> {
-    const bareResult = await this.runInsight();
-    const renderedData = this.renderData(bareResult);
-    const result: InsightResult = {
-      metaData: {
-        name: this.name,
-        description: this.description,
-      },
-      data: bareResult.data,
-      message: bareResult.message,
-      renderedData,
-    };
-
-    if (bareResult.message) {
-      result.message = bareResult.message;
-    }
-    return result;
-  }
-}

package/core-insights-getter.ts

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

package/exceptions/insight-already-exists.ts

@@ -1,7 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-
-export default class InsightAlreadyExists extends BitError {
-  constructor(readonly insightName: string) {
-    super(`Insight ${insightName} already exists`);
-  }
-}

package/exceptions/insight-not-found.ts

@@ -1,7 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-
-export default class InsightNotFound extends BitError {
-  constructor(readonly insightName: string) {
-    super(`Insight ${insightName} not found`);
-  }
-}

package/exceptions/no-data-for-insight.ts

@@ -1,7 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-
-export default class NoDataForInsight extends BitError {
-  constructor(readonly insightName: string) {
-    super(`No data for ${insightName}`);
-  }
-}

package/index.ts

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

package/insight-manager.ts

@@ -1,85 +0,0 @@
-import InsightAlreadyExists from './exceptions/insight-already-exists';
-import InsightNotFound from './exceptions/insight-not-found';
-import { Insight, InsightResult } from './insight';
-
-export type RunInsightOptions = {
-  renderData: boolean;
-};
-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[] = [];
-    await Promise.all(
-      insightNames.map(async (insightName) => {
-        const insight = this.getByName(insightName);
-        if (insight) {
-          const insightRes: InsightResult = await insight.run();
-          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.provider.ts

@@ -1,19 +0,0 @@
-import { CLIMain } from '@teambit/cli';
-import { GraphBuilder } from '@teambit/graph';
-
-import getCoreInsights from './core-insights-getter';
-import { Insight } from './insight';
-import { InsightManager } from './insight-manager';
-import InsightsCmd from './insights.cmd';
-
-export type InsightDeps = [GraphBuilder, CLIMain];
-
-export async function provide([graphBuilder, cli]: InsightDeps) {
-  // get all insights from registry
-  const initialInsights: Insight[] = getCoreInsights(graphBuilder);
-  // 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 insightsCmd = new InsightsCmd(insightManager);
-  cli.register(insightsCmd);
-}

package/insight.ts

@@ -1,27 +0,0 @@
-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(...args: any[]): Promise<InsightResult>;
-}

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,57 +0,0 @@
-import chalk from 'chalk';
-import { Command, CommandOptions } from '@teambit/cli';
-import { InsightResult } from './insight';
-import { InsightManager, RunInsightOptions } from './insight-manager';
-
-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'],
-  ] as CommandOptions;
-  insightManager: InsightManager;
-  constructor(insightManager: InsightManager) {
-    this.insightManager = insightManager;
-  }
-
-  async report(names: [string[]], options: { list: boolean }): Promise<string> {
-    if (options.list) {
-      const results = await this.json(names, options);
-      return JSON.stringify(results, null, 2);
-    }
-    const results = await this.runInsights(names, { renderData: true });
-    return template(results);
-  }
-
-  async json(names: [string[]], { list }: { list: boolean }) {
-    if (list) {
-      const results = this.insightManager.listInsights();
-      return results;
-    }
-    return this.runInsights(names, { renderData: false });
-  }
-
-  private 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;
-  }
-}
-
-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,17 +0,0 @@
-import { CLIAspect, MainRuntime } from '@teambit/cli';
-import { GraphAspect } from '@teambit/graph';
-
-import { provide } from './insight.provider';
-import { InsightsAspect } from './insights.aspect';
-
-export const InsightsMain = {
-  runtime: MainRuntime,
-  name: 'insights',
-  dependencies: [GraphAspect, CLIAspect],
-  config: {
-    silence: false,
-  },
-  provider: provide,
-};
-
-InsightsAspect.addRuntime(InsightsMain);

package/tsconfig.json

@@ -1,34 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
-    ],
-    "target": "es2015",
-    "module": "commonjs",
-    "jsx": "react",
-    "declaration": true,
-    "sourceMap": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "outDir": "dist",
-    "composite": true,
-    "emitDeclarationOnly": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "rootDir": ".",
-    "preserveConstEnums": true,
-    "resolveJsonModule": true
-  },
-  "exclude": [
-    "dist"
-  ]
-}

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-declare module '*.png' {
-  const value: any;
-  export = value;
-}
-declare module '*.svg' {
-  import type { FunctionComponent, SVGProps } from 'react';
-
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
-  const src: string;
-  export default src;
-}
-
-// @TODO Gilad
-declare module '*.jpg' {
-  const value: any;
-  export = value;
-}
-declare module '*.jpeg' {
-  const value: any;
-  export = value;
-}
-declare module '*.gif' {
-  const value: any;
-  export = value;
-}
-declare module '*.bmp' {
-  const value: any;
-  export = value;
-}

package/types/style.d.ts

@@ -1,42 +0,0 @@
-declare module '*.module.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.module.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.mdx' {
-  const component: any;
-  export default component;
-}