{"_id":"@alpeshabitat/matomo","_rev":"1-502ea614ea7e81f90c59438107486d25","name":"@alpeshabitat/matomo","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@alpeshabitat/matomo","version":"1.0.0","type":"module","author":{"name":"benoit.barberot@alpeshabitat.fr"},"scripts":{"dev":"vite","build":"tsc && vite build","watch":"vite build --watch","preview":"vite preview"},"keywords":["analytics","symfony","matomo"],"exports":{".":{"import":"./dist/main.js","require":"./dist/main.cjs.js"}},"main":"./dist/main.js","module":"./dist/main.es.js","typings":"./dist/main.d.ts","devDependencies":{"@rollup/plugin-typescript":"^8.5.0","@types/node":"^18.7.18","prettier":"2.7.1","rollup-plugin-typescript-paths":"^1.4.0","tslib":"^2.4.0","typescript":"^4.8.3","vite":"^3.1.0"},"dependencies":{"core-js":"^3.25.1"},"gitHead":"32d82e8654ed892641b9e85121557d89177cf35e","description":"Micro librairie permettant d'utiliser facilement l'outil [Matomo](https://fr.matomo.org/)","_id":"@alpeshabitat/matomo@1.0.0","_nodeVersion":"16.15.0","_npmVersion":"8.5.5","dist":{"integrity":"sha512-Wnngs/1csT3xfE7c1AgZZPnvWXpv9KedYqXjUBwSAxn9Yy1nTiChcZ+mHsfQiaKxnlaqNN+YOd6fiVoOkLXXiw==","shasum":"0ee595f995112575957b75c2107a23585d458a5a","tarball":"https://registry.npmjs.org/@alpeshabitat/matomo/-/matomo-1.0.0.tgz","fileCount":6,"unpackedSize":6927,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD9szrsjjqPxFeuxtIhlQyPN8M0WJxBbR57aFUPsNWv6QIgXx+BTo/gehBHfjqfD00t3245wdzR7cXqs/jpwrXosnk="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjKFzcACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqIJw/9Hlw0T9cWqJO0rY41u/NAujihhR04xT+R/ZUyGzG0HEPirLpZ\r\n60HOni5N1sGtyBVayOuiZLQ7vzZx0+xIrPf4pEsCKuSGIA4F4R3AjNQX1rc+\r\n8UWhRBTZtBKEHWdBa4LYwKHTIP8af0HBQ0K038UcFTL8cZtcdGrkzw99ZKAa\r\nReGo3ibKns1VmK5tCqxBWAxk5t7XIdNXoizqSc2AVgFL2HVCutDcTxsrrTuZ\r\ncS8AWFJlaVugDzoI+dzj6ipDCf/9dJ21E0ORSAerZXTDWfaOf1GwfHIj3GLd\r\n8k7IvAuQyURC+kf9QxwRkDHlMMxv1IDM2DSOK/lDPpP1j6qe7V/KA6lREAmV\r\nrt394rgjyCngGsbVJaRO/IYAfJrwrxxC80MtkyCRby+La5R9LG8yJ1RJCNqc\r\ny2vAUOBb3jVJFhuTWA6DsxraQMNVu4gIJKgulKlD/LVdFTSoB0uF/hbqLIhJ\r\nPhznjbHNr4otNLBxWj8wrQK6cSw/z7m671p/gqmgefQI8NGFDCh0O/NuKbOU\r\nhBLTnG3rO8m9AVqxmQ27RWtrIouFdHFYP/UCL4H7oSnrgbmI+1w8FpHwImX2\r\nNImYoF0WcY2EsXU/b2m7R39OG2UsGpNz+D1M9C6FeA+b73v3Sy2nN8wioD3s\r\n4NfaSRiw2kovibx+YvIglS0SXMye5mmHMo4=\r\n=JyXB\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"barberob","email":"barberot.b@proton.me"},"directories":{},"maintainers":[{"name":"barberob","email":"barberot.b@proton.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/matomo_1.0.0_1663589596095_0.08096908235693978"},"_hasShrinkwrap":false}},"time":{"created":"2022-09-19T12:13:16.028Z","1.0.0":"2022-09-19T12:13:16.237Z","modified":"2024-05-14T14:33:55.975Z"},"maintainers":[{"email":"bruno.barthez@alpeshabitat.fr","name":"bruno38000"},{"email":"barberot.b@proton.me","name":"barberob"}],"description":"Micro librairie permettant d'utiliser facilement l'outil [Matomo](https://fr.matomo.org/)","keywords":["analytics","symfony","matomo"],"author":{"name":"benoit.barberot@alpeshabitat.fr"},"readme":"# matomo\nMicro librairie permettant d'utiliser facilement l'outil [Matomo](https://fr.matomo.org/)\n\n> ⚠️ Attention ⚠️ La documentation est écrite pour une utilisation avec [Symfony](https://symfony.com/) mais est compatible avec n'importe quel projet.\n\n## Utilisation\n\n### Installation\nL'utilisation de la librairie se veux le plus simple possible.\nInstallez la avec\n```bash\nnpm install @alpeshabitat/matomo\n```\n### Utilisation\nImportez la librairie dans votre fichier JavaScript\n```js\nimport matomo from '@alpeshabitat/matomo'\n```\n\nIl faut ensuite l'activer\n```js\nmatomo()\n```\nOn peut également passer un objet de configuration pour modifier certains paramètres si besoin. Voici les valeurs par défaut et leur utilité.\n```js\nmatomo({\n debug: false, // Active le mode debug qui affiche les erreurs et les infos envoyées à matomo dans la console\n trackerUrl: null, // Url du tracker de matomo (ex: https://matomo.example.com)\n siteId: null, // Id du site sur matomo\n userId: null // Id de l'utilisateur sur matomo (ex: nom prenom de l'utilisateur connecté)\n})\n```\n\nLes éléments de configuration ne sont la que pour les cas particuliers. Si vous n'avez pas besoin de les modifier, vous pouvez simplement utiliser la librairie sans les passer en paramètre. Dans ce cas, il est nécessaire de placer un ```span``` avec l'id ```matomo-data``` dans votre page HTML. Ce span doit contenir les données suivantes :\n```twig\n\n\n```\nLes données sont récupérées depuis ce span et sont utilisées pour l'initialisation de la librairie.\n\nDans votre fichier de config twig.yaml, il faut ajouter les données utilisées ci-dessus.\n```yaml\ntwig:\n globals:\n tracker_url: '%env(TRACKER_URL)%'\n tracker_site_id: '%env(TRACKER_SITE_ID)%'\n```\n\nEnfin, il faut ajouter les variables d'environnement dans votre fichier .env\n```dotenv\n###> MATOMO ###\nTRACKER_URL=\"\"\nTRACKER_SITE_ID=\n###< MATOMO ###\n```\n\n\n\nEt c'est tout!\n\n## 👾 Environnement de développement\n\n### 🏁 Pré-requis\n\n* [NPM/Nodejs](https://nodejs.org/en/)\n\n## 🤝 Contribuer au projet\n\nDans le dossier du projet Lancer la commande\n```bash\nnpm install\n```\n\nIl est possible de tester facilement le paquet en l'installant dans un autre projet avec la commande\n```bash\nnpm install /chemin/complet/vers/le/dossier/de/matomo\n```\n\nLes changements s'appliqueront en temps réel (après avoir fait un ```npm run build```)\n\n\n### 📃 Règles de codage\n\n- Le projet utilise une configuration prettier disponible dans le fichier prettierrc, il faut donc installer l'extension [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) sur VsCode\n- Indentation = 4 espaces\n\n### 🔍 Merge Request\n\nLes \"Merges Requests\" sont les bienvenues.\n\nPour les changements majeurs, veuillez en discuter avec le reste de l'équipe.\n\nMerci de ne jamais travailler directement dans la branche main.\n\n### 🏛 Code de Conduite\n\nDans l'intérêt de favoriser un environnement ouvert et accueillant, nous nous engageons à faire de la participation à ce projet une expérience exempte de harcèlement pour tout le monde, quel que soit le niveau d'expérience, le sexe, l'identité ou l'expression de genre, l'orientation sexuelle, le handicap, l'apparence personnelle, la taille physique, l'origine ethnique, l'âge, la religion ou la nationalité.","readmeFilename":"README.md"}