Rename event modules to comply with naming pattern

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Johan Haals <johan.haals@gmail.com>

.changeset/big-gorillas-fail1.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-events-backend-module-bitbucket-cloud': patch
+---
+
+Renamed `bitbucketCloudEventRouterEventsModule` to `eventsModuleBitbucketCloudEventRouter` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).

.changeset/big-gorillas-fail2.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-events-backend-module-aws-sqs': patch
+---
+
+Renamed `awsSqsConsumingEventPublisherEventsModule` to `eventsModuleAwsSqsConsumingEventPublisher` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).

.changeset/big-gorillas-fail3.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-events-backend-module-gerrit': patch
+---
+
+Renamed `gerritEventRouterEventsModule` to `eventsModuleGerritEventRouter` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).

.changeset/big-gorillas-fail4.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-events-backend-module-github': patch
+---
+
+Renamed `githubEventRouterEventsModule` to `eventsModuleGithubEventRouter` and `githubWebhookEventsModule` to `eventsModuleGithubWebhook`, to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).

.changeset/big-gorillas-fail5.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-events-backend-module-gitlab': patch
+---
+
+Renamed `gitlabEventRouterEventsModule` to `eventsModuleGitlabEventRouter` and `gitlabWebhookEventsModule` to `eventsModuleGitlabWebhook` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).

.changeset/big-gorillas-fail6.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-events-backend-module-azure': patch
+---
+
+Renamed `azureDevOpsEventRouterEventsModule` to `eventsModuleAzureDevOpsEventRouter` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).

.changeset/stupid-games-brake.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-events-backend': patch
+---
+
+Updated README instructions

plugins/events-backend-module-aws-sqs/alpha-api-report.md

@@ -6,7 +6,7 @@
 import { BackendFeature } from '@backstage/backend-plugin-api';
 
 // @alpha
-export const awsSqsConsumingEventPublisherEventsModule: () => BackendFeature;
+export const eventsModuleAwsSqsConsumingEventPublisher: () => BackendFeature;
 
 // (No @packageDocumentation comment for this package)
 ```

plugins/events-backend-module-aws-sqs/src/alpha.ts

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export { awsSqsConsumingEventPublisherEventsModule } from './service/AwsSqsConsumingEventPublisherEventsModule';
+export { eventsModuleAwsSqsConsumingEventPublisher } from './service/eventsModuleAwsSqsConsumingEventPublisher';

plugins/events-backend-module-aws-sqs/src/service/eventsModuleAwsSqsConsumingEventPublisher.test.ts

@@ -20,10 +20,10 @@ import { startTestBackend } from '@backstage/backend-test-utils';
 import { ConfigReader } from '@backstage/config';
 import { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';
 import { TestEventBroker } from '@backstage/plugin-events-backend-test-utils';
-import { awsSqsConsumingEventPublisherEventsModule } from './AwsSqsConsumingEventPublisherEventsModule';
+import { eventsModuleAwsSqsConsumingEventPublisher } from './eventsModuleAwsSqsConsumingEventPublisher';
 import { AwsSqsConsumingEventPublisher } from '../publisher/AwsSqsConsumingEventPublisher';
 
-describe('awsSqsEventsModule', () => {
+describe('eventsModuleAwsSqsConsumingEventPublisher', () => {
   it('should be correctly wired and set up', async () => {
     const config = new ConfigReader({
       events: {
@@ -68,7 +68,7 @@ describe('awsSqsEventsModule', () => {
         [coreServices.logger, getVoidLogger()],
         [coreServices.scheduler, scheduler],
       ],
-      features: [awsSqsConsumingEventPublisherEventsModule()],
+      features: [eventsModuleAwsSqsConsumingEventPublisher()],
     });
 
     expect(addedPublishers).not.toBeUndefined();

plugins/events-backend-module-aws-sqs/src/service/eventsModuleAwsSqsConsumingEventPublisher.ts

@@ -27,9 +27,9 @@ import { AwsSqsConsumingEventPublisher } from '../publisher/AwsSqsConsumingEvent
  *
  * @alpha
  */
-export const awsSqsConsumingEventPublisherEventsModule = createBackendModule({
+export const eventsModuleAwsSqsConsumingEventPublisher = createBackendModule({
   pluginId: 'events',
-  moduleId: 'awsSqsConsumingEventPublisherEventsModule',
+  moduleId: 'awsSqsConsumingEventPublisher',
   register(env) {
     env.registerInit({
       deps: {

plugins/events-backend-module-azure/alpha-api-report.md

@@ -6,7 +6,7 @@
 import { BackendFeature } from '@backstage/backend-plugin-api';
 
 // @alpha
-export const azureDevOpsEventRouterEventsModule: () => BackendFeature;
+export const eventsModuleAzureDevOpsEventRouter: () => BackendFeature;
 
 // (No @packageDocumentation comment for this package)
 ```

plugins/events-backend-module-azure/src/alpha.ts

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export { azureDevOpsEventRouterEventsModule } from './service/AzureDevOpsEventRouterEventsModule';
+export { eventsModuleAzureDevOpsEventRouter } from './service/eventsModuleAzureDevOpsEventRouter';

plugins/events-backend-module-azure/src/service/eventsModuleAzureDevOpsEventRouter.test.ts

@@ -16,10 +16,10 @@
 
 import { startTestBackend } from '@backstage/backend-test-utils';
 import { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';
-import { azureDevOpsEventRouterEventsModule } from './AzureDevOpsEventRouterEventsModule';
+import { eventsModuleAzureDevOpsEventRouter } from './eventsModuleAzureDevOpsEventRouter';
 import { AzureDevOpsEventRouter } from '../router/AzureDevOpsEventRouter';
 
-describe('azureDevOpsEventRouterEventsModule', () => {
+describe('eventsModuleAzureDevOpsEventRouter', () => {
   it('should be correctly wired and set up', async () => {
     let addedPublisher: AzureDevOpsEventRouter | undefined;
     let addedSubscriber: AzureDevOpsEventRouter | undefined;
@@ -35,7 +35,7 @@ describe('azureDevOpsEventRouterEventsModule', () => {
     await startTestBackend({
       extensionPoints: [[eventsExtensionPoint, extensionPoint]],
       services: [],
-      features: [azureDevOpsEventRouterEventsModule()],
+      features: [eventsModuleAzureDevOpsEventRouter()],
     });
 
     expect(addedPublisher).not.toBeUndefined();

plugins/events-backend-module-azure/src/service/eventsModuleAzureDevOpsEventRouter.ts

@@ -25,7 +25,7 @@ import { AzureDevOpsEventRouter } from '../router/AzureDevOpsEventRouter';
  *
  * @alpha
  */
-export const azureDevOpsEventRouterEventsModule = createBackendModule({
+export const eventsModuleAzureDevOpsEventRouter = createBackendModule({
   pluginId: 'events',
   moduleId: 'azureDevOpsEventRouter',
   register(env) {

plugins/events-backend-module-bitbucket-cloud/alpha-api-report.md

@@ -6,7 +6,7 @@
 import { BackendFeature } from '@backstage/backend-plugin-api';
 
 // @alpha
-export const bitbucketCloudEventRouterEventsModule: () => BackendFeature;
+export const eventsModuleBitbucketCloudEventRouter: () => BackendFeature;
 
 // (No @packageDocumentation comment for this package)
 ```

plugins/events-backend-module-bitbucket-cloud/src/alpha.ts

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export { bitbucketCloudEventRouterEventsModule } from './service/BitbucketCloudEventRouterEventsModule';
+export { eventsModuleBitbucketCloudEventRouter } from './service/eventsModuleBitbucketCloudEventRouter';

plugins/events-backend-module-bitbucket-cloud/src/service/eventsModuleBitbucketCloudEventRouter.test.ts

@@ -16,10 +16,10 @@
 
 import { startTestBackend } from '@backstage/backend-test-utils';
 import { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';
-import { bitbucketCloudEventRouterEventsModule } from './BitbucketCloudEventRouterEventsModule';
+import { eventsModuleBitbucketCloudEventRouter } from './eventsModuleBitbucketCloudEventRouter';
 import { BitbucketCloudEventRouter } from '../router/BitbucketCloudEventRouter';
 
-describe('bitbucketCloudEventRouterEventsModule', () => {
+describe('eventsModuleBitbucketCloudEventRouter', () => {
   it('should be correctly wired and set up', async () => {
     let addedPublisher: BitbucketCloudEventRouter | undefined;
     let addedSubscriber: BitbucketCloudEventRouter | undefined;
@@ -35,7 +35,7 @@ describe('bitbucketCloudEventRouterEventsModule', () => {
     await startTestBackend({
       extensionPoints: [[eventsExtensionPoint, extensionPoint]],
       services: [],
-      features: [bitbucketCloudEventRouterEventsModule()],
+      features: [eventsModuleBitbucketCloudEventRouter()],
     });
 
     expect(addedPublisher).not.toBeUndefined();

plugins/events-backend-module-bitbucket-cloud/src/service/eventsModuleBitbucketCloudEventRouter.ts

@@ -25,7 +25,7 @@ import { BitbucketCloudEventRouter } from '../router/BitbucketCloudEventRouter';
  *
  * @alpha
  */
-export const bitbucketCloudEventRouterEventsModule = createBackendModule({
+export const eventsModuleBitbucketCloudEventRouter = createBackendModule({
   pluginId: 'events',
   moduleId: 'bitbucketCloudEventRouter',
   register(env) {

plugins/events-backend-module-gerrit/alpha-api-report.md

@@ -6,7 +6,7 @@
 import { BackendFeature } from '@backstage/backend-plugin-api';
 
 // @alpha
-export const gerritEventRouterEventsModule: () => BackendFeature;
+export const eventsModuleGerritEventRouter: () => BackendFeature;
 
 // (No @packageDocumentation comment for this package)
 ```

plugins/events-backend-module-gerrit/src/alpha.ts

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export { gerritEventRouterEventsModule } from './service/GerritEventRouterEventsModule';
+export { eventsModuleGerritEventRouter } from './service/eventsModuleGerritEventRouter';

plugins/events-backend-module-gerrit/src/service/eventsModuleGerritEventRouter.test.ts

@@ -16,10 +16,10 @@
 
 import { startTestBackend } from '@backstage/backend-test-utils';
 import { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';
-import { gerritEventRouterEventsModule } from './GerritEventRouterEventsModule';
+import { eventsModuleGerritEventRouter } from './eventsModuleGerritEventRouter';
 import { GerritEventRouter } from '../router/GerritEventRouter';
 
-describe('gerritEventRouterEventsModule', () => {
+describe('eventsModuleGerritEventRouter', () => {
   it('should be correctly wired and set up', async () => {
     let addedPublisher: GerritEventRouter | undefined;
     let addedSubscriber: GerritEventRouter | undefined;
@@ -35,7 +35,7 @@ describe('gerritEventRouterEventsModule', () => {
     await startTestBackend({
       extensionPoints: [[eventsExtensionPoint, extensionPoint]],
       services: [],
-      features: [gerritEventRouterEventsModule()],
+      features: [eventsModuleGerritEventRouter()],
     });
 
     expect(addedPublisher).not.toBeUndefined();

plugins/events-backend-module-gerrit/src/service/eventsModuleGerritEventRouter.ts

@@ -25,7 +25,7 @@ import { GerritEventRouter } from '../router/GerritEventRouter';
  *
  * @alpha
  */
-export const gerritEventRouterEventsModule = createBackendModule({
+export const eventsModuleGerritEventRouter = createBackendModule({
   pluginId: 'events',
   moduleId: 'gerritEventRouter',
   register(env) {

plugins/events-backend-module-github/alpha-api-report.md

@@ -6,10 +6,10 @@
 import { BackendFeature } from '@backstage/backend-plugin-api';
 
 // @alpha
-export const githubEventRouterEventsModule: () => BackendFeature;
+export const eventsModuleGithubEventRouter: () => BackendFeature;
 
 // @alpha
-export const githubWebhookEventsModule: () => BackendFeature;
+export const eventsModuleGithubWebhook: () => BackendFeature;
 
 // (No @packageDocumentation comment for this package)
 ```

plugins/events-backend-module-github/src/alpha.ts

@@ -14,5 +14,5 @@
  * limitations under the License.
  */
 
-export { githubEventRouterEventsModule } from './service/GithubEventRouterEventsModule';
-export { githubWebhookEventsModule } from './service/GithubWebhookEventsModule';
+export { eventsModuleGithubEventRouter } from './service/eventsModuleGithubEventRouter';
+export { eventsModuleGithubWebhook } from './service/eventsModuleGithubWebhook';

plugins/events-backend-module-github/src/service/eventsModuleGithubEventRouter.test.ts

@@ -16,10 +16,10 @@
 
 import { startTestBackend } from '@backstage/backend-test-utils';
 import { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';
-import { githubEventRouterEventsModule } from './GithubEventRouterEventsModule';
+import { eventsModuleGithubEventRouter } from './eventsModuleGithubEventRouter';
 import { GithubEventRouter } from '../router/GithubEventRouter';
 
-describe('githubEventRouterEventsModule', () => {
+describe('eventsModuleGithubEventRouter', () => {
   it('should be correctly wired and set up', async () => {
     let addedPublisher: GithubEventRouter | undefined;
     let addedSubscriber: GithubEventRouter | undefined;
@@ -35,7 +35,7 @@ describe('githubEventRouterEventsModule', () => {
     await startTestBackend({
       extensionPoints: [[eventsExtensionPoint, extensionPoint]],
       services: [],
-      features: [githubEventRouterEventsModule()],
+      features: [eventsModuleGithubEventRouter()],
     });
 
     expect(addedPublisher).not.toBeUndefined();

plugins/events-backend-module-github/src/service/eventsModuleGithubEventRouter.ts

@@ -25,7 +25,7 @@ import { GithubEventRouter } from '../router/GithubEventRouter';
  *
  * @alpha
  */
-export const githubEventRouterEventsModule = createBackendModule({
+export const eventsModuleGithubEventRouter = createBackendModule({
   pluginId: 'events',
   moduleId: 'githubEventRouter',
   register(env) {

plugins/events-backend-module-github/src/service/eventsModuleGithubWebhook.test.ts

@@ -23,9 +23,9 @@ import {
   RequestDetails,
 } from '@backstage/plugin-events-node';
 import { sign } from '@octokit/webhooks-methods';
-import { githubWebhookEventsModule } from './GithubWebhookEventsModule';
+import { eventsModuleGithubWebhook } from './eventsModuleGithubWebhook';
 
-describe('githubWebhookEventsModule', () => {
+describe('eventsModuleGithubWebhook', () => {
   const secret = 'valid-secret';
   const payload = { test: 'payload' };
   const payloadString = JSON.stringify(payload);
@@ -60,7 +60,7 @@ describe('githubWebhookEventsModule', () => {
     await startTestBackend({
       extensionPoints: [[eventsExtensionPoint, extensionPoint]],
       services: [[coreServices.config, config]],
-      features: [githubWebhookEventsModule()],
+      features: [eventsModuleGithubWebhook()],
     });
 
     expect(addedIngress).not.toBeUndefined();

plugins/events-backend-module-github/src/service/eventsModuleGithubWebhook.ts

@@ -28,7 +28,7 @@ import { createGithubSignatureValidator } from '../http/createGithubSignatureVal
  *
  * @alpha
  */
-export const githubWebhookEventsModule = createBackendModule({
+export const eventsModuleGithubWebhook = createBackendModule({
   pluginId: 'events',
   moduleId: 'githubWebhook',
   register(env) {

plugins/events-backend-module-gitlab/alpha-api-report.md

@@ -6,10 +6,10 @@
 import { BackendFeature } from '@backstage/backend-plugin-api';
 
 // @alpha
-export const gitlabEventRouterEventsModule: () => BackendFeature;
+export const eventsModuleGitlabEventRouter: () => BackendFeature;
 
 // @alpha
-export const gitlabWebhookEventsModule: () => BackendFeature;
+export const eventsModuleGitlabWebhook: () => BackendFeature;
 
 // (No @packageDocumentation comment for this package)
 ```

plugins/events-backend-module-gitlab/src/alpha.ts

@@ -14,5 +14,5 @@
  * limitations under the License.
  */
 
-export { gitlabEventRouterEventsModule } from './service/GitlabEventRouterEventsModule';
-export { gitlabWebhookEventsModule } from './service/GitlabWebhookEventsModule';
+export { eventsModuleGitlabEventRouter } from './service/eventsModuleGitlabEventRouter';
+export { eventsModuleGitlabWebhook } from './service/eventsModuleGitlabWebhook';

plugins/events-backend-module-gitlab/src/service/eventsModuleGitlabEventRouter.test.ts

@@ -16,10 +16,10 @@
 
 import { startTestBackend } from '@backstage/backend-test-utils';
 import { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';
-import { gitlabEventRouterEventsModule } from './GitlabEventRouterEventsModule';
+import { eventsModuleGitlabEventRouter } from './eventsModuleGitlabEventRouter';
 import { GitlabEventRouter } from '../router/GitlabEventRouter';
 
-describe('gitlabEventRouterEventsModule', () => {
+describe('eventsModuleGitlabEventRouter', () => {
   it('should be correctly wired and set up', async () => {
     let addedPublisher: GitlabEventRouter | undefined;
     let addedSubscriber: GitlabEventRouter | undefined;
@@ -35,7 +35,7 @@ describe('gitlabEventRouterEventsModule', () => {
     await startTestBackend({
       extensionPoints: [[eventsExtensionPoint, extensionPoint]],
       services: [],
-      features: [gitlabEventRouterEventsModule()],
+      features: [eventsModuleGitlabEventRouter()],
     });
 
     expect(addedPublisher).not.toBeUndefined();

plugins/events-backend-module-gitlab/src/service/eventsModuleGitlabEventRouter.ts

@@ -25,7 +25,7 @@ import { GitlabEventRouter } from '../router/GitlabEventRouter';
  *
  * @alpha
  */
-export const gitlabEventRouterEventsModule = createBackendModule({
+export const eventsModuleGitlabEventRouter = createBackendModule({
   pluginId: 'events',
   moduleId: 'gitlabEventRouter',
   register(env) {

plugins/events-backend-module-gitlab/src/service/eventsModuleGitlabWebhook.test.ts

@@ -22,7 +22,7 @@ import {
   HttpPostIngressOptions,
   RequestDetails,
 } from '@backstage/plugin-events-node';
-import { gitlabWebhookEventsModule } from './GitlabWebhookEventsModule';
+import { eventsModuleGitlabWebhook } from './eventsModuleGitlabWebhook';
 
 describe('gitlabWebhookEventsModule', () => {
   const requestWithToken = (token?: string) => {
@@ -55,7 +55,7 @@ describe('gitlabWebhookEventsModule', () => {
     await startTestBackend({
       extensionPoints: [[eventsExtensionPoint, extensionPoint]],
       services: [[coreServices.config, config]],
-      features: [gitlabWebhookEventsModule()],
+      features: [eventsModuleGitlabWebhook()],
     });
 
     expect(addedIngress).not.toBeUndefined();

plugins/events-backend-module-gitlab/src/service/eventsModuleGitlabWebhook.ts

@@ -30,7 +30,7 @@ import { createGitlabTokenValidator } from '../http/createGitlabTokenValidator';
  *
  * @alpha
  */
-export const gitlabWebhookEventsModule = createBackendModule({
+export const eventsModuleGitlabWebhook = createBackendModule({
   pluginId: 'events',
   moduleId: 'gitlabWebhook',
   register(env) {

plugins/events-backend/README.md

@@ -186,9 +186,9 @@ import { eventsExtensionPoint } from '@backstage/plugin-events-node';
 
 // [...]
 
-export const yourModuleEventsModule = createBackendModule({
+export const eventsModuleYourFeature = createBackendModule({
   pluginId: 'events',
-  moduleId: 'yourModule',
+  moduleId: 'yourFeature',
   register(env) {
     // [...]
     env.registerInit({