Skip to main content

Mdformat plugin to beautify Bash scripts

Project description

Build Status PyPI version

mdformat-beautysh

Mdformat plugin to beautify Bash scripts

Description

mdformat-beautysh is an mdformat plugin that makes mdformat format Bash scripts with Beautysh.

Usage

Install with:

pip install mdformat-beautysh

When using mdformat on the command line, Beautysh formatting will be automatically enabled after install.

When using mdformat Python API, code formatting for Bash scripts will have to be enabled explicitly:

import mdformat


unformatted = """```bash
function bad_func()
 {
echo "test"
}
```
"""

formatted = mdformat.text(unformatted, codeformatters={"bash", "sh"})

assert formatted == """```bash
function bad_func()
{
    echo "test"
}
```
"""

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

mdformat-beautysh-0.1.1.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

mdformat_beautysh-0.1.1-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

Details for the file mdformat-beautysh-0.1.1.tar.gz.

File metadata

  • Download URL: mdformat-beautysh-0.1.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.0 Linux/5.4.0-47-generic

File hashes

Hashes for mdformat-beautysh-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b63a0e3adfc29238917b5d163483952f9326f7737cbe3137d3c6c512daf70789
MD5 2a3371ee26ff50a4fce1f6453f435109
BLAKE2b-256 71d2e29d0f7a2f6b8112b5b96399b427dad20fcfc54a458b52614f8b4dca45cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdformat_beautysh-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.0 Linux/5.4.0-47-generic

File hashes

Hashes for mdformat_beautysh-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 23e52dc93ce4cdee12033766a6146f656c72095f74bc80a2bdfde1974a50ee72
MD5 637b9e862846c819f96c840d3777618c
BLAKE2b-256 dd0579f8253b4206e7bc00d7ba201c32b0c7668d03c142dacf37d981dfb225df

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page