posthog / posthog-hello-world-plugin

Exemplary PostHog plugin

PostHog Plugin: Hello World Starter Kit

This is a basic exemplary PostHog plugin. It adds property "greeting" to every event, with a configurable value (default: "Hello world!").

Feel free to use it as a base for your own plugins!

How to develop

All of the plugin's code is located in the index.js file, which is JavaScript ran inside of PostHog. To get yourself up to speed with this environment, we sincerely recommend checking out our [Plugins overview in PostHog Docs](the Plugins Overview. For a crash course, read our plugin building tutorial in PostHog Docs.

How to test

To test the plugin, you'll need to install a few npm dependencies already specified in package.json:

npm install

This will get you the testing library Jest and some our test helpers. Then to run tests it's just:

npm test

How to install

1. Open PostHog.
2. Open the Plugins page from the sidebar.
3. Head to the Advanced tab.
4. "Install from GitHub, GitLab or npm" using this repository's URL.

Questions?

Join our Slack community.

We're here to help you with anything PostHog!

posthog-hello-world-plugin's Issues

Rename to posthog-helloworld-plugin

Rename the plugin to be in line with others, since it's public. Actually I'd suggest a slightly different naming scheme: posthog-plugin-${pluginName}, but it's mostly about consistency anyway.

Update the plugin for $CURRENT_YEAR

Plugins have evolved quite a bit since this plugin last saw any updates. Let's get it up to speed with code from PostHog/posthog-plugin-starter-kit#6.