Skip to main content

CLI tool to validate and auto-fix structured files recursively.

Project description

superform

superform is a CLI tool that scans structured text files from the current directory (or a provided path), validates them, and rewrites them with consistent formatting.

Supported formats:

  • YAML: .yaml, .yml
  • JSON: .json
  • XML family: .xml, .xsd, .xsl, .svg

Install

cd superform
pip install -e .

Usage

# scan from current directory and auto-fix files
superform

# scan another directory
superform /path/to/repo

# check only (no writes)
superform --check

# show each processed file
superform --verbose

# validate only a single file
superform path/to/file.json --check

Exit codes

  • 0: all scanned files are valid (and fixed if not in check mode)
  • 1: at least one scanned file has a parse error

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

superform-0.1.1.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

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

superform-0.1.1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file superform-0.1.1.tar.gz.

File metadata

  • Download URL: superform-0.1.1.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for superform-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8fd618053b956467ed4516b33592868e900f7483bf7fb872473e3564fff6817d
MD5 2714f8ee8d7f4ccaf87f3a46af9e73bb
BLAKE2b-256 713ad944c1e31d2b96b05ec22e105fa5b4d5ba6a4ac3e6a7a78acbe9c28411a9

See more details on using hashes here.

File details

Details for the file superform-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: superform-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for superform-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7cd5112a2d23a025e887b1c13a52d5bc7a3dafa535b1dadcfa055410c260b445
MD5 a2c20561ee7c94b0585aeba1956bd646
BLAKE2b-256 32aeba7abf0e4f4688b82d1b69efefe0c49dbc12f8385156efc8d2026ee77350

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