Skip to main content

A lightweight rule-based JavaScript/TypeScript code formatter

Project description

CutyJS

CutyJS currently doesn't obey PEP 8 in many cases. It is a work in progress and may not be ready for production use. Use with caution and report any issues you encounter.

A lightweight JavaScript/TypeScript code formatter.

Installation

pip install cutyjs

About

CutyJS is a minimal and fast JavaScript/TypeScript formatter designed to enforce consistent formatting rules across JS/TS codebases.

Unlike large formatters that heavily restructure code, CutyJS focuses on deterministic formatting rules applied through a small rule engine. Each rule handles a specific formatting concern such as indentation, spacing, blank lines, or import ordering.

The formatter processes files using modular formatting rules, making the system easier to reason about, extend, and control.

Features

  • Deterministic JavaScript/TypeScript formatting
  • Rule-based formatting system
  • Import sorting
  • Consistent indentation enforcement
  • Blank line normalization
  • Trailing space cleanup
  • Line ending normalization
  • Automatic EOF newline insertion
  • Optional check mode for CI pipelines

Usage

Format a file or directory:

cutyjs path/to/file_or_directory

Check if files need formatting (useful for CI or pre-commit):

cutyjs --check path/to/project

If formatting changes are required in check mode, CutyJS exits with a non-zero status code.

Formatting Rules

CutyJS applies a set of focused formatting rules:

  • Blank line normalization
  • Declaration spacing adjustments
  • Removal of excessive blank lines
  • End-of-file newline enforcement
  • Import ordering
  • Indentation consistency
  • Leading blank line cleanup
  • Line ending normalization
  • Trailing comma formatting
  • Removal of trailing spaces

Each rule operates independently, allowing the formatter to remain simple and predictable.

Project Structure

cutyjs
├── __init__.py
├── fmt.py
├── format_file.py
└── rules
    └── format
        ├── blank_lines.py
        ├── declaration_spacing.py
        ├── double_blanks.py
        ├── eof_newline.py
        ├── import_sort.py
        ├── indentation.py
        ├── leading_blank_lines.py
        ├── line_endings.py
        ├── trailing_commas.py
        └── trailing_spaces.py
  • fmt.py provides the CLI entrypoint.
  • format_file.py handles formatting of individual files.
  • rules/format contains independent formatting rules applied sequentially.

Design Philosophy

CutyJS is built around a few core ideas:

  • Minimal implementation
  • Explicit formatting rules
  • Predictable output
  • Easy extensibility
  • Suitable for automation (CI / pre-commit)

Rather than trying to cover every stylistic decision, CutyPy focuses on enforcing a small set of reliable formatting guarantees.

Status

Experimental and under active development.

Links

Made by AttAditya

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cutyjs-0.2.9.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cutyjs-0.2.9-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file cutyjs-0.2.9.tar.gz.

File metadata

  • Download URL: cutyjs-0.2.9.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for cutyjs-0.2.9.tar.gz
Algorithm Hash digest
SHA256 b7c545f18013b307ac1f4e0b409e2391938592b8b3d1f4a4c1804e9c835b77bc
MD5 957905332a2d6564ae05912ab855d81a
BLAKE2b-256 463a4a921675fc3ea14debcba4b2e1d4d81618b9cf1abfd5bcd005d1678968e1

See more details on using hashes here.

File details

Details for the file cutyjs-0.2.9-py3-none-any.whl.

File metadata

  • Download URL: cutyjs-0.2.9-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for cutyjs-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 c7dd0e0d25d2c61bc0ec16ea8c5378fa6de919ce0d61654cf44b1cb1bee3b01c
MD5 3716b3c0ba7369690fee842022d0402f
BLAKE2b-256 f6009123bba0646594d7ec7c51b799db7cc889d86d76d1b30976c63bb223f84b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page