Registry / devops / prettier-plugin-telepact

prettier-plugin-telepact

library1.0.0-alpha.301jsnpmunverified

A Prettier plugin that formats Telepact API schema files (*.telepact.json and *.telepact.yaml). Currently in alpha (v1.0.0-alpha.301), released as part of the Telepact monorepo with weekly updates. It focuses on consistent docstring formatting and indentation. Unlike generic JSON/YAML formatters, this plugin understands the Telepact schema structure, ensuring proper alignment of docstrings and fields. Primarily useful for teams that author schemas in JSON; YAML block scalars are recommended for new projects.

devops

npm install prettier-plugin-telepact

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PRETTIER-PLUGIN-TE

prettier-plugin-telepact

devopsjavascriptv1.0.0-alpha.301

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

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

prettier-plugin-telepact

✓ Add to Prettier plugins array in config: 'plugins': ['prettier-plugin-telepact']

No direct import in code; configured via .prettierrc or Prettier API options.

Configure Prettier to use the Telepact plugin and format schema files.

// .prettierrc { "plugins": ["prettier-plugin-telepact"], "overrides": [ { "files": "*.telepact.json", "options": { "parser": "telepact-parse" } } ] } // Run: npx prettier --write '**/*.telepact.json'

Debug

Known issues

gotchaThe plugin only formats files when the parser is explicitly set to 'telepact-parse'. Without the parser override, Prettier will fall back to the default JSON parser.

fix

Add override in .prettierrc: { 'files': '*.telepact.json', 'options': { 'parser': 'telepact-parse' } }

affects: >=1.0.0-alpha.301

gotchaThe plugin is only needed for .telepact.json files; .telepact.yaml files can be formatted with standard YAML plugins. Using this plugin on YAML files may produce unexpected results.

fix

Only apply this plugin to .telepact.json files via overrides.

affects: >=1.0.0-alpha.301

deprecatedThe plugin is in alpha and may undergo breaking changes. Schema structure changes in future Telepact releases may cause formatting inconsistencies.

fix

Pin to a specific version and test formatting after upgrading Telepact.

affects: >=1.0.0-alpha.301

Errors

Common errors & fixes

Error: No parser could be inferred for file: example.telepact.json

Missing parser override in Prettier configuration.

fix

Add override: { 'files': '*.telepact.json', 'options': { 'parser': 'telepact-parse' } }

Cannot find module 'prettier-plugin-telepact'

Plugin not installed or not in node_modules.

fix

Run 'npm install prettier-plugin-telepact' and ensure it's listed in package.json.

Upgrade

Version history

1.0.0-alpha.301latest on npm

Audit

Dependencies

prettierrequiredCore dependency; this is a plugin for Prettier

Agent activity

10 hits · last 30 days

node

Resources

githubhttps://github.com/telepact/telepact ↗

packagehttps://www.npmjs.com/package/prettier-plugin-telepact ↗

homepagehttps://telepact.org ↗