Plugins


Overview


You can create and include plugins for you Actionhero project. Plugins are collections of tasks, actions, servers, initializers, and public static assets that are collected as a module. You can install plugins via NPM or keep them in a local path. This enables a few useful features:

  • Sharing and re-using common code
  • Composing your application via namespaced plugins for simpler SOA development.

Plugins are loaded after all local Actionhero project files, but initializers follow the same priority scheme as all other initializers.


Creating


/
| - actions
| - tasks
| - servers
| - initializers
| - config
| - public
| - cli
|
| - package.json

To create a plugin, create a project with the above structure via actionhero generate plugin. Note that actionhero should be a peerDependency within your plugin, with the proper version.

This structure will allow elements to be loaded into Actionhero (we search /actions for actions, /tasks for tasks, etc)

When developing your plugin locally, you can load it into an existing Actionhero project to test it out.

To include your plugin in an Actionhero project, add it to config/plugins.js

// If you want to use plugins in your application, include them here:
return {
  myPlugin: { path: __dirname + "/../node_modules/myPlugin" }
};

// You can also toggle on or off sections of a plugin to include (default true for all sections):
return {
  myPlugin: {
    path: __dirname + "/../node_modules/myPlugin",
    actions: true,
    tasks: true,
    initializers: true,
    servers: true,
    cli: true,
    public: true
  }
};

Please use the npm naming convention ah-(name)-plugin when uploading your plugin to npm


Testing


This new plugin structure also makes testing plugins much easier, as you can boot up an Actionhero server from within your plugin (if actionhero is a devDependency) with the following:

const path = require("path");
process.env.PROJECT_ROOT = path.join(
  __dirname,
  "..",
  "node_modules",
  "actionhero"
);

const actionhero = require("actionhero");
const Actionhero = new actionhero.Process();
let api;

describe("My Plugin", () => {
  before(async () => {
    let configChanges = {
      plugins: {
        testPlugin: { path: path.join(__dirname, "..") }
      }
    };

    api = await Actionhero.start({ configChanges });
  });

  after(async () => {
    await Actionhero.stop();
  });

  it("does stuff", async () => {
    //...
  });
});

Methods


When creating plugins, you may find yourself wanting to do things which could normally be accomplished easily with a "top level" Actionhero project, but might be difficult from within a plugin. Here are some helpers:


Routes:


  • api.routes.registerRoute(method, path, action, apiVersion, matchTrailingPathParts)
    • Add a route to the system.

Published


You can view a list of plugins maintained by at www.actionherojs.com/plugins


    Solutions

    Actionhero was built from the ground up to include all the features you expect from a modern API framework.

    Open Source


    The Actionhero server is open source, under the Apache-2 license


    Actionhero runs on Linux, OS X, and Windows


    You always have access to the Actionhero team via Slack and Github



    Premium Training & Review


    We provide support for corporate & nonprofit customers starting at a flat rate of $150/hr. Our services include:


    • Remote training for your team
    • Code Reviews
    • Best Practices Audits
    • Custom plugin & Feature Development

    We have packages appropriate for all company sizes. Contact us to learn more.


    Premium Training & Review


    We provide support for corporate & nonprofit customers starting at a flat rate of $150/hr. Our services include:


    • Remote training for your team
    • Code Reviews
    • Best Practices Workshops
    • Custom plugin & Feature Development

    We have packages appropriate for all company sizes. Contact us to learn more.


    Enterprise


    For larger customers in need of a support contract, we offer an enterprise plan including everything in the Premium plan plus:


    • 24/7 access to core members of the Actionhero Team
    • Emergency response packages
    • Deployment support
    • ...and custom development against Actionhero’s core as needed.