fix(registerplugin): better error on type (#225)

* fix(registerplugin): better error on type

When given the wrong type for a plugin, throw a proper explaination.

closes #219

* fix(typo): fix typo in errormessage

Author: SanderElias

scully/pluginManagement/pluginRepository.ts

@@ -39,9 +39,12 @@ export const registerPlugin = (
   {replaceExistingPlugin = false} = {}
 ) => {
   if (!['router', 'render', 'fileHandler'].includes(type)) {
-    throw new Error(
-      `Type "${yellow(type)}" is not a known plugin type for registering plugin "${yellow(name)}"`
-    );
+    throw new Error(`
+--------------
+  Type "${yellow(type)}" is not a known plugin type for registering plugin "${yellow(name)}".
+  The first parameter of registerPlugin needs to be one of: 'fileHandler', 'router', 'render'
+--------------
+`);
   }
   if (replaceExistingPlugin === false && plugins[type][name]) {
     throw new Error(`Plugin ${name} already exists`);

scully/pluginManagement/systemPlugins.ts

@@ -3,3 +3,4 @@ import '../fileHanderPlugins/asciidoc';
 import '../renderPlugins/contentRenderPlugin';
 import '../routerPlugins/jsonRoutePlugin';
 import '../routerPlugins/contentFolderPlugin';
+import '../routerPlugins/ignoredRoutePlugin';

scully/routerPlugins/ignoredRoutePlugin.ts

@@ -0,0 +1,7 @@
+import {registerPlugin} from '../pluginManagement/pluginRepository';
+
+/**
+ * The ignoredPlugin helps to take routes out.
+ * when you use this plugin, the route will never be rendered.
+ */
+registerPlugin('router', 'ignored', () => []);