Browse Source

refactor(server): Rename VendurePlugin.init() -> configure()

Michael Bromley 7 years ago
parent
commit
57bb328d7a

+ 3 - 4
server/src/bootstrap.ts

@@ -57,7 +57,7 @@ export async function preBootstrapConfig(
     });
 
     let config = getConfig();
-    config = await runPluginInitMethods(config);
+    config = await runPluginConfigurations(config);
     registerCustomEntityFields(config);
     return config;
 }
@@ -65,12 +65,11 @@ export async function preBootstrapConfig(
 /**
  * Initialize any configured plugins.
  */
-async function runPluginInitMethods(
+async function runPluginConfigurations(
     config: ReadOnlyRequired<VendureConfig>,
 ): Promise<ReadOnlyRequired<VendureConfig>> {
-    // Initialize plugins
     for (const plugin of config.plugins) {
-        config = (await plugin.init(config)) as ReadOnlyRequired<VendureConfig>;
+        config = (await plugin.configure(config)) as ReadOnlyRequired<VendureConfig>;
     }
     return config;
 }

+ 3 - 3
server/src/config/vendure-plugin/vendure-plugin.ts

@@ -8,15 +8,15 @@ import { VendureConfig } from '../vendure-config';
  * a plugin simply modifies the VendureConfig object. Although such configuration can be directly supplied to the bootstrap
  * function, using a plugin allows one to abstract away a set of related configuration.
  *
- * Aditionally, the init() method can perform async work such as starting servers, making calls to 3rd party services, or any other
- * kind of task which may be called for.
+ * As well as configuring the app, a plugin may also extend the GraphQL schema by extending existing types or adding
+ * entirely new types. Database entities and resolvers can also be defined to handle the extended GraphQL types.
  */
 export interface VendurePlugin {
     /**
      * This method is called before the app bootstraps, and can modify the VendureConfig object and perform
      * other (potentially async) tasks needed.
      */
-    init(config: Required<VendureConfig>): Required<VendureConfig> | Promise<Required<VendureConfig>>;
+    configure(config: Required<VendureConfig>): Required<VendureConfig> | Promise<Required<VendureConfig>>;
 
     /**
      * This method is called after the app has bootstrapped. In this method, instances of services may be injected

+ 0 - 0
server/src/plugin/default-asset-server/default-asset-preview-strategy.ts → server/src/plugin/default-asset-server-plugin/default-asset-preview-strategy.ts


+ 1 - 1
server/src/plugin/default-asset-server/default-asset-server-plugin.ts → server/src/plugin/default-asset-server-plugin/default-asset-server-plugin.ts

@@ -41,7 +41,7 @@ export class DefaultAssetServerPlugin implements VendurePlugin {
 
     constructor(private options: DefaultAssetServerOptions) {}
 
-    init(config: Required<VendureConfig>) {
+    configure(config: Required<VendureConfig>) {
         this.createAssetServer();
         this.assetStorage = new DefaultAssetStorageStrategy(this.options.assetUploadDir, this.options.route);
         config.assetOptions.assetPreviewStrategy = new DefaultAssetPreviewStrategy({

+ 0 - 0
server/src/plugin/default-asset-server/default-asset-storage-strategy.ts → server/src/plugin/default-asset-server-plugin/default-asset-storage-strategy.ts


+ 0 - 0
server/src/plugin/default-asset-server/file-icon.png → server/src/plugin/default-asset-server-plugin/file-icon.png


+ 0 - 0
server/src/plugin/default-asset-server/file-icon.psd → server/src/plugin/default-asset-server-plugin/file-icon.psd


+ 0 - 0
server/src/plugin/default-asset-server/transform-image.ts → server/src/plugin/default-asset-server-plugin/transform-image.ts


+ 1 - 1
server/src/plugin/default-search-engine/default-search-plugin.ts → server/src/plugin/default-search-plugin/default-search-plugin.ts

@@ -8,7 +8,7 @@ import { SearchIndexItem } from './search-index-item.entity';
 export class DefaultSearchPlugin implements VendurePlugin {
     private fulltextSearchService: FulltextSearchService;
 
-    async init(config: Required<VendureConfig>): Promise<Required<VendureConfig>> {
+    async configure(config: Required<VendureConfig>): Promise<Required<VendureConfig>> {
         return config;
     }
 

+ 0 - 0
server/src/plugin/default-search-engine/fulltext-search.resolver.ts → server/src/plugin/default-search-plugin/fulltext-search.resolver.ts


+ 0 - 0
server/src/plugin/default-search-engine/fulltext-search.service.ts → server/src/plugin/default-search-plugin/fulltext-search.service.ts


+ 0 - 0
server/src/plugin/default-search-engine/search-index-item.entity.ts → server/src/plugin/default-search-plugin/search-index-item.entity.ts


+ 4 - 4
server/src/plugin/index.ts

@@ -1,4 +1,4 @@
-export * from './default-asset-server/default-asset-server-plugin';
-export * from './default-asset-server/default-asset-preview-strategy';
-export * from './default-asset-server/default-asset-storage-strategy';
-export * from './default-search-engine/default-search-plugin';
+export * from './default-asset-server-plugin/default-asset-server-plugin';
+export * from './default-asset-server-plugin/default-asset-preview-strategy';
+export * from './default-asset-server-plugin/default-asset-storage-strategy';
+export * from './default-search-plugin/default-search-plugin';