Merge pull request #21604 from backstage/rugvip/kebab

switch all backend module IDs to use kebab-case
2023-11-29 10:54:41 +01:00
parent 422521a645 cc4228ec11
commit 2faf047072
47 changed files with 106 additions and 69 deletions
@@ -26,7 +26,7 @@ import { gcpIapSignInResolvers } from './resolvers';
 /** @public */
 export const authModuleGcpIapProvider = createBackendModule({
  pluginId: 'auth',
-  moduleId: 'gcpIapProvider',
+  moduleId: 'gcp-iap-provider',
  register(reg) {
    reg.registerInit({
      deps: {
@@ -26,7 +26,7 @@ import { googleSignInResolvers } from './resolvers';
 /** @public */
 export const authModuleGoogleProvider = createBackendModule({
  pluginId: 'auth',
-  moduleId: 'googleProvider',
+  moduleId: 'google-provider',
  register(reg) {
    reg.registerInit({
      deps: {
@@ -26,7 +26,7 @@ import { oauth2ProxySignInResolvers } from './resolvers';
 /** @public */
 export const authModuleOauth2ProxyProvider = createBackendModule({
  pluginId: 'auth',
-  moduleId: 'oauth2ProxyProvider',
+  moduleId: 'oauth2-proxy-provider',
  register(reg) {
    reg.registerInit({
      deps: {
@@ -29,7 +29,7 @@ import { AwsS3EntityProvider } from '../providers';
 */
 export const catalogModuleAwsS3EntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'awsS3EntityProvider',
+  moduleId: 'aws-s3-entity-provider',
  register(env) {
    env.registerInit({
      deps: {
@@ -29,7 +29,7 @@ import { AzureDevOpsEntityProvider } from '../providers';
 */
 export const catalogModuleAzureDevOpsEntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'azureDevOpsEntityProvider',
+  moduleId: 'azure-dev-ops-entity-provider',
  register(env) {
    env.registerInit({
      deps: {
@@ -31,7 +31,7 @@ import { BitbucketCloudEntityProvider } from '../providers/BitbucketCloudEntityP
 */
 export const catalogModuleBitbucketCloudEntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'bitbucketCloudEntityProvider',
+  moduleId: 'bitbucket-cloud-entity-provider',
  register(env) {
    env.registerInit({
      deps: {
@@ -27,7 +27,7 @@ import { BitbucketServerEntityProvider } from '../providers';
 */
 export const catalogModuleBitbucketServerEntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'bitbucketServerEntityProvider',
+  moduleId: 'bitbucket-server-entity-provider',
  register(env) {
    env.registerInit({
      deps: {
@@ -29,7 +29,7 @@ import { GkeEntityProvider } from '../providers/GkeEntityProvider';
 */
 export const catalogModuleGcpGkeEntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'gcpGkeEntityProvider',
+  moduleId: 'gcp-gke-entity-provider',
  register(env) {
    env.registerInit({
      deps: {
@@ -27,7 +27,7 @@ import { GerritEntityProvider } from '../providers/GerritEntityProvider';
 */
 export const catalogModuleGerritEntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'gerritEntityProvider',
+  moduleId: 'gerrit-entity-provider',
  register(env) {
    env.registerInit({
      deps: {
@@ -68,7 +68,7 @@ export const githubOrgEntityProviderTransformsExtensionPoint =
 */
 export const catalogModuleGithubOrgEntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'githubOrgEntityProvider',
+  moduleId: 'github-org-entity-provider',
  register(env) {
    let userTransformer: UserTransformer | undefined;
    let teamTransformer: TeamTransformer | undefined;
@@ -29,7 +29,7 @@ import { GithubEntityProvider } from '../providers/GithubEntityProvider';
 */
 export const catalogModuleGithubEntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'githubEntityProvider',
+  moduleId: 'github-entity-provider',
  register(env) {
    env.registerInit({
      deps: {
@@ -29,7 +29,7 @@ import { GitlabDiscoveryEntityProvider } from '../providers';
 */
 export const catalogModuleGitlabDiscoveryEntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'gitlabDiscoveryEntityProvider',
+  moduleId: 'gitlab-discovery-entity-provider',
  register(env) {
    env.registerInit({
      deps: {
@@ -48,7 +48,7 @@ describe('catalogModuleIncrementalIngestionEntityProvider', () => {
        catalogModuleIncrementalIngestionEntityProvider(),
        createBackendModule({
          pluginId: 'catalog',
-          moduleId: 'incrementalTest',
+          moduleId: 'incremental-test',
          register(env) {
            env.registerInit({
              deps: { extension: incrementalIngestionProvidersExtensionPoint },
@@ -49,7 +49,7 @@ export interface IncrementalIngestionProviderExtensionPoint {
 * ```ts
 * backend.add(createBackendModule({
 *   pluginId: 'catalog',
- *   moduleId: 'myIncrementalProvider',
+ *   moduleId: 'my-incremental-provider',
 *   register(env) {
 *     env.registerInit({
 *       deps: {
@@ -85,7 +85,7 @@ export const incrementalIngestionProvidersExtensionPoint =
 export const catalogModuleIncrementalIngestionEntityProvider =
  createBackendModule({
    pluginId: 'catalog',
-    moduleId: 'incrementalIngestionEntityProvider',
+    moduleId: 'incremental-ingestion-entity-provider',
    register(env) {
      const addedProviders = new Array<{
        provider: IncrementalEntityProvider<unknown, unknown>;
@@ -67,7 +67,7 @@ async function main() {
  backend.add(
    createBackendModule({
      pluginId: 'catalog',
-      moduleId: 'incrementalTestProvider',
+      moduleId: 'incremental-test-provider',
      register(reg) {
        reg.registerInit({
          deps: { extension: incrementalIngestionProvidersExtensionPoint },
@@ -29,7 +29,7 @@ import { PuppetDbEntityProvider } from '../providers/PuppetDbEntityProvider';
 */
 export const catalogModulePuppetDbEntityProvider = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'puppetDbEntityProvider',
+  moduleId: 'puppetdb-entity-provider',
  register(env) {
    env.registerInit({
      deps: {
@@ -26,7 +26,7 @@ import { ScaffolderEntitiesProcessor } from '@backstage/plugin-catalog-backend-m
 */
 export const catalogModuleScaffolderEntityModel = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'scaffolderEntityModel',
+  moduleId: 'scaffolder-entity-model',
  register(env) {
    env.registerInit({
      deps: {
@@ -27,7 +27,7 @@ import { UnprocessedEntitiesModule } from './UnprocessedEntitiesModule';
 */
 export const catalogModuleUnprocessedEntities = createBackendModule({
  pluginId: 'catalog',
-  moduleId: 'catalogModuleUnprocessedEntities',
+  moduleId: 'catalog-module-unprocessed-entities',
  register(env) {
    env.registerInit({
      deps: {
@@ -188,8 +188,8 @@ describePerformanceTest('stitchingPerformance', () => {
            factory: () => ({ getClient: async () => knex }),
          }),
          createBackendModule({
-            moduleId: 'syntheticLoadEntities',
            pluginId: 'catalog',
+            moduleId: 'synthetic-load-entities',
            register(reg) {
              reg.registerInit({
                deps: {
@@ -245,8 +245,8 @@ describePerformanceTest('stitchingPerformance', () => {
            factory: () => ({ getClient: async () => knex }),
          }),
          createBackendModule({
-            moduleId: 'syntheticLoadEntities',
            pluginId: 'catalog',
+            moduleId: 'synthetic-load-entities',
            register(reg) {
              reg.registerInit({
                deps: {
@@ -29,7 +29,7 @@ import { AwsSqsConsumingEventPublisher } from '../publisher/AwsSqsConsumingEvent
 */
 export const eventsModuleAwsSqsConsumingEventPublisher = createBackendModule({
  pluginId: 'events',
-  moduleId: 'awsSqsConsumingEventPublisher',
+  moduleId: 'aws-sqs-consuming-event-publisher',
  register(env) {
    env.registerInit({
      deps: {
@@ -27,7 +27,7 @@ import { AzureDevOpsEventRouter } from '../router/AzureDevOpsEventRouter';
 */
 export const eventsModuleAzureDevOpsEventRouter = createBackendModule({
  pluginId: 'events',
-  moduleId: 'azureDevOpsEventRouter',
+  moduleId: 'azure-dev-ops-event-router',
  register(env) {
    env.registerInit({
      deps: {
@@ -27,7 +27,7 @@ import { BitbucketCloudEventRouter } from '../router/BitbucketCloudEventRouter';
 */
 export const eventsModuleBitbucketCloudEventRouter = createBackendModule({
  pluginId: 'events',
-  moduleId: 'bitbucketCloudEventRouter',
+  moduleId: 'bitbucket-cloud-event-router',
  register(env) {
    env.registerInit({
      deps: {
@@ -27,7 +27,7 @@ import { GerritEventRouter } from '../router/GerritEventRouter';
 */
 export const eventsModuleGerritEventRouter = createBackendModule({
  pluginId: 'events',
-  moduleId: 'gerritEventRouter',
+  moduleId: 'gerrit-event-router',
  register(env) {
    env.registerInit({
      deps: {
@@ -27,7 +27,7 @@ import { GithubEventRouter } from '../router/GithubEventRouter';
 */
 export const eventsModuleGithubEventRouter = createBackendModule({
  pluginId: 'events',
-  moduleId: 'githubEventRouter',
+  moduleId: 'github-event-router',
  register(env) {
    env.registerInit({
      deps: {
@@ -30,7 +30,7 @@ import { createGithubSignatureValidator } from '../http/createGithubSignatureVal
 */
 export const eventsModuleGithubWebhook = createBackendModule({
  pluginId: 'events',
-  moduleId: 'githubWebhook',
+  moduleId: 'github-webhook',
  register(env) {
    env.registerInit({
      deps: {
@@ -27,7 +27,7 @@ import { GitlabEventRouter } from '../router/GitlabEventRouter';
 */
 export const eventsModuleGitlabEventRouter = createBackendModule({
  pluginId: 'events',
-  moduleId: 'gitlabEventRouter',
+  moduleId: 'gitlab-event-router',
  register(env) {
    env.registerInit({
      deps: {
@@ -32,7 +32,7 @@ import { createGitlabTokenValidator } from '../http/createGitlabTokenValidator';
 */
 export const eventsModuleGitlabWebhook = createBackendModule({
  pluginId: 'events',
-  moduleId: 'gitlabWebhook',
+  moduleId: 'gitlab-webhook',
  register(env) {
    env.registerInit({
      deps: {
@@ -201,7 +201,7 @@ import { eventsExtensionPoint } from '@backstage/plugin-events-node';

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

 export const eventsModuleYourFeature = createBackendModule({
  pluginId: 'events',
-  moduleId: 'yourFeature',
+  moduleId: 'your-feature',
  register(env) {
    // [...]
    env.registerInit({
@@ -107,7 +107,7 @@ describe('resourcesRoutes', () => {
        import('@backstage/plugin-kubernetes-backend/alpha'),
        createBackendModule({
          pluginId: 'kubernetes',
-          moduleId: 'testObjectsProvider',
+          moduleId: 'test-objects-provider',
          register(env) {
            env.registerInit({
              deps: { extension: kubernetesObjectsProviderExtensionPoint },
@@ -23,8 +23,8 @@ import { AllowAllPermissionPolicy } from './policy';
 * @public
 */
 export const permissionModuleAllowAllPolicy = createBackendModule({
-  moduleId: 'allowAllPolicy',
  pluginId: 'permission',
+  moduleId: 'allow-all-policy',
  register(reg) {
    reg.registerInit({
      deps: { policy: policyExtensionPoint },
@@ -61,7 +61,7 @@ backend.add(searchModuleCatalogCollator());
 backend.add(
  createBackendModule({
    pluginId: 'search',
-    moduleId: 'myCatalogCollatorOptions',
+    moduleId: 'my-catalog-collator-options',
    register(reg) {
      reg.registerInit({
        deps: { collator: catalogCollatorExtensionPoint },
@@ -61,8 +61,8 @@ export const catalogCollatorExtensionPoint =
 * @alpha
 */
 export default createBackendModule({
-  moduleId: 'catalogCollator',
  pluginId: 'search',
+  moduleId: 'catalog-collator',
  register(env) {
    let entityTransformer: CatalogCollatorEntityTransformer | undefined;

@@ -45,8 +45,8 @@ export const elasticsearchTranslatorExtensionPoint =
 * @alpha
 */
 export default createBackendModule({
-  moduleId: 'elasticsearchEngine',
  pluginId: 'search',
+  moduleId: 'elasticsearch-engine',
  register(env) {
    let translator: ElasticSearchQueryTranslator | undefined;

@@ -35,8 +35,8 @@ import { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';
 * @alpha
 */
 export default createBackendModule({
-  moduleId: 'exploreCollator',
  pluginId: 'search',
+  moduleId: 'explore-collator',
  register(env) {
    env.registerInit({
      deps: {
@@ -25,8 +25,8 @@ import { PgSearchEngine } from './PgSearchEngine';
 * Search backend module for the Postgres engine.
 */
 export default createBackendModule({
-  moduleId: 'postgresEngine',
  pluginId: 'search',
+  moduleId: 'postgres-engine',
  register(env) {
    env.registerInit({
      deps: {
@@ -28,8 +28,8 @@ import { StackOverflowQuestionsCollatorFactory } from '../collators';
 * Search backend module for the Stack Overflow index.
 */
 export const searchStackOverflowCollatorModule = createBackendModule({
-  moduleId: 'stackOverflowCollator',
  pluginId: 'search',
+  moduleId: 'stack-overflow-collator',
  register(env) {
    env.registerInit({
      deps: {
@@ -51,8 +51,8 @@ export const techdocsCollatorEntityTransformerExtensionPoint =
 * Search backend module for the TechDocs index.
 */
 export default createBackendModule({
-  moduleId: 'techDocsCollator',
  pluginId: 'search',
+  moduleId: 'techdocs-collator',
  register(env) {
    let transformer: TechDocsCollatorEntityTransformer | undefined;