@teambit/tester 1.0.106 → 1.0.108

package/tester.ts

@@ -0,0 +1,172 @@
+import { Component, ComponentID, ComponentMap } from '@teambit/component';
+import { ExecutionContext } from '@teambit/envs';
+import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import { TestsResult } from '@teambit/tests-results';
+
+export class Tests {
+  constructor(public components: ComponentsResults[]) {}
+  get errors(): Error[] {
+    return this.components.map((comp) => comp.errors || []).flat();
+  }
+}
+
+export type ComponentsResults = {
+  /**
+   * component id.
+   */
+  componentId: ComponentID;
+  /**
+   * test results for the component.
+   */
+  results?: TestsResult;
+  /**
+   * aggregated errors from all files
+   */
+  errors?: Error[];
+
+  /**
+   * loading.
+   */
+  loading?: boolean;
+};
+
+export type SpecFiles = ComponentMap<AbstractVinyl[]>;
+
+export type ComponentPatternsEntry = {
+  /**
+   * component directory in the workspace.
+   */
+  componentDir: string;
+
+  /**
+   * paths to test files.
+   */
+  paths: { path: string; relative: string }[];
+
+  /**
+   * root dir of the package in bit_roots.
+   */
+  packageRootDir: string;
+};
+
+export type ComponentPatternsMap = ComponentMap<ComponentPatternsEntry>;
+
+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.
+   */
+  // workspace: 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;
+
+  /**
+   *
+   * additional test host dependencies
+   * This can be used in cases when you want specific dependencies to be resolved from the env during testing
+   * but you don't want these dependencies as peer dependencies of the component (as they are not used during runtime)
+   * An example for this is @angular/compiler, which during running tests you want to resolve from the env, but you don't
+   * need it during component runtime.
+   */
+  additionalHostDependencies?: string[];
+}
+
+/**
+ * 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 type CallbackFn = (testSuite: Tests) => void;

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;
+}