From 28a0882dbbe7c48d92649f3324f3321564109d0a Mon Sep 17 00:00:00 2001 From: Aramis Date: Mon, 12 Feb 2024 08:38:48 -0500 Subject: [PATCH] rename to transformLegacyPolicyToProcessor Signed-off-by: Aramis Signed-off-by: aramissennyeydd --- plugins/catalog-backend/api-report.md | 10 +++++----- plugins/catalog-backend/src/modules/core/index.ts | 2 +- ...est.ts => transformLegacyPolicyToProcessor.test.ts} | 10 +++++----- ...nsformer.ts => transformLegacyPolicyToProcessor.ts} | 2 +- plugins/catalog-node/src/extensions.ts | 2 +- 5 files changed, 13 insertions(+), 13 deletions(-) rename plugins/catalog-backend/src/modules/core/{policyToProcessorTransformer.test.ts => transformLegacyPolicyToProcessor.test.ts} (88%) rename plugins/catalog-backend/src/modules/core/{policyToProcessorTransformer.ts => transformLegacyPolicyToProcessor.ts} (96%) diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index e00436846a..92a2fbb280 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -421,11 +421,6 @@ export type PlaceholderResolverRead = PlaceholderResolverRead_2; // @public @deprecated (undocumented) export type PlaceholderResolverResolveUrl = PlaceholderResolverResolveUrl_2; -// @public -export function policyToProcessorTransformer( - policy: EntityPolicy, -): CatalogProcessor_2; - // @public export type ProcessingIntervalFunction = () => number; @@ -455,6 +450,11 @@ export const processingResult: Readonly<{ // @public @deprecated (undocumented) export type ScmLocationAnalyzer = ScmLocationAnalyzer_2; +// @public +export function transformLegacyPolicyToProcessor( + policy: EntityPolicy, +): CatalogProcessor_2; + // @public (undocumented) export class UrlReaderProcessor implements CatalogProcessor_2 { constructor(options: { reader: UrlReader; logger: Logger }); diff --git a/plugins/catalog-backend/src/modules/core/index.ts b/plugins/catalog-backend/src/modules/core/index.ts index 54f16c99b1..e410c3824d 100644 --- a/plugins/catalog-backend/src/modules/core/index.ts +++ b/plugins/catalog-backend/src/modules/core/index.ts @@ -24,4 +24,4 @@ export { PlaceholderProcessor } from './PlaceholderProcessor'; export type { PlaceholderProcessorOptions } from './PlaceholderProcessor'; export { UrlReaderProcessor } from './UrlReaderProcessor'; export { parseEntityYaml } from '../util/parse'; -export { policyToProcessorTransformer } from './policyToProcessorTransformer'; +export { transformLegacyPolicyToProcessor } from './transformLegacyPolicyToProcessor'; diff --git a/plugins/catalog-backend/src/modules/core/policyToProcessorTransformer.test.ts b/plugins/catalog-backend/src/modules/core/transformLegacyPolicyToProcessor.test.ts similarity index 88% rename from plugins/catalog-backend/src/modules/core/policyToProcessorTransformer.test.ts rename to plugins/catalog-backend/src/modules/core/transformLegacyPolicyToProcessor.test.ts index 46338ce6cb..a38074723c 100644 --- a/plugins/catalog-backend/src/modules/core/policyToProcessorTransformer.test.ts +++ b/plugins/catalog-backend/src/modules/core/transformLegacyPolicyToProcessor.test.ts @@ -15,10 +15,10 @@ */ import { Entity, EntityPolicy } from '@backstage/catalog-model'; -import { policyToProcessorTransformer } from './policyToProcessorTransformer'; +import { transformLegacyPolicyToProcessor } from './transformLegacyPolicyToProcessor'; import { clone } from 'lodash'; -describe('policyToProcessorTransformer', () => { +describe('transformLegacyPolicyToProcessor', () => { const entityToProcess: Entity = { apiVersion: 'backstage.io/v1alpha', kind: 'Component', @@ -33,7 +33,7 @@ describe('policyToProcessorTransformer', () => { return entity; }, }; - const processor = policyToProcessorTransformer(policy); + const processor = transformLegacyPolicyToProcessor(policy); const clonedEntity = clone(entityToProcess); const entity = await processor.preProcessEntity?.( clonedEntity, @@ -54,7 +54,7 @@ describe('policyToProcessorTransformer', () => { return undefined; }, }; - const processor = policyToProcessorTransformer(policy); + const processor = transformLegacyPolicyToProcessor(policy); const clonedEntity = clone(entityToProcess); const entity = await processor.preProcessEntity?.( clonedEntity, @@ -75,7 +75,7 @@ describe('policyToProcessorTransformer', () => { throw new TypeError('Invalid value for metadata.name'); }, }; - const processor = policyToProcessorTransformer(policy); + const processor = transformLegacyPolicyToProcessor(policy); const clonedEntity = clone(entityToProcess); await expect( processor.preProcessEntity?.( diff --git a/plugins/catalog-backend/src/modules/core/policyToProcessorTransformer.ts b/plugins/catalog-backend/src/modules/core/transformLegacyPolicyToProcessor.ts similarity index 96% rename from plugins/catalog-backend/src/modules/core/policyToProcessorTransformer.ts rename to plugins/catalog-backend/src/modules/core/transformLegacyPolicyToProcessor.ts index 69b2788779..40a3e749ab 100644 --- a/plugins/catalog-backend/src/modules/core/policyToProcessorTransformer.ts +++ b/plugins/catalog-backend/src/modules/core/transformLegacyPolicyToProcessor.ts @@ -23,7 +23,7 @@ import { CatalogProcessor } from '@backstage/plugin-catalog-node'; * @returns A new entity processor that uses the entity policy. * @public */ -export function policyToProcessorTransformer( +export function transformLegacyPolicyToProcessor( policy: EntityPolicy, ): CatalogProcessor { return { diff --git a/plugins/catalog-node/src/extensions.ts b/plugins/catalog-node/src/extensions.ts index 004a46445e..df1b8b0d57 100644 --- a/plugins/catalog-node/src/extensions.ts +++ b/plugins/catalog-node/src/extensions.ts @@ -48,7 +48,7 @@ export interface CatalogProcessingExtensionPoint { /** @alpha */ export interface CatalogModelExtensionPoint { /** - * @deprecated Use `policyToProcessorTransformer` from `@backstage/plugin-catalog-backend` + * @deprecated Use `transformLegacyPolicyToProcessor` from `@backstage/plugin-catalog-backend` * and `CatalogProcessingExtensionPoint.addProcessor` instead. */ addEntityPolicies(