@teambit/insights 0.0.549 → 0.0.555

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,12 +3,37 @@ export declare type RunInsightOptions = {
3
3
  renderData: boolean;
4
4
  };
5
5
  export declare class InsightManager {
6
+ /** insights is an insight registry */
6
7
  readonly insights: Map<string, Insight>;
7
- constructor(insights: Insight[]);
8
+ constructor(
9
+ /**
10
+ * array of registered insights
11
+ */
12
+ insights: Insight[]);
13
+ /**
14
+ * registers a new insight and returns the updated insight registry map
15
+ */
8
16
  register(insight: Insight): void;
17
+ /**
18
+ * list of all registered insights
19
+ */
9
20
  listInsights(): string[];
21
+ /**
22
+ * gets a specific insight by its name or undefined if doesn't exist
23
+ */
10
24
  getByName(insightName: string): Insight | undefined;
25
+ /**
26
+ * deletes a specific insight by its name if exists
27
+ */
11
28
  delete(insightName: string): void;
29
+ /**
30
+ * execute an array of insights
31
+ *
32
+ */
12
33
  run(insightNames: string[], opts: RunInsightOptions): Promise<InsightResult[]>;
34
+ /**
35
+ * execute all insights in the registry
36
+ *
37
+ */
13
38
  runAll(opts: RunInsightOptions): Promise<InsightResult[]>;
14
39
  }
package/dist/insight.d.ts CHANGED
@@ -15,5 +15,8 @@ export declare type RawResult = {
15
15
  export interface Insight {
16
16
  name: string;
17
17
  description: string;
18
+ /**
19
+ * runs a specific insight using _runInsight, gets a RawResult, and uses _formatData to transform the output to InsightResult.
20
+ */
18
21
  run(...args: any[]): Promise<InsightResult>;
19
22
  }
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@teambit/insights",
3
- "version": "0.0.549",
3
+ "version": "0.0.555",
4
4
  "homepage": "https://bit.dev/teambit/explorer/insights",
5
5
  "main": "dist/index.js",
6
6
  "componentId": {
7
7
  "scope": "teambit.explorer",
8
8
  "name": "insights",
9
- "version": "0.0.549"
9
+ "version": "0.0.555"
10
10
  },
11
11
  "dependencies": {
12
12
  "@teambit/harmony": "0.2.11",
@@ -14,10 +14,10 @@
14
14
  "semver": "7.3.4",
15
15
  "@babel/runtime": "7.12.18",
16
16
  "core-js": "^3.0.0",
17
- "@teambit/graph": "0.0.549",
18
- "@teambit/cli": "0.0.380",
19
- "@teambit/component": "0.0.549",
20
- "@teambit/bit-error": "0.0.366"
17
+ "@teambit/graph": "0.0.555",
18
+ "@teambit/cli": "0.0.386",
19
+ "@teambit/component": "0.0.555",
20
+ "@teambit/bit-error": "0.0.372"
21
21
  },
22
22
  "devDependencies": {
23
23
  "@types/semver": "7.3.4",
@@ -29,7 +29,7 @@
29
29
  "@types/node": "12.20.4"
30
30
  },
31
31
  "peerDependencies": {
32
- "@teambit/legacy": "1.0.76",
32
+ "@teambit/legacy": "1.0.172",
33
33
  "react-dom": "^16.8.0 || ^17.0.0",
34
34
  "react": "^16.8.0 || ^17.0.0"
35
35
  },
@@ -57,7 +57,7 @@
57
57
  "react": "-"
58
58
  },
59
59
  "peerDependencies": {
60
- "@teambit/legacy": "1.0.76",
60
+ "@teambit/legacy": "1.0.172",
61
61
  "react-dom": "^16.8.0 || ^17.0.0",
62
62
  "react": "^16.8.0 || ^17.0.0"
63
63
  }
package/tsconfig.json CHANGED
@@ -25,7 +25,6 @@
25
25
  "strict": true,
26
26
  "noImplicitAny": false,
27
27
  "rootDir": ".",
28
- "removeComments": true,
29
28
  "preserveConstEnums": true,
30
29
  "resolveJsonModule": true
31
30
  },