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, .wsdl, .plist, .xhtml, .config, .csproj, .vbproj, .fsproj, .props, .targets, .resx

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: superform-0.1.3.tar.gz
  • Upload date:
  • Size: 10.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.3.tar.gz
Algorithm Hash digest
SHA256 8ccc3df75956f1d59c9c2fff62dd728d84a4ff6042853410f14de99c9181c6d4
MD5 2a5203e74a287694a1d7588eb444f772
BLAKE2b-256 10196d1ca498185c40ea577ccc5e9d86a70d034b2f598033902bd035b21213a4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: superform-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 8.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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 11e5c4286192557af0b461c36ba57ad8ab77c2d33c7d8623ab1ef7ca8f6a1105
MD5 6b2e849d02a0387de82cae33b2d70112
BLAKE2b-256 1c1d40a30e3440d29e89b2e35601b10dc526c7d7d85f45ffe134ed2da3f8ee32

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