diff --git a/packages/cli/src/lib/new/collection/collectTemplateParams.test.ts b/packages/cli/src/lib/new/collection/collectPortableTemplateParams.test.ts similarity index 90% rename from packages/cli/src/lib/new/collection/collectTemplateParams.test.ts rename to packages/cli/src/lib/new/collection/collectPortableTemplateParams.test.ts index dfb54f846a..9ae5bff62e 100644 --- a/packages/cli/src/lib/new/collection/collectTemplateParams.test.ts +++ b/packages/cli/src/lib/new/collection/collectPortableTemplateParams.test.ts @@ -16,7 +16,7 @@ import inquirer from 'inquirer'; import { PortableTemplateConfig } from '../types'; -import { collectTemplateParams } from './collectTemplateParams'; +import { collectPortableTemplateParams } from './collectPortableTemplateParams'; describe('collectTemplateParams', () => { const baseOptions = { @@ -38,7 +38,7 @@ describe('collectTemplateParams', () => { }; it('should return default values if not provided', async () => { - await expect(collectTemplateParams(baseOptions)).resolves.toEqual({ + await expect(collectPortableTemplateParams(baseOptions)).resolves.toEqual({ pluginId: 'test', private: true, baseVersion: '0.1.0', @@ -51,7 +51,7 @@ describe('collectTemplateParams', () => { it('should include all non-standard global and prompt values', async () => { await expect( - collectTemplateParams({ + collectPortableTemplateParams({ ...baseOptions, config: { ...baseOptions.config, globals: { foo: 'bar' } }, }), @@ -71,7 +71,7 @@ describe('collectTemplateParams', () => { jest.spyOn(inquirer, 'prompt').mockResolvedValueOnce({ pluginId: 'other' }); await expect( - collectTemplateParams({ + collectPortableTemplateParams({ ...baseOptions, prefilledParams: {}, }), diff --git a/packages/cli/src/lib/new/collection/collectTemplateParams.ts b/packages/cli/src/lib/new/collection/collectPortableTemplateParams.ts similarity index 97% rename from packages/cli/src/lib/new/collection/collectTemplateParams.ts rename to packages/cli/src/lib/new/collection/collectPortableTemplateParams.ts index a6e603a1cd..1048ad39f2 100644 --- a/packages/cli/src/lib/new/collection/collectTemplateParams.ts +++ b/packages/cli/src/lib/new/collection/collectPortableTemplateParams.ts @@ -27,7 +27,7 @@ type CollectTemplateParamsOptions = { prefilledParams: Record; }; -export async function collectTemplateParams( +export async function collectPortableTemplateParams( options: CollectTemplateParamsOptions, ): Promise> { const { config, template, prefilledParams } = options; diff --git a/packages/cli/src/lib/new/createNewPackage.ts b/packages/cli/src/lib/new/createNewPackage.ts index 64ee02da3a..200ee475b0 100644 --- a/packages/cli/src/lib/new/createNewPackage.ts +++ b/packages/cli/src/lib/new/createNewPackage.ts @@ -14,11 +14,11 @@ * limitations under the License. */ -import { collectTemplateParams } from './collection/collectTemplateParams'; -import { loadConfig } from './preparation/loadConfig'; -import { executeNewTemplate } from './execution/executeTemplate'; +import { collectPortableTemplateParams } from './collection/collectPortableTemplateParams'; +import { loadPortableTemplateConfig } from './preparation/loadPortableTemplateConfig'; +import { executePortableTemplate } from './execution/executePortableTemplate'; import { selectTemplateInteractively } from './preparation/selectTemplateInteractively'; -import { loadTemplate } from './preparation/loadTemplate'; +import { loadPortableTemplate } from './preparation/loadPortableTemplate'; export type CreateNewPackageOptions = { preselectedTemplateId?: string; @@ -33,7 +33,7 @@ export type CreateNewPackageOptions = { }; export async function createNewPackage(options: CreateNewPackageOptions) { - const config = await loadConfig({ + const config = await loadPortableTemplateConfig({ globalOverrides: options.globals, }); @@ -41,15 +41,15 @@ export async function createNewPackage(options: CreateNewPackageOptions) { config, options.preselectedTemplateId, ); - const template = await loadTemplate(selectedTemplate); + const template = await loadPortableTemplate(selectedTemplate); - const params = await collectTemplateParams({ + const params = await collectPortableTemplateParams({ config, template, prefilledParams: options.prefilledParams, }); - await executeNewTemplate({ + await executePortableTemplate({ config, template, params, diff --git a/packages/cli/src/lib/new/execution/executeTemplate.ts b/packages/cli/src/lib/new/execution/executePortableTemplate.ts similarity index 97% rename from packages/cli/src/lib/new/execution/executeTemplate.ts rename to packages/cli/src/lib/new/execution/executePortableTemplate.ts index 26f7dd7e09..a5baaed6ff 100644 --- a/packages/cli/src/lib/new/execution/executeTemplate.ts +++ b/packages/cli/src/lib/new/execution/executePortableTemplate.ts @@ -36,7 +36,9 @@ type ExecuteNewTemplateOptions = { params: Record; }; -export async function executeNewTemplate(options: ExecuteNewTemplateOptions) { +export async function executePortableTemplate( + options: ExecuteNewTemplateOptions, +) { const { template, params } = options; const tmpDirManager = TemporaryDirectoryManager.create(); diff --git a/packages/cli/src/lib/new/preparation/loadTemplate.test.ts b/packages/cli/src/lib/new/preparation/loadPortableTemplate.test.ts similarity index 92% rename from packages/cli/src/lib/new/preparation/loadTemplate.test.ts rename to packages/cli/src/lib/new/preparation/loadPortableTemplate.test.ts index c653370cdc..1d6a67a345 100644 --- a/packages/cli/src/lib/new/preparation/loadTemplate.test.ts +++ b/packages/cli/src/lib/new/preparation/loadPortableTemplate.test.ts @@ -15,7 +15,7 @@ */ import { createMockDirectory } from '@backstage/backend-test-utils'; -import { loadTemplate } from './loadTemplate'; +import { loadPortableTemplate } from './loadPortableTemplate'; describe('loadTemplate', () => { it('should load a valid template', async () => { @@ -30,7 +30,7 @@ describe('loadTemplate', () => { }, }); - const result = await loadTemplate({ + const result = await loadPortableTemplate({ id: 'template1', target: mockDir.resolve('path/to/template1.yaml'), }); @@ -47,7 +47,7 @@ describe('loadTemplate', () => { const mockDir = createMockDirectory(); await expect( - loadTemplate({ + loadPortableTemplate({ id: 'template1', target: mockDir.resolve('path/to/template1.yaml'), }), @@ -64,7 +64,7 @@ describe('loadTemplate', () => { }); await expect( - loadTemplate({ + loadPortableTemplate({ id: 'template1', target: mockDir.resolve('path/to/template1.yaml'), }), @@ -75,7 +75,7 @@ describe('loadTemplate', () => { it('should throw an error if target is a remote URL', async () => { await expect( - loadTemplate({ + loadPortableTemplate({ id: 'template1', target: 'http://example.com', }), @@ -84,7 +84,7 @@ describe('loadTemplate', () => { it('should throw an error if target directory does not exist', async () => { await expect( - loadTemplate({ + loadPortableTemplate({ id: 'template1', target: 'http://example.com', }), @@ -103,7 +103,7 @@ describe('loadTemplate', () => { }); await expect( - loadTemplate({ + loadPortableTemplate({ id: 'template1', target: mockDir.resolve('path/to/template1.yaml'), }), @@ -126,7 +126,7 @@ describe('loadTemplate', () => { }); await expect( - loadTemplate({ + loadPortableTemplate({ id: 'template1', target: mockDir.resolve('path/to/template1.yaml'), }), diff --git a/packages/cli/src/lib/new/preparation/loadTemplate.ts b/packages/cli/src/lib/new/preparation/loadPortableTemplate.ts similarity index 98% rename from packages/cli/src/lib/new/preparation/loadTemplate.ts rename to packages/cli/src/lib/new/preparation/loadPortableTemplate.ts index d465b74666..e308f9ba2d 100644 --- a/packages/cli/src/lib/new/preparation/loadTemplate.ts +++ b/packages/cli/src/lib/new/preparation/loadPortableTemplate.ts @@ -45,7 +45,7 @@ const templateDefinitionSchema = z }) .strict(); -export async function loadTemplate({ +export async function loadPortableTemplate({ id, target, }: PortableTemplatePointer): Promise { diff --git a/packages/cli/src/lib/new/preparation/loadConfig.test.ts b/packages/cli/src/lib/new/preparation/loadPortableTemplateConfig.test.ts similarity index 92% rename from packages/cli/src/lib/new/preparation/loadConfig.test.ts rename to packages/cli/src/lib/new/preparation/loadPortableTemplateConfig.test.ts index 2f5367ef96..9f2ee8c490 100644 --- a/packages/cli/src/lib/new/preparation/loadConfig.test.ts +++ b/packages/cli/src/lib/new/preparation/loadPortableTemplateConfig.test.ts @@ -14,11 +14,11 @@ * limitations under the License. */ -import { loadConfig } from './loadConfig'; +import { loadPortableTemplateConfig } from './loadPortableTemplateConfig'; import { defaultTemplates } from '../defaultTemplates'; import { createMockDirectory } from '@backstage/backend-test-utils'; -describe('loadConfig', () => { +describe('loadPortableTemplateConfig', () => { const mockPkgJson = { backstage: { new: { @@ -61,7 +61,7 @@ describe('loadConfig', () => { }); await expect( - loadConfig({ + loadPortableTemplateConfig({ packagePath: mockDir.resolve('package.json'), }), ).resolves.toEqual({ @@ -75,7 +75,7 @@ describe('loadConfig', () => { }); await expect( - loadConfig({ + loadPortableTemplateConfig({ packagePath: mockDir.resolve('package.json'), globalOverrides: { key2: 'override', @@ -110,7 +110,7 @@ describe('loadConfig', () => { }); await expect( - loadConfig({ + loadPortableTemplateConfig({ packagePath: mockDir.resolve('package.json'), }), ).resolves.toEqual({ @@ -136,7 +136,7 @@ describe('loadConfig', () => { }); await expect( - loadConfig({ + loadPortableTemplateConfig({ packagePath: mockDir.resolve('package.json'), }), ).rejects.toThrow( @@ -150,7 +150,7 @@ describe('loadConfig', () => { }); await expect( - loadConfig({ + loadPortableTemplateConfig({ packagePath: mockDir.resolve('package.json'), }), ).resolves.toEqual({ @@ -160,7 +160,7 @@ describe('loadConfig', () => { }); await expect( - loadConfig({ + loadPortableTemplateConfig({ packagePath: mockDir.resolve('package.json'), globalOverrides: { key: 'override', diff --git a/packages/cli/src/lib/new/preparation/loadConfig.ts b/packages/cli/src/lib/new/preparation/loadPortableTemplateConfig.ts similarity index 97% rename from packages/cli/src/lib/new/preparation/loadConfig.ts rename to packages/cli/src/lib/new/preparation/loadPortableTemplateConfig.ts index 88ec2b45de..853f33c1f4 100644 --- a/packages/cli/src/lib/new/preparation/loadConfig.ts +++ b/packages/cli/src/lib/new/preparation/loadPortableTemplateConfig.ts @@ -58,7 +58,7 @@ type LoadConfigOptions = { globalOverrides?: Record; }; -export async function loadConfig( +export async function loadPortableTemplateConfig( options: LoadConfigOptions = {}, ): Promise { const pkgPath =