feat: use class inheritance for plug-in api [wip]

Author: paulrobertlloyd

packages/indiekit/lib/plugin.js

@@ -0,0 +1,105 @@
+import { createRequire } from "node:module";
+import path from "node:path";
+
+import { IndiekitError } from "@indiekit/error";
+import makeDebug from "debug";
+
+import { getPluginId } from "./plugins.js";
+
+const debug = makeDebug(`indiekit:plugin`);
+
+export class IndiekitPlugin {
+  constructor(Indiekit) {
+    this.indiekit = Indiekit;
+    this.name = undefined;
+    this.packageName = undefined;
+    this.options = {};
+  }
+
+  static async register(indiekit, packageName) {
+    debug(`Registering ${packageName}`);
+
+    const plugin = new this(indiekit);
+    plugin.packageName = packageName;
+    plugin.options = indiekit.config[packageName];
+    plugin.name = plugin.name || packageName;
+
+    // Initiate plugin features
+    await plugin.init();
+
+    // Add plugin to Indiekit
+    indiekit.installedPlugins.add(plugin);
+
+    return plugin;
+  }
+
+  get filePath() {
+    const require = createRequire(import.meta.url);
+
+    try {
+      return path.dirname(require.resolve(`${this.packageName}/package.json`));
+    } catch (error) {
+      throw new IndiekitError(
+        `Could not resolve path for ${this.packageName}`,
+        {
+          cause: error,
+          plugin: this.packageName,
+        },
+      );
+    }
+  }
+
+  get id() {
+    return getPluginId(this.packageName);
+  }
+
+  async init() {
+    debug(`Initiating ${this.packageName}`);
+  }
+}
+
+export class IndiekitPostTypePlugin extends IndiekitPlugin {
+  constructor(Indiekit) {
+    super(Indiekit);
+
+    this.type = undefined;
+  }
+
+  get config() {
+    return {};
+  }
+
+  addPostTypes() {
+    // Override post type configuration with user options
+    const postType = { ...this.config, ...this.options };
+
+    if (postType) {
+      debug("Adding post type configuration for", this.type);
+      this.indiekit.postTypes.set(this.type, {
+        ...this.indiekit.postTypes.get(this.type),
+        ...postType,
+      });
+    }
+  }
+
+  get validationSchemas() {
+    return {};
+  }
+
+  addValidationSchemas() {
+    const validationSchemas = this.validationSchemas;
+    if (validationSchemas) {
+      for (const [field, schema] of Object.entries(validationSchemas)) {
+        debug("Adding validation schemas for", field);
+        this.indiekit.validationSchemas.set(field, schema);
+      }
+    }
+  }
+
+  async init() {
+    await super.init();
+
+    this.addPostTypes();
+    this.addValidationSchemas();
+  }
+}

packages/indiekit/lib/plugins.js

@@ -1,26 +1,12 @@
-import { createRequire } from "node:module";
-import path from "node:path";
-const require = createRequire(import.meta.url);
-
 /**
  * Add plug-ins to application configuration
  * @param {object} Indiekit - Indiekit instance
  */
 export async function getInstalledPlugins(Indiekit) {
   for await (const pluginName of Indiekit.config.plugins) {
     const { default: IndiekitPlugin } = await import(pluginName);
-    const plugin = new IndiekitPlugin(Indiekit.config[pluginName]);
-
-    // Add plug-in file path
-    plugin.filePath = path.dirname(require.resolve(pluginName));
-
-    // Add plug-in ID
-    plugin.id = getPluginId(pluginName);
-
-    // Register plug-in functions
-    if (plugin.init) {
-      await plugin.init(Indiekit);
-      Indiekit.installedPlugins.add(plugin);
+    if (IndiekitPlugin.register) {
+      await IndiekitPlugin.register(Indiekit, pluginName);
     }
   }
 }

packages/post-type-article/index.js

@@ -1,32 +1,27 @@
-const defaults = {
-  name: "Article",
-  fields: {
-    name: { required: true },
-    summary: {},
-    content: { required: true },
-    category: {},
-    geo: {},
-    "post-status": {},
-    published: { required: true },
-    visibility: {},
-  },
-};
+import { IndiekitPostTypePlugin } from "../indiekit/lib/plugin.js";
 
-export default class ArticlePostType {
-  constructor(options = {}) {
+export default class ArticlePostTypePlugin extends IndiekitPostTypePlugin {
+  constructor(Indiekit) {
+    super(Indiekit);
+
+    this.type = "article";
     this.name = "Article post type";
-    this.options = { ...defaults, ...options };
   }
 
   get config() {
     return {
-      name: this.options.name,
+      name: "Article",
       h: "entry",
-      fields: this.options.fields,
+      fields: {
+        name: { required: true },
+        summary: {},
+        content: { required: true },
+        category: {},
+        geo: {},
+        "post-status": {},
+        published: { required: true },
+        visibility: {},
+      },
     };
   }
-
-  init(Indiekit) {
-    Indiekit.addPostType("article", this);
-  }
 }