make the backend plugin ts files consistent

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

docs/features/search/getting-started.md

@@ -150,20 +150,24 @@ import {
 } from '@backstage/plugin-search-backend-node';
 import { PluginEnvironment } from '../types';
 import { DefaultCatalogCollator } from '@backstage/plugin-catalog-backend';
+import { Router } from 'express';
 
-export default async function createPlugin({
-  logger,
-  discovery,
-  tokenManager,
-}: PluginEnvironment) {
-  const searchEngine = new LunrSearchEngine({ logger });
-  const indexBuilder = new IndexBuilder({ logger, searchEngine });
+export default async function createPlugin(
+  env: PluginEnvironment,
+): Promise<Router> {
+  const searchEngine = new LunrSearchEngine({
+    logger: env.logger,
+  });
+  const indexBuilder = new IndexBuilder({
+    logger: env.logger,
+    searchEngine,
+  });
 
   indexBuilder.addCollator({
     defaultRefreshIntervalSeconds: 600,
     collator: new DefaultCatalogCollator({
-      discovery,
-      tokenManager,
+      discovery: env.discovery,
+      tokenManager: env.tokenManager,
     }),
   });
 
@@ -174,7 +178,7 @@ export default async function createPlugin({
 
   return await createRouter({
     engine: indexBuilder.getSearchEngine(),
-    logger,
+    logger: env.logger,
   });
 }
 ```
@@ -285,13 +289,13 @@ which are responsible for providing documents
 number of collators with the `IndexBuilder` like this:
 
 ```typescript
-const indexBuilder = new IndexBuilder({ logger, searchEngine });
+const indexBuilder = new IndexBuilder({ logger: env.logger, searchEngine });
 
 indexBuilder.addCollator({
   defaultRefreshIntervalSeconds: 600,
   collator: new DefaultCatalogCollator({
-    discovery,
-    tokenManager,
+    discovery: env.discovery,
+    tokenManager: env.tokenManager,
   }),
 });
 
@@ -311,8 +315,8 @@ its `defaultRefreshIntervalSeconds` value, like this:
 indexBuilder.addCollator({
   defaultRefreshIntervalSeconds: 600,
   collator: new DefaultCatalogCollator({
-    discovery,
-    tokenManager,
+    discovery: env.discovery,
+    tokenManager: env.tokenManager,
   }),
 });
 ```

docs/features/search/how-to-guides.md

@@ -72,10 +72,10 @@ import { DefaultTechDocsCollatorFactory } from '@backstage/plugin-techdocs-backe
 ```typescript
 indexBuilder.addCollator({
   defaultRefreshIntervalSeconds: 600,
-  factory: DefaultTechDocsCollatorFactory.fromConfig(config, {
-    discovery,
-    logger,
-    tokenManager,
+  factory: DefaultTechDocsCollatorFactory.fromConfig(env.config, {
+    discovery: env.discovery,
+    logger: env.logger,
+    tokenManager: env.tokenManager,
   }),
 });
 ```
@@ -120,9 +120,9 @@ provided by `@backstage/plugin-catalog-backend` offers some configuration too!
 
 indexBuilder.addCollator({
   defaultRefreshIntervalSeconds: 600,
-  collator: DefaultCatalogCollator.fromConfig(config, {
-    discovery,
-    tokenManager,
+  collator: DefaultCatalogCollator.fromConfig(env.config, {
+    discovery: env.discovery,
+    tokenManager: env.tokenManager,
 +   filter: {
 +      kind: ['API', 'Component', 'Domain', 'Group', 'System', 'User'],
 +   },
@@ -167,18 +167,22 @@ provided by existing plugins, the migration process is fairly straightforward:
    +import { DefaultCatalogCollatorFactory } from '@backstage/plugin-catalog-backend';
    +import { DefaultTechDocsCollatorFactory } from '@backstage/plugin-techdocs-backend';
    // ...
-     const indexBuilder = new IndexBuilder({ logger, searchEngine });
+     const indexBuilder = new IndexBuilder({ logger: env.logger, searchEngine });
      indexBuilder.addCollator({
        defaultRefreshIntervalSeconds: 600,
-   -    collator: DefaultCatalogCollator.fromConfig(config, { discovery }),
-   +    factory: DefaultCatalogCollatorFactory.fromConfig(config, { discovery }),
+   -    collator: DefaultCatalogCollator.fromConfig(env.config, {
+          discovery: env.discovery,
+        }),
+   +    factory: DefaultCatalogCollatorFactory.fromConfig(env.config, {
+          discovery: env.discovery,
+        }),
      });
      indexBuilder.addCollator({
        defaultRefreshIntervalSeconds: 600,
-   -    collator: DefaultTechDocsCollator.fromConfig(config, {
-   +    factory: DefaultTechDocsCollatorFactory.fromConfig(config, {
-         discovery,
-         logger,
+   -     collator: DefaultTechDocsCollator.fromConfig(env.config, {
+   +     factory: DefaultTechDocsCollatorFactory.fromConfig(env.config, {
+           discovery: env.discovery,
+           logger: env.logger,
        }),
      });
    ```

docs/features/search/search-engines.md

@@ -17,7 +17,7 @@ provided search engines by using the exposed setter to set the modified query
 translator into the instance.
 
 ```typescript
-const searchEngine = new LunrSearchEngine({ logger });
+const searchEngine = new LunrSearchEngine({ logger: env.logger });
 searchEngine.setTranslator(new MyNewAndBetterQueryTranslator());
 ```
 
@@ -30,8 +30,8 @@ Lunr can be instantiated like this:
 
 ```typescript
 // app/backend/src/plugins/search.ts
-const searchEngine = new LunrSearchEngine({ logger });
-const indexBuilder = new IndexBuilder({ logger, searchEngine });
+const searchEngine = new LunrSearchEngine({ logger: env.logger });
+const indexBuilder = new IndexBuilder({ logger: env.logger, searchEngine });
 ```
 
 ## Postgres
@@ -58,9 +58,9 @@ configured and make the following changes to your backend:
 // In packages/backend/src/plugins/search.ts
 
 // Initialize a connection to a search engine.
-const searchEngine = (await PgSearchEngine.supported(database))
-  ? await PgSearchEngine.from({ database })
-  : new LunrSearchEngine({ logger });
+const searchEngine = (await PgSearchEngine.supported(env.database))
+  ? await PgSearchEngine.from({ database: env.database })
+  : new LunrSearchEngine({ logger: env.logger });
 ```
 
 ## ElasticSearch
@@ -74,10 +74,10 @@ Similarly to Lunr above, ElasticSearch can be set up like this:
 ```typescript
 // app/backend/src/plugins/search.ts
 const searchEngine = await ElasticSearchSearchEngine.initialize({
-  logger,
-  config,
+  logger: env.logger,
+  config: env.config,
 });
-const indexBuilder = new IndexBuilder({ logger, searchEngine });
+const indexBuilder = new IndexBuilder({ logger: env.logger, searchEngine });
 ```
 
 For the engine to be available, your backend package needs a dependency into