Skip to content

feat(config) - add option to remove "specific" aspect config #9488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(config) - add option to remove "specific" aspect config #9488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions components/legacy/extension-data/extension-data-list.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,12 @@ export class ExtensionDataList extends Array<ExtensionDataEntry> {
});
}

filterIgnoredFromSpecificExtensions(): ExtensionDataList {
return this.filter((entry) => {
return !entry.isIgnoredFromSpecific;
});
}

toConfigObject() {
const res = {};
this.forEach((entry) => {
Expand Down
15 changes: 11 additions & 4 deletions components/legacy/extension-data/extension-data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import { cloneDeep } from 'lodash';
import { cloneDeep, isObject } from 'lodash';
import { ComponentID } from '@teambit/component-id';

type ExtensionConfig = { [extName: string]: any } | RemoveExtensionSpecialSign;
type ExtensionConfig = { [extName: string]: any } | RemoveExtensionSpecialSign | IgnoreFromSpecificSpecialSign;

export const REMOVE_EXTENSION_SPECIAL_SIGN = '-';
export const IGNORE_FROM_SPECIFIC_SPECIAL_SIGN = '--';

type RemoveExtensionSpecialSign = '-';
type IgnoreFromSpecificSpecialSign = '--';

export class ExtensionDataEntry {
constructor(
Expand Down Expand Up @@ -33,7 +36,7 @@ export class ExtensionDataEntry {
return '';
}

get config(): { [key: string]: any } {
get config(): { [key: string]: any } | string {
if (this.rawConfig === REMOVE_EXTENSION_SPECIAL_SIGN) return {};
return this.rawConfig;
Comment on lines +39 to 41
Copy link

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The return type change from { [key: string]: any } to { [key: string]: any } | string is a breaking change that could affect consumers expecting only object types. Consider maintaining backward compatibility or documenting this breaking change.

Suggested change
get config(): { [key: string]: any } | string {
if (this.rawConfig === REMOVE_EXTENSION_SPECIAL_SIGN) return {};
return this.rawConfig;
get config(): { [key: string]: any } {
if (
this.rawConfig === REMOVE_EXTENSION_SPECIAL_SIGN ||
this.rawConfig === IGNORE_FROM_SPECIFIC_SPECIAL_SIGN
) {
return {};
}
return this.rawConfig as { [key: string]: any };

Copilot uses AI. Check for mistakes.
}
Expand All @@ -43,14 +46,18 @@ export class ExtensionDataEntry {
}

get isLegacy(): boolean {
if (this.config?.__legacy) return true;
if (isObject(this.config) && this.config?.__legacy) return true;
return false;
}

get isRemoved(): boolean {
return this.rawConfig === REMOVE_EXTENSION_SPECIAL_SIGN;
}

get isIgnoredFromSpecific(): boolean {
return this.rawConfig === IGNORE_FROM_SPECIFIC_SPECIAL_SIGN;
}

toModelObject() {
const extensionId =
this.extensionId && this.extensionId.serialize ? this.extensionId.serialize() : this.extensionId;
Expand Down
2 changes: 1 addition & 1 deletion components/legacy/extension-data/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export { ExtensionDataEntry, REMOVE_EXTENSION_SPECIAL_SIGN } from './extension-data';
export { ExtensionDataEntry, REMOVE_EXTENSION_SPECIAL_SIGN, IGNORE_FROM_SPECIFIC_SPECIAL_SIGN } from './extension-data';
export {
ExtensionDataList,
removeInternalConfigFields,
Expand Down
22 changes: 19 additions & 3 deletions scopes/workspace/workspace/aspects-merger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ComponentID } from '@teambit/component-id';
import { EnvsAspect } from '@teambit/envs';
import { DependencyResolverAspect } from '@teambit/dependency-resolver';
import { ExtensionDataList, getCompareExtPredicate } from '@teambit/legacy.extension-data';
import { partition, mergeWith, merge, uniq, uniqWith, compact } from 'lodash';
import { partition, mergeWith, merge, uniq, uniqWith, compact, isObject } from 'lodash';
import { MergeConfigConflict } from './exceptions/merge-config-conflict';
import { AspectSpecificField, ExtensionsOrigin, Workspace } from './workspace';
import { MergeConflictFile } from './merge-conflict-file';
Expand Down Expand Up @@ -120,13 +120,25 @@ export class AspectsMerger {
const extensionsToMerge: Array<{ origin: ExtensionsOrigin; extensions: ExtensionDataList; extraData: any }> = [];
let envWasFoundPreviously = false;
const removedExtensionIds: string[] = [];
const ignoredFromSpecificsExtensionIds: string[] = [];

const addExtensionsToMerge = async (extensions: ExtensionDataList, origin: ExtensionsOrigin, extraData?: any) => {
if (!extensions.length) {
return;
}

const isSpecific = ['BitmapFile', 'ModelSpecific', 'ComponentJsonFile'].includes(origin);

removedExtensionIds.push(...extensions.filter((extData) => extData.isRemoved).map((extData) => extData.stringId));
const extsWithoutRemoved = extensions.filterRemovedExtensions();
let extsWithoutIgnored = extensions;
if (isSpecific) {
ignoredFromSpecificsExtensionIds.push(
...extensions.filter((extData) => extData.isIgnoredFromSpecific).map((extData) => extData.stringId)
);
extsWithoutIgnored = extensions.filter((ext) => !ignoredFromSpecificsExtensionIds.includes(ext.stringId));
Copy link

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using includes() with an array for filtering can be inefficient for large datasets. Consider using a Set for ignoredFromSpecificsExtensionIds to improve lookup performance from O(n) to O(1).

Copilot uses AI. Check for mistakes.
}

const extsWithoutRemoved = extsWithoutIgnored.filterRemovedExtensions();
const selfInMergedExtensions = extsWithoutRemoved.findExtension(componentId.toStringWithoutVersion(), true);
const extsWithoutSelf = selfInMergedExtensions?.extensionId
? extsWithoutRemoved.remove(selfInMergedExtensions.extensionId)
Expand All @@ -149,7 +161,11 @@ export class AspectsMerger {
extensionsToMerge.push({ origin, extensions: extensionDataListFiltered, extraData });
};
const setDataListAsSpecific = (extensions: ExtensionDataList) => {
extensions.forEach((dataEntry) => (dataEntry.config[AspectSpecificField] = true));
extensions.forEach((dataEntry) => {
if (isObject(dataEntry.config)) {
dataEntry.config[AspectSpecificField] = true;
}
});
};
if (bitMapExtensions && !excludeOrigins.includes('BitmapFile')) {
const extensionDataList = ExtensionDataList.fromConfigObject(bitMapExtensions);
Expand Down