From db1066eec96294abbc9da34817c7afe973a0dae1 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Tue, 8 Feb 2022 15:00:12 +0100 Subject: [PATCH] chore: clarify function names Signed-off-by: Johan Haals --- packages/cli/src/commands/versions/bump.ts | 10 ++++++---- packages/release-manifests/api-report.md | 12 ++++++------ packages/release-manifests/src/index.ts | 6 +++--- .../release-manifests/src/manifest.test.ts | 18 +++++++++--------- packages/release-manifests/src/manifest.ts | 12 ++++++------ 5 files changed, 30 insertions(+), 28 deletions(-) diff --git a/packages/cli/src/commands/versions/bump.ts b/packages/cli/src/commands/versions/bump.ts index 85385616c9..fc455b9fbd 100644 --- a/packages/cli/src/commands/versions/bump.ts +++ b/packages/cli/src/commands/versions/bump.ts @@ -33,8 +33,8 @@ import { forbiddenDuplicatesFilter } from './lint'; import { BACKSTAGE_JSON } from '@backstage/cli-common'; import { runParallelWorkers } from '../../lib/parallel'; import { - getByReleaseLine, - getByVersion, + getManifestByReleaseLine, + getManifestByVersion, ReleaseManifest, } from '@backstage/release-manifests'; @@ -69,12 +69,14 @@ export default async (cmd: Command) => { let findTargetVersion: (name: string) => Promise; let releaseManifest: ReleaseManifest; if (semver.valid(cmd.release)) { - releaseManifest = await getByVersion({ version: cmd.release }); + releaseManifest = await getManifestByVersion({ version: cmd.release }); findTargetVersion = createStrictVersionFinder({ releaseManifest, }); } else { - releaseManifest = await getByReleaseLine({ releaseLine: cmd.release }); + releaseManifest = await getManifestByReleaseLine({ + releaseLine: cmd.release, + }); findTargetVersion = createVersionFinder({ releaseLine: cmd.releaseLine, releaseManifest, diff --git a/packages/release-manifests/api-report.md b/packages/release-manifests/api-report.md index 6dc3dde258..1ffa35838b 100644 --- a/packages/release-manifests/api-report.md +++ b/packages/release-manifests/api-report.md @@ -4,22 +4,22 @@ ```ts // @public -export function getByReleaseLine( - options: GetByReleaseLineOptions, +export function getManifestByReleaseLine( + options: GetManifestByReleaseLineOptions, ): Promise; // @public -export type GetByReleaseLineOptions = { +export type GetManifestByReleaseLineOptions = { releaseLine: string; }; // @public -export function getByVersion( - options: GetByVersionOptions, +export function getManifestByVersion( + options: GetManifestByVersionOptions, ): Promise; // @public -export type GetByVersionOptions = { +export type GetManifestByVersionOptions = { version: string; }; diff --git a/packages/release-manifests/src/index.ts b/packages/release-manifests/src/index.ts index 25101d4cbf..f8ea22a3cb 100644 --- a/packages/release-manifests/src/index.ts +++ b/packages/release-manifests/src/index.ts @@ -20,9 +20,9 @@ * @packageDocumentation */ -export { getByVersion, getByReleaseLine } from './manifest'; +export { getManifestByVersion, getManifestByReleaseLine } from './manifest'; export type { ReleaseManifest, - GetByReleaseLineOptions, - GetByVersionOptions, + GetManifestByReleaseLineOptions, + GetManifestByVersionOptions, } from './manifest'; diff --git a/packages/release-manifests/src/manifest.test.ts b/packages/release-manifests/src/manifest.test.ts index efd5728fbc..70894e5431 100644 --- a/packages/release-manifests/src/manifest.test.ts +++ b/packages/release-manifests/src/manifest.test.ts @@ -15,11 +15,11 @@ */ import { setupRequestMockHandlers } from '@backstage/test-utils'; -import { getByReleaseLine, getByVersion } from './manifest'; +import { getManifestByReleaseLine, getManifestByVersion } from './manifest'; import { setupServer } from 'msw/node'; import { rest } from 'msw'; -describe('getByVersion', () => { +describe('getManifestByVersion', () => { const worker = setupServer(); setupRequestMockHandlers(worker); @@ -38,7 +38,7 @@ describe('getByVersion', () => { ), ); - const pkgs = await getByVersion({ version: '0.0.0' }); + const pkgs = await getManifestByVersion({ version: '0.0.0' }); expect(pkgs.packages).toEqual([ { name: '@backstage/core', @@ -46,13 +46,13 @@ describe('getByVersion', () => { }, ]); - await expect(getByVersion({ version: '999.0.1' })).rejects.toThrow( + await expect(getManifestByVersion({ version: '999.0.1' })).rejects.toThrow( 'No release found for 999.0.1 version', ); }); }); -describe('getByReleaseLine', () => { +describe('getManifestByReleaseLine', () => { const worker = setupServer(); setupRequestMockHandlers(worker); @@ -71,7 +71,7 @@ describe('getByReleaseLine', () => { ), ); - const pkgs = await getByReleaseLine({ releaseLine: 'main' }); + const pkgs = await getManifestByReleaseLine({ releaseLine: 'main' }); expect(pkgs.packages).toEqual([ { name: '@backstage/core', @@ -79,8 +79,8 @@ describe('getByReleaseLine', () => { }, ]); - await expect(getByReleaseLine({ releaseLine: 'foo' })).rejects.toThrow( - "No 'foo' release line found", - ); + await expect( + getManifestByReleaseLine({ releaseLine: 'foo' }), + ).rejects.toThrow("No 'foo' release line found"); }); }); diff --git a/packages/release-manifests/src/manifest.ts b/packages/release-manifests/src/manifest.ts index ab2fa6c9fa..4068f4c963 100644 --- a/packages/release-manifests/src/manifest.ts +++ b/packages/release-manifests/src/manifest.ts @@ -31,7 +31,7 @@ export type ReleaseManifest = { * Options for getByVersion. * @public */ -export type GetByVersionOptions = { +export type GetManifestByVersionOptions = { version: string; }; @@ -39,8 +39,8 @@ export type GetByVersionOptions = { * Returns a release manifest based on supplied version. * @public */ -export async function getByVersion( - options: GetByVersionOptions, +export async function getManifestByVersion( + options: GetManifestByVersionOptions, ): Promise { const url = `${VERSIONS_DOMAIN}/v1/releases/${encodeURIComponent( options.version, @@ -61,7 +61,7 @@ export async function getByVersion( * Options for getByReleaseLine. * @public */ -export type GetByReleaseLineOptions = { +export type GetManifestByReleaseLineOptions = { releaseLine: string; }; @@ -69,8 +69,8 @@ export type GetByReleaseLineOptions = { * Returns a release manifest based on supplied release line. * @public */ -export async function getByReleaseLine( - options: GetByReleaseLineOptions, +export async function getManifestByReleaseLine( + options: GetManifestByReleaseLineOptions, ): Promise { const url = `${VERSIONS_DOMAIN}/v1/tags/${encodeURIComponent( options.releaseLine,