@teambit/component-compare 1.0.108 → 1.0.109

package/artifacts/preview/teambit_component_component_compare-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.component/component-compare-preview"]=t():e["teambit.component/component-compare-preview"]=t()}(self,(()=>(()=>{"use strict";var e={69198:(e,t,o)=>{var n={id:"teambit.component/component-compare@1.0.109",homepage:"https://bit.cloud/teambit/component/component-compare",exported:!0};function r(){const e=a(o(87363));return r=function(){return e},e}function a(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(t,"__esModule",{value:!0}),t.Logo=void 0,r.__bit_component=n,a.__bit_component=n;const i=()=>r().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},r().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/bit-icons/compare.svg"}));i.__bit_component=n,t.Logo=i},87363:e=>{e.exports=React}},t={};function o(n){var r=t[n];if(void 0!==r)return r.exports;var a=t[n]={exports:{}};return e[n](a,a.exports,o),a.exports}o.d=(e,t)=>{for(var n in t)o.o(t,n)&&!o.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},o.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var n={};return(()=>{o.r(n),o.d(n,{compositions:()=>d,compositions_metadata:()=>u,overview:()=>l});var e={};o.r(e),o.d(e,{default:()=>s});var t=o(69198);o(87363);const r=MdxJsReact,a=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 n in o)Object.prototype.hasOwnProperty.call(o,n)&&(e[n]=o[n])}return e},p.apply(this,arguments)}var c={},m="wrapper";function s(e){var t=e.components,o=function(e,t){if(null==e)return{};var o,n,r=function(e,t){if(null==e)return{};var o,n,r={},a=Object.keys(e);for(n=0;n<a.length;n++)o=a[n],t.indexOf(o)>=0||(r[o]=e[o]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)o=a[n],t.indexOf(o)>=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(r[o]=e[o])}return r}(e,i);return(0,r.mdx)(m,p({},c,o,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)(a.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,r.mdx)("p",null,(0,r.mdx)("a",{parentName:"p",href:"https://bit.cloud/blog/introducing-a-new-feature-component-compare-l4qyxtoo?baseVersion=0.0.5"},"Introducing Component Compare")),(0,r.mdx)("p",null,"Component Compare allows users to compare two component versions. It provides a unified view of all the following differences,"),(0,r.mdx)("ul",null,(0,r.mdx)("li",{parentName:"ul"},"Code: Modifications made to the source code of the component."),(0,r.mdx)("li",{parentName:"ul"},"Composition: Changes made to how the component looks visually."),(0,r.mdx)("li",{parentName:"ul"},"Tests: Changes made to how the component is tested."),(0,r.mdx)("li",{parentName:"ul"},"Dependencies: Changes made to the component's dependency graph."),(0,r.mdx)("li",{parentName:"ul"},"Overview: Changes to the auto-generated documentation for the component."),(0,r.mdx)("li",{parentName:"ul"},"Aspects: Changes made to the extensions for the component."),(0,r.mdx)("li",{parentName:"ul"},"Changelog: Changes exported between the two selected versions"))))}s.isMDXComponent=!0;const d=[t],l=[e],u={compositions:[{displayName:"Logo",identifier:"Logo"}]}})(),n})()));

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

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

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/component-compare",
-  "version": "1.0.108",
+  "version": "1.0.109",
   "homepage": "https://bit.cloud/teambit/component/component-compare",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.component",
     "name": "component-compare",
-    "version": "1.0.108"
+    "version": "1.0.109"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -21,23 +21,23 @@
     "@teambit/component.ui.component-compare.compare-aspects.compare-aspects": "0.0.145",
     "@teambit/component.ui.component-compare.component-compare": "0.0.171",
     "@teambit/ui-foundation.ui.react-router.slot-router": "0.0.506",
-    "@teambit/component": "1.0.108",
-    "@teambit/builder": "1.0.108",
-    "@teambit/cli": "0.0.840",
-    "@teambit/dependency-resolver": "1.0.108",
-    "@teambit/graphql": "1.0.108",
-    "@teambit/logger": "0.0.933",
-    "@teambit/scope": "1.0.108",
-    "@teambit/tester": "1.0.108",
-    "@teambit/workspace": "1.0.108",
-    "@teambit/ui": "1.0.108"
+    "@teambit/component": "1.0.109",
+    "@teambit/builder": "1.0.109",
+    "@teambit/cli": "0.0.841",
+    "@teambit/dependency-resolver": "1.0.109",
+    "@teambit/graphql": "1.0.109",
+    "@teambit/logger": "0.0.934",
+    "@teambit/scope": "1.0.109",
+    "@teambit/tester": "1.0.109",
+    "@teambit/workspace": "1.0.109",
+    "@teambit/ui": "1.0.109"
   },
   "devDependencies": {
     "@types/lodash.flatten": "4.4.6",
     "@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/component-compare.aspect.ts

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

package/component-compare.graphql.ts

@@ -1,77 +0,0 @@
-import gql from 'graphql-tag';
-import { ComponentCompareMain, ComponentCompareResult } from './component-compare.main.runtime';
-
-export function componentCompareSchema(componentCompareMain: ComponentCompareMain) {
-  return {
-    typeDefs: gql`
-      type FileCompareResult {
-        fileName: String!
-        baseContent: String!
-        compareContent: String!
-        status: String
-        diffOutput: String
-      }
-
-      type FieldCompareResult {
-        fieldName: String!
-        diffOutput: String
-      }
-
-      type ComponentCompareResult {
-        # unique id for graphql - baseId + compareId
-        id: String!
-        code(fileName: String): [FileCompareResult!]!
-        aspects(aspectName: String): [FieldCompareResult!]!
-        tests(fileName: String): [FileCompareResult!]
-      }
-
-      extend type ComponentHost {
-        compareComponent(baseId: String!, compareId: String!): ComponentCompareResult
-      }
-    `,
-    resolvers: {
-      ComponentHost: {
-        compareComponent: async (_, { baseId, compareId }: { baseId: string; compareId: string }) => {
-          return componentCompareMain.compare(baseId, compareId);
-        },
-      },
-      ComponentCompareResult: {
-        id: (result: ComponentCompareResult) => result.id,
-        code: (result: ComponentCompareResult, { fileName }: { fileName?: string }) => {
-          if (fileName) {
-            return result.code
-              .filter((codeFile) => codeFile.filePath === fileName)
-              .map((c) => ({ ...c, fileName: c.filePath, baseContent: c.fromContent, compareContent: c.toContent }));
-          }
-
-          return result.code.map((c) => ({
-            ...c,
-            fileName: c.filePath,
-            baseContent: c.fromContent,
-            compareContent: c.toContent,
-          }));
-        },
-        tests: (result: ComponentCompareResult, { fileName }: { fileName?: string }) => {
-          if (fileName) {
-            return result.tests
-              .filter((testFile) => testFile.filePath === fileName)
-              .map((c) => ({ ...c, fileName: c.filePath, baseContent: c.fromContent, compareContent: c.toContent }));
-          }
-
-          return result.tests.map((c) => ({
-            ...c,
-            fileName: c.filePath,
-            baseContent: c.fromContent,
-            compareContent: c.toContent,
-          }));
-        },
-        aspects: (result: ComponentCompareResult, { fieldName }: { fieldName?: string }) => {
-          if (fieldName) {
-            return result.fields.filter((field) => field.fieldName === fieldName);
-          }
-          return result.fields;
-        },
-      },
-    },
-  };
-}

package/component-compare.main.runtime.ts

@@ -1,230 +0,0 @@
-import { CLIAspect, CLIMain, MainRuntime } from '@teambit/cli';
-import { BitError } from '@teambit/bit-error';
-import { WorkspaceAspect, OutsideWorkspaceError, Workspace } from '@teambit/workspace';
-import { ComponentID } from '@teambit/component-id';
-import ComponentsList from '@teambit/legacy/dist/consumer/component/components-list';
-import hasWildcard from '@teambit/legacy/dist/utils/string/has-wildcard';
-import { ScopeMain, ScopeAspect } from '@teambit/scope';
-import { GraphqlAspect, GraphqlMain } from '@teambit/graphql';
-import BuilderAspect from '@teambit/builder';
-import GeneralError from '@teambit/legacy/dist/error/general-error';
-import DependencyResolverAspect, {
-  DependencyList,
-  DependencyResolverMain,
-  SerializedDependency,
-} from '@teambit/dependency-resolver';
-import { LoggerAspect, LoggerMain, Logger } from '@teambit/logger';
-import componentsDiff, {
-  diffBetweenVersionsObjects,
-  DiffResults,
-  FieldsDiff,
-  FileDiff,
-} from '@teambit/legacy/dist/consumer/component-ops/components-diff';
-import { TesterMain, TesterAspect } from '@teambit/tester';
-import ComponentAspect, { Component, ComponentMain } from '@teambit/component';
-import { componentCompareSchema } from './component-compare.graphql';
-import { ComponentCompareAspect } from './component-compare.aspect';
-import { DiffCmd } from './diff-cmd';
-
-export type ComponentCompareResult = {
-  id: string;
-  code: FileDiff[];
-  fields: FieldsDiff[];
-  tests: FileDiff[];
-};
-
-type ConfigDiff = {
-  version?: string;
-  dependencies?: string[];
-  aspects?: Record<string, any>;
-};
-
-export class ComponentCompareMain {
-  constructor(
-    private componentAspect: ComponentMain,
-    private scope: ScopeMain,
-    private logger: Logger,
-    private tester: TesterMain,
-    private depResolver: DependencyResolverMain,
-    private workspace?: Workspace
-  ) {}
-
-  async compare(baseIdStr: string, compareIdStr: string): Promise<ComponentCompareResult> {
-    const host = this.componentAspect.getHost();
-    const [baseCompId, compareCompId] = await host.resolveMultipleComponentIds([baseIdStr, compareIdStr]);
-    const modelComponent = await this.scope.legacyScope.getModelComponentIfExist(compareCompId);
-
-    if (!modelComponent) {
-      throw new GeneralError(`component ${compareCompId.toString()} doesn't have any version yet`);
-    }
-
-    const baseVersion = baseCompId.version as string;
-    const compareVersion = compareCompId.version as string;
-
-    const repository = this.scope.legacyScope.objects;
-    const baseVersionObject = await modelComponent.loadVersion(baseVersion, repository);
-    const compareVersionObject = await modelComponent.loadVersion(compareVersion, repository);
-
-    const diff: DiffResults = await diffBetweenVersionsObjects(
-      modelComponent,
-      baseVersionObject,
-      compareVersionObject,
-      baseVersion,
-      compareVersion,
-      this.scope.legacyScope,
-      {}
-    );
-
-    const baseComponent = await host.get(baseCompId);
-    const compareComponent = await host.get(compareCompId);
-
-    const baseTestFiles =
-      (baseComponent && (await this.tester.getTestFiles(baseComponent).map((file) => file.relative))) || [];
-    const compareTestFiles =
-      (compareComponent && (await this.tester.getTestFiles(compareComponent).map((file) => file.relative))) || [];
-
-    const allTestFiles = [...baseTestFiles, ...compareTestFiles];
-
-    const testFilesDiff = (diff.filesDiff || []).filter(
-      (fileDiff: FileDiff) => allTestFiles.includes(fileDiff.filePath) && fileDiff.status !== 'UNCHANGED'
-    );
-
-    const compareResult = {
-      id: `${baseCompId}-${compareCompId}`,
-      code: diff.filesDiff || [],
-      fields: diff.fieldsDiff || [],
-      tests: testFilesDiff,
-    };
-
-    return compareResult;
-  }
-
-  async diffByCLIValues(values: string[], verbose: boolean, table: boolean): Promise<any> {
-    if (!this.workspace) throw new OutsideWorkspaceError();
-    const consumer = this.workspace.consumer;
-    const { bitIds, version, toVersion } = await this.parseValues(values);
-    if (!bitIds || !bitIds.length) {
-      throw new BitError('there are no modified components to diff');
-    }
-    const diffResults = await componentsDiff(consumer, bitIds, version, toVersion, {
-      verbose,
-      formatDepsAsTable: table,
-    });
-    await consumer.onDestroy('diff');
-    return diffResults;
-  }
-
-  async getConfigForDiffById(id: string): Promise<ConfigDiff> {
-    const workspace = this.workspace;
-    if (!workspace) throw new OutsideWorkspaceError();
-    const componentId = await workspace.resolveComponentId(id);
-    const component = await workspace.scope.get(componentId, false);
-    if (!component) throw new Error(`getConfigForDiff: unable to find component ${id} in local scope`);
-    return this.getConfigForDiffByCompObject(component);
-  }
-
-  async getConfigForDiffByCompObject(component: Component) {
-    const depData = await this.depResolver.getDependencies(component);
-    const serializedToString = (dep: SerializedDependency) => {
-      const idWithoutVersion = dep.__type === 'package' ? dep.id : dep.id.split('@')[0];
-      return `${idWithoutVersion}@${dep.version} (${dep.lifecycle}) ${dep.source ? `(${dep.source})` : ''}`;
-    };
-    const serializeAndSort = (deps: DependencyList) => {
-      const serialized = deps.serialize().map(serializedToString);
-      return serialized.sort();
-    };
-    const serializeAspect = (comp: Component) => {
-      const aspects = comp.state.aspects.withoutEntries([BuilderAspect.id, DependencyResolverAspect.id]);
-      // return aspects.serialize();
-      return aspects.toLegacy().sortById().toConfigObject();
-    };
-    return {
-      version: component.id.version,
-      dependencies: serializeAndSort(depData),
-      aspects: serializeAspect(component),
-    };
-  }
-
-  private async parseValues(
-    values: string[]
-  ): Promise<{ bitIds: ComponentID[]; version?: string; toVersion?: string }> {
-    if (!this.workspace) throw new OutsideWorkspaceError();
-    // option #1: bit diff
-    // no arguments
-    if (!values.length) {
-      const componentIds = await this.workspace.listTagPendingIds();
-      return { bitIds: componentIds.map((id) => id) };
-    }
-    const firstValue = values[0];
-    const lastValue = values[values.length - 1];
-    const oneBeforeLastValue = values[values.length - 2];
-    const isLastItemVersion = ComponentID.isValidVersion(lastValue);
-    const isOneBeforeLastItemVersion = ComponentID.isValidVersion(oneBeforeLastValue);
-    // option #2: bit diff [ids...]
-    // all arguments are ids
-    if (!isLastItemVersion) {
-      return { bitIds: this.getBitIdsForDiff(values) };
-    }
-    // option #3: bit diff [id] [version]
-    // last argument is a version, first argument is id
-    if (!isOneBeforeLastItemVersion) {
-      if (values.length !== 2) {
-        throw new BitError(
-          `bit diff [id] [version] syntax was used, however, ${values.length} arguments were given instead of 2`
-        );
-      }
-      return { bitIds: this.getBitIdsForDiff([firstValue]), version: lastValue };
-    }
-    // option #4: bit diff [id] [version] [to_version]
-    // last argument and one before the last are versions, first argument is id
-    if (values.length !== 3) {
-      throw new BitError(
-        `bit diff [id] [version] [to_version] syntax was used, however, ${values.length} arguments were given instead of 3`
-      );
-    }
-    return { bitIds: this.getBitIdsForDiff([firstValue]), version: oneBeforeLastValue, toVersion: lastValue };
-  }
-
-  private getBitIdsForDiff(ids: string[]): ComponentID[] {
-    if (!this.workspace) throw new OutsideWorkspaceError();
-    const consumer = this.workspace.consumer;
-    if (hasWildcard(ids)) {
-      const componentsList = new ComponentsList(consumer);
-      return componentsList.listComponentsByIdsWithWildcard(ids);
-    }
-    return ids.map((id) => consumer.getParsedId(id));
-  }
-
-  static slots = [];
-  static dependencies = [
-    GraphqlAspect,
-    ComponentAspect,
-    ScopeAspect,
-    LoggerAspect,
-    CLIAspect,
-    WorkspaceAspect,
-    TesterAspect,
-    DependencyResolverAspect,
-  ];
-  static runtime = MainRuntime;
-  static async provider([graphql, component, scope, loggerMain, cli, workspace, tester, depResolver]: [
-    GraphqlMain,
-    ComponentMain,
-    ScopeMain,
-    LoggerMain,
-    CLIMain,
-    Workspace,
-    TesterMain,
-    DependencyResolverMain
-  ]) {
-    const logger = loggerMain.createLogger(ComponentCompareAspect.id);
-    const componentCompareMain = new ComponentCompareMain(component, scope, logger, tester, depResolver, workspace);
-    cli.register(new DiffCmd(componentCompareMain));
-    graphql.register(componentCompareSchema(componentCompareMain));
-    return componentCompareMain;
-  }
-}
-
-ComponentCompareAspect.addRuntime(ComponentCompareMain);
-
-export default ComponentCompareMain;

package/diff-cmd.ts

@@ -1,30 +0,0 @@
-import { Command, CommandOptions } from '@teambit/cli';
-import { WILDCARD_HELP } from '@teambit/legacy/dist/constants';
-import { DiffResults, outputDiffResults } from '@teambit/legacy/dist/consumer/component-ops/components-diff';
-import { ComponentCompareMain } from './component-compare.main.runtime';
-
-export class DiffCmd implements Command {
-  name = 'diff [values...]';
-  group = 'development';
-  description =
-    "show the diff between the components' current source files and config, and their latest snapshot or tag";
-  helpUrl = 'docs/components/merging-changes#compare-component-snaps';
-  extendedDescription = `bit diff => compare all modified components to their model version
-bit diff [ids...] => compare the specified components against their modified states
-bit diff [id] [version] => compare component's current files and configs to the specified version of the component
-bit diff [id] [version] [to_version] => compare component's files and configs between the specified version and the to_version provided
-${WILDCARD_HELP('diff')}`;
-  alias = '';
-  options = [
-    ['v', 'verbose', 'show a more verbose output where possible'],
-    ['t', 'table', 'show tables instead of plain text for dependencies diff'],
-  ] as CommandOptions;
-  loader = true;
-
-  constructor(private componentCompareMain: ComponentCompareMain) {}
-
-  async report([values = []]: [string[]], { verbose = false, table = false }: { verbose?: boolean; table: boolean }) {
-    const diffResults: DiffResults[] = await this.componentCompareMain.diffByCLIValues(values, verbose, table);
-    return outputDiffResults(diffResults);
-  }
-}

package/index.ts

@@ -1,6 +0,0 @@
-import { ComponentCompareAspect } from './component-compare.aspect';
-
-export type { ComponentCompareMain } from './component-compare.main.runtime';
-export type { ComponentCompareUI, ComponentCompareNavSlot } from './component-compare.ui.runtime';
-export { ComponentCompareAspect };
-export default ComponentCompareAspect;