1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
============
Installation
============
All of the tools are included as part of the ``cmakelang`` python
distribution package.
.. note:: Until verion 0.6.13 the software was distributed under the
``cmake-format`` python package. As the project grew to include
multiple tools beyond the formatter, the name was changed to something
more appropriate. The ``cmake-format`` package will be maintained
for the forseable future as an empty package depending on ``cmakelang``
to ease users transition.
Install with pip
================
The easiest way to install ``cmakelang`` is from `pypi.org`_
using `pip`_. For example::
pip install cmakelang
If you're on a linux-type system (such as ubuntu) the above command might not
work if it would install into a system-wide location. If that's what you
really want you might need to use :code:`sudo`, e.g.::
sudo pip install cmakelang
In general though I wouldn't really recommend doing that though since things
can get pretty messy between your system python distributions and your
:code:`pip` managed directories. Alternatively you can install it for your user
with::
pip install --user cmakelang
which I would probably recommend for most users.
.. note::
If you wish to use a configuration file in YAML format you'll want to
install with the optional ``YAML`` feature, e.g.::
pip install cmakelang[YAML]
or manually install ``pyyaml``. Likewise, if you'd like to use the HTML
annotator you may install with the optional ``html-gen`` feature, e.g.::
pip install cmakelang[html-gen]
or you may install ``jinja2`` manually.
.. _`pypi.org`: https://pypi.org/project/cmakelang/
.. _pip: https://pip.pypa.io/en/stable/
Install from source
===================
You can also install from source with pip. You can download a release package
from github__ or pypi__ and then install it directly with pip. For example::
pip install v0.6.13.tar.gz
.. __: https://github.com/cheshirekow/cmake_format/releases
.. __: https://pypi.org/project/cmake-format/#files
Note that the release packages on github are automatically generated from git
tags which are the same commit used to generate the corresponding version
package on ``pypi.org``. So whether you install a particular version from
github or pypi shouldn't matter.
Pip can also install directly from github. For example::
pip install git+https://github.com/cheshirekow/cmake_format.git
If you wish to test a pre-release or dev package from a branch called
``foobar`` you can install it with::
pip install "git+https://github.com/cheshirekow/cmake_format.git@foobar"
IDE Integrations
================
For the formatter specifically:
* There is an official `vscode extension`__
* Someone also created a `sublime plugin`__
.. __: https://marketplace.visualstudio.com/items?itemName=cheshirekow.cmake-format
.. __: https://packagecontrol.io/packages/CMakeFormat
Note that for both plugins ``cmake-format`` itself must be installed
separately.
Pre-commit
==========
If you are a user of the `pre-commit`__ project you can easily add the
formatter, ``cmake-format``, to your hooks with the following addition to your
``.pre-commit-hooks.yaml`` file.
.. __: https://pre-commit.com/
.. code:: yaml
repos:
- repo: https://github.com/cheshirekow/cmake-format-precommit
rev: v0.6.13
hooks:
- id: cmake-format
Docker Images
=============
There is an official docker image at dockerhub__. You can pull the latest with,
e.g.::
docker pull cheshirekow/cmake-format
.. __: https://hub.docker.com/repository/docker/cheshirekow/cmake-format
|
