https://github.com/sayanarijit/tomlcheck

A simple toml syntax checker
https://github.com/sayanarijit/tomlcheck

pre-commit pre-commit-hooks toml toml-validation

Last synced: about 2 months ago
JSON representation

A simple toml syntax checker

• Host: GitHub
• URL: https://github.com/sayanarijit/tomlcheck
• Owner: sayanarijit
• Created: 2020-03-19T08:30:06.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-22T05:05:08.000Z (6 months ago)
• Last Synced: 2024-09-29T04:53:20.903Z (3 months ago)
• Topics: pre-commit, pre-commit-hooks, toml, toml-validation
• Language: Python
• Size: 33.2 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
tomlcheck

==========

.. image:: https://img.shields.io/pypi/v/tomlcheck.svg

    :target: https://pypi.org/project/tomlcheck

    :alt:

.. image:: https://img.shields.io/pypi/pyversions/tomlcheck.svg

    :target: https://pypi.org/project/tomlcheck

    :alt:

.. image:: https://travis-ci.com/sayanarijit/tomlcheck.svg?branch=master

    :target: https://travis-ci.com/sayanarijit/tomlcheck

    :alt:

.. image:: https://codecov.io/gh/sayanarijit/tomlcheck/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/sayanarijit/tomlcheck

    :alt:

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/python/black

    :alt:

A simple toml syntax checker.

Designed to be used by `pre-commit `_ hooks.

Installation

------------

.. code-block:: bash

    pip install -U tomlcheck

Usage

-----

Check files:

.. code-block:: bash

    tomlcheck $(find . -type f -name "*.toml")

    # Or read from stdin

    find . -type f -name "*.toml" | tomlcheck -

With logging:

.. code-block:: bash

    tomlcheck --log-level DEBUG $(find . -type f -name "*.toml")

    

    # Or read from stdin

    find . -type f -name "*.toml" | tomlcheck --log-level DEBUG -

In `pre-commit `_ config:

.. code-block:: yaml

    # .pre-commit-config.yaml

    - repo: local

      hooks:

      - id: tomlcheck

        name: Check TOML Syntax

        description: Checks TOML files for valid syntax.

        entry: tomlcheck

        language: system

        files: \**/*.toml$

        stages: [commit, push, manual]

Help Menu

---------

.. code-block:: bash

    tomlcheck --help