Skip to main content

About

A Cuty-Series Custom JavaScript Formatter

Installation

pip install cutyjs

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, formatter exits with a non-zero status code.

About

The tool is a minimal and fast Python formatter designed to enforce consistent formatting rules across Python 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 Python 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

Project Structure

cutyjs
├── __init__.py
├── __main__.py
├── checker
│   ├── __init__.py
│   └── check_line_length.py
├── cli
│   ├── __init__.py
│   ├── args_handler.py
│   └── version.py
├── common
│   ├── __init__.py
│   ├── compact.py
│   ├── expand.py
│   └── reset.py
├── core
│   ├── __init__.py
│   └── main.py
├── engine
│   ├── __init__.py
│   ├── discovery.py
│   ├── pipelines
│   │   ├── __init__.py
│   │   ├── check.py
│   │   └── solve.py
│   └── worker.py
├── models
│   ├── __init__.py
│   ├── args.py
│   └── content.py
└── solver
    ├── __init__.py
    ├── add_eof_double_blanks.py
    ├── add_keyword_blanks.py
    ├── fix_double_blanks.py
    ├── fix_import_order.py
    ├── fix_indentation.py
    ├── fix_line_ends.py
    └── remove_blanks.py

Design Philosophy

The formatter 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, the formatter focuses on enforcing a small set of reliable formatting guarantees.

Links

Made with <3 by AttAditya

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cutyjs-0.3.0.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for cutyjs-0.3.0.tar.gz
Algorithm Hash digest
SHA256 c92174968091d8716acbad530389155ef1883d86b4ff02309649c1c893d7f22a
MD5 c0341aeda301c56971e2292eb5ba2d38
BLAKE2b-256 25026c9e228a2f0ab3f4c25b18cf99bfc2c5b8952abe9abe82f633756ace9461

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cutyjs-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for cutyjs-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 85a4106f257f0c03c6ed15ac7832505b2c3a2431ffe0bf86bb804400bf3e28f4
MD5 fa90c4d7ffd959120acf55d6aee86593
BLAKE2b-256 59afe06f501557ba3a7583985c28725f5ca63e0187db10c4a889898853053c8b

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