From 90469c02c8c3a03aef6a7bc117fd169d5e2b7a10 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Wed, 8 Mar 2023 14:30:16 +0100 Subject: [PATCH] rename catalog modules to fit naming pattern MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/healthy-buses-live-1.md | 5 +++++ .changeset/healthy-buses-live-2.md | 5 +++++ .changeset/healthy-buses-live-3.md | 5 +++++ .changeset/healthy-buses-live-4.md | 5 +++++ .changeset/healthy-buses-live-5.md | 5 +++++ .changeset/healthy-buses-live-6.md | 5 +++++ .changeset/healthy-buses-live-7.md | 5 +++++ .changeset/healthy-buses-live-8.md | 5 +++++ .changeset/healthy-buses-live-9.md | 5 +++++ .../alpha-api-report.md | 2 +- .../catalog-backend-module-aws/src/alpha.ts | 2 +- .../catalogModuleAwsS3EntityProvider.test.ts} | 6 +++--- .../catalogModuleAwsS3EntityProvider.ts} | 2 +- .../src/module/index.ts | 17 +++++++++++++++++ .../alpha-api-report.md | 2 +- .../catalog-backend-module-azure/src/alpha.ts | 2 +- ...logModuleAzureDevOpsEntityProvider.test.ts} | 6 +++--- .../catalogModuleAzureDevOpsEntityProvider.ts} | 2 +- .../src/module/index.ts | 17 +++++++++++++++++ .../alpha-api-report.md | 2 +- .../src/alpha.ts | 2 +- .../src/index.ts | 2 +- ...ModuleBitbucketCloudEntityProvider.test.ts} | 8 ++++---- ...talogModuleBitbucketCloudEntityProvider.ts} | 4 ++-- .../src/module/index.ts | 17 +++++++++++++++++ .../BitbucketCloudEntityProvider.test.ts | 0 .../BitbucketCloudEntityProvider.ts | 0 .../BitbucketCloudEntityProviderConfig.test.ts | 0 .../BitbucketCloudEntityProviderConfig.ts | 0 .../alpha-api-report.md | 2 +- .../src/alpha.ts | 2 +- ...oduleBitbucketServerEntityProvider.test.ts} | 6 +++--- ...alogModuleBitbucketServerEntityProvider.ts} | 2 +- .../src/module/index.ts | 17 +++++++++++++++++ .../alpha-api-report.md | 2 +- .../catalog-backend-module-gerrit/src/alpha.ts | 2 +- .../catalogModuleGerritEntityProvider.test.ts} | 6 +++--- .../catalogModuleGerritEntityProvider.ts} | 2 +- .../src/module/index.ts | 17 +++++++++++++++++ .../alpha-api-report.md | 2 +- .../catalog-backend-module-github/src/alpha.ts | 2 +- .../catalogModuleGithubEntityProvider.test.ts} | 6 +++--- .../catalogModuleGithubEntityProvider.ts} | 2 +- .../src/module/index.ts | 17 +++++++++++++++++ .../alpha-api-report.md | 2 +- .../catalog-backend-module-gitlab/src/alpha.ts | 2 +- ...oduleGitlabDiscoveryEntityProvider.test.ts} | 6 +++--- ...alogModuleGitlabDiscoveryEntityProvider.ts} | 2 +- .../alpha-api-report.md | 2 +- ...IncrementalIngestionEntityProvider.test.ts} | 6 +++--- ...oduleIncrementalIngestionEntityProvider.ts} | 2 +- .../src/module/index.ts | 2 +- .../src/run.ts | 4 ++-- .../alpha-api-report.md | 4 ++-- .../src/alpha.ts | 3 +-- ...uleMicrosoftGraphOrgEntityProvider.test.ts} | 6 +++--- ...ogModuleMicrosoftGraphOrgEntityProvider.ts} | 8 ++++---- .../src/module/index.ts | 18 ++++++++++++++++++ 58 files changed, 228 insertions(+), 64 deletions(-) create mode 100644 .changeset/healthy-buses-live-1.md create mode 100644 .changeset/healthy-buses-live-2.md create mode 100644 .changeset/healthy-buses-live-3.md create mode 100644 .changeset/healthy-buses-live-4.md create mode 100644 .changeset/healthy-buses-live-5.md create mode 100644 .changeset/healthy-buses-live-6.md create mode 100644 .changeset/healthy-buses-live-7.md create mode 100644 .changeset/healthy-buses-live-8.md create mode 100644 .changeset/healthy-buses-live-9.md rename plugins/catalog-backend-module-aws/src/{service/AwsS3EntityProviderCatalogModule.test.ts => module/catalogModuleAwsS3EntityProvider.test.ts} (92%) rename plugins/catalog-backend-module-aws/src/{service/AwsS3EntityProviderCatalogModule.ts => module/catalogModuleAwsS3EntityProvider.ts} (96%) create mode 100644 plugins/catalog-backend-module-aws/src/module/index.ts rename plugins/catalog-backend-module-azure/src/{service/AzureDevOpsEntityProviderCatalogModule.test.ts => module/catalogModuleAzureDevOpsEntityProvider.test.ts} (92%) rename plugins/catalog-backend-module-azure/src/{service/AzureDevOpsEntityProviderCatalogModule.ts => module/catalogModuleAzureDevOpsEntityProvider.ts} (96%) create mode 100644 plugins/catalog-backend-module-azure/src/module/index.ts rename plugins/catalog-backend-module-bitbucket-cloud/src/{service/BitbucketCloudEntityProviderCatalogModule.test.ts => module/catalogModuleBitbucketCloudEntityProvider.test.ts} (90%) rename plugins/catalog-backend-module-bitbucket-cloud/src/{service/BitbucketCloudEntityProviderCatalogModule.ts => module/catalogModuleBitbucketCloudEntityProvider.ts} (93%) create mode 100644 plugins/catalog-backend-module-bitbucket-cloud/src/module/index.ts rename plugins/catalog-backend-module-bitbucket-cloud/src/{ => providers}/BitbucketCloudEntityProvider.test.ts (100%) rename plugins/catalog-backend-module-bitbucket-cloud/src/{ => providers}/BitbucketCloudEntityProvider.ts (100%) rename plugins/catalog-backend-module-bitbucket-cloud/src/{ => providers}/BitbucketCloudEntityProviderConfig.test.ts (100%) rename plugins/catalog-backend-module-bitbucket-cloud/src/{ => providers}/BitbucketCloudEntityProviderConfig.ts (100%) rename plugins/catalog-backend-module-bitbucket-server/src/{service/BitbucketServerEntityProviderCatalogModule.test.ts => module/catalogModuleBitbucketServerEntityProvider.test.ts} (92%) rename plugins/catalog-backend-module-bitbucket-server/src/{service/BitbucketServerEntityProviderCatalogModule.ts => module/catalogModuleBitbucketServerEntityProvider.ts} (96%) create mode 100644 plugins/catalog-backend-module-bitbucket-server/src/module/index.ts rename plugins/catalog-backend-module-gerrit/src/{service/GerritEntityProviderCatalogModule.test.ts => module/catalogModuleGerritEntityProvider.test.ts} (93%) rename plugins/catalog-backend-module-gerrit/src/{service/GerritEntityProviderCatalogModule.ts => module/catalogModuleGerritEntityProvider.ts} (96%) create mode 100644 plugins/catalog-backend-module-gerrit/src/module/index.ts rename plugins/catalog-backend-module-github/src/{service/GithubEntityProviderCatalogModule.test.ts => module/catalogModuleGithubEntityProvider.test.ts} (92%) rename plugins/catalog-backend-module-github/src/{service/GithubEntityProviderCatalogModule.ts => module/catalogModuleGithubEntityProvider.ts} (96%) create mode 100644 plugins/catalog-backend-module-github/src/module/index.ts rename plugins/catalog-backend-module-gitlab/src/{service/GitlabDiscoveryEntityProviderCatalogModule.test.ts => module/catalogModuleGitlabDiscoveryEntityProvider.test.ts} (92%) rename plugins/catalog-backend-module-gitlab/src/{service/GitlabDiscoveryEntityProviderCatalogModule.ts => module/catalogModuleGitlabDiscoveryEntityProvider.ts} (96%) rename plugins/catalog-backend-module-incremental-ingestion/src/module/{incrementalIngestionEntityProviderCatalogModule.test.ts => catalogModuleIncrementalIngestionEntityProvider.test.ts} (91%) rename plugins/catalog-backend-module-incremental-ingestion/src/module/{incrementalIngestionEntityProviderCatalogModule.ts => catalogModuleIncrementalIngestionEntityProvider.ts} (97%) rename plugins/catalog-backend-module-msgraph/src/{service/MicrosoftGraphOrgEntityProviderCatalogModule.test.ts => module/catalogModuleMicrosoftGraphOrgEntityProvider.test.ts} (92%) rename plugins/catalog-backend-module-msgraph/src/{service/MicrosoftGraphOrgEntityProviderCatalogModule.ts => module/catalogModuleMicrosoftGraphOrgEntityProvider.ts} (91%) create mode 100644 plugins/catalog-backend-module-msgraph/src/module/index.ts diff --git a/.changeset/healthy-buses-live-1.md b/.changeset/healthy-buses-live-1.md new file mode 100644 index 0000000000..7e433372df --- /dev/null +++ b/.changeset/healthy-buses-live-1.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch +--- + +Renamed `incrementalIngestionEntityProviderCatalogModule` to `catalogModuleIncrementalIngestionEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns). diff --git a/.changeset/healthy-buses-live-2.md b/.changeset/healthy-buses-live-2.md new file mode 100644 index 0000000000..ab577276d8 --- /dev/null +++ b/.changeset/healthy-buses-live-2.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-bitbucket-server': patch +--- + +Renamed `bitbucketServerEntityProviderCatalogModule` to `catalogModuleBitbucketServerEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns). diff --git a/.changeset/healthy-buses-live-3.md b/.changeset/healthy-buses-live-3.md new file mode 100644 index 0000000000..493236ea73 --- /dev/null +++ b/.changeset/healthy-buses-live-3.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-bitbucket-cloud': patch +--- + +Renamed `bitbucketCloudEntityProviderCatalogModule` to `catalogModuleBitbucketCloudEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns). diff --git a/.changeset/healthy-buses-live-4.md b/.changeset/healthy-buses-live-4.md new file mode 100644 index 0000000000..fdc223a7f4 --- /dev/null +++ b/.changeset/healthy-buses-live-4.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-msgraph': patch +--- + +Renamed `microsoftGraphOrgEntityProviderCatalogModule` to `catalogModuleMicrosoftGraphOrgEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns). diff --git a/.changeset/healthy-buses-live-5.md b/.changeset/healthy-buses-live-5.md new file mode 100644 index 0000000000..f540751696 --- /dev/null +++ b/.changeset/healthy-buses-live-5.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-gerrit': patch +--- + +Renamed `gerritEntityProviderCatalogModule` to `catalogModuleGerritEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns). diff --git a/.changeset/healthy-buses-live-6.md b/.changeset/healthy-buses-live-6.md new file mode 100644 index 0000000000..f293e56eae --- /dev/null +++ b/.changeset/healthy-buses-live-6.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-github': patch +--- + +Renamed `githubEntityProviderCatalogModule` to `catalogModuleGithubEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns). diff --git a/.changeset/healthy-buses-live-7.md b/.changeset/healthy-buses-live-7.md new file mode 100644 index 0000000000..7e7219bf01 --- /dev/null +++ b/.changeset/healthy-buses-live-7.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-gitlab': patch +--- + +Renamed `gitlabDiscoveryEntityProviderCatalogModule` to `catalogModuleGitlabDiscoveryEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns). diff --git a/.changeset/healthy-buses-live-8.md b/.changeset/healthy-buses-live-8.md new file mode 100644 index 0000000000..9137a3b31a --- /dev/null +++ b/.changeset/healthy-buses-live-8.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-azure': patch +--- + +Renamed `azureDevOpsEntityProviderCatalogModule` to `catalogModuleAzureDevOpsEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns). diff --git a/.changeset/healthy-buses-live-9.md b/.changeset/healthy-buses-live-9.md new file mode 100644 index 0000000000..dbcba51470 --- /dev/null +++ b/.changeset/healthy-buses-live-9.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-aws': patch +--- + +Renamed `awsS3EntityProviderCatalogModule` to `catalogModuleAwsS3EntityProviders` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns). diff --git a/plugins/catalog-backend-module-aws/alpha-api-report.md b/plugins/catalog-backend-module-aws/alpha-api-report.md index 8781975085..f78f6a802d 100644 --- a/plugins/catalog-backend-module-aws/alpha-api-report.md +++ b/plugins/catalog-backend-module-aws/alpha-api-report.md @@ -6,7 +6,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const awsS3EntityProviderCatalogModule: () => BackendFeature; +export const catalogModuleAwsS3EntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-aws/src/alpha.ts b/plugins/catalog-backend-module-aws/src/alpha.ts index 3ae30df0cb..c277a0a680 100644 --- a/plugins/catalog-backend-module-aws/src/alpha.ts +++ b/plugins/catalog-backend-module-aws/src/alpha.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { awsS3EntityProviderCatalogModule } from './service/AwsS3EntityProviderCatalogModule'; +export * from './module'; diff --git a/plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.test.ts similarity index 92% rename from plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.test.ts rename to plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.test.ts index 868a9535b4..1475da9e79 100644 --- a/plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.test.ts +++ b/plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.test.ts @@ -24,10 +24,10 @@ import { startTestBackend } from '@backstage/backend-test-utils'; import { ConfigReader } from '@backstage/config'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { Duration } from 'luxon'; -import { awsS3EntityProviderCatalogModule } from './AwsS3EntityProviderCatalogModule'; +import { catalogModuleAwsS3EntityProvider } from './catalogModuleAwsS3EntityProvider'; import { AwsS3EntityProvider } from '../providers'; -describe('awsS3EntityProviderCatalogModule', () => { +describe('catalogModuleAwsS3EntityProvider', () => { it('should register provider at the catalog extension point', async () => { let addedProviders: Array | undefined; let usedSchedule: TaskScheduleDefinition | undefined; @@ -66,7 +66,7 @@ describe('awsS3EntityProviderCatalogModule', () => { [coreServices.logger, getVoidLogger()], [coreServices.scheduler, scheduler], ], - features: [awsS3EntityProviderCatalogModule()], + features: [catalogModuleAwsS3EntityProvider()], }); expect(usedSchedule?.frequency).toEqual(Duration.fromISO('P1M')); diff --git a/plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.ts b/plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.ts similarity index 96% rename from plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.ts rename to plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.ts index 5d4170ec1c..452284e526 100644 --- a/plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-aws/src/module/catalogModuleAwsS3EntityProvider.ts @@ -27,7 +27,7 @@ import { AwsS3EntityProvider } from '../providers'; * * @alpha */ -export const awsS3EntityProviderCatalogModule = createBackendModule({ +export const catalogModuleAwsS3EntityProvider = createBackendModule({ pluginId: 'catalog', moduleId: 'awsS3EntityProvider', register(env) { diff --git a/plugins/catalog-backend-module-aws/src/module/index.ts b/plugins/catalog-backend-module-aws/src/module/index.ts new file mode 100644 index 0000000000..5644c034ea --- /dev/null +++ b/plugins/catalog-backend-module-aws/src/module/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export { catalogModuleAwsS3EntityProvider } from './catalogModuleAwsS3EntityProvider'; diff --git a/plugins/catalog-backend-module-azure/alpha-api-report.md b/plugins/catalog-backend-module-azure/alpha-api-report.md index 486aac7775..66551a2856 100644 --- a/plugins/catalog-backend-module-azure/alpha-api-report.md +++ b/plugins/catalog-backend-module-azure/alpha-api-report.md @@ -6,7 +6,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const azureDevOpsEntityProviderCatalogModule: () => BackendFeature; +export const catalogModuleAzureDevOpsEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-azure/src/alpha.ts b/plugins/catalog-backend-module-azure/src/alpha.ts index cc3c4a83af..c277a0a680 100644 --- a/plugins/catalog-backend-module-azure/src/alpha.ts +++ b/plugins/catalog-backend-module-azure/src/alpha.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { azureDevOpsEntityProviderCatalogModule } from './service/AzureDevOpsEntityProviderCatalogModule'; +export * from './module'; diff --git a/plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.test.ts similarity index 92% rename from plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.test.ts rename to plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.test.ts index a8e526e871..fa3b3d865e 100644 --- a/plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.test.ts +++ b/plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.test.ts @@ -24,10 +24,10 @@ import { startTestBackend } from '@backstage/backend-test-utils'; import { ConfigReader } from '@backstage/config'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { Duration } from 'luxon'; -import { azureDevOpsEntityProviderCatalogModule } from './AzureDevOpsEntityProviderCatalogModule'; +import { catalogModuleAzureDevOpsEntityProvider } from './catalogModuleAzureDevOpsEntityProvider'; import { AzureDevOpsEntityProvider } from '../providers'; -describe('azureDevOpsEntityProviderCatalogModule', () => { +describe('catalogModuleAzureDevOpsEntityProvider', () => { it('should register provider at the catalog extension point', async () => { let addedProviders: Array | undefined; let usedSchedule: TaskScheduleDefinition | undefined; @@ -69,7 +69,7 @@ describe('azureDevOpsEntityProviderCatalogModule', () => { [coreServices.logger, getVoidLogger()], [coreServices.scheduler, scheduler], ], - features: [azureDevOpsEntityProviderCatalogModule()], + features: [catalogModuleAzureDevOpsEntityProvider()], }); expect(usedSchedule?.frequency).toEqual(Duration.fromISO('P1M')); diff --git a/plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.ts similarity index 96% rename from plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.ts rename to plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.ts index 3fc1ddf3a4..ec8b6441ba 100644 --- a/plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-azure/src/module/catalogModuleAzureDevOpsEntityProvider.ts @@ -27,7 +27,7 @@ import { AzureDevOpsEntityProvider } from '../providers'; * * @alpha */ -export const azureDevOpsEntityProviderCatalogModule = createBackendModule({ +export const catalogModuleAzureDevOpsEntityProvider = createBackendModule({ pluginId: 'catalog', moduleId: 'azureDevOpsEntityProvider', register(env) { diff --git a/plugins/catalog-backend-module-azure/src/module/index.ts b/plugins/catalog-backend-module-azure/src/module/index.ts new file mode 100644 index 0000000000..cfa8c78548 --- /dev/null +++ b/plugins/catalog-backend-module-azure/src/module/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export { catalogModuleAzureDevOpsEntityProvider } from './catalogModuleAzureDevOpsEntityProvider'; diff --git a/plugins/catalog-backend-module-bitbucket-cloud/alpha-api-report.md b/plugins/catalog-backend-module-bitbucket-cloud/alpha-api-report.md index 77b4b77410..a5d0ffc665 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/alpha-api-report.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/alpha-api-report.md @@ -6,7 +6,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha (undocumented) -export const bitbucketCloudEntityProviderCatalogModule: () => BackendFeature; +export const catalogModuleBitbucketCloudEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/alpha.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/alpha.ts index e949dcb894..c277a0a680 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/alpha.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/alpha.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { bitbucketCloudEntityProviderCatalogModule } from './service/BitbucketCloudEntityProviderCatalogModule'; +export * from './module'; diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts index 1c15ad4e8f..d730d8618d 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/index.ts @@ -20,4 +20,4 @@ * @packageDocumentation */ -export { BitbucketCloudEntityProvider } from './BitbucketCloudEntityProvider'; +export { BitbucketCloudEntityProvider } from './providers/BitbucketCloudEntityProvider'; diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.test.ts similarity index 90% rename from plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.test.ts rename to plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.test.ts index 630c18b134..a34eae3750 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.test.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.test.ts @@ -23,10 +23,10 @@ import { startTestBackend, mockServices } from '@backstage/backend-test-utils'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha'; import { Duration } from 'luxon'; -import { bitbucketCloudEntityProviderCatalogModule } from './BitbucketCloudEntityProviderCatalogModule'; -import { BitbucketCloudEntityProvider } from '../BitbucketCloudEntityProvider'; +import { catalogModuleBitbucketCloudEntityProvider } from './catalogModuleBitbucketCloudEntityProvider'; +import { BitbucketCloudEntityProvider } from '../providers/BitbucketCloudEntityProvider'; -describe('bitbucketCloudEntityProviderCatalogModule', () => { +describe('catalogModuleBitbucketCloudEntityProvider', () => { it('should register provider at the catalog extension point', async () => { let addedProviders: Array | undefined; let addedSubscribers: Array | undefined; @@ -73,7 +73,7 @@ describe('bitbucketCloudEntityProviderCatalogModule', () => { }), [coreServices.scheduler, scheduler], ], - features: [bitbucketCloudEntityProviderCatalogModule()], + features: [catalogModuleBitbucketCloudEntityProvider()], }); expect(usedSchedule?.frequency).toEqual(Duration.fromISO('P1M')); diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.ts similarity index 93% rename from plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.ts rename to plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.ts index a95d99ceef..7c4f4a30b2 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/module/catalogModuleBitbucketCloudEntityProvider.ts @@ -24,12 +24,12 @@ import { catalogServiceRef, } from '@backstage/plugin-catalog-node/alpha'; import { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha'; -import { BitbucketCloudEntityProvider } from '../BitbucketCloudEntityProvider'; +import { BitbucketCloudEntityProvider } from '../providers/BitbucketCloudEntityProvider'; /** * @alpha */ -export const bitbucketCloudEntityProviderCatalogModule = createBackendModule({ +export const catalogModuleBitbucketCloudEntityProvider = createBackendModule({ pluginId: 'catalog', moduleId: 'bitbucketCloudEntityProvider', register(env) { diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/module/index.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/module/index.ts new file mode 100644 index 0000000000..f9654971be --- /dev/null +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/module/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export { catalogModuleBitbucketCloudEntityProvider } from './catalogModuleBitbucketCloudEntityProvider'; diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProvider.test.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProvider.test.ts similarity index 100% rename from plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProvider.test.ts rename to plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProvider.test.ts diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProvider.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProvider.ts similarity index 100% rename from plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProvider.ts rename to plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProvider.ts diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProviderConfig.test.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProviderConfig.test.ts similarity index 100% rename from plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProviderConfig.test.ts rename to plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProviderConfig.test.ts diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProviderConfig.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProviderConfig.ts similarity index 100% rename from plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProviderConfig.ts rename to plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProviderConfig.ts diff --git a/plugins/catalog-backend-module-bitbucket-server/alpha-api-report.md b/plugins/catalog-backend-module-bitbucket-server/alpha-api-report.md index 3177828f51..2cc53a3c16 100644 --- a/plugins/catalog-backend-module-bitbucket-server/alpha-api-report.md +++ b/plugins/catalog-backend-module-bitbucket-server/alpha-api-report.md @@ -6,7 +6,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha (undocumented) -export const bitbucketServerEntityProviderCatalogModule: () => BackendFeature; +export const catalogModuleBitbucketServerEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/src/alpha.ts b/plugins/catalog-backend-module-bitbucket-server/src/alpha.ts index d6227c29f1..c277a0a680 100644 --- a/plugins/catalog-backend-module-bitbucket-server/src/alpha.ts +++ b/plugins/catalog-backend-module-bitbucket-server/src/alpha.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { bitbucketServerEntityProviderCatalogModule } from './service/BitbucketServerEntityProviderCatalogModule'; +export * from './module'; diff --git a/plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.test.ts similarity index 92% rename from plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.test.ts rename to plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.test.ts index bdd7209364..d17b4a4c96 100644 --- a/plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.test.ts +++ b/plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.test.ts @@ -23,11 +23,11 @@ import { } from '@backstage/backend-tasks'; import { startTestBackend } from '@backstage/backend-test-utils'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; -import { bitbucketServerEntityProviderCatalogModule } from './BitbucketServerEntityProviderCatalogModule'; +import { catalogModuleBitbucketServerEntityProvider } from './catalogModuleBitbucketServerEntityProvider'; import { Duration } from 'luxon'; import { BitbucketServerEntityProvider } from '../providers'; -describe('bitbucketServerEntityProviderCatalogModule', () => { +describe('catalogModuleBitbucketServerEntityProvider', () => { it('should register provider at the catalog extension point', async () => { let addedProviders: Array | undefined; let usedSchedule: TaskScheduleDefinition | undefined; @@ -73,7 +73,7 @@ describe('bitbucketServerEntityProviderCatalogModule', () => { [coreServices.logger, getVoidLogger()], [coreServices.scheduler, scheduler], ], - features: [bitbucketServerEntityProviderCatalogModule()], + features: [catalogModuleBitbucketServerEntityProvider()], }); expect(usedSchedule?.frequency).toEqual(Duration.fromISO('P1M')); diff --git a/plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.ts similarity index 96% rename from plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.ts rename to plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.ts index deab47c9e9..354bce7d6d 100644 --- a/plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-bitbucket-server/src/module/catalogModuleBitbucketServerEntityProvider.ts @@ -25,7 +25,7 @@ import { BitbucketServerEntityProvider } from '../providers'; /** * @alpha */ -export const bitbucketServerEntityProviderCatalogModule = createBackendModule({ +export const catalogModuleBitbucketServerEntityProvider = createBackendModule({ pluginId: 'catalog', moduleId: 'bitbucketServerEntityProvider', register(env) { diff --git a/plugins/catalog-backend-module-bitbucket-server/src/module/index.ts b/plugins/catalog-backend-module-bitbucket-server/src/module/index.ts new file mode 100644 index 0000000000..160f099ae0 --- /dev/null +++ b/plugins/catalog-backend-module-bitbucket-server/src/module/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export { catalogModuleBitbucketServerEntityProvider } from './catalogModuleBitbucketServerEntityProvider'; diff --git a/plugins/catalog-backend-module-gerrit/alpha-api-report.md b/plugins/catalog-backend-module-gerrit/alpha-api-report.md index 03f5d099b9..5aee61f28a 100644 --- a/plugins/catalog-backend-module-gerrit/alpha-api-report.md +++ b/plugins/catalog-backend-module-gerrit/alpha-api-report.md @@ -6,7 +6,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha (undocumented) -export const gerritEntityProviderCatalogModule: () => BackendFeature; +export const catalogModuleGerritEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gerrit/src/alpha.ts b/plugins/catalog-backend-module-gerrit/src/alpha.ts index 8b03d9312a..c277a0a680 100644 --- a/plugins/catalog-backend-module-gerrit/src/alpha.ts +++ b/plugins/catalog-backend-module-gerrit/src/alpha.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { gerritEntityProviderCatalogModule } from './service/GerritEntityProviderCatalogModule'; +export * from './module'; diff --git a/plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.test.ts similarity index 93% rename from plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.test.ts rename to plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.test.ts index 51c1749c66..0511aa7b4c 100644 --- a/plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.test.ts +++ b/plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.test.ts @@ -24,10 +24,10 @@ import { startTestBackend } from '@backstage/backend-test-utils'; import { ConfigReader } from '@backstage/config'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { Duration } from 'luxon'; -import { gerritEntityProviderCatalogModule } from './GerritEntityProviderCatalogModule'; +import { catalogModuleGerritEntityProvider } from './catalogModuleGerritEntityProvider'; import { GerritEntityProvider } from '../providers/GerritEntityProvider'; -describe('gerritEntityProviderCatalogModule', () => { +describe('catalogModuleGerritEntityProvider', () => { it('should register provider at the catalog extension point', async () => { let addedProviders: Array | undefined; let usedSchedule: TaskScheduleDefinition | undefined; @@ -79,7 +79,7 @@ describe('gerritEntityProviderCatalogModule', () => { [coreServices.logger, getVoidLogger()], [coreServices.scheduler, scheduler], ], - features: [gerritEntityProviderCatalogModule()], + features: [catalogModuleGerritEntityProvider()], }); expect(usedSchedule?.frequency).toEqual(Duration.fromISO('P1M')); diff --git a/plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.ts similarity index 96% rename from plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.ts rename to plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.ts index 782c724094..814259fb40 100644 --- a/plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-gerrit/src/module/catalogModuleGerritEntityProvider.ts @@ -25,7 +25,7 @@ import { GerritEntityProvider } from '../providers/GerritEntityProvider'; /** * @alpha */ -export const gerritEntityProviderCatalogModule = createBackendModule({ +export const catalogModuleGerritEntityProvider = createBackendModule({ pluginId: 'catalog', moduleId: 'gerritEntityProvider', register(env) { diff --git a/plugins/catalog-backend-module-gerrit/src/module/index.ts b/plugins/catalog-backend-module-gerrit/src/module/index.ts new file mode 100644 index 0000000000..95760538e7 --- /dev/null +++ b/plugins/catalog-backend-module-gerrit/src/module/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export { catalogModuleGerritEntityProvider } from './catalogModuleGerritEntityProvider'; diff --git a/plugins/catalog-backend-module-github/alpha-api-report.md b/plugins/catalog-backend-module-github/alpha-api-report.md index eb13ec4558..0d4e16b4ea 100644 --- a/plugins/catalog-backend-module-github/alpha-api-report.md +++ b/plugins/catalog-backend-module-github/alpha-api-report.md @@ -6,7 +6,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const githubEntityProviderCatalogModule: () => BackendFeature; +export const catalogModuleGithubEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-github/src/alpha.ts b/plugins/catalog-backend-module-github/src/alpha.ts index 1b83eead82..c277a0a680 100644 --- a/plugins/catalog-backend-module-github/src/alpha.ts +++ b/plugins/catalog-backend-module-github/src/alpha.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { githubEntityProviderCatalogModule } from './service/GithubEntityProviderCatalogModule'; +export * from './module'; diff --git a/plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-github/src/module/catalogModuleGithubEntityProvider.test.ts similarity index 92% rename from plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.test.ts rename to plugins/catalog-backend-module-github/src/module/catalogModuleGithubEntityProvider.test.ts index 7c08e8947d..82a5552dba 100644 --- a/plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.test.ts +++ b/plugins/catalog-backend-module-github/src/module/catalogModuleGithubEntityProvider.test.ts @@ -24,10 +24,10 @@ import { startTestBackend } from '@backstage/backend-test-utils'; import { ConfigReader } from '@backstage/config'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { Duration } from 'luxon'; -import { githubEntityProviderCatalogModule } from './GithubEntityProviderCatalogModule'; +import { catalogModuleGithubEntityProvider } from './catalogModuleGithubEntityProvider'; import { GithubEntityProvider } from '../providers/GithubEntityProvider'; -describe('githubEntityProviderCatalogModule', () => { +describe('catalogModuleGithubEntityProvider', () => { it('should register provider at the catalog extension point', async () => { let addedProviders: Array | undefined; let usedSchedule: TaskScheduleDefinition | undefined; @@ -66,7 +66,7 @@ describe('githubEntityProviderCatalogModule', () => { [coreServices.logger, getVoidLogger()], [coreServices.scheduler, scheduler], ], - features: [githubEntityProviderCatalogModule()], + features: [catalogModuleGithubEntityProvider()], }); expect(usedSchedule?.frequency).toEqual(Duration.fromISO('P1M')); diff --git a/plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-github/src/module/catalogModuleGithubEntityProvider.ts similarity index 96% rename from plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.ts rename to plugins/catalog-backend-module-github/src/module/catalogModuleGithubEntityProvider.ts index 246f700248..997da3023b 100644 --- a/plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-github/src/module/catalogModuleGithubEntityProvider.ts @@ -27,7 +27,7 @@ import { GithubEntityProvider } from '../providers/GithubEntityProvider'; * * @alpha */ -export const githubEntityProviderCatalogModule = createBackendModule({ +export const catalogModuleGithubEntityProvider = createBackendModule({ pluginId: 'catalog', moduleId: 'githubEntityProvider', register(env) { diff --git a/plugins/catalog-backend-module-github/src/module/index.ts b/plugins/catalog-backend-module-github/src/module/index.ts new file mode 100644 index 0000000000..640a633093 --- /dev/null +++ b/plugins/catalog-backend-module-github/src/module/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export { catalogModuleGithubEntityProvider } from './catalogModuleGithubEntityProvider'; diff --git a/plugins/catalog-backend-module-gitlab/alpha-api-report.md b/plugins/catalog-backend-module-gitlab/alpha-api-report.md index 8912b4a7b2..f14b41d6c5 100644 --- a/plugins/catalog-backend-module-gitlab/alpha-api-report.md +++ b/plugins/catalog-backend-module-gitlab/alpha-api-report.md @@ -6,7 +6,7 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @alpha -export const gitlabDiscoveryEntityProviderCatalogModule: () => BackendFeature; +export const catalogModuleGitlabDiscoveryEntityProvider: () => BackendFeature; // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gitlab/src/alpha.ts b/plugins/catalog-backend-module-gitlab/src/alpha.ts index 883ffc13c4..ace970e3aa 100644 --- a/plugins/catalog-backend-module-gitlab/src/alpha.ts +++ b/plugins/catalog-backend-module-gitlab/src/alpha.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { gitlabDiscoveryEntityProviderCatalogModule } from './service/GitlabDiscoveryEntityProviderCatalogModule'; +export { catalogModuleGitlabDiscoveryEntityProvider } from './module/catalogModuleGitlabDiscoveryEntityProvider'; diff --git a/plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.test.ts similarity index 92% rename from plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.test.ts rename to plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.test.ts index efb86e4223..7a3d0a0e0d 100644 --- a/plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.test.ts +++ b/plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.test.ts @@ -24,10 +24,10 @@ import { startTestBackend } from '@backstage/backend-test-utils'; import { ConfigReader } from '@backstage/config'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { Duration } from 'luxon'; -import { gitlabDiscoveryEntityProviderCatalogModule } from './GitlabDiscoveryEntityProviderCatalogModule'; +import { catalogModuleGitlabDiscoveryEntityProvider } from './catalogModuleGitlabDiscoveryEntityProvider'; import { GitlabDiscoveryEntityProvider } from '../providers'; -describe('gitlabDiscoveryEntityProviderCatalogModule', () => { +describe('catalogModuleGitlabDiscoveryEntityProvider', () => { it('should register provider at the catalog extension point', async () => { let addedProviders: Array | undefined; let usedSchedule: TaskScheduleDefinition | undefined; @@ -78,7 +78,7 @@ describe('gitlabDiscoveryEntityProviderCatalogModule', () => { [coreServices.logger, getVoidLogger()], [coreServices.scheduler, scheduler], ], - features: [gitlabDiscoveryEntityProviderCatalogModule()], + features: [catalogModuleGitlabDiscoveryEntityProvider()], }); expect(usedSchedule?.frequency).toEqual(Duration.fromISO('P1M')); diff --git a/plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.ts similarity index 96% rename from plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.ts rename to plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.ts index 0adf5b18f2..ffae233319 100644 --- a/plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-gitlab/src/module/catalogModuleGitlabDiscoveryEntityProvider.ts @@ -27,7 +27,7 @@ import { GitlabDiscoveryEntityProvider } from '../providers'; * * @alpha */ -export const gitlabDiscoveryEntityProviderCatalogModule = createBackendModule({ +export const catalogModuleGitlabDiscoveryEntityProvider = createBackendModule({ pluginId: 'catalog', moduleId: 'gitlabDiscoveryEntityProvider', register(env) { diff --git a/plugins/catalog-backend-module-incremental-ingestion/alpha-api-report.md b/plugins/catalog-backend-module-incremental-ingestion/alpha-api-report.md index ec9c59a4c4..b11ec43cf5 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/alpha-api-report.md +++ b/plugins/catalog-backend-module-incremental-ingestion/alpha-api-report.md @@ -8,7 +8,7 @@ import { IncrementalEntityProvider } from '@backstage/plugin-catalog-backend-mod import { IncrementalEntityProviderOptions } from '@backstage/plugin-catalog-backend-module-incremental-ingestion'; // @alpha -export const incrementalIngestionEntityProviderCatalogModule: (options: { +export const catalogModuleIncrementalIngestionEntityProvider: (options: { providers: { provider: IncrementalEntityProvider; options: IncrementalEntityProviderOptions; diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/module/incrementalIngestionEntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.test.ts similarity index 91% rename from plugins/catalog-backend-module-incremental-ingestion/src/module/incrementalIngestionEntityProviderCatalogModule.test.ts rename to plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.test.ts index dbadf573a4..ef07b4cb10 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/module/incrementalIngestionEntityProviderCatalogModule.test.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.test.ts @@ -20,9 +20,9 @@ import { startTestBackend } from '@backstage/backend-test-utils'; import { ConfigReader } from '@backstage/config'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { IncrementalEntityProvider } from '../types'; -import { incrementalIngestionEntityProviderCatalogModule } from './incrementalIngestionEntityProviderCatalogModule'; +import { catalogModuleIncrementalIngestionEntityProvider } from './catalogModuleIncrementalIngestionEntityProvider'; -describe('bitbucketServerEntityProviderCatalogModule', () => { +describe('catalogModuleIncrementalIngestionEntityProvider', () => { it('should register provider at the catalog extension point', async () => { const provider1: IncrementalEntityProvider = { getProviderName: () => 'provider1', @@ -57,7 +57,7 @@ describe('bitbucketServerEntityProviderCatalogModule', () => { [coreServices.scheduler, scheduler], ], features: [ - incrementalIngestionEntityProviderCatalogModule({ + catalogModuleIncrementalIngestionEntityProvider({ providers: [ { provider: provider1, diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/module/incrementalIngestionEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.ts similarity index 97% rename from plugins/catalog-backend-module-incremental-ingestion/src/module/incrementalIngestionEntityProviderCatalogModule.ts rename to plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.ts index 261768c142..19d5742b46 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/module/incrementalIngestionEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/module/catalogModuleIncrementalIngestionEntityProvider.ts @@ -30,7 +30,7 @@ import { WrapperProviders } from './WrapperProviders'; * * @alpha */ -export const incrementalIngestionEntityProviderCatalogModule = +export const catalogModuleIncrementalIngestionEntityProvider = createBackendModule( (options: { providers: Array<{ diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/module/index.ts b/plugins/catalog-backend-module-incremental-ingestion/src/module/index.ts index 577cf193e2..9fcee99e01 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/module/index.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/module/index.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { incrementalIngestionEntityProviderCatalogModule } from './incrementalIngestionEntityProviderCatalogModule'; +export { catalogModuleIncrementalIngestionEntityProvider } from './catalogModuleIncrementalIngestionEntityProvider'; diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/run.ts b/plugins/catalog-backend-module-incremental-ingestion/src/run.ts index f1b6bd1529..f94c988237 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/run.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/run.ts @@ -25,7 +25,7 @@ import { import { ConfigReader } from '@backstage/config'; import { catalogPlugin } from '@backstage/plugin-catalog-backend/alpha'; import { IncrementalEntityProvider } from '.'; -import { incrementalIngestionEntityProviderCatalogModule } from './alpha'; +import { catalogModuleIncrementalIngestionEntityProvider } from './alpha'; const provider: IncrementalEntityProvider = { getProviderName: () => 'test-provider', @@ -63,7 +63,7 @@ async function main() { backend.add(catalogPlugin()); backend.add( - incrementalIngestionEntityProviderCatalogModule({ + catalogModuleIncrementalIngestionEntityProvider({ providers: [ { provider: provider, diff --git a/plugins/catalog-backend-module-msgraph/alpha-api-report.md b/plugins/catalog-backend-module-msgraph/alpha-api-report.md index ed30b83bc8..0fa093a1bc 100644 --- a/plugins/catalog-backend-module-msgraph/alpha-api-report.md +++ b/plugins/catalog-backend-module-msgraph/alpha-api-report.md @@ -9,10 +9,10 @@ import { OrganizationTransformer } from '@backstage/plugin-catalog-backend-modul import { UserTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; // @alpha -export const microsoftGraphOrgEntityProviderCatalogModule: () => BackendFeature; +export const catalogModuleMicrosoftGraphOrgEntityProvider: () => BackendFeature; // @alpha -export interface MicrosoftGraphOrgEntityProviderCatalogModuleOptions { +export interface CatalogModuleMicrosoftGraphOrgEntityProviderOptions { groupTransformer?: GroupTransformer | Record; organizationTransformer?: | OrganizationTransformer diff --git a/plugins/catalog-backend-module-msgraph/src/alpha.ts b/plugins/catalog-backend-module-msgraph/src/alpha.ts index 137808d881..c277a0a680 100644 --- a/plugins/catalog-backend-module-msgraph/src/alpha.ts +++ b/plugins/catalog-backend-module-msgraph/src/alpha.ts @@ -14,5 +14,4 @@ * limitations under the License. */ -export { microsoftGraphOrgEntityProviderCatalogModule } from './service/MicrosoftGraphOrgEntityProviderCatalogModule'; -export type { MicrosoftGraphOrgEntityProviderCatalogModuleOptions } from './service/MicrosoftGraphOrgEntityProviderCatalogModule'; +export * from './module'; diff --git a/plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.test.ts similarity index 92% rename from plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.test.ts rename to plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.test.ts index 3763553162..3362c75c95 100644 --- a/plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.test.ts +++ b/plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.test.ts @@ -24,10 +24,10 @@ import { startTestBackend } from '@backstage/backend-test-utils'; import { ConfigReader } from '@backstage/config'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { Duration } from 'luxon'; -import { microsoftGraphOrgEntityProviderCatalogModule } from './MicrosoftGraphOrgEntityProviderCatalogModule'; +import { catalogModuleMicrosoftGraphOrgEntityProvider } from './catalogModuleMicrosoftGraphOrgEntityProvider'; import { MicrosoftGraphOrgEntityProvider } from '../processors'; -describe('awsS3EntityProviderCatalogModule', () => { +describe('catalogModuleMicrosoftGraphOrgEntityProvider', () => { it('should register provider at the catalog extension point', async () => { let addedProviders: Array | undefined; let usedSchedule: TaskScheduleDefinition | undefined; @@ -71,7 +71,7 @@ describe('awsS3EntityProviderCatalogModule', () => { [coreServices.logger, getVoidLogger()], [coreServices.scheduler, scheduler], ], - features: [microsoftGraphOrgEntityProviderCatalogModule()], + features: [catalogModuleMicrosoftGraphOrgEntityProvider()], }); expect(usedSchedule?.frequency).toEqual(Duration.fromISO('PT30M')); diff --git a/plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.ts similarity index 91% rename from plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.ts rename to plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.ts index 11be567045..7cd8b65f0b 100644 --- a/plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-msgraph/src/module/catalogModuleMicrosoftGraphOrgEntityProvider.ts @@ -28,11 +28,11 @@ import { import { MicrosoftGraphOrgEntityProvider } from '../processors'; /** - * Options for {@link microsoftGraphOrgEntityProviderCatalogModule}. + * Options for {@link catalogModuleMicrosoftGraphOrgEntityProvider}. * * @alpha */ -export interface MicrosoftGraphOrgEntityProviderCatalogModuleOptions { +export interface CatalogModuleMicrosoftGraphOrgEntityProviderOptions { /** * The function that transforms a user entry in msgraph to an entity. * Optionally, you can pass separate transformers per provider ID. @@ -59,13 +59,13 @@ export interface MicrosoftGraphOrgEntityProviderCatalogModuleOptions { * * @alpha */ -export const microsoftGraphOrgEntityProviderCatalogModule = createBackendModule( +export const catalogModuleMicrosoftGraphOrgEntityProvider = createBackendModule( { pluginId: 'catalog', moduleId: 'microsoftGraphOrgEntityProvider', register( env, - options?: MicrosoftGraphOrgEntityProviderCatalogModuleOptions, + options?: CatalogModuleMicrosoftGraphOrgEntityProviderOptions, ) { env.registerInit({ deps: { diff --git a/plugins/catalog-backend-module-msgraph/src/module/index.ts b/plugins/catalog-backend-module-msgraph/src/module/index.ts new file mode 100644 index 0000000000..f53f41141c --- /dev/null +++ b/plugins/catalog-backend-module-msgraph/src/module/index.ts @@ -0,0 +1,18 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export { catalogModuleMicrosoftGraphOrgEntityProvider } from './catalogModuleMicrosoftGraphOrgEntityProvider'; +export type { CatalogModuleMicrosoftGraphOrgEntityProviderOptions } from './catalogModuleMicrosoftGraphOrgEntityProvider';