Skip to content

Commit 08a8e02

Browse files
hanna-skrylhanna-skryl
committed
feat(create-cli): add monorepo setup mode
1 parent a04d8fa commit 08a8e02

File tree

10 files changed

+879
-127
lines changed

10 files changed

+879
-127
lines changed

‎packages/create-cli/src/index.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { parsePluginSlugs, validatePluginSlugs } from './lib/setup/plugins.js';
55
import {
66
CONFIG_FILE_FORMATS,
77
type PluginSetupBinding,
8+
SETUP_MODES,
89
} from './lib/setup/types.js';
910
import { runSetupWizard } from './lib/setup/wizard.js';
1011

@@ -33,6 +34,11 @@ const argv = await yargs(hideBin(process.argv))
3334
describe: 'Comma-separated plugin slugs to include (e.g. eslint,coverage)',
3435
coerce: parsePluginSlugs,
3536
})
37+
.option('mode', {
38+
type: 'string',
39+
choices: SETUP_MODES,
40+
describe: 'Setup mode (default: auto-detected from project)',
41+
})
3642
.check(parsed => {
3743
validatePluginSlugs(bindings, parsed.plugins);
3844
return true;

‎packages/create-cli/src/lib/setup/codegen.ts‎

Lines changed: 107 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import path from 'node:path';
2+
import { toUnixPath } from '@code-pushup/utils';
13
import type {
24
ConfigFileFormat,
35
ImportDeclarationStructure,
@@ -32,6 +34,60 @@ class CodeBuilder {
3234
}
3335
}
3436

37+
export function generateConfigSource(
38+
plugins: PluginCodegenResult[],
39+
format: ConfigFileFormat,
40+
): string {
41+
const builder = new CodeBuilder();
42+
addImports(builder, collectImports(plugins, format));
43+
if (format === 'ts') {
44+
builder.addLine('export default {');
45+
addPlugins(builder, plugins);
46+
builder.addLine('} satisfies CoreConfig;');
47+
} else {
48+
builder.addLine("/** @type {import('@code-pushup/models').CoreConfig} */");
49+
builder.addLine('export default {');
50+
addPlugins(builder, plugins);
51+
builder.addLine('};');
52+
}
53+
return builder.toString();
54+
}
55+
56+
export function generatePresetSource(
57+
plugins: PluginCodegenResult[],
58+
format: ConfigFileFormat,
59+
): string {
60+
const builder = new CodeBuilder();
61+
addImports(builder, collectImports(plugins, format));
62+
addPresetExport(builder, plugins, format);
63+
return builder.toString();
64+
}
65+
66+
export function generateProjectSource(
67+
projectName: string,
68+
presetImportPath: string,
69+
): string {
70+
const builder = new CodeBuilder();
71+
builder.addLine(
72+
formatImport({
73+
moduleSpecifier: presetImportPath,
74+
namedImports: ['createConfig'],
75+
}),
76+
);
77+
builder.addEmptyLine();
78+
builder.addLine(`export default await createConfig('${projectName}');`);
79+
return builder.toString();
80+
}
81+
82+
export function computeRelativePresetImport(
83+
projectRelativeDir: string,
84+
presetFilename: string,
85+
): string {
86+
const relativePath = path.relative(projectRelativeDir, presetFilename);
87+
const importPath = toUnixPath(relativePath).replace(/\.ts$/, '.js');
88+
return importPath.startsWith('.') ? importPath : `./${importPath}`;
89+
}
90+
3591
function formatImport({
3692
moduleSpecifier,
3793
defaultImport,
@@ -45,76 +101,77 @@ function formatImport({
45101
return `import ${type}${from}'${moduleSpecifier}';`;
46102
}
47103

48-
function collectTsImports(
49-
plugins: PluginCodegenResult[],
104+
function sortImports(
105+
imports: ImportDeclarationStructure[],
50106
): ImportDeclarationStructure[] {
51-
return [
52-
CORE_CONFIG_IMPORT,
53-
...plugins.flatMap(({ imports }) => imports),
54-
].toSorted((a, b) => a.moduleSpecifier.localeCompare(b.moduleSpecifier));
107+
return imports.toSorted((a, b) =>
108+
a.moduleSpecifier.localeCompare(b.moduleSpecifier),
109+
);
55110
}
56111

57-
function collectJsImports(
112+
function collectImports(
58113
plugins: PluginCodegenResult[],
114+
format: ConfigFileFormat,
59115
): ImportDeclarationStructure[] {
60-
return plugins
61-
.flatMap(({ imports }) => imports)
62-
.map(({ isTypeOnly: _, ...rest }) => rest)
63-
.toSorted((a, b) => a.moduleSpecifier.localeCompare(b.moduleSpecifier));
116+
const pluginImports = plugins.flatMap(({ imports }) => imports);
117+
if (format === 'ts') {
118+
return sortImports([CORE_CONFIG_IMPORT, ...pluginImports]);
119+
}
120+
return sortImports(pluginImports.map(({ isTypeOnly: _, ...rest }) => rest));
121+
}
122+
123+
function addImports(
124+
builder: CodeBuilder,
125+
imports: ImportDeclarationStructure[],
126+
): void {
127+
if (imports.length > 0) {
128+
builder.addLines(imports.map(formatImport));
129+
builder.addEmptyLine();
130+
}
64131
}
65132

66133
function addPlugins(
67134
builder: CodeBuilder,
68135
plugins: PluginCodegenResult[],
136+
depth = 1,
69137
): void {
138+
builder.addLine('plugins: [', depth);
70139
if (plugins.length === 0) {
71-
builder.addLine('plugins: [', 1);
72-
builder.addLine('// TODO: register some plugins', 2);
73-
builder.addLine('],', 1);
140+
builder.addLine('// TODO: register some plugins', depth + 1);
74141
} else {
75-
builder.addLine('plugins: [', 1);
76142
builder.addLines(
77143
plugins.map(({ pluginInit }) => `${pluginInit},`),
78-
2,
144+
depth + 1,
79145
);
80-
builder.addLine('],', 1);
81146
}
147+
builder.addLine('],', depth);
82148
}
83149

84-
export function generateConfigSource(
150+
function addPresetExport(
151+
builder: CodeBuilder,
85152
plugins: PluginCodegenResult[],
86153
format: ConfigFileFormat,
87-
): string {
88-
return format === 'ts'
89-
? generateTsConfig(plugins)
90-
: generateJsConfig(plugins);
91-
}
92-
93-
function generateTsConfig(plugins: PluginCodegenResult[]): string {
94-
const builder = new CodeBuilder();
95-
96-
builder.addLines(collectTsImports(plugins).map(formatImport));
97-
builder.addEmptyLine();
98-
builder.addLine('export default {');
99-
addPlugins(builder, plugins);
100-
builder.addLine('} satisfies CoreConfig;');
101-
102-
return builder.toString();
103-
}
104-
105-
function generateJsConfig(plugins: PluginCodegenResult[]): string {
106-
const builder = new CodeBuilder();
107-
108-
const pluginImports = collectJsImports(plugins);
109-
if (pluginImports.length > 0) {
110-
builder.addLines(pluginImports.map(formatImport));
111-
builder.addEmptyLine();
154+
): void {
155+
if (format === 'ts') {
156+
builder.addLines([
157+
'/**',
158+
' * Creates a Code PushUp config for a project.',
159+
' * @param project Project name',
160+
' */',
161+
'export async function createConfig(project: string): Promise<CoreConfig> {',
162+
]);
163+
} else {
164+
builder.addLines([
165+
'/**',
166+
' * Creates a Code PushUp config for a project.',
167+
' * @param {string} project Project name',
168+
" * @returns {Promise<import('@code-pushup/models').CoreConfig>}",
169+
' */',
170+
'export async function createConfig(project) {',
171+
]);
112172
}
113-
114-
builder.addLine("/** @type {import('@code-pushup/models').CoreConfig} */");
115-
builder.addLine('export default {');
116-
addPlugins(builder, plugins);
117-
builder.addLine('};');
118-
119-
return builder.toString();
173+
builder.addLine('return {', 1);
174+
addPlugins(builder, plugins, 2);
175+
builder.addLine('};', 1);
176+
builder.addLine('}');
120177
}

‎packages/create-cli/src/lib/setup/codegen.unit.test.ts‎

Lines changed: 88 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
1-
import { generateConfigSource } from './codegen.js';
1+
import {
2+
computeRelativePresetImport,
3+
generateConfigSource,
4+
generatePresetSource,
5+
generateProjectSource,
6+
} from './codegen.js';
27
import type { PluginCodegenResult } from './types.js';
38

9+
const ESLINT_PLUGIN: PluginCodegenResult = {
10+
imports: [
11+
{
12+
moduleSpecifier: '@code-pushup/eslint-plugin',
13+
defaultImport: 'eslintPlugin',
14+
},
15+
],
16+
pluginInit: "await eslintPlugin({ patterns: '.' })",
17+
};
18+
419
describe('generateConfigSource', () => {
520
describe('TypeScript format', () => {
621
it('should generate config with TODO placeholder when no plugins provided', () => {
@@ -187,3 +202,75 @@ describe('generateConfigSource', () => {
187202
});
188203
});
189204
});
205+
206+
describe('generatePresetSource', () => {
207+
it('should generate TS preset with function signature and plugins', () => {
208+
expect(generatePresetSource([ESLINT_PLUGIN], 'ts')).toMatchInlineSnapshot(`
209+
"import eslintPlugin from '@code-pushup/eslint-plugin';
210+
import type { CoreConfig } from '@code-pushup/models';
211+
212+
/**
213+
* Creates a Code PushUp config for a project.
214+
* @param project Project name
215+
*/
216+
export async function createConfig(project: string): Promise<CoreConfig> {
217+
return {
218+
plugins: [
219+
await eslintPlugin({ patterns: '.' }),
220+
],
221+
};
222+
}
223+
"
224+
`);
225+
});
226+
227+
it('should generate JS preset with JSDoc annotation', () => {
228+
expect(generatePresetSource([ESLINT_PLUGIN], 'js')).toMatchInlineSnapshot(`
229+
"import eslintPlugin from '@code-pushup/eslint-plugin';
230+
231+
/**
232+
* Creates a Code PushUp config for a project.
233+
* @param {string} project Project name
234+
* @returns {Promise<import('@code-pushup/models').CoreConfig>}
235+
*/
236+
export async function createConfig(project) {
237+
return {
238+
plugins: [
239+
await eslintPlugin({ patterns: '.' }),
240+
],
241+
};
242+
}
243+
"
244+
`);
245+
});
246+
});
247+
248+
describe('generateProjectSource', () => {
249+
it('should generate import and createConfig call', () => {
250+
const source = generateProjectSource(
251+
'my-app',
252+
'../../code-pushup.preset.js',
253+
);
254+
expect(source).toMatchInlineSnapshot(`
255+
"import { createConfig } from '../../code-pushup.preset.js';
256+
257+
export default await createConfig('my-app');
258+
"
259+
`);
260+
});
261+
});
262+
263+
describe('computeRelativePresetImport', () => {
264+
it.each([
265+
['packages/my-app', 'code-pushup.preset.ts', '../../code-pushup.preset.js'],
266+
['apps/web', 'code-pushup.preset.mjs', '../../code-pushup.preset.mjs'],
267+
['packages/lib', 'code-pushup.preset.js', '../../code-pushup.preset.js'],
268+
])(
269+
'should resolve %j relative to %j as %j',
270+
(projectDir, presetFilename, expected) => {
271+
expect(computeRelativePresetImport(projectDir, presetFilename)).toBe(
272+
expected,
273+
);
274+
},
275+
);
276+
});

‎packages/create-cli/src/lib/setup/config-format.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ export async function promptConfigFormat(
3535
});
3636
}
3737

38-
/** Returns `code-pushup.config.{ts,js,mjs}` based on format and ESM context. */
39-
export function resolveConfigFilename(
38+
export function resolveFilename(
39+
baseName: string,
4040
format: ConfigFileFormat,
4141
isEsm: boolean,
4242
): string {
4343
if (format === 'ts') {
44-
return 'code-pushup.config.ts';
44+
return `${baseName}.ts`;
4545
}
4646
if (format === 'js' && isEsm) {
47-
return 'code-pushup.config.js';
47+
return `${baseName}.js`;
4848
}
49-
return 'code-pushup.config.mjs';
49+
return `${baseName}.mjs`;
5050
}
5151

5252
export async function readPackageJson(targetDir: string): Promise<PackageJson> {

‎packages/create-cli/src/lib/setup/config-format.unit.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { vol } from 'memfs';
22
import { MEMFS_VOLUME } from '@code-pushup/test-utils';
3-
import { promptConfigFormat, resolveConfigFilename } from './config-format.js';
3+
import { promptConfigFormat, resolveFilename } from './config-format.js';
44
import type { ConfigFileFormat } from './types.js';
55

66
vi.mock('@inquirer/prompts', () => ({
@@ -18,7 +18,7 @@ describe('resolveConfigFilename', () => {
1818
['js', true, 'code-pushup.config.js'],
1919
['js', false, 'code-pushup.config.mjs'],
2020
])('should resolve format %j (ESM: %j) to %j', (format, isEsm, expected) => {
21-
expect(resolveConfigFilename(format, isEsm)).toBe(expected);
21+
expect(resolveFilename('code-pushup.config', format, isEsm)).toBe(expected);
2222
});
2323
});
2424

0 commit comments

Comments
 (0)