Skip to content
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.

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

feature(create) - re-generate ws config files on bit create #7808

Merged
merged 6 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
34 changes: 33 additions & 1 deletion scopes/generator/generator/component-generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ import componentIdToPackageName from '@teambit/legacy/dist/utils/bit/component-i
import DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';
import { NewComponentHelperMain } from '@teambit/new-component-helper';
import { ComponentID } from '@teambit/component-id';
import { WorkspaceConfigFilesMain } from '@teambit/workspace-config-files';

import { ComponentTemplate, ComponentFile, ComponentConfig } from './component-template';
import { CreateOptions } from './create.cmd';

Expand All @@ -36,6 +38,7 @@ export class ComponentGenerator {
private envs: EnvsMain,
private newComponentHelper: NewComponentHelperMain,
private tracker: TrackerMain,
private wsConfigFiles: WorkspaceConfigFilesMain,
private logger: Logger,
private aspectId: string,
private envId?: ComponentID
Expand Down Expand Up @@ -65,6 +68,13 @@ export class ComponentGenerator {
await this.workspace.bitMap.write();

const ids = generateResults.map((r) => r.id);
await this.tryLinkToNodeModules(ids);
await this.tryWriteConfigFiles(ids);

return generateResults;
}

private async tryLinkToNodeModules(ids: ComponentID[]) {
try {
await linkToNodeModulesByIds(
this.workspace,
Expand All @@ -75,8 +85,30 @@ export class ComponentGenerator {
`failed linking the new components to node_modules, please run "bit link" manually. error: ${err.message}`
);
}
}

return generateResults;
/**
* The function `tryWriteConfigFiles` attempts to write workspace config files, and if it fails, it logs an error
* message.
* @returns If the condition `!shouldWrite` is true, then nothing is being returned. Otherwise, if the `writeConfigFiles`
* function is successfully executed, nothing is being returned. If an error occurs during the execution of
* `writeConfigFiles`, an error message is being returned.
*/
private async tryWriteConfigFiles(ids: ComponentID[]) {
try {
const shouldWrite = !this.wsConfigFiles.isWorkspaceConfigWriteDisabled();
if (!shouldWrite) return;
ids.map((id) => this.workspace.clearComponentCache(id));
await this.wsConfigFiles.writeConfigFiles({
clean: true,
silent: true,
dedupe: true,
});
} catch (err: any) {
this.logger.consoleFailure(
`failed generating workspace config files, please run "bit ws-config write" manually. error: ${err.message}`
);
}
}

private async deleteGeneratedComponents(dirs: string[]) {
Expand Down
13 changes: 10 additions & 3 deletions scopes/generator/generator/generator.main.runtime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { EnvDefinition, EnvsAspect, EnvsMain } from '@teambit/envs';
import { CommunityAspect } from '@teambit/community';
import type { CommunityMain } from '@teambit/community';
import ComponentConfig from '@teambit/legacy/dist/consumer/config';
import WorkspaceConfigFilesAspect, { WorkspaceConfigFilesMain } from '@teambit/workspace-config-files';

import ComponentAspect, { ComponentID } from '@teambit/component';
import type { ComponentMain, Component } from '@teambit/component';
Expand Down Expand Up @@ -82,7 +83,8 @@ export class GeneratorMain {
private componentAspect: ComponentMain,
private tracker: TrackerMain,
private logger: Logger,
private git: GitMain
private git: GitMain,
private wsConfigFiles: WorkspaceConfigFilesMain
) {}

/**
Expand Down Expand Up @@ -303,6 +305,7 @@ export class GeneratorMain {
this.envs,
this.newComponentHelper,
this.tracker,
this.wsConfigFiles,
this.logger,
templateWithId.id,
templateWithId.envName ? ComponentID.fromString(templateWithId.id) : undefined
Expand Down Expand Up @@ -479,6 +482,7 @@ export class GeneratorMain {
TrackerAspect,
LoggerAspect,
GitAspect,
WorkspaceConfigFilesAspect,
];

static runtime = MainRuntime;
Expand All @@ -496,6 +500,7 @@ export class GeneratorMain {
tracker,
loggerMain,
git,
wsConfigFiles,
]: [
Workspace,
CLIMain,
Expand All @@ -507,7 +512,8 @@ export class GeneratorMain {
ComponentMain,
TrackerMain,
LoggerMain,
GitMain
GitMain,
WorkspaceConfigFilesMain
],
config: GeneratorConfig,
[componentTemplateSlot, workspaceTemplateSlot]: [ComponentTemplateSlot, WorkspaceTemplateSlot]
Expand All @@ -524,7 +530,8 @@ export class GeneratorMain {
componentAspect,
tracker,
logger,
git
git,
wsConfigFiles
);
const commands = [
new CreateCmd(generator, community.getDocsDomain()),
Expand Down
4 changes: 4 additions & 0 deletions scopes/harmony/config/workspace-template.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@
}
},

"teambit.workspace/workspace-config-files": {
"disableWorkspaceConfigWrite": false
},

/**
* workspace variants allow to set different subsets of configuration for components in your
* workspace. this is extremely useful for upgrading, aligning and building components with a new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import {
*/
export type WorkspaceConfigFilesAspectConfig = {
configsRootDir?: string;
disableWorkspaceConfigWrite?: boolean;
};

export type EnvConfigWriter = {
Expand Down Expand Up @@ -144,6 +145,14 @@ export class WorkspaceConfigFilesMain {
return cleanResults;
}

/**
* The function checks if the writing of workspace configuration is disabled.
* @returns the boolean value of `!!this.config.disableWorkspaceConfigWrite`.
*/
isWorkspaceConfigWriteDisabled() {
return !!this.config.disableWorkspaceConfigWrite;
}

/**
* It returns a list of all the config writers that have been registered with the config writer slot
* @returns An array of objects with aspectId and configWriter properties.
Expand Down Expand Up @@ -339,6 +348,10 @@ ${chalk.bold('Do you want to continue? [yes(y)/no(n)]')}`,

static runtime = MainRuntime;

static defaultConfig: Partial<WorkspaceConfigFilesAspectConfig> = {
disableWorkspaceConfigWrite: true,
};

static async provider(
[cli, workspace, envs, loggerAspect]: [CLIMain, Workspace, EnvsMain, LoggerMain],
config: WorkspaceConfigFilesAspectConfig
Expand Down