a204c89066
|
||
|---|---|---|
| .. | ||
| compiler | ||
| installation_support | ||
| npm_package | ||
| src | ||
| test | ||
| .prettierignore | ||
| .prettierrc.json | ||
| ARCHITECTURE.md | ||
| CHANGELOG.md | ||
| LICENSE.md | ||
| README.md | ||
| compile.js | ||
| eslint.config.mjs | ||
| package-lock.json | ||
| package.json | ||
| playwright.config.ts | ||
| release-update-changelog.sh | ||
README.md
Plausible tracker
This contains Plausible tracker script and NPM package which Plausible users integrate into their site and which captures pageviews and more.
Development
See also ARCHITECTURE.md
Dependencies
To download dependencies, do:
npm install
npx playwright install # installs browsers used by playwright
Compilation
Compile tracker code by node compile.js.
Use node compile.js --watch to watch for changes.
Use node compile.js --web-snippet if you need to update web snippet code.
Tests
Tests can be run in UI mode via npm run playwright --ui. This helps with debugging.
NPM package
To test changes to the npm package by installing the local version against a test project, we recommend:
- installing yalc via
npm install yalc -g - compiling the tracker
- running
yalc publishintracker/npm_packagedirectory
More instructions can be found in yalc repo.
Cloud deployment
Handled via PRs. When making tracker changes, it's required to:
- Tag your PR with a
tracker release:label - Update
tracker/CHANGELOG.md
After merge github actions automatically:
- includes the updated tracker scripts in the next cloud deploy
- updates npm package package.json and CHANGELOG.md with the new version
- releases the new package version on NPM.