JSPM

posthog-js

1.9.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1304465
  • Score
    100M100P100Q221603F
  • License MIT

Posthog-js allows you to automatically capture usage and send events to PostHog.

Package Exports

  • posthog-js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (posthog-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

PostHog.js

npm package MIT License

Please see the main PostHog docs.

Specifically, the JS integration details.

Testing

Unit tests: run yarn test Cypress: yarn cypress

Running TestCafe E2E tests with BrowserStack

Testing on IE11 requires a bit more setup.

  1. Run posthog locally on port 8000
  2. Run python manage.py setup_dev --no-data on posthog repo, which sets up a demo account
  3. Optional: rebuild array.js on changes: nodemon -w src/ --exec bash -c "yarn build-array"
  4. Export browserstack credentials: export BROWSERSTACK_USERNAME=xxx BROWSERSTACK_ACCESS_KEY=xxx
  5. Run tests: npx testcafe "browserstack:ie" testcafe/e2e.spec.js

Developing together with another repo

Update dependency in package.json to e.g. "posthog-js": "link:../posthog-js", yarn and run yarn build && yarn build-module

Releasing a new version

To release a new version, make sure you're logged in to NPM (npm login)

We tend to follow the following steps:

  1. Merge your changes into master
  2. Release changes as a beta version
    • npm version 1.x.x-beta.0
    • npm publish --tag beta
    • git push --tags
  3. Create a PR linking to this version in the main repo
  4. Once deployed and tested, write up CHANGELOG.md, and commit.
  5. Release a new version
    • npm version 1.x.x
    • npm publish
    • git push --tags
  6. Create a PR linking to this version in the main repo

Questions?

Join our Slack community.