mdformat_clang 0.0.1

An mdformat plugin for any language supported by clang-format

mdformat-clang

An mdformat plugin for clang-format.

Supports all of the languages supported by clang-format with the following markdown tags:

• cpp
• cxx
• c++
• c
• csharp
• c#"
• cs
• java
• javascript
• typescript
• ts
• json
• json-object
• objc
• obj-c
• objectivec
• objective-c
• protobuf
• proto
• tablegen
• td
• verilog
• v
• objective-c++
• objectivec++
• obj-c++
• objc++

Development

This package utilises flit as the build engine, and tox for test automation.

To install these development dependencies:

pip install tox

To run the tests:

tox

and with test coverage:

tox -e py-cov

The easiest way to write tests, is to edit tests/fixtures.md

To run the code formatting and style checks:

tox -e py-pre-commit

or directly

pip install pre-commit
pre-commit run --all

To run the pre-commit hook test:

tox -e py-hook

Publish to PyPi

Either use flit directly:

pip install flit
flit publish

or trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. v0.0.1.

Note, this requires generating an API key on PyPi and adding it to the repository Settings/Secrets, under the name PYPI_KEY.