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.7.tar.gz (11.7 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.7-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cutyjs-0.2.7.tar.gz
  • Upload date:
  • Size: 11.7 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.7.tar.gz
Algorithm Hash digest
SHA256 11b8e2191f440ba37df5a17146e9ae46abb23c0836a6198446c2e0fe1db74179
MD5 9654373617a34097904dde5598002161
BLAKE2b-256 6ad5101d7f4089b528285172f0d81bd6b445203df721a4016b0cd0734adc9f68

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cutyjs-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 15.8 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 498960c8fc7e8347f702565e15b97d1f506b79faa614b96a7804ec66003ade5d
MD5 7584f15d2e7d7b486500a9ffd31f07e9
BLAKE2b-256 5d70a9576aebb72328c49c44499e8f8b14aaf6eed4bac473e3118f5fdff393a1

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