righteous

library1.1.3jsnpmunverified

Righteous is a Kary Foundation coding style based code formatter for TypeScript and JavaScript, using TypeScript's own compiler service APIs. It enforces Kary Foundation's indentation and spacing policies. This package is version 1.1.3 with no major updates since its initial release. It is primarily intended for use within Kary Foundation's IDEs and editors, not as a general-purpose formatter like Prettier. The package ships with TypeScript declaration files but lacks active maintenance.

devops

npm install righteous

package ↗

INSTALL

IMPORT

SIG · RIGHTEOUS

righteous

devopsjavascriptv1.1.3

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.

righteous

✓ import righteous from 'righteous'

✗ const righteous = require('righteous')

The library is ESM-first and uses a single default export of a function.

RighteousOptions

✓ import { RighteousOptions } from 'righteous'

✗ import RighteousOptions from 'righteous'

This is a named type export, not a default export. Use named import for TypeScript options type.

format

✓ import { format } from 'righteous'

✗ import format from 'righteous'

The library also exports a named function 'format' for explicit usage, but the default export is the same function.

Shows basic usage: import the formatter, call it with source code and optional options, and get formatted output.

import righteous from 'righteous'; // Or CommonJS: const righteous = require('righteous').default; const sourceCode = `function hello) { return;`; const formatted = righteous(sourceCode, { // Options can include: indentSize, tabChar, etc. indentSize: 2, }); console.log(formatted); // Output: function hello() { return; }

Debug

Known issues

breakingRequires TypeScript as a peer dependency. Not installing TypeScript will cause a runtime error.

fix

Install TypeScript in your project: npm install typescript

affects: >=1.0.0

deprecatedThe package uses deprecated TypeScript compiler APIs (Compiler API). Future versions of TypeScript may break compatibility.

fix

Consider using a modern formatter like Prettier for long-term maintenance.

affects: >=1.0.0

breakingDefault export is a function, but CommonJS require returns an object with a 'default' property. Using const righteous = require('righteous') will result in righteous being an object, not a function.

fix

Use ESM imports or const righteous = require('righteous').default;

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: righteous is not a function

In CommonJS (Node.js), require('righteous') returns an object with a 'default' property; the function is not directly the require result.

fix

Use import righteous from 'righteous' (ESM) or const righteous = require('righteous').default;

Cannot find module 'typescript'

TypeScript is a peer dependency and not installed automatically.

fix

Run npm install typescript

error TS2307: Cannot find module 'righteous'

The TypeScript declaration file path is not resolved correctly or the module is not installed.

fix

Ensure righteous is installed and referenced in tsconfig.json. If needed, add reference: /// <reference path="node_modules/righteous/typings/righteous.d.ts" />

Upgrade

Version history

1.1.3latest on npm

Audit

Dependencies

typescriptrequiredRighteous uses TypeScript's compiler service to parse and format TypeScript/JavaScript. It requires the TypeScript package to be installed as a peer dependency.

Agent activity

4 hits · last 30 days

node

Resources

packagerighteous ↗