Awesome
<p align="center"> <br> <br> <img src=".github/assets/typewriter-logo.svg?sanitize=true" alt="Typewriter logo" /> <br> <br> <br> <br> <a href="http://www.npmjs.com/package/typewriter"> <img src="https://img.shields.io/npm/v/typewriter.svg" alt="NPM Version"> </a> <a href="./.github/LICENSE.md"> <img src="https://img.shields.io/npm/l/typewriter.svg" alt="License"> </a> <a href="https://snyk.io/test/github/segmentio/typewriter?targetFile=package.json"> <img src="https://snyk.io/test/github/segmentio/typewriter/badge.svg?targetFile=package.json" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/segmentio/typewriter?targetFile=package.json"> </a> <br> <br> <br> <img src=".github/assets/readme-example.gif" alt="Typewriter GIF Example" width="70%"/> </p>-
💪 Strongly Typed Analytics: Generates strongly-typed Segment analytics clients that provide compile-time errors, along with intellisense for event/property names, types and descriptions.
-
👮 Analytics Testing: Validate your instrumentation matches your spec before deploying to production, so you can fail your CI builds without a manual analytics QA process.
-
🌐 Cross-Language Support: Supports native clients for
analytics.js,analytics-node,analytics-androidandanalytics-ios. -
✨ Segment Protocols: Built-in support to sync your
typewriterclients with your centralized Segment Tracking Plans.
Get Started
# Walks you through setting up a `typewriter.yml` and generating your first client.
$ npx typewriter init
For more instructions on setting up your typewriter client, such as adding it to your CI, see our documentation.
Contributing
- To submit a bug report or feature request, file an issue here.
- To develop on
typewriteror propose support for a new language, see our contributors documentation.
Migrating from v7
Check the instructions on our documentation
- You'll need to change your Segment Config API Token for a Public API Token
- v8 doesn't support Analytics-iOS nor Analytics-Android. We recommend using Analytics-Swift and Analytics-Kotlin instead which are supported. If you need to use these libraries you can run v7 specifying the version with your commands:
$ npx typewriter@7 build