Browse Source

Added files.

master
Franco Masotti 1 year ago
parent
commit
6cb205cad2
Signed by: frnmst
GPG Key ID: 24116ED85666780A
  1. 1
      assets/buy_me_a_coffee.svg
  2. 1
      docs/api.rst
  3. 1
      docs/index.rst
  4. 41
      docs/pre_commit_hook.rst

1
assets/buy_me_a_coffee.svg

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="106" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="106" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555555" d="M0 0h31v20H0z"/><path fill="#ff813f" d="M31 0h75v20H31z"/><path fill="url(#b)" d="M0 0h106v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="165" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="210">buy</text><text x="165" y="140" transform="scale(.1)" textLength="210">buy</text><text x="675" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="650">me a coffee</text><text x="675" y="140" transform="scale(.1)" textLength="650">me a coffee</text></g> </svg>

After

Width:  |  Height:  |  Size: 965 B

1
docs/api.rst

@ -39,3 +39,4 @@ Exceptions
.. autoexception:: InvalidCache
.. autoexception:: InvalidOutput
.. autoexception:: InvalidCommonDataStructure
.. autoexception:: IncoherentProgrammingLanguageValue

1
docs/index.rst

@ -12,6 +12,7 @@ Welcome to licheck's documentation!
install
api
pre_commit_hook
contributing
workflow
source_code

41
docs/pre_commit_hook.rst

@ -0,0 +1,41 @@
Pre-commit hook
---------------
This repo provides the following plugin for use with the `Pre-commit framework <https://pre-commit.com/>`_:
.. literalinclude:: ../.pre-commit-hooks.yaml
:caption: The .pre-commit-hooks.yaml file
:name: .pre-commit-hooks.yaml
:language: yaml
Add a ``.pre-commit-config.yaml`` file in the root of your git repo.
These are the default plugin settings:
.. code-block:: yaml
:caption: A simple example of a .pre-commit-config.yaml file
:name: .pre-commit-config.yaml simple
repos:
- repo: https://github.com/frnmst/licheck
rev: master # or a specific git tag from md-toc
hooks:
- id: licheck
You can override the defaults via the ``args`` parameter, such as:
.. code-block:: yaml
:caption: Example of arguments passed as a pre-commit
:name: .pre-commit-config.yaml args
repos:
- repo: https://github.com/frnmst/licheck
rev: master # or a specific git tag from md-toc
hooks:
- id: licheck
args: ['.allowed_licenses.yml', '--clear-cache'] # CLI options
Finally run ``$ pre-commit install`` to enable the hook.
Loading…
Cancel
Save