refactor: Rename plugins - remove "default"

It is redundant. Default plugins will only refer to plugins which ship with the core package.

.gitignore

@@ -12,14 +12,6 @@ docker-compose.yml
 lerna-debug.log
 dist
 e2e/__data__/*
-packages/core/assets
-packages/core/dist
-packages/core/e2e/__data__/*.sqlite
-!packages/core/e2e/__data__/.gitkeep
-packages/core/test-emails
-packages/core/src/email/preview/output
-packages/dev-server/assets
-packages/dev-server/vendure
 docs/resources/_gen/*
 docs/static/main.js*
 docs/static/main.css*

package.json

@@ -17,9 +17,9 @@
     "prepush": "yarn test:all && cd admin-ui && yarn build --prod",
     "dev-server": "cd packages/dev-server && yarn start",
     "dev-server:populate": "cd packages/dev-server && yarn populate",
-    "test:all": "cd admin-ui && yarn test --watch=false --browsers=ChromeHeadlessCI --progress=false && cd ../server && yarn test && yarn test:e2e",
+    "test:all": "cd admin-ui && yarn test --watch=false --browsers=ChromeHeadlessCI --progress=false && cd ../ && yarn test:common && yarn test:core && yarn test:e2e",
     "test:common": "jest --config packages/common/jest.config.js",
-    "test:server": "jest --config packages/core/jest.config.js",
+    "test:core": "jest --config packages/core/jest.config.js",
     "test:e2e": "jest --config packages/core/e2e/config/jest-e2e.json --runInBand",
     "test:admin-ui": "jest --config packages/core/e2e/config/jest-e2e.json --runInBand",
     "build": "lerna run build"

packages/asset-server-plugin/index.ts

@@ -0,0 +1,3 @@
+export * from './src/plugin';
+export * from './src/sharp-asset-preview-strategy';
+export * from './src/local-asset-storage-strategy';

packages/default-asset-server-plugin/package.json → packages/asset-server-plugin/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@vendure/default-asset-server-plugin",
+  "name": "@vendure/asset-server-plugin",
   "version": "1.0.0",
   "module": "./lib/index.js",
   "files": ["./lib"],
@@ -21,5 +21,8 @@
     "http-proxy-middleware": "^0.19.1",
     "sharp": "^0.22.0",
     "typescript": "^3.3.4000"
+  },
+  "peerDependencies": {
+    "@vendure/core": "1.0.0"
   }
 }

packages/default-asset-server-plugin/src/default-asset-storage-strategy.ts → packages/asset-server-plugin/src/local-asset-storage-strategy.ts

@@ -8,7 +8,7 @@ import { Stream } from 'stream';
 /**
  * A persistence strategy which saves files to the local file system.
  */
-export class DefaultAssetStorageStrategy implements AssetStorageStrategy {
+export class LocalAssetStorageStrategy implements AssetStorageStrategy {
     constructor(private readonly uploadPath: string, private readonly route: string) {
         this.ensureUploadPathExists(this.uploadPath);
     }

packages/default-asset-server-plugin/src/plugin.ts → packages/asset-server-plugin/src/plugin.ts

@@ -4,8 +4,8 @@ import { Server } from 'http';
 import proxy from 'http-proxy-middleware';
 import path from 'path';
 
-import { DefaultAssetPreviewStrategy } from './default-asset-preview-strategy';
-import { DefaultAssetStorageStrategy } from './default-asset-storage-strategy';
+import { SharpAssetPreviewStrategy } from './sharp-asset-preview-strategy';
+import { LocalAssetStorageStrategy } from './local-asset-storage-strategy';
 import { transformImage } from './transform-image';
 
 /**
@@ -50,7 +50,7 @@ export interface ImageTransformPreset {
  *
  * @docsCategory plugin
  */
-export interface DefaultAssetServerOptions {
+export interface AssetServerOptions {
     hostname?: string;
     /**
      * @description
@@ -91,11 +91,11 @@ export interface DefaultAssetServerOptions {
 }
 
 /**
- * The DefaultAssetServerPlugin instantiates a static Express server which is used to
+ * The AssetServerPlugin instantiates a static Express server which is used to
  * serve the assets. It can also perform on-the-fly image transformations and caches the
  * results for subsequent calls.
  */
-export class DefaultAssetServerPlugin implements VendurePlugin {
+export class AssetServerPlugin implements VendurePlugin {
     private server: Server;
     private assetStorage: AssetStorageStrategy;
     private readonly cacheDir = 'cache';
@@ -107,7 +107,7 @@ export class DefaultAssetServerPlugin implements VendurePlugin {
         { name: 'large', width: 800, height: 800, mode: 'resize' },
     ];
 
-    constructor(private options: DefaultAssetServerOptions) {
+    constructor(private options: AssetServerOptions) {
         if (options.presets) {
             for (const preset of options.presets) {
                 const existingIndex = this.presets.findIndex(p => p.name === preset.name);
@@ -121,8 +121,8 @@ export class DefaultAssetServerPlugin implements VendurePlugin {
     }
 
     configure(config: Required<VendureConfig>) {
-        this.assetStorage = new DefaultAssetStorageStrategy(this.options.assetUploadDir, this.options.route);
-        config.assetOptions.assetPreviewStrategy = new DefaultAssetPreviewStrategy({
+        this.assetStorage = new LocalAssetStorageStrategy(this.options.assetUploadDir, this.options.route);
+        config.assetOptions.assetPreviewStrategy = new SharpAssetPreviewStrategy({
             maxWidth: this.options.previewMaxWidth || 1600,
             maxHeight: this.options.previewMaxHeight || 1600,
         });

packages/default-asset-server-plugin/src/default-asset-preview-strategy.ts → packages/asset-server-plugin/src/sharp-asset-preview-strategy.ts

@@ -3,7 +3,7 @@ import { AssetPreviewStrategy, getAssetType } from '@vendure/core';
 import path from 'path';
 import sharp from 'sharp';
 
-export class DefaultAssetPreviewStrategy implements AssetPreviewStrategy {
+export class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
     constructor(
         private config: {
             maxHeight: number;

packages/core/.gitignore

@@ -0,0 +1,5 @@
+assets
+dist
+e2e/__data__/*.sqlite
+!e2e/__data__/.gitkeep
+test-emails

packages/default-asset-server-plugin/index.ts

@@ -1,3 +0,0 @@
-export * from './src/plugin';
-export * from './src/default-asset-preview-strategy';
-export * from './src/default-asset-storage-strategy';

packages/dev-server/.gitignore

@@ -0,0 +1,3 @@
+assets
+vendure
+test-emails

packages/dev-server/dev-config.ts

@@ -1,3 +1,4 @@
+import { AssetServerPlugin } from '@vendure/asset-server-plugin';
 import { ADMIN_API_PATH, API_PORT, SHOP_API_PATH } from '@vendure/common/lib/shared-constants';
 import {
     AdminUiPlugin,
@@ -5,8 +6,7 @@ import {
     examplePaymentHandler,
     VendureConfig,
 } from '@vendure/core';
-import { DefaultAssetServerPlugin } from '@vendure/default-asset-server-plugin';
-import { DefaultEmailPlugin } from '@vendure/default-email-plugin';
+import { EmailPlugin } from '@vendure/email-plugin';
 import path from 'path';
 
 /**
@@ -50,15 +50,15 @@ export const devConfig: VendureConfig = {
         importAssetsDir: path.join(__dirname, 'import-assets'),
     },
     plugins: [
-        new DefaultAssetServerPlugin({
+        new AssetServerPlugin({
             route: 'assets',
             assetUploadDir: path.join(__dirname, 'assets'),
             port: 5002,
         }),
         new DefaultSearchPlugin(),
-        new DefaultEmailPlugin({
+        new EmailPlugin({
             devMode: true,
-            templatePath: path.join(__dirname, '../default-email-plugin/templates'),
+            templatePath: path.join(__dirname, '../email-plugin/templates'),
             outputPath: path.join(__dirname, 'test-emails'),
         }),
        /* new AdminUiPlugin({

packages/dev-server/package.json

@@ -11,8 +11,8 @@
   "dependencies": {
     "@vendure/common": "1.0.0",
     "@vendure/core": "1.0.0",
-    "@vendure/default-asset-server-plugin": "1.0.0",
-    "@vendure/default-email-plugin": "1.0.0",
+    "@vendure/asset-server-plugin": "1.0.0",
+    "@vendure/email-plugin": "1.0.0",
     "typescript": "^3.3.4000"
   },
   "devDependencies": {

packages/default-email-plugin/package.json → packages/email-plugin/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@vendure/default-email-plugin",
+  "name": "@vendure/email-plugin",
   "version": "1.0.0",
   "module": "./lib/index.js",
   "files": [

packages/default-email-plugin/src/plugin.ts → packages/email-plugin/src/plugin.ts

@@ -7,12 +7,12 @@ import { EmailContext } from './email-context';
 import { EmailSender } from './email-sender';
 import { HandlebarsMjmlGenerator } from './handlebars-mjml-generator';
 import { TemplateLoader } from './template-loader';
-import { DefaultEmailPluginDevModeOptions, DefaultEmailPluginOptions, EmailOptions, EmailTransportOptions, EmailTypeConfig } from './types';
+import { EmailOptions, EmailPluginDevModeOptions, EmailPluginOptions, EmailTransportOptions, EmailTypeConfig } from './types';
 
 /**
  * Configures the server to use the Handlebars / MJML email generator.
  */
-export class DefaultEmailPlugin implements VendurePlugin {
+export class EmailPlugin implements VendurePlugin {
     private readonly templatePath: string;
     private readonly transport: EmailTransportOptions;
     private readonly templateVars: { [name: string]: any };
@@ -21,7 +21,7 @@ export class DefaultEmailPlugin implements VendurePlugin {
     private emailSender: EmailSender;
     private readonly emailOptions: EmailOptions<DefaultEmailType>;
 
-    constructor(options: DefaultEmailPluginOptions | DefaultEmailPluginDevModeOptions) {
+    constructor(options: EmailPluginOptions | EmailPluginDevModeOptions) {
         this.templatePath = options.templatePath;
         this.templateVars = options.templateVars || {};
         if (isDevModeOptions(options)) {
@@ -100,7 +100,7 @@ export class DefaultEmailPlugin implements VendurePlugin {
 }
 
 function isDevModeOptions(
-    input: DefaultEmailPluginOptions | DefaultEmailPluginDevModeOptions,
-): input is DefaultEmailPluginDevModeOptions {
-    return (input as DefaultEmailPluginDevModeOptions).devMode === true;
+    input: EmailPluginOptions | EmailPluginDevModeOptions,
+): input is EmailPluginDevModeOptions {
+    return (input as EmailPluginDevModeOptions).devMode === true;
 }

packages/default-email-plugin/src/types.ts → packages/email-plugin/src/types.ts

@@ -57,11 +57,11 @@ export interface EmailOptions<EmailType extends string> {
 
 /**
  * @description
- * Configuration for the DefaultEmailPlugin.
+ * Configuration for the EmailPlugin.
  *
  * @docsCategory plugin
  */
-export interface DefaultEmailPluginOptions {
+export interface EmailPluginOptions {
     /**
      * @description
      * The path to the location of the email templates. In a default Vendure installation,
@@ -80,7 +80,7 @@ export interface DefaultEmailPluginOptions {
     templateVars: { [name: string]: any };
 }
 
-export interface DefaultEmailPluginDevModeOptions {
+export interface EmailPluginDevModeOptions {
     templatePath: string;
     outputPath: string;
     devMode: true;

tslint.json

@@ -1,53 +1,54 @@
 {
-    "defaultSeverity": "error",
-    "extends": [
-        "tslint:recommended"
+  "defaultSeverity": "error",
+  "extends": [
+    "tslint:recommended"
+  ],
+  "jsRules": {
+    "no-unused-expression": true,
+    "quotemark": [true, "single"]
+  },
+  "rules": {
+    "interface-over-type-literal": false,
+    "quotemark": [
+      true,
+      "single"
     ],
-    "jsRules": {
-        "no-unused-expression": true
-    },
-    "rules": {
-        "interface-over-type-literal": false,
-        "quotemark": [
-            true,
-            "single"
-        ],
-        "indent": false,
-        "ordered-imports": [
-            true,
-            {
-                "grouped-imports": true
-            }
-        ],
-        "jsdoc-format": false,
-        "no-inferrable-types": [
-            true,
-            "ignore-params"
-        ],
-        "max-line-length": [
-            true,
-            150
-        ],
-        "member-access": false,
-        "member-ordering": false,
-        "interface-name": false,
-        "array-type": [
-            true,
-            "array-simple"
-        ],
-        "no-non-null-assertion": true,
-        "no-empty-interface": false,
-        "no-switch-case-fall-through": true,
-        "arrow-parens": false,
-        "object-literal-sort-keys": false,
-        "no-unused-expression": true,
-        "max-classes-per-file": [
-            false
-        ],
-        "variable-name": [
-            false
-        ],
-        "no-floating-promises": true
-    },
-    "rulesDirectory": []
+    "indent": false,
+    "ordered-imports": [
+      true,
+      {
+        "grouped-imports": true
+      }
+    ],
+    "jsdoc-format": false,
+    "no-inferrable-types": [
+      true,
+      "ignore-params"
+    ],
+    "max-line-length": [
+      true,
+      150
+    ],
+    "member-access": false,
+    "member-ordering": false,
+    "interface-name": false,
+    "array-type": [
+      true,
+      "array-simple"
+    ],
+    "no-non-null-assertion": true,
+    "no-empty-interface": false,
+    "no-switch-case-fall-through": true,
+    "arrow-parens": false,
+    "object-literal-sort-keys": false,
+    "no-unused-expression": true,
+    "max-classes-per-file": [
+      false
+    ],
+    "variable-name": [
+      false
+    ],
+    "no-floating-promises": true
+  },
+  "rulesDirectory": []
 }