Skip to content

Commit d4c9628

Browse files
authored
Update starter kit template (#5)
* update main template * update dep * remove advanced kit recommendation * update README, add info about logo
1 parent b74196c commit d4c9628

File tree

9 files changed

+3430
-4900
lines changed

9 files changed

+3430
-4900
lines changed

.editorconfig

Lines changed: 0 additions & 14 deletions
This file was deleted.

.gitattributes

Lines changed: 0 additions & 2 deletions
This file was deleted.

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,17 @@ This is an exemplary PostHog plugin. It adds property `"greeting"` to every even
77

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

10-
Want something with batteries included? Check out [PostHog Plugin Advanced Kit](https://github.com/PostHog/posthog-plugin-advanced-kit) – TypeScript, Jest, Prettier, ESLint from the get-go.
10+
You can also add a `logo.png` file to give this plugin its own logo.
11+
12+
Need more information on developing plugins? Check out [the Plugins Overview](https://posthog.com/docs/plugins/build/overview)
1113

1214
## Installation
1315

1416
1. Open PostHog.
1517
1. Head to the Plugins page from the sidebar.
16-
1. Either install Hello World from Available plugins, or install from URL using this repository's URL.
18+
1. Install from URL using this repository's URL.
1719

20+
More information in [the Plugins Tutorial](https://posthog.com/docs/plugins/build/tutorial)
1821
## Questions?
1922

2023
### [Join our Slack community.](https://join.slack.com/t/posthogusers/shared_invite/enQtOTY0MzU5NjAwMDY3LTc2MWQ0OTZlNjhkODk3ZDI3NDVjMDE1YjgxY2I4ZjI4MzJhZmVmNjJkN2NmMGJmMzc2N2U3Yjc3ZjI5NGFlZDQ)

index.test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
const { createEvent, createIdentify, getMeta, resetMeta, clone } = require("@posthog/plugin-scaffold/test/utils");
22

3-
const { processEvent } = require(".");
3+
const { processEvent } = require("./index");
44

55
beforeEach(() => {
66
resetMeta({

jest.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

package-lock.json

Lines changed: 0 additions & 4870 deletions
This file was deleted.

package.json

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,14 @@
1515
"homepage": "https://github.com/PostHog/posthog-plugin-starter-kit#readme",
1616
"author": "PostHog <[email protected]>",
1717
"license": "MIT",
18-
"configSchema": {
19-
"greeting": {
20-
"name": "What greeting would you like to use?",
21-
"type": "string",
22-
"default": "Hello world!",
23-
"required": false
24-
}
18+
"jest": {
19+
"testEnvironment": "node"
2520
},
2621
"scripts": {
2722
"test": "jest ."
2823
},
2924
"devDependencies": {
30-
"@posthog/plugin-scaffold": "0.2.8-alpha.2",
25+
"@posthog/plugin-scaffold": "0.10.0",
3126
"jest": "^26.6.3"
3227
}
3328
}

plugin.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "Hello World",
3+
"url": "<Your Plugin URL here>",
4+
"description": "<Your Plugin description here>",
5+
"main": "index.js",
6+
"posthogVersion": ">= 1.25.0",
7+
"config": [
8+
{
9+
"key": "greeting",
10+
"name": "What greeting would you like to use?",
11+
"type": "string",
12+
"default": "Hello World!",
13+
"required": false
14+
}
15+
]
16+
}

yarn.lock

Lines changed: 3405 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)