Registry / devops / rudder-typer-mattiasmts

rudder-typer-mattiasmts

library1.7.9jsnpmunverified

A CLI tool from RudderStack (v1.7.9) that generates strongly-typed analytics client libraries from a centralized tracking plan spec. Supports JavaScript, TypeScript, Node.js, Android, and iOS. Compile-time errors and intellisense help catch instrumentation mismatches before production. Integrates with the RudderStack Tracking Plans API. Released under Apache 2.0. Active development with monthly releases. Differentiator: prevents silent analytics drift and enables CI validation of event schemas.

devops http-networking data

npm install rudder-typer-mattiasmts

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · RUDDER-TYPER-MATTI

rudder-typer-mattiasmts

devopsjavascriptv1.7.9

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

RudderTyper

✓ import { RudderTyper } from 'rudder-typer-mattiasmts'

✗ const RudderTyper = require('rudder-typer-mattiasmts')

ESM-only; CommonJS require will fail.

RudderAnalytics

✓ import { RudderAnalytics } from '@rudderstack/analytics-js'

✗ import { RudderAnalytics } from 'rudder-typer-mattiasmts'

RudderTyper is a code generator, not the runtime analytics SDK.

generateClient

✓ import { generateClient } from 'rudder-typer-mattiasmts'

Used programmatically to generate client code.

Initializes a RudderTyper project using the CLI, configures it, builds the client, and demonstrates using it with the RudderStack JavaScript SDK.

npx rudder-typer-mattiasmts init # Follow the interactive prompt to configure. npx rudder-typer-mattiasmts build npm install @rudderstack/analytics-js import { RudderAnalytics } from '@rudderstack/analytics-js'; import generatedClient from './generated/rudder-typer'; const analytics = new RudderAnalytics(); generatedClient(analytics, { writeKey: 'YOUR_WRITE_KEY' });

rudder-typer --version

Debug

Known issues

deprecatedv1.6.0 introduced a breaking change: the generated client now sorts tracking plan choices by `createdAt` during initialization, which may alter event ordering.

fix

Update to v1.6.0 or later and verify event order in tests.

affects: <1.6.0

gotchaThe CLI `init` command only supports interactive mode; non‑interactive environments will hang.

fix

Use `npx rudder-typer-mattiasmts init` only in a TTY. For CI, preconfigure a `ruddertyper.yml` and run `build`.

affects: *

gotchaGenerated clients require a separate runtime analytics SDK (e.g., `@rudderstack/analytics-js` for browser).

fix

Install the appropriate RudderStack SDK for your platform.

affects: *

deprecatedThe `plan.json` file is cached locally; calling `update` may not reflect the latest tracking plan if the cache is stale.

fix

Run `rm -r ~/.ruddertyper` to clear cache before `update` if changes are not appearing.

affects: <=1.7.9

gotchaTypeScript users must manually ensure the generated `.ts` files include the correct import paths after moving or copying the generated directory.

fix

Check the generated index file and adjust imports relative to your project structure.

affects: *

Errors

Common errors & fixes

Your workspace does not have any Tracking Plans

CLI version <1.6.2 or incorrect API token.

fix

Update to latest version (`npx rudder-typer-mattiasmts@latest`) and verify API token with `npx rudder-typer-mattiasmts token`.

Error: EACCES: permission denied, open '~/.ruddertyper/token'

Missing write permissions to the config directory.

fix

Run `sudo chown -R $USER ~/.ruddertyper` or change the config path in ruddertyper.yml.

Could not find a plan.json. Run `npx rudder-typer build` first.

The `update` command was run before a plan was generated.

fix

Run `npx rudder-typer-mattiasmts build` first, or use `init` to create the initial plan.

Upgrade

Version history

1.7.9latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

7 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/rudderlabs/rudder-typer ↗

packagehttps://www.npmjs.com/package/rudder-typer-mattiasmts ↗

homepagehttps://rudderstack.com ↗