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

Uploaded Python 3

File details

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

File metadata

  • Download URL: superform-0.1.2.tar.gz
  • Upload date:
  • Size: 8.8 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.2.tar.gz
Algorithm Hash digest
SHA256 849e81015465996fc661a984c3f59b9eafda17af5070b5b58430a5a15bf943fd
MD5 20803a6f85bf820edf40085cee965ab0
BLAKE2b-256 239809be47b9199d8bd48586296146dac5653e23afc8ebdac446ae5e6f8e636f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: superform-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 90c632df9965612c3855baf784cf7314bef87f6bbeac86da21a4142bbc3e60a4
MD5 6d56df7d05bc38f0929231a4fd404771
BLAKE2b-256 c23661f711d86ba43c688a3cb91eb54555d69b2ae4e1a1e0354521a3ab59d925

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