@teambit/tester 0.0.551 → 0.0.556

package/dist/tester.d.ts

@@ -17,26 +17,90 @@ export declare type ComponentPatternsMap = ComponentMap<{
     relative: string;
 }[]>;
 export interface TesterContext extends ExecutionContext {
+    /**
+     * whether the tester run for release (during bit build/tag) or not (during bit test command).
+     */
     release: boolean;
+    /**
+     * list of components to test.
+     */
     components: Component[];
+    /**
+     * component workspace.
+     */
+    /**
+     * defines whether tester is expected to run in quiet mode.
+     */
     quiet?: boolean;
+    /**
+     * list of spec files to test.
+     */
     specFiles: SpecFiles;
+    /**
+     * rootPath of the component workspace or the capsule root dir (during build).
+     */
     rootPath: string;
+    /**
+     * determines whether tester is expected to run in debug mode.
+     */
     debug?: boolean;
+    /**
+     * is start from ui
+     */
     ui?: boolean;
+    /**
+     * determines whether to start the tester in watch mode.
+     */
     watch?: boolean;
+    /**
+     * whether the tester should show code coverage
+     */
     coverage?: boolean;
+    /**
+     * array of patterns to test.
+     */
     patterns: ComponentPatternsMap;
 }
+/**
+ * tester interface allows extensions to implement a component tester into bit.
+ */
 export interface Tester {
+    /**
+     * display name of the tester.
+     */
     displayName?: string;
+    /**
+     * icon of the tester.
+     */
     icon?: string;
+    /**
+     * serialized config of the tester.
+     */
     displayConfig?(): string;
+    /**
+     * path to the config in the filesystem.
+     */
     configPath?: string;
+    /**
+     * id of the tester.
+     */
     id: string;
+    /**
+     * on test run complete. (applies only during watch)
+     * @param callback
+     */
     onTestRunComplete?(callback: CallbackFn): Promise<void>;
+    /**
+     * execute tests on all components in the given execution context.
+     */
     test(context: TesterContext): Promise<Tests>;
+    /**
+     * watch tests on all components
+     */
     watch?(context: TesterContext): Promise<Tests>;
+    /**
+     * return the tester version.
+     */
     version(): string;
 }
 export declare type CallbackFn = (testSuite: Tests) => void;

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

@@ -12,35 +12,97 @@ import { ComponentsResults, CallbackFn, Tests } from './tester';
 import { TesterService } from './tester.service';
 import { TesterTask } from './tester.task';
 export declare type TesterExtensionConfig = {
+    /**
+     * regex of the text environment.
+     */
     testRegex: string;
+    /**
+     * determine whether to watch on start.
+     */
     watchOnStart: boolean;
     patterns: string[];
 };
 export declare type TesterOptions = {
+    /**
+     * start the tester in watch mode.
+     */
     watch: boolean;
+    /**
+     * start the tester in debug mode.
+     */
     debug: boolean;
+    /**
+     * start the tester in debug mode.
+     */
     ui?: boolean;
+    /**
+     * initiate the tester on given env.
+     */
     env?: string;
+    /**
+     * generate JUnit files on the specified dir
+     */
     junit?: string;
+    /**
+     * show code coverage
+     */
     coverage?: boolean;
     callback?: CallbackFn;
 };
 export declare class TesterMain {
+    /**
+     * graphql extension.
+     */
     private graphql;
+    /**
+     * envs extension.
+     */
     private envs;
+    /**
+     * workspace extension.
+     */
     private workspace;
+    /**
+     * tester service.
+     */
     readonly service: TesterService;
+    /**
+     * build task.
+     */
     readonly task: TesterTask;
     private devFiles;
     private builder;
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     static dependencies: import("@teambit/harmony").Aspect[];
-    constructor(graphql: GraphqlMain, envs: EnvsMain, workspace: Workspace, service: TesterService, task: TesterTask, devFiles: DevFilesMain, builder: BuilderMain);
+    constructor(
+    /**
+     * graphql extension.
+     */
+    graphql: GraphqlMain, 
+    /**
+     * envs extension.
+     */
+    envs: EnvsMain, 
+    /**
+     * workspace extension.
+     */
+    workspace: Workspace, 
+    /**
+     * tester service.
+     */
+    service: TesterService, 
+    /**
+     * build task.
+     */
+    task: TesterTask, devFiles: DevFilesMain, builder: BuilderMain);
     _testsResults: {
         [componentId: string]: ComponentsResults;
     } | undefined[];
     test(components: Component[], opts?: TesterOptions): Promise<EnvsExecutionResult<Tests>>;
     private generateJUnit;
+    /**
+     * watch all components for changes and test upon each.
+     */
     watch(components: Component[], opts?: TesterOptions): Promise<EnvsExecutionResult<Tests>>;
     uiWatch(): Promise<EnvsExecutionResult<Tests>>;
     getTestsResults(component: Component): Promise<{
@@ -48,10 +110,19 @@ export declare class TesterMain {
         loading: boolean;
     } | undefined>;
     private getTestsResultsFromState;
+    /**
+     * get all test files of a component.
+     */
     getTestFiles(component: Component): import("@teambit/legacy/dist/consumer/component/sources").AbstractVinyl[];
     private getOptions;
     static defaultConfig: {
+        /**
+         * default test regex for which files tester to apply on.
+         */
         patterns: string[];
+        /**
+         * determine whether to watch on start.
+         */
         watchOnStart: boolean;
     };
     static provider([cli, envs, workspace, loggerAspect, graphql, ui, devFiles, builder]: [

package/dist/tester.service.d.ts

@@ -7,20 +7,39 @@ import { Tests, CallbackFn } from './tester';
 import { TesterOptions } from './tester.main.runtime';
 export declare const OnTestsChanged = "OnTestsChanged";
 export declare type TesterDescriptor = {
+    /**
+     * id of the tester (e.g. jest/mocha)
+     */
     id: string;
+    /**
+     * display name of the tester (e.g. Jest / Mocha)
+     */
     displayName: string;
+    /**
+     * icon of the configured tester.
+     */
     icon: string;
+    /**
+     * string containing the config for display.
+     */
     config: string;
     version?: string;
 };
 export declare class TesterService implements EnvService<Tests, TesterDescriptor> {
     readonly workspace: Workspace;
+    /**
+     * regex used to identify which files to test.
+     */
     readonly patterns: string[];
     private logger;
     private pubsub;
     private devFiles;
     name: string;
-    constructor(workspace: Workspace, patterns: string[], logger: Logger, pubsub: PubSub, devFiles: DevFilesMain);
+    constructor(workspace: Workspace, 
+    /**
+     * regex used to identify which files to test.
+     */
+    patterns: string[], logger: Logger, pubsub: PubSub, devFiles: DevFilesMain);
     _callback: CallbackFn | undefined;
     render(env: EnvDefinition): JSX.Element;
     getDescriptor(environment: EnvDefinition): {

package/dist/tester.task.d.ts

@@ -1,5 +1,8 @@
 import { BuildContext, BuiltTaskResult, BuildTask } from '@teambit/builder';
 import { DevFilesMain } from '@teambit/dev-files';
+/**
+ * tester build task. Allows to test components during component build.
+ */
 export declare class TesterTask implements BuildTask {
     readonly aspectId: string;
     private devFiles;

package/dist/tester.ui.runtime.d.ts

@@ -9,6 +9,9 @@ export declare class TesterUI {
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     stageKey?: string;
     constructor(component: ComponentUI, emptyStateSlot: EmptyStateSlot);
+    /**
+     * register a new tester empty state. this allows to register a different empty state from each environment for example.
+     */
     registerEmptyState(emptyStateComponent: ComponentType): this;
     static slots: ((registerFn: () => string) => SlotRegistry<ComponentType<{}>>)[];
     static provider([component]: [ComponentUI], config: any, [emptyStateSlot]: [EmptyStateSlot]): Promise<TesterUI>;

package/dist/utils/detect-spec-files.d.ts

@@ -1,3 +1,6 @@
 import { Component } from '@teambit/component';
 import { DevFilesMain } from '@teambit/dev-files';
+/**
+ * detect test files in components
+ */
 export declare function detectTestFiles(component: Component, devFiles: DevFilesMain): import("@teambit/legacy/dist/consumer/component/sources").AbstractVinyl[];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/tester",
-  "version": "0.0.551",
+  "version": "0.0.556",
   "homepage": "https://bit.dev/teambit/defender/tester",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.defender",
     "name": "tester",
-    "version": "0.0.551"
+    "version": "0.0.556"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -24,24 +24,24 @@
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
     "@teambit/documenter.ui.heading": "4.1.1",
-    "@teambit/cli": "0.0.382",
-    "@teambit/logger": "0.0.467",
-    "@teambit/workspace": "0.0.551",
-    "@teambit/component": "0.0.551",
-    "@teambit/graphql": "0.0.551",
-    "@teambit/builder": "0.0.551",
-    "@teambit/dev-files": "0.0.551",
-    "@teambit/envs": "0.0.551",
-    "@teambit/tests-results": "0.0.68",
-    "@teambit/ui": "0.0.551",
-    "@teambit/compiler": "0.0.551",
-    "@teambit/bit-error": "0.0.368",
-    "@teambit/defender.ui.test-loader": "0.0.461",
-    "@teambit/defender.ui.test-table": "0.0.464",
+    "@teambit/cli": "0.0.387",
+    "@teambit/logger": "0.0.472",
+    "@teambit/workspace": "0.0.556",
+    "@teambit/component": "0.0.556",
+    "@teambit/graphql": "0.0.556",
+    "@teambit/builder": "0.0.556",
+    "@teambit/dev-files": "0.0.556",
+    "@teambit/envs": "0.0.556",
+    "@teambit/tests-results": "0.0.73",
+    "@teambit/ui": "0.0.556",
+    "@teambit/compiler": "0.0.556",
+    "@teambit/bit-error": "0.0.373",
+    "@teambit/defender.ui.test-loader": "0.0.466",
+    "@teambit/defender.ui.test-table": "0.0.469",
     "@teambit/design.ui.alert-card": "0.0.13",
     "@teambit/design.ui.empty-box": "0.0.352",
     "@teambit/design.ui.separator": "0.0.351",
-    "@teambit/mdx.ui.mdx-layout": "0.0.463"
+    "@teambit/mdx.ui.mdx-layout": "0.0.468"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",
@@ -57,7 +57,7 @@
   },
   "peerDependencies": {
     "@apollo/client": "^3.0.0",
-    "@teambit/legacy": "1.0.169",
+    "@teambit/legacy": "1.0.173",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -85,12 +85,18 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.169",
+        "@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/exceptions/index.ts

@@ -1,2 +0,0 @@
-export { NoTestFilesFound } from './no-test-files-found';
-export { NoMatchingComponents } from './no-matching-components';

package/exceptions/no-matching-components.ts

@@ -1,5 +0,0 @@
-export class NoMatchingComponents extends Error {
-  constructor(pattern: string) {
-    super(`could not find components matching to pattern: ${pattern}`);
-  }
-}

package/exceptions/no-test-files-found.ts

@@ -1,7 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-
-export class NoTestFilesFound extends BitError {
-  constructor(testRegex: string) {
-    super(`no test files for regex: '${testRegex}' found for any of the components in the workspace.`);
-  }
-}

package/index.ts

@@ -1,8 +0,0 @@
-import { TesterAspect } from './tester.aspect';
-
-export type { Tester, Tests, TesterContext, CallbackFn, SpecFiles, ComponentPatternsMap } from './tester';
-export type { TesterMain } from './tester.main.runtime';
-export type { TesterUI } from './tester.ui.runtime';
-
-export { TesterAspect };
-export default TesterAspect;

package/test.cmd.tsx

@@ -1,93 +0,0 @@
-import { Command, CommandOptions } from '@teambit/cli';
-import chalk from 'chalk';
-import { Logger } from '@teambit/logger';
-import { Workspace } from '@teambit/workspace';
-import { ConsumerNotFound } from '@teambit/legacy/dist/consumer/exceptions';
-import { Timer } from '@teambit/legacy/dist/toolbox/timer';
-import { Box, Text } from 'ink';
-import React from 'react';
-import { NoMatchingComponents } from './exceptions';
-
-import type { TesterMain } from './tester.main.runtime';
-
-type TestFlags = {
-  watch: boolean;
-  debug: boolean;
-  env?: string;
-  scope?: string;
-  junit?: string;
-  coverage?: boolean;
-};
-
-export class TestCmd implements Command {
-  name = 'test [pattern]';
-  description = 'test set of components in your workspace';
-  alias = 'at';
-  group = 'development';
-  shortDescription = '';
-  options = [
-    ['w', 'watch', 'start the tester in watch mode.'],
-    ['d', 'debug', 'start the tester in debug mode.'],
-    ['', 'junit <filepath>', 'write tests results as JUnit XML format into the specified file path'],
-    ['', 'coverage', 'show code coverage data'],
-    ['e', 'env <id>', 'test only the given env'],
-    ['s', 'scope <scope>', 'name of the scope to test'],
-    // TODO: we need to reduce this redundant casting every time.
-  ] as CommandOptions;
-
-  constructor(private tester: TesterMain, private workspace: Workspace, private logger: Logger) {}
-
-  async render(
-    [userPattern]: [string],
-    { watch = false, debug = false, env, scope, junit, coverage = false }: TestFlags
-  ) {
-    this.logger.off();
-    const timer = Timer.create();
-    const scopeName = typeof scope === 'string' ? scope : undefined;
-    timer.start();
-    if (!this.workspace) throw new ConsumerNotFound();
-    const pattern = userPattern && userPattern.toString();
-    const components =
-      pattern || scopeName ? await this.workspace.byPattern(pattern || '*', scopeName) : await this.workspace.list();
-
-    if (!components.length) throw new NoMatchingComponents(pattern);
-
-    this.logger.console(
-      `testing total of ${components.length} components in workspace '${chalk.cyan(this.workspace.name)}'`
-    );
-
-    let code = 0;
-    if (watch && !debug) {
-      await this.tester.watch(components, {
-        watch,
-        debug,
-        env,
-        coverage,
-      });
-    } else {
-      const tests = await this.tester.test(components, {
-        watch,
-        debug,
-        env,
-        junit,
-        coverage,
-      });
-      tests?.results?.forEach((test) => (test.data?.errors?.length ? (code = 1) : null));
-    }
-    const { seconds } = timer.stop();
-
-    if (watch) return <Box></Box>;
-    return {
-      code,
-      data: (
-        <Box>
-          <Text>tested </Text>
-          <Text color="cyan">{components.length} </Text>
-          <Text>components in </Text>
-          <Text color="cyan">{seconds} </Text>
-          <Text>seconds.</Text>
-        </Box>
-      ),
-    };
-  }
-}

package/tester.aspect.ts

@@ -1,7 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const TesterAspect = Aspect.create({
-  id: 'teambit.defender/tester',
-});
-
-export default TesterAspect;

package/tester.graphql.ts

@@ -1,83 +0,0 @@
-import { GraphqlMain, Schema } from '@teambit/graphql';
-import { ComponentFactory } from '@teambit/component';
-import { withFilter } from 'graphql-subscriptions';
-import gql from 'graphql-tag';
-
-import { TesterMain } from './tester.main.runtime';
-import { OnTestsChanged } from './tester.service';
-
-export function testerSchema(tester: TesterMain, graphql: GraphqlMain): Schema {
-  return {
-    typeDefs: gql`
-      extend type ComponentHost {
-        getTests(id: String!): Tests
-      }
-
-      type Subscription {
-        testsChanged(id: String!): Tests
-      }
-
-      type Tests {
-        loading: Boolean!
-        testsResults: TestsResults
-      }
-
-      type TestsChanged {
-        testsResults: TestsResults
-      }
-
-      type TestsResults {
-        testFiles: [TestFiles]
-        success: Boolean
-        start: Int
-      }
-
-      type TestFiles {
-        file: String
-        tests: [Tests]
-        pass: Int
-        failed: Int
-        pending: Int
-        duration: Int
-        slow: Boolean
-        error: TestError
-      }
-
-      type TestError {
-        failureMessage: String
-        error: String
-      }
-
-      type Tests {
-        ancestor: [String]
-        name: String
-        duration: String
-        status: String
-        error: String
-      }
-    `,
-    resolvers: {
-      Subscription: {
-        testsChanged: {
-          subscribe: withFilter(
-            () => graphql.pubsub.asyncIterator(OnTestsChanged),
-            (payload, variables) => {
-              return payload.testsChanged.id === variables.id;
-            }
-          ),
-        },
-      },
-
-      ComponentHost: {
-        getTests: async (host: ComponentFactory, { id }: { id: string }) => {
-          const componentId = await host.resolveComponentId(id);
-          const component = await host.get(componentId);
-          if (!component) return null;
-          const testsResults = await tester.getTestsResults(component);
-          if (!testsResults) return null;
-          return testsResults;
-        },
-      },
-    },
-  };
-}