Skip to content

Commit

Permalink
Refactor & fix workspace config normalization
Browse files Browse the repository at this point in the history
  • Loading branch information
@webpro
webpro committed Oct 6, 2023
1 parent 51d7e64 commit 9ed0775
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 69 deletions.
132 changes: 64 additions & 68 deletions src/ConfigurationChief.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,8 @@ const defaultConfig: Configuration = {
ignoreWorkspaces: [],
syncCompilers: new Map(),
asyncCompilers: new Map(),
workspaces: {
[ROOT_WORKSPACE_NAME]: getDefaultWorkspaceConfig(),
},
defaultWorkspaceConfig: getDefaultWorkspaceConfig(),
rootPluginConfigs: {},
};

const PLUGIN_NAMES = Object.keys(plugins);
Expand Down Expand Up @@ -109,6 +108,8 @@ export class ConfigurationChief {

resolvedConfigFilePath?: string;

rawConfig?: any;

constructor({ cwd, isProduction }: ConfigurationManagerOptions) {
this.cwd = cwd;
this.isProduction = isProduction;
Expand Down Expand Up @@ -142,13 +143,11 @@ export class ConfigurationChief {
throw new ConfigurationError(`Unable to find ${rawConfigArg} or package.json#knip`);
}

const rawLocalConfig = this.resolvedConfigFilePath ? await _load(this.resolvedConfigFilePath) : manifest.knip;
this.rawConfig = this.resolvedConfigFilePath ? await _load(this.resolvedConfigFilePath) : manifest.knip;

if (rawLocalConfig) {
// Have to partition compiler functions before Zod touches them
const parsedConfig = ConfigurationValidator.parse(partitionCompilers(rawLocalConfig));
this.config = this.normalize(parsedConfig);
}
// Have to partition compiler functions before Zod touches them
const parsedConfig = this.rawConfig ? ConfigurationValidator.parse(partitionCompilers(this.rawConfig)) : {};
this.config = this.normalize(parsedConfig);

await this.setWorkspaces();
}
Expand All @@ -161,72 +160,31 @@ export class ConfigurationChief {
return this.config.rules;
}

private normalize(rawLocalConfig: RawConfiguration) {
const initialWorkspaces = rawLocalConfig.workspaces ?? {
[ROOT_WORKSPACE_NAME]: {
...rawLocalConfig,
},
};

const rules = { ...defaultRules, ...rawLocalConfig.rules };
const include = rawLocalConfig.include ?? defaultConfig.include;
const exclude = rawLocalConfig.exclude ?? defaultConfig.exclude;
const ignore = arrayify(rawLocalConfig.ignore ?? defaultConfig.ignore);
const ignoreBinaries = rawLocalConfig.ignoreBinaries ?? [];
const ignoreExportsUsedInFile = rawLocalConfig.ignoreExportsUsedInFile ?? false;
const ignoreDependencies = rawLocalConfig.ignoreDependencies ?? [];
const ignoreWorkspaces = rawLocalConfig.ignoreWorkspaces ?? defaultConfig.ignoreWorkspaces;
private normalize(rawConfig: RawConfiguration) {
const rules = { ...defaultRules, ...rawConfig.rules };
const include = rawConfig.include ?? defaultConfig.include;
const exclude = rawConfig.exclude ?? defaultConfig.exclude;
const ignore = arrayify(rawConfig.ignore ?? defaultConfig.ignore);
const ignoreBinaries = rawConfig.ignoreBinaries ?? [];
const ignoreExportsUsedInFile = rawConfig.ignoreExportsUsedInFile ?? false;
const ignoreDependencies = rawConfig.ignoreDependencies ?? [];
const ignoreWorkspaces = rawConfig.ignoreWorkspaces ?? defaultConfig.ignoreWorkspaces;

const { syncCompilers, asyncCompilers } = rawLocalConfig;
const { syncCompilers, asyncCompilers } = rawConfig;

const extensions = [...Object.keys(syncCompilers ?? {}), ...Object.keys(asyncCompilers ?? {})];

const defaultWorkspaceConfig = getDefaultWorkspaceConfig(extensions);

const rootPluginConfigs: Partial<PluginsConfiguration> = {};

for (const [name, pluginConfig] of Object.entries(rawLocalConfig)) {
for (const [name, pluginConfig] of Object.entries(rawConfig)) {
const pluginName = toCamelCase(name) as PluginName;
if (PLUGIN_NAMES.includes(pluginName)) {
rootPluginConfigs[pluginName] = normalizePluginConfig(pluginConfig as RawPluginConfiguration);
}
}

const workspaces = Object.entries(initialWorkspaces)
.filter(([workspaceName]) => !ignoreWorkspaces.includes(workspaceName))
.reduce(
(workspaces, workspace) => {
const [workspaceName, workspaceConfig] = workspace;

const entry = workspaceConfig.entry ? arrayify(workspaceConfig.entry) : defaultWorkspaceConfig.entry;
const project = workspaceConfig.project ? arrayify(workspaceConfig.project) : defaultWorkspaceConfig.project;
const paths = workspaceConfig.paths ?? defaultWorkspaceConfig.paths;

workspaces[workspaceName] = {
entry,
project,
paths,
ignore: arrayify(workspaceConfig.ignore),
ignoreBinaries: arrayify(workspaceConfig.ignoreBinaries),
ignoreDependencies: arrayify(workspaceConfig.ignoreDependencies),
};

for (const [name, pluginConfig] of Object.entries(rootPluginConfigs)) {
const pluginName = toCamelCase(name) as PluginName;
if (pluginConfig) workspaces[workspaceName][pluginName] = pluginConfig;
}

for (const [name, pluginConfig] of Object.entries(workspaceConfig)) {
const pluginName = toCamelCase(name) as PluginName;
if (PLUGIN_NAMES.includes(pluginName)) {
workspaces[workspaceName][pluginName] = normalizePluginConfig(pluginConfig as RawPluginConfiguration);
}
}
return workspaces;
},
{} as Record<string, WorkspaceConfiguration>
);

return {
rules,
include,
Expand All @@ -238,7 +196,8 @@ export class ConfigurationChief {
ignoreWorkspaces,
syncCompilers: new Map(Object.entries(syncCompilers ?? {})),
asyncCompilers: new Map(Object.entries(asyncCompilers ?? {})),
workspaces,
rootPluginConfigs,
defaultWorkspaceConfig,
};
}

Expand Down Expand Up @@ -283,10 +242,18 @@ export class ConfigurationChief {
return manifestWorkspaces;
}

private getConfiguredWorkspaceKeys() {
const initialWorkspaces = this.rawConfig?.workspaces
? Object.keys(this.rawConfig.workspaces)
: [ROOT_WORKSPACE_NAME];
const ignoreWorkspaces = this.rawConfig?.ignoreWorkspaces ?? defaultConfig.ignoreWorkspaces;
return initialWorkspaces.filter(workspaceName => !ignoreWorkspaces.includes(workspaceName));
}

private async getAdditionalWorkspaceNames() {
const additionalWorkspaceKeys = Object.keys(this.config.workspaces);
const patterns = additionalWorkspaceKeys.filter(key => key.includes('*'));
const dirs = additionalWorkspaceKeys.filter(key => !key.includes('*'));
const workspaceKeys = this.getConfiguredWorkspaceKeys();
const patterns = workspaceKeys.filter(key => key.includes('*'));
const dirs = workspaceKeys.filter(key => !key.includes('*'));
const globbedDirs = await _dirGlob({ patterns, cwd: this.cwd });
return new Set(
[...dirs, ...globbedDirs].filter(
Expand Down Expand Up @@ -359,16 +326,45 @@ export class ConfigurationChief {
}

private getConfigKeyForWorkspace(workspaceName: string) {
return Object.keys(this.config.workspaces)
return this.getConfiguredWorkspaceKeys()
.sort(byPathDepth)
.reverse()
.find(pattern => micromatch.isMatch(workspaceName, pattern));
}

private getConfigForWorkspace(workspaceName: string) {
const key = this.getConfigKeyForWorkspace(workspaceName);
if (key && this.config?.workspaces?.[key]) return this.config.workspaces[key];
return getDefaultWorkspaceConfig();
const defaultConfig = this.config.defaultWorkspaceConfig;
const workspaces = this.rawConfig?.workspaces ?? {};
const workspaceConfig =
(key
? key === ROOT_WORKSPACE_NAME && !(ROOT_WORKSPACE_NAME in workspaces)
? this.rawConfig
: workspaces[key]
: {}) ?? {};

const entry = workspaceConfig.entry ? arrayify(workspaceConfig.entry) : defaultConfig.entry;
const project = workspaceConfig.project ? arrayify(workspaceConfig.project) : defaultConfig.project;
const paths = workspaceConfig.paths ?? defaultConfig.paths;
const ignore = arrayify(workspaceConfig.ignore);
const ignoreBinaries = arrayify(workspaceConfig.ignoreBinaries);
const ignoreDependencies = arrayify(workspaceConfig.ignoreDependencies);

const plugins: Partial<PluginsConfiguration> = {};

for (const [name, pluginConfig] of Object.entries(this.config.rootPluginConfigs)) {
const pluginName = toCamelCase(name) as PluginName;
if (typeof pluginConfig !== 'undefined') plugins[pluginName] = pluginConfig;
}

for (const [name, pluginConfig] of Object.entries(workspaceConfig)) {
const pluginName = toCamelCase(name) as PluginName;
if (PLUGIN_NAMES.includes(pluginName)) {
plugins[pluginName] = normalizePluginConfig(pluginConfig as RawPluginConfiguration);
}
}

return { entry, project, paths, ignore, ignoreBinaries, ignoreDependencies, ...plugins };
}

public getIssueTypesToReport() {
Expand Down
3 changes: 2 additions & 1 deletion src/types/config.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ export interface Configuration {
ignoreDependencies: string[];
ignoreExportsUsedInFile: boolean | Partial<Record<IgnorableExport, boolean>>;
ignoreWorkspaces: string[];
workspaces: Record<string, WorkspaceConfiguration>;
syncCompilers: SyncCompilers;
asyncCompilers: AsyncCompilers;
defaultWorkspaceConfig: WorkspaceConfiguration;
rootPluginConfigs: Partial<PluginsConfiguration>;
}

0 comments on commit 9ed0775

Please sign in to comment.