Sync linter with ethz fork

README.md

@@ -1,48 +1,74 @@
 # linter
 
-This repo contains a (C++, python (experimental)) linter and auto formatter package that can be included into your repository as a submodule. It provides the following git hooks:
+This repo contains a (C++, python) linter and auto formatter package that can be conveniently installed into your repositories using git hooks. It provides the following git hooks:
  * **General**
    * Prevent commits to master.
  * **C++** files:
-   * **clang-format** Formats your code based on your .clang-format preferences.
+ *
+   * **clang-format** Formats your code based on your `.clang-format` preferences.
    * **cpplint** Checks your C++ code for style errors and warnings.
-
- * **EXPERIMENTAL - Python** files:
 
-      **WARNING:** The default linter settings are very strict and might not actually conform with the formatting produced by autopep8. If you want to use this linter for python you will need to do some tweaking.
-      * **autopep8** Formats your python code.
+ * **Python** files:
+
+      * **yapf** Formats your python code.
       * **pylint** Checks your Python code for style errors and warnings.
-     
+
 
 ## Dependencies
 
- * **autopep8** ([Introduction to autopep8](http://avilpage.com/2015/05/automatically-pep8-your-python-code.html))
-   * Ubuntu 14.04 / macOS: `pip install autopep8`
+ * **pylint**
+   * macOS:
+     ```
+     pip install pylint
+     ```
+ * **yapf**
+   * Ubuntu / macOS: `pip install yapf`
  * **clang-format**
-   * Ubuntu 14.04: `sudo apt-get install clang-format-3.X`
-   * macOS: 
+   * Compatible with `clang-format-3.8 - 6.0`
+   * Ubuntu: `sudo apt install clang-format-${VERSION}`
+   * macOS:
      ```
      brew install clang-format
-     ln -s /usr/local/share/clang/clang-format-diff.py /usr/local/bin/clang-format-diff-3.8
+     ln -s /usr/local/share/clang/clang-format-diff.py /usr/local/bin/clang-format-diff
      ```
-
+ * **requests**
+   * Ubuntu:
+     ```
+     pip install requests
+     ``` 
 
 ## Installation
 
+```bash
+git clone [email protected]:ethz-asl/linter.git
+cd linter
+echo ". $(realpath setup_linter.sh)" >> ~/.bashrc  # Or the matching file for
+                                                   # your shell.
+bash
+```
+
+Then you can install the linter in your repository:
 ```bash
 cd $YOUR_REPO
-git submodule add [email protected]:ethz-asl/linter.git
-./linter/init-git-hooks.py
+init_linter_git_hooks
 ```
 
-You can also add the linter submodule in a subfolder of your repo, e.g.:
+## Uninstallation
+To remove the linter from your git repository again, run the following:
 ```bash
-mkdir $YOUR_REPO/dev_tools
-git submodule add [email protected]:ethz-asl/linter.git dev_tools/linter
-./dev_tools/linter/init-git-hooks.py
+cd $YOUR_REPO
+init_linter_git_hooks --remove
 ```
 
-Define the project-specific C++ format by adding a file `.clang-format` to your projects root folder. Example:
+## Linter configuration
+
+**General**
+
+To configure the linter, add a file named `.linterconfig.yaml` in your repository root. An example file is given under [`linterconfig.yaml_example`](https://github.com/ethz-asl/linter/blob/master/linterconfig.yaml_example).
+
+**C++**
+
+clang-format can be configured by defining a project-specific C++ format by adding a file `.clang-format` to your projects root folder. Example file:
 
 ```
 ---
@@ -63,6 +89,52 @@ IncludeCategories:
 ...
 ```
 
-#### ASCII-Art Sources
+**Python**
+
+Currently there it is not possible to configure the python formatter on a per-repository basis. The linter can be configured on a per-repository bais by adding a `.pylintrc` file to your repositorie's root folder.
+
+
+
+## Disable Linter Functionalities for a Specific Line
+
+ * **C++ Linter (`cpplint`):**
+   ```cpp
+   void your_awful_function(int & result) // NOLINT
+   ```
+ * **C++ Formatting (`clang-format`):**
+   ```cpp
+   // clang-format off
+   ...
+   // clang-format on   
+   ```
+ * **Python Linter (`pylint`)**
+
+   For whole file:
+   ```python
+   #!/usr/bin/env python
+   # pylint: disable=C0103,E1101
+   ...
+   ```
+   For a line:
+   ```Python
+   your_awful_function('-legal/copyright,-build/c++11')  # pylint: disable=W0212
+   ```
+   The full list of pylint warnings and errors can be found [here](http://pylint-messages.wikidot.com/all-messages)
+
+ * **Python Formatting (`yapf`)**
+   ```python
+   # yapf: disable
+   ...
+   # yapf: enable
+   ```
+
+## Tools
+* **Checking an entire repository** 
+
+  Type `linter_check_all` to run the linters and formatters on all files within the current repository.
+
+
+## ASCII-Art Sources
 
+ * [www.asciiart.eu](https://www.asciiart.eu)
  * [www.retrojunkie.com (accessed through web.archive.org)](https://web.archive.org/web/20150831003349/http://www.retrojunkie.com:80/asciiart/)

ascii_art.py

@@ -4,7 +4,7 @@
 
 class AsciiArt(object):
 
-  tiger = r"""
+    tiger = r"""
                                                      _
                                                    ,',\
                                                   ( / \\
@@ -37,7 +37,7 @@ class AsciiArt(object):
 
   """
 
-  cthulhu = r"""
+    cthulhu = r"""
 
 
                                     _.---._
@@ -75,7 +75,7 @@ class AsciiArt(object):
 
   """
 
-  story = r"""
+    story = r"""
               ______        _         ______        _
               \___  \____  | |        \__   \____  | |
                | | _/\__ \ | |__       | | _/\__ \ | |__
@@ -134,7 +134,7 @@ class AsciiArt(object):
 
   """
 
-  commit_success = r"""
+    commit_success = r"""
 
             d888888b                         d888888b
          d888    8888b                    d888888   888b
@@ -150,12 +150,12 @@ class AsciiArt(object):
                88          _(<_   / )_          88
               d88b        (__\_\_|_/__)        d88b
 
-        Your happiness shall not depend on what you have or what your are,
+        Your happiness shall not depend on what you have or what you are,
          it shall solely depend on the beauty of your code.
 
   """
 
-  grumpy_cat = r"""
+    grumpy_cat = r"""
 
                                                    : sdMMm+
                                                 /mMMMMMMM+
@@ -203,7 +203,7 @@ class AsciiArt(object):
 
   """
 
-  homer_woohoo = r"""
+    homer_woohoo = r"""
 
                                     ,#M]RRD`"RW
                                    ,R,qB*""``"*Rw,
@@ -239,3 +239,38 @@ class AsciiArt(object):
                     Woohoo, no formatter or linter for merge commits!
 
   """
+
+    yoda = r"""
+    ____
+                    _.' :  `._
+                .-.'`.  ;   .'`.-.
+        __      / : ___\ ;  /___ ; \      __
+      ,'_ ""--.:__;".-.";: :".-.":__;.--"" _`,
+      :' `.t""--.. '<@.`;_  ',@>` ..--""j.' `;
+          `:-.._J '-.-'L__ `-- ' L_..-;'
+            "-.__ ;  .-"  "-.  : __.-"
+                L ' /.------.\ ' J
+                  "-.   "--"   .-"
+                __.l"-:_JL_;-";.__
+              .-j/'.;  ;  / .'\-.
+            .' /:`. "-.:     .-" .';  `.
+        .-"  / ;  "-. "-..-" .-"  :    "-.
+      .+"-.  : :      "-.__.-"      ;-._   \
+      ; \  `.; ;                    : : "+. ;
+      :  ;   ; ;                    : ;  : \:
+    : `."-; ;  ;                  :  ;   ,/;
+      ;    -: ;  :                ;  : .-"'  :
+      :\     \  : ;             : \.-"      :
+      ;`.    \  ; :            ;.'_..--  / ;
+      :  "-.  "-:  ;          :/."      .'  :
+        \       .-`.\        /t-""  ":-+.   :
+          `.  .-"    `l    __/ /`. :  ; ; \  ;
+            \   .-" .-"-.-"  .' .'j \  /   ;/
+            \ / .-"   /.     .'.' ;_:'    ;
+              :-""-.`./-.'     /    `.___.'
+                    \ `t  ._  /  bug :F_P:
+                    "-.t-._:'
+        Careful be, you must. Unformatted code
+                to the dark side leads
+
+    """