@teambit/merging 0.0.251 → 0.0.253

package/dist/config-merge-result.d.ts

@@ -0,0 +1,11 @@
+import { MergeStrategyResult } from './config-merger';
+export declare class ConfigMergeResult {
+    readonly compIdStr: string;
+    private results;
+    constructor(compIdStr: string, results: MergeStrategyResult[]);
+    hasConflicts(): boolean;
+    generateMergeConflictFile(): string | null;
+    getSuccessfullyMergedConfig(): Record<string, any>;
+    private formatConflict;
+    private concatenateConflicts;
+}

package/dist/config-merge-result.js

@@ -0,0 +1,78 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+require("core-js/modules/es.regexp.exec.js");
+require("core-js/modules/es.string.replace.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ConfigMergeResult = void 0;
+function _defineProperty2() {
+  const data = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+  _defineProperty2 = function () {
+    return data;
+  };
+  return data;
+}
+function _lodash() {
+  const data = require("lodash");
+  _lodash = function () {
+    return data;
+  };
+  return data;
+}
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2().default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+class ConfigMergeResult {
+  constructor(compIdStr, results) {
+    this.compIdStr = compIdStr;
+    this.results = results;
+  }
+  hasConflicts() {
+    return this.results.some(result => result.conflict);
+  }
+  generateMergeConflictFile() {
+    const resultsWithConflict = this.results.filter(result => result.conflict);
+    if (!resultsWithConflict.length) return null;
+    const configMergeAspects = (0, _lodash().compact)(resultsWithConflict.map(result => result.conflict));
+    const configMergeFormatted = configMergeAspects.map(c => this.formatConflict(c));
+    const conflictStr = `{
+${this.concatenateConflicts(configMergeFormatted)}
+}
+`;
+    return conflictStr;
+  }
+  getSuccessfullyMergedConfig() {
+    const resultsWithMergedConfig = this.results.filter(result => result.mergedConfig);
+    return resultsWithMergedConfig.reduce((acc, curr) => {
+      const currObject = {
+        [curr.id]: curr.mergedConfig
+      };
+      return _objectSpread(_objectSpread({}, acc), currObject);
+    }, {});
+  }
+  formatConflict(conflict) {
+    return conflict.split('\n')
+    // add 2 spaces before each line
+    .map(line => `  ${line}`)
+    // remove the white spaces before the conflict indicators
+    .map(line => line.replace(/ *(<<<<<<<|>>>>>>>|=======)/g, '$1')).join('\n');
+  }
+  concatenateConflicts(conflicts) {
+    const conflictsWithComma = conflicts.map((conflict, index) => {
+      if (index === conflicts.length - 1) return conflict; // last element in the array, no need to add a comma
+      if (conflict.endsWith('}')) return `${conflict},`; // ends normally with a closing brace, add a comma.
+      // if it doesn't end with a closing brace, it means it ends with a conflict indicator.
+      // the comma should be added after the last line with a closing brace.
+      const conflictSplit = conflict.split('\n');
+      // find the last line with '}' and add a comma after it
+      const lastLineWithClosingBrace = conflictSplit.lastIndexOf('  }');
+      conflictSplit[lastLineWithClosingBrace] += ',';
+      return conflictSplit.join('\n');
+    });
+    return conflictsWithComma.join('\n');
+  }
+}
+exports.ConfigMergeResult = ConfigMergeResult;
+
+//# sourceMappingURL=config-merge-result.js.map

package/dist/config-merge-result.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ConfigMergeResult","constructor","compIdStr","results","hasConflicts","some","result","conflict","generateMergeConflictFile","resultsWithConflict","filter","length","configMergeAspects","compact","map","configMergeFormatted","c","formatConflict","conflictStr","concatenateConflicts","getSuccessfullyMergedConfig","resultsWithMergedConfig","mergedConfig","reduce","acc","curr","currObject","id","split","line","replace","join","conflicts","conflictsWithComma","index","endsWith","conflictSplit","lastLineWithClosingBrace","lastIndexOf"],"sources":["config-merge-result.ts"],"sourcesContent":["import { compact } from 'lodash';\nimport { MergeStrategyResult } from './config-merger';\n\nexport class ConfigMergeResult {\n  constructor(readonly compIdStr: string, private results: MergeStrategyResult[]) {}\n  hasConflicts(): boolean {\n    return this.results.some((result) => result.conflict);\n  }\n  generateMergeConflictFile(): string | null {\n    const resultsWithConflict = this.results.filter((result) => result.conflict);\n    if (!resultsWithConflict.length) return null;\n    const configMergeAspects = compact(resultsWithConflict.map((result) => result.conflict));\n    const configMergeFormatted = configMergeAspects.map((c) => this.formatConflict(c));\n    const conflictStr = `{\n${this.concatenateConflicts(configMergeFormatted)}\n}\n`;\n    return conflictStr;\n  }\n  getSuccessfullyMergedConfig(): Record<string, any> {\n    const resultsWithMergedConfig = this.results.filter((result) => result.mergedConfig);\n    return resultsWithMergedConfig.reduce((acc, curr) => {\n      const currObject = { [curr.id]: curr.mergedConfig };\n      return { ...acc, ...currObject };\n    }, {});\n  }\n\n  private formatConflict(conflict: string) {\n    return (\n      conflict\n        .split('\\n')\n        // add 2 spaces before each line\n        .map((line) => `  ${line}`)\n        // remove the white spaces before the conflict indicators\n        .map((line) => line.replace(/ *(<<<<<<<|>>>>>>>|=======)/g, '$1'))\n        .join('\\n')\n    );\n  }\n\n  private concatenateConflicts(conflicts: string[]) {\n    const conflictsWithComma = conflicts.map((conflict, index) => {\n      if (index === conflicts.length - 1) return conflict; // last element in the array, no need to add a comma\n      if (conflict.endsWith('}')) return `${conflict},`; // ends normally with a closing brace, add a comma.\n      // if it doesn't end with a closing brace, it means it ends with a conflict indicator.\n      // the comma should be added after the last line with a closing brace.\n      const conflictSplit = conflict.split('\\n');\n      // find the last line with '}' and add a comma after it\n      const lastLineWithClosingBrace = conflictSplit.lastIndexOf('  }');\n      conflictSplit[lastLineWithClosingBrace] += ',';\n      return conflictSplit.join('\\n');\n    });\n    return conflictsWithComma.join('\\n');\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAAiC;AAAA;AAG1B,MAAMA,iBAAiB,CAAC;EAC7BC,WAAW,CAAUC,SAAiB,EAAUC,OAA8B,EAAE;IAAA,KAA3DD,SAAiB,GAAjBA,SAAiB;IAAA,KAAUC,OAA8B,GAA9BA,OAA8B;EAAG;EACjFC,YAAY,GAAY;IACtB,OAAO,IAAI,CAACD,OAAO,CAACE,IAAI,CAAEC,MAAM,IAAKA,MAAM,CAACC,QAAQ,CAAC;EACvD;EACAC,yBAAyB,GAAkB;IACzC,MAAMC,mBAAmB,GAAG,IAAI,CAACN,OAAO,CAACO,MAAM,CAAEJ,MAAM,IAAKA,MAAM,CAACC,QAAQ,CAAC;IAC5E,IAAI,CAACE,mBAAmB,CAACE,MAAM,EAAE,OAAO,IAAI;IAC5C,MAAMC,kBAAkB,GAAG,IAAAC,iBAAO,EAACJ,mBAAmB,CAACK,GAAG,CAAER,MAAM,IAAKA,MAAM,CAACC,QAAQ,CAAC,CAAC;IACxF,MAAMQ,oBAAoB,GAAGH,kBAAkB,CAACE,GAAG,CAAEE,CAAC,IAAK,IAAI,CAACC,cAAc,CAACD,CAAC,CAAC,CAAC;IAClF,MAAME,WAAW,GAAI;AACzB,EAAE,IAAI,CAACC,oBAAoB,CAACJ,oBAAoB,CAAE;AAClD;AACA,CAAC;IACG,OAAOG,WAAW;EACpB;EACAE,2BAA2B,GAAwB;IACjD,MAAMC,uBAAuB,GAAG,IAAI,CAAClB,OAAO,CAACO,MAAM,CAAEJ,MAAM,IAAKA,MAAM,CAACgB,YAAY,CAAC;IACpF,OAAOD,uBAAuB,CAACE,MAAM,CAAC,CAACC,GAAG,EAAEC,IAAI,KAAK;MACnD,MAAMC,UAAU,GAAG;QAAE,CAACD,IAAI,CAACE,EAAE,GAAGF,IAAI,CAACH;MAAa,CAAC;MACnD,uCAAYE,GAAG,GAAKE,UAAU;IAChC,CAAC,EAAE,CAAC,CAAC,CAAC;EACR;EAEQT,cAAc,CAACV,QAAgB,EAAE;IACvC,OACEA,QAAQ,CACLqB,KAAK,CAAC,IAAI;IACX;IAAA,CACCd,GAAG,CAAEe,IAAI,IAAM,KAAIA,IAAK,EAAC;IAC1B;IAAA,CACCf,GAAG,CAAEe,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC,CACjEC,IAAI,CAAC,IAAI,CAAC;EAEjB;EAEQZ,oBAAoB,CAACa,SAAmB,EAAE;IAChD,MAAMC,kBAAkB,GAAGD,SAAS,CAAClB,GAAG,CAAC,CAACP,QAAQ,EAAE2B,KAAK,KAAK;MAC5D,IAAIA,KAAK,KAAKF,SAAS,CAACrB,MAAM,GAAG,CAAC,EAAE,OAAOJ,QAAQ,CAAC,CAAC;MACrD,IAAIA,QAAQ,CAAC4B,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAQ,GAAE5B,QAAS,GAAE,CAAC,CAAC;MACnD;MACA;MACA,MAAM6B,aAAa,GAAG7B,QAAQ,CAACqB,KAAK,CAAC,IAAI,CAAC;MAC1C;MACA,MAAMS,wBAAwB,GAAGD,aAAa,CAACE,WAAW,CAAC,KAAK,CAAC;MACjEF,aAAa,CAACC,wBAAwB,CAAC,IAAI,GAAG;MAC9C,OAAOD,aAAa,CAACL,IAAI,CAAC,IAAI,CAAC;IACjC,CAAC,CAAC;IACF,OAAOE,kBAAkB,CAACF,IAAI,CAAC,IAAI,CAAC;EACtC;AACF;AAAC"}

package/dist/config-merge-result.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/config-merge-result.spec.js

@@ -0,0 +1,39 @@
+"use strict";
+
+require("core-js/modules/es.regexp.exec.js");
+function _chai() {
+  const data = require("chai");
+  _chai = function () {
+    return data;
+  };
+  return data;
+}
+function _configMergeResult() {
+  const data = require("./config-merge-result");
+  _configMergeResult = function () {
+    return data;
+  };
+  return data;
+}
+describe('ConfigMergeResult', function () {
+  describe('generateMergeConflictFile()', () => {
+    it('should generate a merge conflict file', () => {
+      const mergeStrategyResult1 = {
+        id: 'teambit.component/renaming',
+        conflict: '<<<<<<< 8e589ef07ce6e9f4e7b7dce5c409c269adfc76d5 (teambit.hello/world)\n' + '=======\n' + '"teambit.component/renaming": {\n' + '  "renamedFrom": {\n' + '    "scope": "teambit.design",\n' + '    "name": "ui/panels/tabs",\n' + '    "version": "1.0.17"\n' + '  }\n' + '}\n' + '>>>>>>> 93ba7ce641ab443b18243d93f2725604640c2090 (main)'
+      };
+      const mergeStrategyResult2 = {
+        id: 'teambit.envs/envs',
+        conflict: '"teambit.envs/envs": {\n' + '<<<<<<< 8e589ef07ce6e9f4e7b7dce5c409c269adfc76d5 (teambit.hello/world)\n' + '  "env": "teambit.community/envs/community-react@2.1.8"\n' + '=======\n' + '  "env": "teambit.design/envs/react@2.0.9"\n' + '>>>>>>> 93ba7ce641ab443b18243d93f2725604640c2090 (main)\n' + '}'
+      };
+      const configMergeResult = new (_configMergeResult().ConfigMergeResult)('compIdStr', [mergeStrategyResult1, mergeStrategyResult2]);
+      const generatedFile = configMergeResult.generateMergeConflictFile();
+      (0, _chai().expect)(generatedFile).to.not.be.null;
+      if (!generatedFile) throw new Error('generatedFile is null');
+      const generatedFileSplit = generatedFile.split('\n');
+      (0, _chai().expect)(generatedFileSplit[9]).to.equal('  },');
+    });
+  });
+});
+
+//# sourceMappingURL=config-merge-result.spec.js.map

package/dist/config-merge-result.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["describe","it","mergeStrategyResult1","id","conflict","mergeStrategyResult2","configMergeResult","ConfigMergeResult","generatedFile","generateMergeConflictFile","expect","to","not","be","null","Error","generatedFileSplit","split","equal"],"sources":["config-merge-result.spec.ts"],"sourcesContent":["import { expect } from 'chai';\nimport { ConfigMergeResult } from './config-merge-result';\n\ndescribe('ConfigMergeResult', function () {\n  describe('generateMergeConflictFile()', () => {\n    it('should generate a merge conflict file', () => {\n      const mergeStrategyResult1 = {\n        id: 'teambit.component/renaming',\n        conflict:\n          '<<<<<<< 8e589ef07ce6e9f4e7b7dce5c409c269adfc76d5 (teambit.hello/world)\\n' +\n          '=======\\n' +\n          '\"teambit.component/renaming\": {\\n' +\n          '  \"renamedFrom\": {\\n' +\n          '    \"scope\": \"teambit.design\",\\n' +\n          '    \"name\": \"ui/panels/tabs\",\\n' +\n          '    \"version\": \"1.0.17\"\\n' +\n          '  }\\n' +\n          '}\\n' +\n          '>>>>>>> 93ba7ce641ab443b18243d93f2725604640c2090 (main)',\n      };\n      const mergeStrategyResult2 = {\n        id: 'teambit.envs/envs',\n        conflict:\n          '\"teambit.envs/envs\": {\\n' +\n          '<<<<<<< 8e589ef07ce6e9f4e7b7dce5c409c269adfc76d5 (teambit.hello/world)\\n' +\n          '  \"env\": \"teambit.community/envs/community-react@2.1.8\"\\n' +\n          '=======\\n' +\n          '  \"env\": \"teambit.design/envs/react@2.0.9\"\\n' +\n          '>>>>>>> 93ba7ce641ab443b18243d93f2725604640c2090 (main)\\n' +\n          '}',\n      };\n      const configMergeResult = new ConfigMergeResult('compIdStr', [mergeStrategyResult1, mergeStrategyResult2]);\n      const generatedFile = configMergeResult.generateMergeConflictFile();\n      expect(generatedFile).to.not.be.null;\n      if (!generatedFile) throw new Error('generatedFile is null');\n      const generatedFileSplit = generatedFile.split('\\n');\n      expect(generatedFileSplit[9]).to.equal('  },');\n    });\n  });\n});\n"],"mappings":";;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAEAA,QAAQ,CAAC,mBAAmB,EAAE,YAAY;EACxCA,QAAQ,CAAC,6BAA6B,EAAE,MAAM;IAC5CC,EAAE,CAAC,uCAAuC,EAAE,MAAM;MAChD,MAAMC,oBAAoB,GAAG;QAC3BC,EAAE,EAAE,4BAA4B;QAChCC,QAAQ,EACN,0EAA0E,GAC1E,WAAW,GACX,mCAAmC,GACnC,sBAAsB,GACtB,kCAAkC,GAClC,iCAAiC,GACjC,2BAA2B,GAC3B,OAAO,GACP,KAAK,GACL;MACJ,CAAC;MACD,MAAMC,oBAAoB,GAAG;QAC3BF,EAAE,EAAE,mBAAmB;QACvBC,QAAQ,EACN,0BAA0B,GAC1B,0EAA0E,GAC1E,2DAA2D,GAC3D,WAAW,GACX,8CAA8C,GAC9C,2DAA2D,GAC3D;MACJ,CAAC;MACD,MAAME,iBAAiB,GAAG,KAAIC,sCAAiB,EAAC,WAAW,EAAE,CAACL,oBAAoB,EAAEG,oBAAoB,CAAC,CAAC;MAC1G,MAAMG,aAAa,GAAGF,iBAAiB,CAACG,yBAAyB,EAAE;MACnE,IAAAC,cAAM,EAACF,aAAa,CAAC,CAACG,EAAE,CAACC,GAAG,CAACC,EAAE,CAACC,IAAI;MACpC,IAAI,CAACN,aAAa,EAAE,MAAM,IAAIO,KAAK,CAAC,uBAAuB,CAAC;MAC5D,MAAMC,kBAAkB,GAAGR,aAAa,CAACS,KAAK,CAAC,IAAI,CAAC;MACpD,IAAAP,cAAM,EAACM,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAACL,EAAE,CAACO,KAAK,CAAC,MAAM,CAAC;IAChD,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/dist/config-merger.d.ts

@@ -0,0 +1,58 @@
+import { ComponentID } from '@teambit/component-id';
+import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config/extension-data';
+import { ConfigMergeResult } from './config-merge-result';
+declare type GenericConfigOrRemoved = Record<string, any> | '-';
+export declare type MergeStrategyResult = {
+    id: string;
+    mergedConfig?: GenericConfigOrRemoved;
+    conflict?: string;
+};
+/**
+ * perform 3-way merge of component configuration (aspects).
+ * normally this is needed when merging one lane into another. the component may have different aspects config in each lane.
+ * the baseAspects are the aspects of the component in the diversion point (the common ancestor of the two lanes).
+ * the currentAspects are the aspects of the component in the current lane.
+ * the otherAspects are the aspects of the component in the other lane. this is the lane we merge into the current lane.
+ *
+ * the basic merging strategy is a simple comparison between the aspect-configs, if they're different, we have a conflict.
+ * we have two special cases:
+ *
+ * 1. dependency-resolver: we do a deeper check for the policy, we compare each dependency separately. also, we take
+ * into account not only the config, but also the data. this is needed because some dependencies are automatically
+ * added by Bit (from the import statements in the code) and they're not in the config. the final config has the deps
+ * from both sources, the config and the data. The way we know to differentiate between them is by the "force" prop.
+ * the config has always force: true.
+ *
+ * 2. envs: if we don't treat it specially, the user will need to make the change not only in the envs aspect, but also
+ * in the deps-resolver (because the env is added as a devDependency) and also in the aspect itself (because
+ * teambit.envs/env has only the id and not the version). to make it simpler, we ignore the envs in the deps-resolver
+ * we ignore the individual aspect that is the env itself. we only show teambit.envs/env and we put the env id and
+ * version. later, when the component is loaded, we split the id and the version and put them in the correct places.
+ * see workspace.componentExtension / adjustEnvsOnConfigMerge for more details.
+ */
+export declare class ConfigMerger {
+    private compIdStr;
+    private workspaceIds;
+    private currentAspects;
+    private baseAspects;
+    private otherAspects;
+    private currentLabel;
+    private otherLabel;
+    private currentEnv;
+    private otherEnv;
+    private baseEnv?;
+    private handledExtIds;
+    constructor(compIdStr: string, workspaceIds: ComponentID[], currentAspects: ExtensionDataList, baseAspects: ExtensionDataList, otherAspects: ExtensionDataList, currentLabel: string, otherLabel: string);
+    merge(): ConfigMergeResult;
+    private populateEnvs;
+    private envStrategy;
+    private areConfigsEqual;
+    private mergePerStrategy;
+    private basicConfigMerge;
+    private basicConflictGenerator;
+    private depResolverStrategy;
+    private isIdInWorkspace;
+    private isEnv;
+    private getConfig;
+}
+export {};