Whitespace checking tool
Project description
WSCheck
=======
|PyPi| |Build| |Docs| |DependencyStatus| |CodeQuality| |Coverage| |License|
`WSCheck <https://github.com/andras-tim/wscheck>`__ is a static analysis tool for whitespaces.
Installation
------------
``pip install wscheck``
Usage
-----
**Check multiple files:**
.. code-block:: bash
$ wscheck orange.sh pineapple.xml kiwi.js
**Exclude rules:**
.. code-block:: bash
$ wscheck --exclude WSC002 --exclude WSC003 orange.sh
**Get list of available rules:**
.. code-block:: bash
$ wscheck --list-rules
For details about rules, see :ref:`Rules <rules>`
**Write CheckStyle output too:**
.. code-block:: bash
$ wscheck --checkstyle results.xml pineapple.xml
Example
-------
.. code-block:: bash
$ wscheck examples/multiple_problems.py
.. code-block:: none
In examples/multiple_problems.py line 5:
self.print_to_pdf()
^-- WSC002: Tailing whitespace
In examples/multiple_problems.py line 8:
def __generate_pdf(self):
^-- WSC003: Indentation is not multiple of 2
In examples/multiple_problems.py line 9:
pdf_generator = _LabelPdfGenerator()
^-- WSC001: Bad line ending '\r\n'
In examples/multiple_problems.py line 15:
--->--->os.makedirs(self.__print_cache_dir, exist_ok=True)
^-- WSC004: Indentation with non-space character
In examples/multiple_problems.py line 21:
return os.path.join(self.__print_cache_dir, pdf_name)
^-- WSC006: Too many newline at end of file (+1)
Bugs
----
Bugs or suggestions? Visit the `issue tracker <https://github.com/andras-tim/wscheck/issues>`__.
.. |Build| image:: https://travis-ci.org/andras-tim/wscheck.svg?branch=master
:target: https://travis-ci.org/andras-tim/wscheck/branches
:alt: Build Status
.. |DependencyStatus| image:: https://gemnasium.com/andras-tim/wscheck.svg
:target: https://gemnasium.com/andras-tim/wscheck
:alt: Dependency Status
.. |PyPi| image:: https://img.shields.io/badge/download-PyPi-green.svg
:target: https://pypi.python.org/pypi/wscheck
:alt: Python Package
.. |Docs| image:: https://readthedocs.org/projects/wscheck/badge/?version=latest
:target: http://wscheck.readthedocs.org/latest/
:alt: Documentation Status
.. |License| image:: https://img.shields.io/badge/license-GPL%203.0-blue.svg
:target: https://github.com/andras-tim/wscheck/blob/master/LICENSE
:alt: License
.. |CodeQuality| image:: https://www.codacy.com/project/badge/345af34d2f3c432bb528a0fb48167d92
:target: https://www.codacy.com/app/andras-tim/wscheck
:alt: Code Quality
.. |Coverage| image:: https://coveralls.io/repos/andras-tim/wscheck/badge.svg?branch=master&service=github
:target: https://coveralls.io/r/andras-tim/wscheck?branch=master&service=github
:alt: Test Coverage
.. |IssueStats| image:: https://img.shields.io/github/issues/andras-tim/wscheck.svg
:target: http://issuestats.com/github/andras-tim/wscheck
:alt: Issue Stats
=======
|PyPi| |Build| |Docs| |DependencyStatus| |CodeQuality| |Coverage| |License|
`WSCheck <https://github.com/andras-tim/wscheck>`__ is a static analysis tool for whitespaces.
Installation
------------
``pip install wscheck``
Usage
-----
**Check multiple files:**
.. code-block:: bash
$ wscheck orange.sh pineapple.xml kiwi.js
**Exclude rules:**
.. code-block:: bash
$ wscheck --exclude WSC002 --exclude WSC003 orange.sh
**Get list of available rules:**
.. code-block:: bash
$ wscheck --list-rules
For details about rules, see :ref:`Rules <rules>`
**Write CheckStyle output too:**
.. code-block:: bash
$ wscheck --checkstyle results.xml pineapple.xml
Example
-------
.. code-block:: bash
$ wscheck examples/multiple_problems.py
.. code-block:: none
In examples/multiple_problems.py line 5:
self.print_to_pdf()
^-- WSC002: Tailing whitespace
In examples/multiple_problems.py line 8:
def __generate_pdf(self):
^-- WSC003: Indentation is not multiple of 2
In examples/multiple_problems.py line 9:
pdf_generator = _LabelPdfGenerator()
^-- WSC001: Bad line ending '\r\n'
In examples/multiple_problems.py line 15:
--->--->os.makedirs(self.__print_cache_dir, exist_ok=True)
^-- WSC004: Indentation with non-space character
In examples/multiple_problems.py line 21:
return os.path.join(self.__print_cache_dir, pdf_name)
^-- WSC006: Too many newline at end of file (+1)
Bugs
----
Bugs or suggestions? Visit the `issue tracker <https://github.com/andras-tim/wscheck/issues>`__.
.. |Build| image:: https://travis-ci.org/andras-tim/wscheck.svg?branch=master
:target: https://travis-ci.org/andras-tim/wscheck/branches
:alt: Build Status
.. |DependencyStatus| image:: https://gemnasium.com/andras-tim/wscheck.svg
:target: https://gemnasium.com/andras-tim/wscheck
:alt: Dependency Status
.. |PyPi| image:: https://img.shields.io/badge/download-PyPi-green.svg
:target: https://pypi.python.org/pypi/wscheck
:alt: Python Package
.. |Docs| image:: https://readthedocs.org/projects/wscheck/badge/?version=latest
:target: http://wscheck.readthedocs.org/latest/
:alt: Documentation Status
.. |License| image:: https://img.shields.io/badge/license-GPL%203.0-blue.svg
:target: https://github.com/andras-tim/wscheck/blob/master/LICENSE
:alt: License
.. |CodeQuality| image:: https://www.codacy.com/project/badge/345af34d2f3c432bb528a0fb48167d92
:target: https://www.codacy.com/app/andras-tim/wscheck
:alt: Code Quality
.. |Coverage| image:: https://coveralls.io/repos/andras-tim/wscheck/badge.svg?branch=master&service=github
:target: https://coveralls.io/r/andras-tim/wscheck?branch=master&service=github
:alt: Test Coverage
.. |IssueStats| image:: https://img.shields.io/github/issues/andras-tim/wscheck.svg
:target: http://issuestats.com/github/andras-tim/wscheck
:alt: Issue Stats
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wscheck-1.0.0.tar.gz
(18.3 kB
view hashes)
Built Distribution
wscheck-1.0.0-py2-none-any.whl
(10.0 kB
view hashes)