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

Uploaded Python 3

File details

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

File metadata

  • Download URL: superform-0.1.0.tar.gz
  • Upload date:
  • Size: 6.9 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.0.tar.gz
Algorithm Hash digest
SHA256 a236db71e42f05190d56e246c2a613da4df124fd56f527fffe18a2836fdbdcfc
MD5 3db124e3930f809c6e6b77a19b6cfbef
BLAKE2b-256 f3ff915b19576998794b9a606a67c4935742b40c7301f0e19d955a3237e1262c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: superform-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.6 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7737ce12a72855f945d608d2bb0263bf7b885bfa27b61b8f8353921c0f559fa3
MD5 e2b8031a1eed6fa01803d22946f19ac3
BLAKE2b-256 867bf7b537c6e92fa30de9f4223273680c19b9c36b7ba233b9c8043ce28c857c

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