Update with fixed references.
This commit is contained in:
parent
2f450c0170
commit
ed92c95c67
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title><no title> — Git Lint 0.0.4 documentation</title>
|
||||
<title><no title> — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -25,8 +25,8 @@
|
|||
<script type="text/javascript" src="static/doctools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -35,14 +35,14 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<dl class="docutils">
|
||||
<dt><strong>-o <linters>, –only=<linters></strong></dt>
|
||||
|
|
@ -83,31 +83,30 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/arguments.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/arguments.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -116,12 +115,12 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
45
authors.html
45
authors.html
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Credits — Git Lint 0.0.4 documentation</title>
|
||||
<title>Credits — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -27,8 +27,8 @@
|
|||
<link rel="next" title="History" href="history.html" />
|
||||
<link rel="prev" title="Contributing" href="contributing.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -43,14 +43,14 @@
|
|||
<li class="right" >
|
||||
<a href="contributing.html" title="Contributing"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="credits">
|
||||
<h1>Credits<a class="headerlink" href="#credits" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -70,7 +70,7 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
|
|
@ -87,29 +87,28 @@
|
|||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="history.html"
|
||||
title="next chapter">History</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/authors.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/authors.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -124,12 +123,12 @@
|
|||
<li class="right" >
|
||||
<a href="contributing.html" title="Contributing"
|
||||
>previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Contributing — Git Lint 0.0.4 documentation</title>
|
||||
<title>Contributing — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -27,8 +27,8 @@
|
|||
<link rel="next" title="Credits" href="authors.html" />
|
||||
<link rel="prev" title="Usage" href="usage.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -43,14 +43,14 @@
|
|||
<li class="right" >
|
||||
<a href="usage.html" title="Usage"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="contributing">
|
||||
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -104,34 +104,34 @@ are welcome :)</li>
|
|||
<li><p class="first">Fork the <cite>git_lint</cite> repo on GitHub.</p>
|
||||
</li>
|
||||
<li><p class="first">Clone your fork locally:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre>$ git clone git@github.com:your_name_here/git_lint.git
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ git clone git@github.com:your_name_here/git_lint.git
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre>$ mkvirtualenv git_lint
|
||||
$ cd git_lint/
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ mkvirtualenv git_lint
|
||||
$ <span class="nb">cd</span> git_lint/
|
||||
$ python setup.py develop
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Create a branch for local development:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre>$ git checkout -b name-of-your-bugfix-or-feature
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ git checkout -b name-of-your-bugfix-or-feature
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Now you can make your changes locally.</p>
|
||||
</li>
|
||||
<li><p class="first">When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre>$ flake8 git_lint tests
|
||||
$ python setup.py test or py.test
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ flake8 git_lint tests
|
||||
$ python setup.py <span class="nb">test</span> or py.test
|
||||
$ tox
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To get flake8 and tox, just pip install them into your virtualenv.</p>
|
||||
</li>
|
||||
<li><p class="first">Commit your changes and push your branch to GitHub:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre>$ git add .
|
||||
$ git commit -m "Your detailed description of your changes."
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ git add .
|
||||
$ git commit -m <span class="s2">"Your detailed description of your changes."</span>
|
||||
$ git push origin name-of-your-bugfix-or-feature
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
@ -156,7 +156,7 @@ and make sure that the tests pass for all supported Python versions.</li>
|
|||
<div class="section" id="tips">
|
||||
<h2>Tips<a class="headerlink" href="#tips" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To run a subset of tests:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre>$ py.test tests.test_git_lint
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ py.test tests.test_git_lint
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -166,7 +166,7 @@ and make sure that the tests pass for all supported Python versions.</li>
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
|
|
@ -192,29 +192,28 @@ and make sure that the tests pass for all supported Python versions.</li>
|
|||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="authors.html"
|
||||
title="next chapter">Credits</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/contributing.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/contributing.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -229,12 +228,12 @@ and make sure that the tests pass for all supported Python versions.</li>
|
|||
<li class="right" >
|
||||
<a href="usage.html" title="Usage"
|
||||
>previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,9 +7,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — Git Lint 0.0.4 documentation</title>
|
||||
<title>Index — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -26,8 +26,8 @@
|
|||
<script type="text/javascript" src="static/doctools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -36,14 +36,14 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1 id="index">Index</h1>
|
||||
|
|
@ -294,29 +294,26 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
|
||||
|
||||
|
||||
<div id="searchbox" style="display: none">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -325,12 +322,12 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
107
git_lint.html
107
git_lint.html
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>git_lint package — Git Lint 0.0.4 documentation</title>
|
||||
<title>git_lint package — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -25,8 +25,8 @@
|
|||
<script type="text/javascript" src="static/doctools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -35,14 +35,14 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="git-lint-package">
|
||||
<h1>git_lint package<a class="headerlink" href="#git-lint-package" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -53,20 +53,20 @@
|
|||
<span id="git-lint-git-lint-module"></span><h2>git_lint.git_lint module<a class="headerlink" href="#module-git_lint.git_lint" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="git_lint.git_lint.Linters">
|
||||
<em class="property">class </em><tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">Linters</tt><big>(</big><em>linters</em>, <em>filenames</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#Linters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">git_lint.git_lint.</code><code class="descname">Linters</code><span class="sig-paren">(</span><em>linters</em>, <em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#Linters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="git_lint.git_lint.Linters.dryrun">
|
||||
<tt class="descname">dryrun</tt><big>(</big><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#Linters.dryrun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.dryrun" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dryrun</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#Linters.dryrun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.dryrun" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="git_lint.git_lint.Linters.encode_shell_messages">
|
||||
<em class="property">static </em><tt class="descname">encode_shell_messages</tt><big>(</big><em>prefix</em>, <em>messages</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#Linters.encode_shell_messages"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.encode_shell_messages" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">static </em><code class="descname">encode_shell_messages</code><span class="sig-paren">(</span><em>prefix</em>, <em>messages</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#Linters.encode_shell_messages"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.encode_shell_messages" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="git_lint.git_lint.Linters.run_external_linter">
|
||||
<em class="property">static </em><tt class="descname">run_external_linter</tt><big>(</big><em>filename</em>, <em>linter</em>, <em>linter_name</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#Linters.run_external_linter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.run_external_linter" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">static </em><code class="descname">run_external_linter</code><span class="sig-paren">(</span><em>filename</em>, <em>linter</em>, <em>linter_name</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#Linters.run_external_linter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.run_external_linter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run one linter against one file.</p>
|
||||
<p>If the result matches the error condition specified in the configuration file,
|
||||
return the error code and messages, otherwise return nothing.</p>
|
||||
|
|
@ -74,7 +74,7 @@ return the error code and messages, otherwise return nothing.</p>
|
|||
|
||||
<dl class="staticmethod">
|
||||
<dt id="git_lint.git_lint.Linters.run_one_linter">
|
||||
<em class="property">static </em><tt class="descname">run_one_linter</tt><big>(</big><em>linter</em>, <em>filenames</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#Linters.run_one_linter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.run_one_linter" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">static </em><code class="descname">run_one_linter</code><span class="sig-paren">(</span><em>linter</em>, <em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#Linters.run_one_linter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.run_one_linter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Runs one linter against a set of files</p>
|
||||
<p>Creates a match filter for the linter, extract the files to be
|
||||
linted, and runs the linter against each file, returning the
|
||||
|
|
@ -86,33 +86,33 @@ return code and the output of the lint process.</p>
|
|||
|
||||
<dl class="class">
|
||||
<dt id="git_lint.git_lint.MatchFilter">
|
||||
<em class="property">class </em><tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">MatchFilter</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#MatchFilter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.MatchFilter" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">git_lint.git_lint.</code><code class="descname">MatchFilter</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#MatchFilter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.MatchFilter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="staticmethod">
|
||||
<dt id="git_lint.git_lint.MatchFilter.make_match_filter_matcher">
|
||||
<em class="property">static </em><tt class="descname">make_match_filter_matcher</tt><big>(</big><em>extensions</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#MatchFilter.make_match_filter_matcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.MatchFilter.make_match_filter_matcher" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">static </em><code class="descname">make_match_filter_matcher</code><span class="sig-paren">(</span><em>extensions</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#MatchFilter.make_match_filter_matcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.MatchFilter.make_match_filter_matcher" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="git_lint.git_lint.StagingRunner">
|
||||
<em class="property">class </em><tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">StagingRunner</tt><big>(</big><em>filenames</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#StagingRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.StagingRunner" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">git_lint.git_lint.</code><code class="descname">StagingRunner</code><span class="sig-paren">(</span><em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#StagingRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.StagingRunner" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="git_lint.git_lint.WorkspaceRunner">
|
||||
<em class="property">class </em><tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">WorkspaceRunner</tt><big>(</big><em>filenames</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#WorkspaceRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.WorkspaceRunner" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||||
<em class="property">class </em><code class="descclassname">git_lint.git_lint.</code><code class="descname">WorkspaceRunner</code><span class="sig-paren">(</span><em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#WorkspaceRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.WorkspaceRunner" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.executable_exists">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">executable_exists</tt><big>(</big><em>script</em>, <em>label</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#executable_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.executable_exists" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">executable_exists</code><span class="sig-paren">(</span><em>script</em>, <em>label</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#executable_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.executable_exists" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.find_config_file">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">find_config_file</tt><big>(</big><em>options</em>, <em>base</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#find_config_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.find_config_file" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">find_config_file</code><span class="sig-paren">(</span><em>options</em>, <em>base</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#find_config_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.find_config_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the configuration file from a prioritized list of locations.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Locations are prioritized as:</dt>
|
||||
|
|
@ -130,48 +130,48 @@ return code and the output of the lint process.</p>
|
|||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_filelist">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">get_filelist</tt><big>(</big><em>options</em>, <em>extras</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#get_filelist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_filelist" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_filelist</code><span class="sig-paren">(</span><em>options</em>, <em>extras</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#get_filelist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_filelist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the list of files against which we’ll run the linters.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_git_base">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">get_git_base</tt><big>(</big><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#get_git_base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_base" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_git_base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#get_git_base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_base" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_git_head">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">get_git_head</tt><big>(</big><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#get_git_head"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_head" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_git_head</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#get_git_head"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_head" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_git_response">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">get_git_response</tt><big>(</big><em>cmd</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#get_git_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_response" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_git_response</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#get_git_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_git_response_raw">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">get_git_response_raw</tt><big>(</big><em>cmd</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#get_git_response_raw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_response_raw" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_git_response_raw</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#get_git_response_raw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_response_raw" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_linter_status">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">get_linter_status</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#get_linter_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_linter_status" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_linter_status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#get_linter_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_linter_status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_shell_response">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">get_shell_response</tt><big>(</big><em>fullcmd</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#get_shell_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_shell_response" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_shell_response</code><span class="sig-paren">(</span><em>fullcmd</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#get_shell_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_shell_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_working_linter_names">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">get_working_linter_names</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#get_working_linter_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_working_linter_names" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_working_linter_names</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#get_working_linter_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_working_linter_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.load_config">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">load_config</tt><big>(</big><em>options</em>, <em>base</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#load_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.load_config" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">load_config</code><span class="sig-paren">(</span><em>options</em>, <em>base</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#load_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.load_config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Loads the git-lint configuration file.</p>
|
||||
<p>Returns the configuration file as a dictionary of dictionaries.
|
||||
Performs substitutions as specified in the SafeConfigParser
|
||||
|
|
@ -184,17 +184,17 @@ files for specific linters.</p>
|
|||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.run_git_command">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">run_git_command</tt><big>(</big><em>cmd</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#run_git_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.run_git_command" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">run_git_command</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#run_git_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.run_git_command" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.run_linters">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">run_linters</tt><big>(</big><em>options</em>, <em>config</em>, <em>extras=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#run_linters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.run_linters" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">run_linters</code><span class="sig-paren">(</span><em>options</em>, <em>config</em>, <em>extras=[]</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#run_linters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.run_linters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.split_git_response">
|
||||
<tt class="descclassname">git_lint.git_lint.</tt><tt class="descname">split_git_response</tt><big>(</big><em>cmd</em><big>)</big><a class="reference internal" href="modules/git_lint/git_lint.html#split_git_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.split_git_response" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">split_git_response</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/git_lint.html#split_git_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.split_git_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
|
|
@ -202,7 +202,7 @@ files for specific linters.</p>
|
|||
<span id="git-lint-option-handler-module"></span><h2>git_lint.option_handler module<a class="headerlink" href="#module-git_lint.option_handler" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="function">
|
||||
<dt id="git_lint.option_handler.cleanup_options">
|
||||
<tt class="descclassname">git_lint.option_handler.</tt><tt class="descname">cleanup_options</tt><big>(</big><em>options</em>, <em>commandline</em><big>)</big><a class="reference internal" href="modules/git_lint/option_handler.html#cleanup_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.option_handler.cleanup_options" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.option_handler.</code><code class="descname">cleanup_options</code><span class="sig-paren">(</span><em>options</em>, <em>commandline</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/option_handler.html#cleanup_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.option_handler.cleanup_options" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="docutils">
|
||||
<dt>Takes a table of options and the commandline, and returns a</dt>
|
||||
<dd>dictionary of those options that appear on the commandline
|
||||
|
|
@ -223,32 +223,32 @@ Help text, list of (long) options superseded by this one.</dd>
|
|||
<span id="git-lint-reporters-module"></span><h2>git_lint.reporters module<a class="headerlink" href="#module-git_lint.reporters" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.base_file_cleaner">
|
||||
<tt class="descclassname">git_lint.reporters.</tt><tt class="descname">base_file_cleaner</tt><big>(</big><em>files</em><big>)</big><a class="reference internal" href="modules/git_lint/reporters.html#base_file_cleaner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.base_file_cleaner" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">base_file_cleaner</code><span class="sig-paren">(</span><em>files</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/reporters.html#base_file_cleaner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.base_file_cleaner" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.group_by">
|
||||
<tt class="descclassname">git_lint.reporters.</tt><tt class="descname">group_by</tt><big>(</big><em>iterable</em>, <em>field_id</em><big>)</big><a class="reference internal" href="modules/git_lint/reporters.html#group_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.group_by" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">group_by</code><span class="sig-paren">(</span><em>iterable</em>, <em>field_id</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/reporters.html#group_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.group_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.print_help">
|
||||
<tt class="descclassname">git_lint.reporters.</tt><tt class="descname">print_help</tt><big>(</big><em>options</em>, <em>name</em><big>)</big><a class="reference internal" href="modules/git_lint/reporters.html#print_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_help" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">print_help</code><span class="sig-paren">(</span><em>options</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/reporters.html#print_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.print_linters">
|
||||
<tt class="descclassname">git_lint.reporters.</tt><tt class="descname">print_linters</tt><big>(</big><em>config</em>, <em>broken_linter_names</em><big>)</big><a class="reference internal" href="modules/git_lint/reporters.html#print_linters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_linters" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">print_linters</code><span class="sig-paren">(</span><em>config</em>, <em>broken_linter_names</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/reporters.html#print_linters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_linters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.print_report">
|
||||
<tt class="descclassname">git_lint.reporters.</tt><tt class="descname">print_report</tt><big>(</big><em>results</em>, <em>unlintable_filenames</em>, <em>cant_lint_filenames</em>, <em>broken_linter_names</em>, <em>unfindable_filenames</em>, <em>options={'bylinter': True}</em><big>)</big><a class="reference internal" href="modules/git_lint/reporters.html#print_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_report" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">print_report</code><span class="sig-paren">(</span><em>results</em>, <em>unlintable_filenames</em>, <em>cant_lint_filenames</em>, <em>broken_linter_names</em>, <em>unfindable_filenames</em>, <em>options={'bylinter': True}</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/reporters.html#print_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_report" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.print_version">
|
||||
<tt class="descclassname">git_lint.reporters.</tt><tt class="descname">print_version</tt><big>(</big><em>name</em>, <em>version</em><big>)</big><a class="reference internal" href="modules/git_lint/reporters.html#print_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_version" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">print_version</code><span class="sig-paren">(</span><em>name</em>, <em>version</em><span class="sig-paren">)</span><a class="reference internal" href="modules/git_lint/reporters.html#print_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_version" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
|
|
@ -261,7 +261,7 @@ Help text, list of (long) options superseded by this one.</dd>
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
|
|
@ -276,29 +276,28 @@ Help text, list of (long) options superseded by this one.</dd>
|
|||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/git_lint.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/git_lint.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -307,12 +306,12 @@ Help text, list of (long) options superseded by this one.</dd>
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
45
history.html
45
history.html
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>History — Git Lint 0.0.4 documentation</title>
|
||||
<title>History — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -26,8 +26,8 @@
|
|||
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="prev" title="Credits" href="authors.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -39,14 +39,14 @@
|
|||
<li class="right" >
|
||||
<a href="authors.html" title="Credits"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="history">
|
||||
<h1>History<a class="headerlink" href="#history" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
|
|
@ -78,29 +78,28 @@
|
|||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="authors.html"
|
||||
title="previous chapter">Credits</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/history.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/history.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -112,12 +111,12 @@
|
|||
<li class="right" >
|
||||
<a href="authors.html" title="Credits"
|
||||
>previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
52
index.html
52
index.html
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Welcome to Git Lint’s documentation! — Git Lint 0.0.4 documentation</title>
|
||||
<title>Welcome to Git Lint’s documentation! — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -26,8 +26,8 @@
|
|||
<link rel="top" title="Git Lint 0.0.4 documentation" href="#" />
|
||||
<link rel="next" title="Git Lint: README" href="readme.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -39,14 +39,14 @@
|
|||
<li class="right" >
|
||||
<a href="readme.html" title="Git Lint: README"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li><a href="#">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="#">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="welcome-to-git-lint-s-documentation">
|
||||
<h1>Welcome to Git Lint’s documentation!<a class="headerlink" href="#welcome-to-git-lint-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -55,6 +55,7 @@
|
|||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="readme.html">Git Lint: README</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#usage">Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#documentation">Documentation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#install">Install</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#features">Features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#acknowledgements">Acknowledgements</a></li>
|
||||
|
|
@ -95,9 +96,9 @@
|
|||
<div class="section" id="indices-and-tables">
|
||||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
|
||||
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
|
||||
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
|
||||
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
|
||||
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
|
||||
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -105,7 +106,7 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="#">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
|
|
@ -116,29 +117,28 @@
|
|||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="readme.html"
|
||||
title="next chapter">Git Lint: README</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/index.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/index.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -150,12 +150,12 @@
|
|||
<li class="right" >
|
||||
<a href="readme.html" title="Git Lint: README"
|
||||
>next</a> |</li>
|
||||
<li><a href="#">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="#">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Installation — Git Lint 0.0.4 documentation</title>
|
||||
<title>Installation — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -27,8 +27,8 @@
|
|||
<link rel="next" title="Usage" href="usage.html" />
|
||||
<link rel="prev" title="Git Lint: README" href="readme.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -43,21 +43,21 @@
|
|||
<li class="right" >
|
||||
<a href="readme.html" title="Git Lint: README"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="installation">
|
||||
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="stable-release">
|
||||
<h2>Stable release<a class="headerlink" href="#stable-release" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To install Git Lint, run this command in your terminal:</p>
|
||||
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> pip install git_linter
|
||||
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> pip install git-linter
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you don’t have <a class="reference external" href="https://pip.pypa.io">pip</a> installed, this <a class="reference external" href="http://docs.python-guide.org/en/latest/starting/installation/">Python installation guide</a> can guide
|
||||
|
|
@ -65,22 +65,21 @@ you through the process.</p>
|
|||
</div>
|
||||
<div class="section" id="from-sources">
|
||||
<h2>From sources<a class="headerlink" href="#from-sources" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The sources for Git Lint can be downloaded from the <a class="reference external" href="https://github.com/elfsternberg/git_linter">Github repo</a>.</p>
|
||||
<p>The sources for Git Lint can be downloaded from the <a class="reference external" href="https://github.com/elfsternberg/git-linter">Github repo</a>.</p>
|
||||
<p>You can either clone the public repository:</p>
|
||||
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> git clone git://github.com/elfsternberg/git_linter
|
||||
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> git clone git://github.com/elfsternberg/git-linter
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Or download the <a class="reference external" href="https://github.com/elfsternberg/git_linter/tarball/master">tarball</a>:</p>
|
||||
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> curl -OL https://github.com/elfsternberg/git_linter/tarball/master
|
||||
<p>Or download the <a class="reference external" href="https://github.com/elfsternberg/git-linter/tarball/master">tarball</a>:</p>
|
||||
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> curl -OL https://github.com/elfsternberg/git-linter/tarball/master
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Once you have a copy of the source, you can install it with:</p>
|
||||
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> python setup.py install
|
||||
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> python setup.py install
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Once installed, please copy the ‘.git-lint’ example file. You may install this either in
|
||||
your home directory as <tt class="docutils literal"><span class="pre">.git-lint</span></tt> or in your project’s git directory as
|
||||
<tt class="docutils literal"><span class="pre">.git/lint/git-lint</span></tt></p>
|
||||
your home or repository directory as <code class="docutils literal"><span class="pre">.git-lint</span></code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -88,7 +87,7 @@ your home directory as <tt class="docutils literal"><span class="pre">.git-lint<
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
|
|
@ -105,29 +104,28 @@ your home directory as <tt class="docutils literal"><span class="pre">.git-lint<
|
|||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="usage.html"
|
||||
title="next chapter">Usage</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/installation.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/installation.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -142,12 +140,12 @@ your home directory as <tt class="docutils literal"><span class="pre">.git-lint<
|
|||
<li class="right" >
|
||||
<a href="readme.html" title="Git Lint: README"
|
||||
>previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
55
manual.html
55
manual.html
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>git-lint(1) — Git Lint 0.0.4 documentation</title>
|
||||
<title>git-lint(1) — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -25,8 +25,8 @@
|
|||
<script type="text/javascript" src="static/doctools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -35,14 +35,14 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="git-lint-1">
|
||||
<h1>git-lint(1)<a class="headerlink" href="#git-lint-1" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -53,7 +53,7 @@
|
|||
<div class="section" id="synopsis">
|
||||
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
|
||||
<p>[verse]
|
||||
<tt class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></tt> [<options>...] [<files...>]</p>
|
||||
<code class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></code> [<options>...] [<files...>]</p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
|
|
@ -106,13 +106,13 @@ the files currently in the staging area.</p>
|
|||
<p>By default, the output is that of all the linters specified, in the
|
||||
order in which they appear in the configuration file, followed by
|
||||
every file specified, sorted ASCIIbetically. This order can be
|
||||
flipped (files first, then linters) with the <tt class="docutils literal"><span class="pre">--byfiles</span></tt> option.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></tt> returns the maximal error code if any linters fail a
|
||||
flipped (files first, then linters) with the <code class="docutils literal"><span class="pre">--byfiles</span></code> option.</p>
|
||||
<p><code class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></code> returns the maximal error code if any linters fail a
|
||||
pass, or zero if they all succeed.</p>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
<h2>CONFIGURATION<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
|
||||
<p><tt class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></tt> uses a standard INI-style configuration file. Aside from the
|
||||
<p><code class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></code> uses a standard INI-style configuration file. Aside from the
|
||||
DEFAULT section, the name of each section is an alphanumeric token name for
|
||||
a linter, followed by configuration details for that linter. Standard details
|
||||
are:</p>
|
||||
|
|
@ -122,7 +122,7 @@ are:</p>
|
|||
<li>match - A comma-separated list of extensions to match against the linter</li>
|
||||
<li>print - If true, will prefix each line of output from the linter with the filename</li>
|
||||
<li>condition - if “error”, the return code of the linter is the status of the pass. If “output,” any output will result in a failure.</li>
|
||||
<li>comment - Text to include when running the <tt class="docutils literal"><span class="pre">--linters</span></tt> option</li>
|
||||
<li>comment - Text to include when running the <code class="docutils literal"><span class="pre">--linters</span></code> option</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -131,7 +131,7 @@ are:</p>
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
|
|
@ -146,29 +146,28 @@ are:</p>
|
|||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/manual.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/manual.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -177,12 +176,12 @@ are:</p>
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
45
modules.html
45
modules.html
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>git_lint — Git Lint 0.0.4 documentation</title>
|
||||
<title>git_lint — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -25,8 +25,8 @@
|
|||
<script type="text/javascript" src="static/doctools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -35,14 +35,14 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="git-lint">
|
||||
<h1>git_lint<a class="headerlink" href="#git-lint" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -65,31 +65,30 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/modules.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/modules.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -98,12 +97,12 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>git_lint.git_lint — Git Lint 0.0.4 documentation</title>
|
||||
<title>git_lint.git_lint — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../../static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -26,8 +26,8 @@
|
|||
<link rel="top" title="Git Lint 0.0.4 documentation" href="../../index.html" />
|
||||
<link rel="up" title="Module code" href="../index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -36,19 +36,19 @@
|
|||
<li class="right" >
|
||||
<a href="../../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li><a href="../index.html" accesskey="U">Module code</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for git_lint.git_lint</h1><div class="highlight"><pre>
|
||||
<span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="nb">reduce</span>
|
||||
<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">namedtuple</span>
|
||||
<span></span><span class="kn">from</span> <span class="nn">functools</span> <span class="k">import</span> <span class="n">reduce</span>
|
||||
<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">namedtuple</span>
|
||||
<span class="kn">import</span> <span class="nn">getopt</span>
|
||||
<span class="kn">import</span> <span class="nn">gettext</span>
|
||||
<span class="kn">import</span> <span class="nn">operator</span>
|
||||
|
|
@ -61,16 +61,16 @@
|
|||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="kn">import</span> <span class="nn">configparser</span>
|
||||
<span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
||||
<span class="kn">import</span> <span class="nn">ConfigParser</span> <span class="kn">as</span> <span class="nn">configparser</span>
|
||||
<span class="kn">import</span> <span class="nn">ConfigParser</span> <span class="k">as</span> <span class="nn">configparser</span>
|
||||
|
||||
<span class="n">_</span> <span class="o">=</span> <span class="n">gettext</span><span class="o">.</span><span class="n">gettext</span>
|
||||
|
||||
|
||||
<span class="c"># ___ __ _ ___ _</span>
|
||||
<span class="c"># / __|___ _ _ / _(_)__ _ | _ \___ __ _ __| |___ _ _</span>
|
||||
<span class="c"># | (__/ _ \ ' \| _| / _` | | / -_) _` / _` / -_) '_|</span>
|
||||
<span class="c"># \___\___/_||_|_| |_\__, | |_|_\___\__,_\__,_\___|_|</span>
|
||||
<span class="c"># |___/</span>
|
||||
<span class="c1"># ___ __ _ ___ _</span>
|
||||
<span class="c1"># / __|___ _ _ / _(_)__ _ | _ \___ __ _ __| |___ _ _</span>
|
||||
<span class="c1"># | (__/ _ \ ' \| _| / _` | | / -_) _` / _` / -_) '_|</span>
|
||||
<span class="c1"># \___\___/_||_|_| |_\__, | |_|_\___\__,_\__,_\___|_|</span>
|
||||
<span class="c1"># |___/</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="find_config_file"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.find_config_file">[docs]</a><span class="k">def</span> <span class="nf">find_config_file</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">base</span><span class="p">):</span>
|
||||
|
|
@ -86,27 +86,27 @@
|
|||
<span class="sd"> If no configuration file is found, this is an error.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">if</span> <span class="s">'config'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="n">config</span> <span class="o">=</span> <span class="n">options</span><span class="p">[</span><span class="s">'config'</span><span class="p">]</span>
|
||||
<span class="k">if</span> <span class="s1">'config'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="n">config</span> <span class="o">=</span> <span class="n">options</span><span class="p">[</span><span class="s1">'config'</span><span class="p">]</span>
|
||||
<span class="n">configpath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">configpath</span><span class="p">):</span>
|
||||
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'Configuration file not found: {}</span><span class="se">\n</span><span class="s">'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">config</span><span class="p">))</span>
|
||||
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'Configuration file not found: </span><span class="si">{}</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">config</span><span class="p">))</span>
|
||||
<span class="k">return</span> <span class="n">configpath</span>
|
||||
|
||||
<span class="n">home</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'HOME'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
|
||||
<span class="n">possibles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">base</span><span class="p">,</span> <span class="s">'.git-lint'</span><span class="p">),</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">base</span><span class="p">,</span> <span class="s">'.git-lint/config'</span><span class="p">)]</span> <span class="o">+</span> <span class="p">((</span><span class="n">home</span> <span class="ow">and</span> <span class="p">[</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">home</span><span class="p">,</span> <span class="s">'.git-lint'</span><span class="p">),</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">home</span><span class="p">,</span> <span class="s">'.git-lint/config'</span><span class="p">)])</span> <span class="ow">or</span> <span class="p">[])</span>
|
||||
<span class="n">home</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'HOME'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="n">possibles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">base</span><span class="p">,</span> <span class="s1">'.git-lint'</span><span class="p">),</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">base</span><span class="p">,</span> <span class="s1">'.git-lint/config'</span><span class="p">)]</span> <span class="o">+</span> <span class="p">((</span><span class="n">home</span> <span class="ow">and</span> <span class="p">[</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">home</span><span class="p">,</span> <span class="s1">'.git-lint'</span><span class="p">),</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">home</span><span class="p">,</span> <span class="s1">'.git-lint/config'</span><span class="p">)])</span> <span class="ow">or</span> <span class="p">[])</span>
|
||||
|
||||
<span class="n">matches</span> <span class="o">=</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">possibles</span> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">p</span><span class="p">)]</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">matches</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
||||
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'No configuration file found, tried: {}'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="s">':'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">possibles</span><span class="p">)))</span>
|
||||
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'No configuration file found, tried: </span><span class="si">{}</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="s1">':'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">possibles</span><span class="p">)))</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">matches</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
||||
<span class="k">return</span> <span class="n">matches</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<span class="c"># (commandLineDictionary, repositoryLocation) -> (configurationDictionary | exit)</span></div>
|
||||
<span class="c1"># (commandLineDictionary, repositoryLocation) -> (configurationDictionary | exit)</span>
|
||||
<div class="viewcode-block" id="load_config"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.load_config">[docs]</a><span class="k">def</span> <span class="nf">load_config</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">base</span><span class="p">):</span>
|
||||
<span class="sd">"""Loads the git-lint configuration file.</span>
|
||||
|
||||
|
|
@ -119,189 +119,189 @@
|
|||
<span class="sd"> files for specific linters.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">Linter</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span><span class="s">'Linter'</span><span class="p">,</span> <span class="p">[</span><span class="s">'name'</span><span class="p">,</span> <span class="s">'linter'</span><span class="p">])</span>
|
||||
<span class="n">Linter</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span><span class="s1">'Linter'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'name'</span><span class="p">,</span> <span class="s1">'linter'</span><span class="p">])</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">find_config_file</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">base</span><span class="p">)</span>
|
||||
<span class="n">configloader</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">SafeConfigParser</span><span class="p">()</span>
|
||||
<span class="n">configloader</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
|
||||
<span class="n">configloader</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'DEFAULT'</span><span class="p">,</span> <span class="s">'repodir'</span><span class="p">,</span> <span class="n">base</span><span class="p">)</span>
|
||||
<span class="n">configloader</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">'DEFAULT'</span><span class="p">,</span> <span class="s1">'repodir'</span><span class="p">,</span> <span class="n">base</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">Linter</span><span class="p">(</span><span class="n">section</span><span class="p">,</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">v</span> <span class="k">for</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="ow">in</span> <span class="n">configloader</span><span class="o">.</span><span class="n">items</span><span class="p">(</span><span class="n">section</span><span class="p">)})</span>
|
||||
<span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">configloader</span><span class="o">.</span><span class="n">sections</span><span class="p">()]</span>
|
||||
<span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">configloader</span><span class="o">.</span><span class="n">sections</span><span class="p">()]</span></div>
|
||||
|
||||
|
||||
<span class="c"># ___ _ _</span>
|
||||
<span class="c"># / __(_) |_</span>
|
||||
<span class="c"># | (_ | | _|</span>
|
||||
<span class="c"># \___|_|\__|</span>
|
||||
<span class="c">#</span>
|
||||
</div>
|
||||
<span class="c1"># ___ _ _</span>
|
||||
<span class="c1"># / __(_) |_</span>
|
||||
<span class="c1"># | (_ | | _|</span>
|
||||
<span class="c1"># \___|_|\__|</span>
|
||||
<span class="c1">#</span>
|
||||
|
||||
<div class="viewcode-block" id="get_git_response_raw"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.get_git_response_raw">[docs]</a><span class="k">def</span> <span class="nf">get_git_response_raw</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||||
<span class="n">fullcmd</span> <span class="o">=</span> <span class="p">([</span><span class="s">'git'</span><span class="p">]</span> <span class="o">+</span> <span class="n">cmd</span><span class="p">)</span>
|
||||
<span class="n">fullcmd</span> <span class="o">=</span> <span class="p">([</span><span class="s1">'git'</span><span class="p">]</span> <span class="o">+</span> <span class="n">cmd</span><span class="p">)</span>
|
||||
<span class="n">process</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">fullcmd</span><span class="p">,</span>
|
||||
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
|
||||
<span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
|
||||
<span class="n">universal_newlines</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
<span class="n">universal_newlines</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span> <span class="o">=</span> <span class="n">process</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">,</span> <span class="n">process</span><span class="o">.</span><span class="n">returncode</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">,</span> <span class="n">process</span><span class="o">.</span><span class="n">returncode</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="get_git_response"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.get_git_response">[docs]</a><span class="k">def</span> <span class="nf">get_git_response</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||||
<span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">error</span><span class="p">,</span> <span class="n">returncode</span><span class="p">)</span> <span class="o">=</span> <span class="n">get_git_response_raw</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">out</span>
|
||||
<span class="k">return</span> <span class="n">out</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="split_git_response"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.split_git_response">[docs]</a><span class="k">def</span> <span class="nf">split_git_response</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||||
<span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">error</span><span class="p">,</span> <span class="n">returncode</span><span class="p">)</span> <span class="o">=</span> <span class="n">get_git_response_raw</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">out</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()</span>
|
||||
<span class="k">return</span> <span class="n">out</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="run_git_command"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.run_git_command">[docs]</a><span class="k">def</span> <span class="nf">run_git_command</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
|
||||
<span class="n">fullcmd</span> <span class="o">=</span> <span class="p">([</span><span class="s">'git'</span><span class="p">]</span> <span class="o">+</span> <span class="n">cmd</span><span class="p">)</span>
|
||||
<span class="n">fullcmd</span> <span class="o">=</span> <span class="p">([</span><span class="s1">'git'</span><span class="p">]</span> <span class="o">+</span> <span class="n">cmd</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">fullcmd</span><span class="p">,</span>
|
||||
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
|
||||
<span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
|
||||
<span class="n">universal_newlines</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
<span class="n">universal_newlines</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="get_shell_response"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.get_shell_response">[docs]</a><span class="k">def</span> <span class="nf">get_shell_response</span><span class="p">(</span><span class="n">fullcmd</span><span class="p">):</span>
|
||||
<span class="n">process</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">fullcmd</span><span class="p">,</span>
|
||||
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
|
||||
<span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
|
||||
<span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
|
||||
<span class="n">universal_newlines</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
<span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
||||
<span class="n">universal_newlines</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span> <span class="o">=</span> <span class="n">process</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">,</span> <span class="n">process</span><span class="o">.</span><span class="n">returncode</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">,</span> <span class="n">process</span><span class="o">.</span><span class="n">returncode</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="get_git_base"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.get_git_base">[docs]</a><span class="k">def</span> <span class="nf">get_git_base</span><span class="p">():</span>
|
||||
<span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">error</span><span class="p">,</span> <span class="n">returncode</span><span class="p">)</span> <span class="o">=</span> <span class="n">get_git_response_raw</span><span class="p">(</span>
|
||||
<span class="p">[</span><span class="s">'rev-parse'</span><span class="p">,</span> <span class="s">'--show-toplevel'</span><span class="p">])</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">out</span><span class="o">.</span><span class="n">rstrip</span><span class="p">())</span> <span class="ow">or</span> <span class="bp">None</span>
|
||||
<span class="p">[</span><span class="s1">'rev-parse'</span><span class="p">,</span> <span class="s1">'--show-toplevel'</span><span class="p">])</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">out</span><span class="o">.</span><span class="n">rstrip</span><span class="p">())</span> <span class="ow">or</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="get_git_head"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.get_git_head">[docs]</a><span class="k">def</span> <span class="nf">get_git_head</span><span class="p">():</span>
|
||||
<span class="n">empty_repository_hash</span> <span class="o">=</span> <span class="s">'4b825dc642cb6eb9a060e54bf8d69288fbee4904'</span>
|
||||
<span class="n">empty_repository_hash</span> <span class="o">=</span> <span class="s1">'4b825dc642cb6eb9a060e54bf8d69288fbee4904'</span>
|
||||
<span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">,</span> <span class="n">returncode</span><span class="p">)</span> <span class="o">=</span> <span class="n">get_git_response_raw</span><span class="p">(</span>
|
||||
<span class="p">[</span><span class="s">'rev-parse'</span><span class="p">,</span> <span class="s">'--verify HEAD'</span><span class="p">])</span>
|
||||
<span class="k">return</span> <span class="p">((</span><span class="n">err</span> <span class="ow">and</span> <span class="n">empty_repository_hash</span><span class="p">)</span> <span class="ow">or</span> <span class="s">'HEAD'</span><span class="p">)</span>
|
||||
<span class="p">[</span><span class="s1">'rev-parse'</span><span class="p">,</span> <span class="s1">'--verify HEAD'</span><span class="p">])</span>
|
||||
<span class="k">return</span> <span class="p">((</span><span class="n">err</span> <span class="ow">and</span> <span class="n">empty_repository_hash</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">'HEAD'</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<span class="n">git_base</span> <span class="o">=</span> <span class="n">get_git_base</span><span class="p">()</span>
|
||||
<span class="n">git_head</span> <span class="o">=</span> <span class="n">get_git_head</span><span class="p">()</span>
|
||||
|
||||
|
||||
<span class="c"># _ _ _ _ _ _ _ _</span>
|
||||
<span class="c"># | | | | |_(_) (_) |_(_)___ ___</span>
|
||||
<span class="c"># | |_| | _| | | | _| / -_|_-<</span>
|
||||
<span class="c"># \___/ \__|_|_|_|\__|_\___/__/</span>
|
||||
<span class="c">#</span>
|
||||
<span class="c1"># _ _ _ _ _ _ _ _</span>
|
||||
<span class="c1"># | | | | |_(_) (_) |_(_)___ ___</span>
|
||||
<span class="c1"># | |_| | _| | | | _| / -_|_-<</span>
|
||||
<span class="c1"># \___/ \__|_|_|_|\__|_\___/__/</span>
|
||||
<span class="c1">#</span>
|
||||
|
||||
<div class="viewcode-block" id="MatchFilter"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.MatchFilter">[docs]</a><span class="k">class</span> <span class="nc">MatchFilter</span><span class="p">:</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">matcher</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_match_filter_matcher</span><span class="p">([</span><span class="n">v</span><span class="o">.</span><span class="n">linter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'match'</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">config</span><span class="p">])</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">matcher</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_match_filter_matcher</span><span class="p">([</span><span class="n">v</span><span class="o">.</span><span class="n">linter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'match'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">config</span><span class="p">])</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">matcher</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@staticmethod</span>
|
||||
<div class="viewcode-block" id="MatchFilter.make_match_filter_matcher"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.MatchFilter.make_match_filter_matcher">[docs]</a> <span class="k">def</span> <span class="nf">make_match_filter_matcher</span><span class="p">(</span><span class="n">extensions</span><span class="p">):</span>
|
||||
<span class="n">trimmed</span> <span class="o">=</span> <span class="p">[</span><span class="n">s</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="nb">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span>
|
||||
<span class="p">[</span><span class="n">ex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">','</span><span class="p">)</span> <span class="k">for</span> <span class="n">ex</span> <span class="ow">in</span> <span class="n">extensions</span><span class="p">],</span> <span class="p">[])]</span>
|
||||
<span class="n">cleaned</span> <span class="o">=</span> <span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">r'^\.'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">trimmed</span><span class="p">]</span>
|
||||
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">r'\.'</span> <span class="o">+</span> <span class="s">'|'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cleaned</span><span class="p">)</span> <span class="o">+</span> <span class="s">r'$'</span><span class="p">)</span>
|
||||
<span class="n">trimmed</span> <span class="o">=</span> <span class="p">[</span><span class="n">s</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span>
|
||||
<span class="p">[</span><span class="n">ex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">)</span> <span class="k">for</span> <span class="n">ex</span> <span class="ow">in</span> <span class="n">extensions</span><span class="p">],</span> <span class="p">[])]</span>
|
||||
<span class="n">cleaned</span> <span class="o">=</span> <span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">r'^\.'</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">trimmed</span><span class="p">]</span>
|
||||
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r'\.'</span> <span class="o">+</span> <span class="s1">'|'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cleaned</span><span class="p">)</span> <span class="o">+</span> <span class="s1">r'$'</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<span class="c"># ___ _ _ _ _ _</span>
|
||||
<span class="c"># / __| |_ ___ __| |__ | (_)_ _| |_ ___ _ _ ___</span>
|
||||
<span class="c"># | (__| ' \/ -_) _| / / | | | ' \ _/ -_) '_(_-<</span>
|
||||
<span class="c"># \___|_||_\___\__|_\_\ |_|_|_||_\__\___|_| /__/</span>
|
||||
<span class="c">#</span>
|
||||
</div></div>
|
||||
<span class="c1"># ___ _ _ _ _ _</span>
|
||||
<span class="c1"># / __| |_ ___ __| |__ | (_)_ _| |_ ___ _ _ ___</span>
|
||||
<span class="c1"># | (__| ' \/ -_) _| / / | | | ' \ _/ -_) '_(_-<</span>
|
||||
<span class="c1"># \___|_||_\___\__|_\_\ |_|_|_||_\__\___|_| /__/</span>
|
||||
<span class="c1">#</span>
|
||||
|
||||
<div class="viewcode-block" id="executable_exists"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.executable_exists">[docs]</a><span class="k">def</span> <span class="nf">executable_exists</span><span class="p">(</span><span class="n">script</span><span class="p">,</span> <span class="n">label</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">len</span><span class="p">(</span><span class="n">script</span><span class="p">):</span>
|
||||
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span>
|
||||
<span class="n">_</span><span class="p">(</span><span class="s">'Syntax error in command configuration for {} '</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">label</span><span class="p">))</span>
|
||||
<span class="n">_</span><span class="p">(</span><span class="s1">'Syntax error in command configuration for </span><span class="si">{}</span><span class="s1"> '</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">label</span><span class="p">))</span>
|
||||
|
||||
<span class="n">scriptname</span> <span class="o">=</span> <span class="n">script</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">' '</span><span class="p">)</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="n">scriptname</span> <span class="o">=</span> <span class="n">script</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">' '</span><span class="p">)</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">len</span><span class="p">(</span><span class="n">scriptname</span><span class="p">):</span>
|
||||
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span>
|
||||
<span class="n">_</span><span class="p">(</span><span class="s">'Syntax error in command configuration for {} '</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">label</span><span class="p">))</span>
|
||||
<span class="n">_</span><span class="p">(</span><span class="s1">'Syntax error in command configuration for </span><span class="si">{}</span><span class="s1"> '</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">label</span><span class="p">))</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">is_executable</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">X_OK</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">scriptname</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'/'</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">is_executable</span><span class="p">(</span><span class="n">scriptname</span><span class="p">)</span> <span class="ow">and</span> <span class="n">scriptname</span><span class="p">)</span> <span class="ow">or</span> <span class="bp">None</span>
|
||||
<span class="k">if</span> <span class="n">scriptname</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'/'</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">is_executable</span><span class="p">(</span><span class="n">scriptname</span><span class="p">)</span> <span class="ow">and</span> <span class="n">scriptname</span><span class="p">)</span> <span class="ow">or</span> <span class="kc">None</span>
|
||||
|
||||
<span class="c"># shutil.which() doesn't appear until Python 3, darnit.</span>
|
||||
<span class="c1"># shutil.which() doesn't appear until Python 3, darnit.</span>
|
||||
<span class="n">possibles</span> <span class="o">=</span> <span class="p">[</span><span class="n">path</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span>
|
||||
<span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">scriptname</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'PATH'</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">)]</span>
|
||||
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'PATH'</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">':'</span><span class="p">)]</span>
|
||||
<span class="k">if</span> <span class="n">is_executable</span><span class="p">(</span><span class="n">path</span><span class="p">)]</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">possibles</span><span class="p">)</span> <span class="ow">and</span> <span class="n">possibles</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span> <span class="ow">or</span> <span class="bp">False</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">possibles</span><span class="p">)</span> <span class="ow">and</span> <span class="n">possibles</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span> <span class="ow">or</span> <span class="kc">False</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="get_working_linter_names"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.get_working_linter_names">[docs]</a><span class="k">def</span> <span class="nf">get_working_linter_names</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">i</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">config</span>
|
||||
<span class="k">if</span> <span class="n">executable_exists</span><span class="p">(</span><span class="n">i</span><span class="o">.</span><span class="n">linter</span><span class="p">[</span><span class="s">'command'</span><span class="p">],</span> <span class="n">i</span><span class="o">.</span><span class="n">name</span><span class="p">)]</span>
|
||||
<span class="k">if</span> <span class="n">executable_exists</span><span class="p">(</span><span class="n">i</span><span class="o">.</span><span class="n">linter</span><span class="p">[</span><span class="s1">'command'</span><span class="p">],</span> <span class="n">i</span><span class="o">.</span><span class="n">name</span><span class="p">)]</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="get_linter_status"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.get_linter_status">[docs]</a><span class="k">def</span> <span class="nf">get_linter_status</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
|
||||
<span class="n">working_linter_names</span> <span class="o">=</span> <span class="n">get_working_linter_names</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
|
||||
<span class="n">broken_linter_names</span> <span class="o">=</span> <span class="p">(</span><span class="nb">set</span><span class="p">([</span><span class="n">i</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">config</span><span class="p">])</span> <span class="o">-</span> <span class="nb">set</span><span class="p">(</span><span class="n">working_linter_names</span><span class="p">))</span>
|
||||
<span class="k">return</span> <span class="n">working_linter_names</span><span class="p">,</span> <span class="n">broken_linter_names</span>
|
||||
<span class="k">return</span> <span class="n">working_linter_names</span><span class="p">,</span> <span class="n">broken_linter_names</span></div>
|
||||
|
||||
|
||||
<span class="c"># ___ _ _ _ _ __ __ _ _</span>
|
||||
<span class="c"># / __|___| |_ | (_)__| |_ ___ / _| / _(_) |___ ___</span>
|
||||
<span class="c"># | (_ / -_) _| | | (_-< _| / _ \ _| | _| | / -_|_-<</span>
|
||||
<span class="c"># \___\___|\__| |_|_/__/\__| \___/_| |_| |_|_\___/__/</span>
|
||||
<span class="c">#</span>
|
||||
</div>
|
||||
<span class="c1"># ___ _ _ _ _ __ __ _ _</span>
|
||||
<span class="c1"># / __|___| |_ | (_)__| |_ ___ / _| / _(_) |___ ___</span>
|
||||
<span class="c1"># | (_ / -_) _| | | (_-< _| / _ \ _| | _| | / -_|_-<</span>
|
||||
<span class="c1"># \___\___|\__| |_|_/__/\__| \___/_| |_| |_|_\___/__/</span>
|
||||
<span class="c1">#</span>
|
||||
|
||||
<div class="viewcode-block" id="get_filelist"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.get_filelist">[docs]</a><span class="k">def</span> <span class="nf">get_filelist</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">extras</span><span class="p">):</span>
|
||||
<span class="sd">""" Returns the list of files against which we'll run the linters. """</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">base_file_filter</span><span class="p">(</span><span class="n">files</span><span class="p">):</span>
|
||||
<span class="sd">""" Return the full path for all files """</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">git_base</span><span class="p">,</span> <span class="nb">file</span><span class="p">)</span> <span class="k">for</span> <span class="nb">file</span> <span class="ow">in</span> <span class="n">files</span><span class="p">]</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">git_base</span><span class="p">,</span> <span class="n">file</span><span class="p">)</span> <span class="k">for</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">files</span><span class="p">]</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">cwd_file_filter</span><span class="p">(</span><span class="n">filenames</span><span class="p">):</span>
|
||||
<span class="sd">""" Return the full path for only those files in the cwd and down """</span>
|
||||
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">samefile</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span> <span class="n">git_base</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">base_file_filter</span><span class="p">(</span><span class="n">filenames</span><span class="p">)</span>
|
||||
<span class="n">gitcwd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span> <span class="n">git_base</span><span class="p">),</span> <span class="s">''</span><span class="p">)</span>
|
||||
<span class="n">gitcwd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span> <span class="n">git_base</span><span class="p">),</span> <span class="s1">''</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">base_file_filter</span><span class="p">([</span><span class="n">filename</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">filenames</span>
|
||||
<span class="k">if</span> <span class="n">filename</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">gitcwd</span><span class="p">)])</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">check_for_conflicts</span><span class="p">(</span><span class="n">filesets</span><span class="p">):</span>
|
||||
<span class="sd">""" Scan list of porcelain files for merge conflic state. """</span>
|
||||
<span class="n">MERGE_CONFLICT_PAIRS</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="s">'DD'</span><span class="p">,</span> <span class="s">'DU'</span><span class="p">,</span> <span class="s">'AU'</span><span class="p">,</span> <span class="s">'AA'</span><span class="p">,</span> <span class="s">'UD'</span><span class="p">,</span> <span class="s">'UA'</span><span class="p">,</span> <span class="s">'UU'</span><span class="p">])</span>
|
||||
<span class="n">status_pairs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="s">''</span> <span class="o">+</span> <span class="n">f</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="n">f</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">filesets</span><span class="p">])</span>
|
||||
<span class="n">MERGE_CONFLICT_PAIRS</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="s1">'DD'</span><span class="p">,</span> <span class="s1">'DU'</span><span class="p">,</span> <span class="s1">'AU'</span><span class="p">,</span> <span class="s1">'AA'</span><span class="p">,</span> <span class="s1">'UD'</span><span class="p">,</span> <span class="s1">'UA'</span><span class="p">,</span> <span class="s1">'UU'</span><span class="p">])</span>
|
||||
<span class="n">status_pairs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="s1">''</span> <span class="o">+</span> <span class="n">f</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="n">f</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">filesets</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">status_pairs</span> <span class="o">&</span> <span class="n">MERGE_CONFLICT_PAIRS</span><span class="p">):</span>
|
||||
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span>
|
||||
<span class="n">_</span><span class="p">(</span><span class="s">'Current repository contains merge conflicts. Linters will not be run.'</span><span class="p">))</span>
|
||||
<span class="n">_</span><span class="p">(</span><span class="s1">'Current repository contains merge conflicts. Linters will not be run.'</span><span class="p">))</span>
|
||||
<span class="k">return</span> <span class="n">filesets</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">remove_submodules</span><span class="p">(</span><span class="n">files</span><span class="p">):</span>
|
||||
<span class="sd">""" Remove all submodules from the list of files git-lint cares about. """</span>
|
||||
|
||||
<span class="n">fixer_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">'^(</span><span class="se">\\</span><span class="s">.</span><span class="se">\\</span><span class="s">.</span><span class="se">\\</span><span class="s">/)+'</span><span class="p">)</span>
|
||||
<span class="n">submodules</span> <span class="o">=</span> <span class="n">split_git_response</span><span class="p">([</span><span class="s">'submodule'</span><span class="p">,</span> <span class="s">'status'</span><span class="p">])</span>
|
||||
<span class="n">submodule_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">fixer_re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">''</span><span class="p">,</span> <span class="n">submodule</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">' '</span><span class="p">)[</span><span class="mi">2</span><span class="p">])</span>
|
||||
<span class="n">fixer_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">'^(</span><span class="se">\\</span><span class="s1">.</span><span class="se">\\</span><span class="s1">.</span><span class="se">\\</span><span class="s1">/)+'</span><span class="p">)</span>
|
||||
<span class="n">submodules</span> <span class="o">=</span> <span class="n">split_git_response</span><span class="p">([</span><span class="s1">'submodule'</span><span class="p">,</span> <span class="s1">'status'</span><span class="p">])</span>
|
||||
<span class="n">submodule_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">fixer_re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">''</span><span class="p">,</span> <span class="n">submodule</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">' '</span><span class="p">)[</span><span class="mi">2</span><span class="p">])</span>
|
||||
<span class="k">for</span> <span class="n">submodule</span> <span class="ow">in</span> <span class="n">submodules</span><span class="p">]</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="nb">file</span> <span class="k">for</span> <span class="nb">file</span> <span class="ow">in</span> <span class="n">files</span> <span class="k">if</span> <span class="p">(</span><span class="nb">file</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">submodule_names</span><span class="p">)]</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">file</span> <span class="k">for</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">files</span> <span class="k">if</span> <span class="p">(</span><span class="n">file</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">submodule_names</span><span class="p">)]</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">get_porcelain_status</span><span class="p">():</span>
|
||||
<span class="sd">""" Return the status of all files in the system. """</span>
|
||||
<span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s">'status'</span><span class="p">,</span> <span class="s">'-z'</span><span class="p">,</span> <span class="s">'--porcelain'</span><span class="p">,</span>
|
||||
<span class="s">'--untracked-files=all'</span><span class="p">,</span> <span class="s">'--ignore-submodules=all'</span><span class="p">]</span>
|
||||
<span class="n">stream</span> <span class="o">=</span> <span class="p">[</span><span class="n">entry</span> <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">get_git_response</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">u'</span><span class="se">\x00</span><span class="s">'</span><span class="p">)</span>
|
||||
<span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'status'</span><span class="p">,</span> <span class="s1">'-z'</span><span class="p">,</span> <span class="s1">'--porcelain'</span><span class="p">,</span>
|
||||
<span class="s1">'--untracked-files=all'</span><span class="p">,</span> <span class="s1">'--ignore-submodules=all'</span><span class="p">]</span>
|
||||
<span class="n">stream</span> <span class="o">=</span> <span class="p">[</span><span class="n">entry</span> <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">get_git_response</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">u'</span><span class="se">\x00</span><span class="s1">'</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">]</span>
|
||||
|
||||
<span class="c"># Yeah, baby, recursion, the way this is meant to be handled.</span>
|
||||
<span class="c"># If you have more than 999 files that need linting, you have</span>
|
||||
<span class="c"># a bigger problem...</span>
|
||||
<span class="c1"># Yeah, baby, recursion, the way this is meant to be handled.</span>
|
||||
<span class="c1"># If you have more than 999 files that need linting, you have</span>
|
||||
<span class="c1"># a bigger problem...</span>
|
||||
<span class="k">def</span> <span class="nf">parse_stream</span><span class="p">(</span><span class="n">acc</span><span class="p">,</span> <span class="n">stream</span><span class="p">):</span>
|
||||
<span class="sd">"""Parse the list of files. T</span>
|
||||
|
||||
|
|
@ -315,7 +315,7 @@
|
|||
<span class="k">return</span> <span class="n">acc</span>
|
||||
<span class="n">entry</span> <span class="o">=</span> <span class="n">stream</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">workspace</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> <span class="o">=</span> <span class="p">(</span><span class="n">entry</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">entry</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">entry</span><span class="p">[</span><span class="mi">3</span><span class="p">:])</span>
|
||||
<span class="k">if</span> <span class="n">index</span> <span class="o">==</span> <span class="s">'R'</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">index</span> <span class="o">==</span> <span class="s1">'R'</span><span class="p">:</span>
|
||||
<span class="n">stream</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">parse_stream</span><span class="p">(</span><span class="n">acc</span> <span class="o">+</span> <span class="p">[(</span><span class="n">index</span><span class="p">,</span> <span class="n">workspace</span><span class="p">,</span> <span class="n">filename</span><span class="p">)],</span> <span class="n">stream</span><span class="p">)</span>
|
||||
|
||||
|
|
@ -325,7 +325,7 @@
|
|||
<span class="sd">""" Return the list of files added or modified to the stage """</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">filename</span> <span class="k">for</span> <span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">workspace</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> <span class="ow">in</span> <span class="n">get_porcelain_status</span><span class="p">()</span>
|
||||
<span class="k">if</span> <span class="n">index</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'A'</span><span class="p">,</span> <span class="s">'M'</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">index</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'A'</span><span class="p">,</span> <span class="s1">'M'</span><span class="p">]]</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">working_list</span><span class="p">():</span>
|
||||
<span class="sd">""" Return the list of files that have been modified in the workspace.</span>
|
||||
|
|
@ -333,13 +333,13 @@
|
|||
<span class="sd"> Includes the '?' to include files that git is not currently tracking.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">filename</span> <span class="k">for</span> <span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">workspace</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> <span class="ow">in</span> <span class="n">get_porcelain_status</span><span class="p">()</span>
|
||||
<span class="k">if</span> <span class="n">workspace</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'A'</span><span class="p">,</span> <span class="s">'M'</span><span class="p">,</span> <span class="s">'?'</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">workspace</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'A'</span><span class="p">,</span> <span class="s1">'M'</span><span class="p">,</span> <span class="s1">'?'</span><span class="p">]]</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">all_list</span><span class="p">():</span>
|
||||
<span class="sd">""" Return all the files git is currently tracking for this repository. """</span>
|
||||
<span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s">'ls-tree'</span><span class="p">,</span> <span class="s">'--name-only'</span><span class="p">,</span> <span class="s">'--full-tree'</span><span class="p">,</span> <span class="s">'-r'</span><span class="p">,</span> <span class="s">'-z'</span><span class="p">,</span> <span class="n">git_head</span><span class="p">]</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="nb">file</span> <span class="k">for</span> <span class="nb">file</span> <span class="ow">in</span> <span class="n">get_git_response</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">u'</span><span class="se">\x00</span><span class="s">'</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="nb">file</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">]</span>
|
||||
<span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'ls-tree'</span><span class="p">,</span> <span class="s1">'--name-only'</span><span class="p">,</span> <span class="s1">'--full-tree'</span><span class="p">,</span> <span class="s1">'-r'</span><span class="p">,</span> <span class="s1">'-z'</span><span class="p">,</span> <span class="n">git_head</span><span class="p">]</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">file</span> <span class="k">for</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">get_git_response</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">u'</span><span class="se">\x00</span><span class="s1">'</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">file</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">]</span>
|
||||
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">extras</span><span class="p">):</span>
|
||||
<span class="n">cwd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">())</span>
|
||||
|
|
@ -348,25 +348,25 @@
|
|||
<span class="k">return</span> <span class="p">([</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">cwd</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="p">(</span><span class="n">extras_fullpathed</span> <span class="o">-</span> <span class="n">not_found</span><span class="p">)],</span> <span class="n">not_found</span><span class="p">)</span>
|
||||
|
||||
<span class="n">working_directory_trans</span> <span class="o">=</span> <span class="n">cwd_file_filter</span>
|
||||
<span class="k">if</span> <span class="s">'base'</span> <span class="ow">in</span> <span class="n">options</span> <span class="ow">or</span> <span class="s">'every'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="s1">'base'</span> <span class="ow">in</span> <span class="n">options</span> <span class="ow">or</span> <span class="s1">'every'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="n">working_directory_trans</span> <span class="o">=</span> <span class="n">base_file_filter</span>
|
||||
|
||||
<span class="n">file_list_generator</span> <span class="o">=</span> <span class="n">working_list</span>
|
||||
<span class="k">if</span> <span class="s">'all'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="s1">'all'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="n">file_list_generator</span> <span class="o">=</span> <span class="n">all_list</span>
|
||||
<span class="k">if</span> <span class="s">'staging'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="s1">'staging'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="n">file_list_generator</span> <span class="o">=</span> <span class="n">staging_list</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">working_directory_trans</span><span class="p">(</span><span class="n">remove_submodules</span><span class="p">(</span><span class="n">file_list_generator</span><span class="p">())),</span> <span class="p">[])</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">working_directory_trans</span><span class="p">(</span><span class="n">remove_submodules</span><span class="p">(</span><span class="n">file_list_generator</span><span class="p">())),</span> <span class="p">[])</span></div>
|
||||
|
||||
|
||||
<span class="c"># ___ _ _</span>
|
||||
<span class="c"># / __| |_ __ _ __ _(_)_ _ __ _ __ __ ___ _ __ _ _ __ _ __ ___ _ _</span>
|
||||
<span class="c"># \__ \ _/ _` / _` | | ' \/ _` | \ V V / '_/ _` | '_ \ '_ \/ -_) '_|</span>
|
||||
<span class="c"># |___/\__\__,_\__, |_|_||_\__, | \_/\_/|_| \__,_| .__/ .__/\___|_|</span>
|
||||
<span class="c"># |___/ |___/ |_| |_|</span>
|
||||
<span class="c1"># ___ _ _</span>
|
||||
<span class="c1"># / __| |_ __ _ __ _(_)_ _ __ _ __ __ ___ _ __ _ _ __ _ __ ___ _ _</span>
|
||||
<span class="c1"># \__ \ _/ _` / _` | | ' \/ _` | \ V V / '_/ _` | '_ \ '_ \/ -_) '_|</span>
|
||||
<span class="c1"># |___/\__\__,_\__, |_|_||_\__, | \_/\_/|_| \__,_| .__/ .__/\___|_|</span>
|
||||
<span class="c1"># |___/ |___/ |_| |_|</span>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="StagingRunner"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.StagingRunner">[docs]</a><span class="k">class</span> <span class="nc">StagingRunner</span><span class="p">:</span>
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filenames</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">filenames</span> <span class="o">=</span> <span class="n">filenames</span>
|
||||
|
|
@ -376,15 +376,15 @@
|
|||
<span class="n">stats</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="p">(</span><span class="n">stats</span><span class="o">.</span><span class="n">st_atime</span><span class="p">,</span> <span class="n">stats</span><span class="o">.</span><span class="n">st_mtime</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">times</span> <span class="o">=</span> <span class="p">[</span><span class="n">time_gather</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">filenames</span><span class="p">]</span>
|
||||
<span class="n">run_git_command</span><span class="p">([</span><span class="s">'stash'</span><span class="p">,</span> <span class="s">'--keep-index'</span><span class="p">])</span>
|
||||
<span class="n">run_git_command</span><span class="p">([</span><span class="s1">'stash'</span><span class="p">,</span> <span class="s1">'--keep-index'</span><span class="p">])</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">traceback</span><span class="p">):</span>
|
||||
<span class="n">run_git_command</span><span class="p">([</span><span class="s">'reset'</span><span class="p">,</span> <span class="s">'--hard'</span><span class="p">])</span>
|
||||
<span class="n">run_git_command</span><span class="p">([</span><span class="s">'stash'</span><span class="p">,</span> <span class="s">'pop'</span><span class="p">,</span> <span class="s">'--quiet'</span><span class="p">,</span> <span class="s">'--index'</span><span class="p">])</span>
|
||||
<span class="n">run_git_command</span><span class="p">([</span><span class="s1">'reset'</span><span class="p">,</span> <span class="s1">'--hard'</span><span class="p">])</span>
|
||||
<span class="n">run_git_command</span><span class="p">([</span><span class="s1">'stash'</span><span class="p">,</span> <span class="s1">'pop'</span><span class="p">,</span> <span class="s1">'--quiet'</span><span class="p">,</span> <span class="s1">'--index'</span><span class="p">])</span>
|
||||
<span class="k">for</span> <span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">timepair</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">times</span><span class="p">:</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">utime</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">timepair</span><span class="p">)</span>
|
||||
<span class="n">os</span><span class="o">.</span><span class="n">utime</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">timepair</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="WorkspaceRunner"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.WorkspaceRunner">[docs]</a><span class="k">class</span> <span class="nc">WorkspaceRunner</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filenames</span><span class="p">):</span>
|
||||
<span class="k">pass</span>
|
||||
|
|
@ -393,15 +393,15 @@
|
|||
<span class="k">pass</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">traceback</span><span class="p">):</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">pass</span></div>
|
||||
|
||||
|
||||
<span class="c"># ___ _ _ _</span>
|
||||
<span class="c"># | _ \_ _ _ _ | (_)_ _| |_ _ __ __ _ ______</span>
|
||||
<span class="c"># | / || | ' \ | | | ' \ _| | '_ \/ _` (_-<_-<</span>
|
||||
<span class="c"># |_|_\\_,_|_||_| |_|_|_||_\__| | .__/\__,_/__/__/</span>
|
||||
<span class="c"># |_|</span>
|
||||
</div>
|
||||
<span class="c1"># ___ _ _ _</span>
|
||||
<span class="c1"># | _ \_ _ _ _ | (_)_ _| |_ _ __ __ _ ______</span>
|
||||
<span class="c1"># | / || | ' \ | | | ' \ _| | '_ \/ _` (_-<_-<</span>
|
||||
<span class="c1"># |_|_\\_,_|_||_| |_|_|_||_\__| | .__/\__,_/__/__/</span>
|
||||
<span class="c1"># |_|</span>
|
||||
|
||||
<div class="viewcode-block" id="Linters"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.Linters">[docs]</a><span class="k">class</span> <span class="nc">Linters</span><span class="p">:</span>
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">linters</span><span class="p">,</span> <span class="n">filenames</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">linters</span> <span class="o">=</span> <span class="n">linters</span>
|
||||
|
|
@ -409,9 +409,9 @@
|
|||
|
||||
<span class="nd">@staticmethod</span>
|
||||
<div class="viewcode-block" id="Linters.encode_shell_messages"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.Linters.encode_shell_messages">[docs]</a> <span class="k">def</span> <span class="nf">encode_shell_messages</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">messages</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="s">'{}{}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">messages</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()]</span>
|
||||
</div>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="s1">'</span><span class="si">{}{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">messages</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()]</span></div>
|
||||
|
||||
<span class="nd">@staticmethod</span>
|
||||
<div class="viewcode-block" id="Linters.run_external_linter"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.Linters.run_external_linter">[docs]</a> <span class="k">def</span> <span class="nf">run_external_linter</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">linter</span><span class="p">,</span> <span class="n">linter_name</span><span class="p">):</span>
|
||||
<span class="sd">"""Run one linter against one file.</span>
|
||||
|
|
@ -420,19 +420,19 @@
|
|||
<span class="sd"> return the error code and messages, otherwise return nothing.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">cmd</span> <span class="o">=</span> <span class="n">linter</span><span class="p">[</span><span class="s">'command'</span><span class="p">]</span> <span class="o">+</span> <span class="s">' "'</span> <span class="o">+</span> <span class="n">filename</span> <span class="o">+</span> <span class="s">'"'</span>
|
||||
<span class="n">cmd</span> <span class="o">=</span> <span class="n">linter</span><span class="p">[</span><span class="s1">'command'</span><span class="p">]</span> <span class="o">+</span> <span class="s1">' "'</span> <span class="o">+</span> <span class="n">filename</span> <span class="o">+</span> <span class="s1">'"'</span>
|
||||
<span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">,</span> <span class="n">returncode</span><span class="p">)</span> <span class="o">=</span> <span class="n">get_shell_response</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
|
||||
<span class="n">failed</span> <span class="o">=</span> <span class="p">((</span><span class="n">out</span> <span class="ow">and</span> <span class="p">(</span><span class="n">linter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'condition'</span><span class="p">,</span> <span class="s">'error'</span><span class="p">)</span> <span class="o">==</span> <span class="s">'output'</span><span class="p">))</span> <span class="ow">or</span> <span class="n">err</span> <span class="ow">or</span> <span class="p">(</span><span class="ow">not</span> <span class="p">(</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)))</span>
|
||||
<span class="n">trimmed_filename</span> <span class="o">=</span> <span class="n">filename</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">git_base</span> <span class="o">+</span> <span class="s">'/'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
||||
<span class="n">failed</span> <span class="o">=</span> <span class="p">((</span><span class="n">out</span> <span class="ow">and</span> <span class="p">(</span><span class="n">linter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'condition'</span><span class="p">,</span> <span class="s1">'error'</span><span class="p">)</span> <span class="o">==</span> <span class="s1">'output'</span><span class="p">))</span> <span class="ow">or</span> <span class="n">err</span> <span class="ow">or</span> <span class="p">(</span><span class="ow">not</span> <span class="p">(</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)))</span>
|
||||
<span class="n">trimmed_filename</span> <span class="o">=</span> <span class="n">filename</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">git_base</span> <span class="o">+</span> <span class="s1">'/'</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">failed</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">trimmed_filename</span><span class="p">,</span> <span class="n">linter_name</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="p">[])</span>
|
||||
|
||||
<span class="n">prefix</span> <span class="o">=</span> <span class="p">(((</span><span class="n">linter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'print'</span><span class="p">,</span> <span class="s">'false'</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">!=</span> <span class="s">'true'</span><span class="p">)</span> <span class="ow">and</span> <span class="s">' '</span><span class="p">)</span> <span class="ow">or</span>
|
||||
<span class="s">' {}: '</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">trimmed_filename</span><span class="p">))</span>
|
||||
<span class="n">prefix</span> <span class="o">=</span> <span class="p">(((</span><span class="n">linter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'print'</span><span class="p">,</span> <span class="s1">'false'</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">!=</span> <span class="s1">'true'</span><span class="p">)</span> <span class="ow">and</span> <span class="s1">' '</span><span class="p">)</span> <span class="ow">or</span>
|
||||
<span class="s1">' </span><span class="si">{}</span><span class="s1">: '</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">trimmed_filename</span><span class="p">))</span>
|
||||
<span class="n">output</span> <span class="o">=</span> <span class="p">(</span><span class="n">Linters</span><span class="o">.</span><span class="n">encode_shell_messages</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span> <span class="o">+</span>
|
||||
<span class="p">((</span><span class="n">err</span> <span class="ow">and</span> <span class="n">Linters</span><span class="o">.</span><span class="n">encode_shell_messages</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">err</span><span class="p">))</span> <span class="ow">or</span> <span class="p">[]))</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">trimmed_filename</span><span class="p">,</span> <span class="n">linter_name</span><span class="p">,</span> <span class="p">(</span><span class="n">returncode</span> <span class="ow">or</span> <span class="mi">1</span><span class="p">),</span> <span class="n">output</span><span class="p">)</span>
|
||||
</div>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">trimmed_filename</span><span class="p">,</span> <span class="n">linter_name</span><span class="p">,</span> <span class="p">(</span><span class="n">returncode</span> <span class="ow">or</span> <span class="mi">1</span><span class="p">),</span> <span class="n">output</span><span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@staticmethod</span>
|
||||
<div class="viewcode-block" id="Linters.run_one_linter"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.Linters.run_one_linter">[docs]</a> <span class="k">def</span> <span class="nf">run_one_linter</span><span class="p">(</span><span class="n">linter</span><span class="p">,</span> <span class="n">filenames</span><span class="p">):</span>
|
||||
<span class="sd">""" Runs one linter against a set of files</span>
|
||||
|
|
@ -444,31 +444,31 @@
|
|||
<span class="sd"> """</span>
|
||||
<span class="n">match_filter</span> <span class="o">=</span> <span class="n">MatchFilter</span><span class="p">([</span><span class="n">linter</span><span class="p">])</span>
|
||||
<span class="n">files</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="n">filename</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">filenames</span> <span class="k">if</span> <span class="n">match_filter</span><span class="p">(</span><span class="n">filename</span><span class="p">)])</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">Linters</span><span class="o">.</span><span class="n">run_external_linter</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">linter</span><span class="o">.</span><span class="n">linter</span><span class="p">,</span> <span class="n">linter</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">files</span><span class="p">]</span>
|
||||
</div>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">Linters</span><span class="o">.</span><span class="n">run_external_linter</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">linter</span><span class="o">.</span><span class="n">linter</span><span class="p">,</span> <span class="n">linter</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">files</span><span class="p">]</span></div>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="sd">""" Returns a function to run a set of linters against a set of filenames</span>
|
||||
|
||||
<span class="sd"> This returns a function because it's going to be wrapped in a</span>
|
||||
<span class="sd"> runner to better handle stashing and restoring a staged commit.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="nb">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span>
|
||||
<span class="k">return</span> <span class="n">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span>
|
||||
<span class="p">[</span><span class="n">Linters</span><span class="o">.</span><span class="n">run_one_linter</span><span class="p">(</span><span class="n">linter</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">filenames</span><span class="p">)</span> <span class="k">for</span> <span class="n">linter</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">linters</span><span class="p">],</span> <span class="p">[])</span>
|
||||
|
||||
<div class="viewcode-block" id="Linters.dryrun"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.Linters.dryrun">[docs]</a> <span class="k">def</span> <span class="nf">dryrun</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">dryrunonefile</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">linter</span><span class="p">):</span>
|
||||
<span class="n">trimmed_filename</span> <span class="o">=</span> <span class="n">filename</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">git_base</span> <span class="o">+</span> <span class="s">'/'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">trimmed_filename</span><span class="p">,</span> <span class="n">linter</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="p">[</span><span class="s">' {}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">trimmed_filename</span><span class="p">)])</span>
|
||||
<span class="n">trimmed_filename</span> <span class="o">=</span> <span class="n">filename</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">git_base</span> <span class="o">+</span> <span class="s1">'/'</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">trimmed_filename</span><span class="p">,</span> <span class="n">linter</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="p">[</span><span class="s1">' </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">trimmed_filename</span><span class="p">)])</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">dryrunonce</span><span class="p">(</span><span class="n">linter</span><span class="p">,</span> <span class="n">filenames</span><span class="p">):</span>
|
||||
<span class="n">match_filter</span> <span class="o">=</span> <span class="n">MatchFilter</span><span class="p">([</span><span class="n">linter</span><span class="p">])</span>
|
||||
<span class="n">files_to_check</span> <span class="o">=</span> <span class="p">[</span><span class="n">filename</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">filenames</span> <span class="k">if</span> <span class="n">match_filter</span><span class="p">(</span><span class="n">filename</span><span class="p">)]</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">dryrunonefile</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">linter</span><span class="p">)</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">files_to_check</span><span class="p">]</span>
|
||||
|
||||
<span class="k">return</span> <span class="nb">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> <span class="p">[</span><span class="n">dryrunonce</span><span class="p">(</span><span class="n">linter</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">filenames</span><span class="p">)</span> <span class="k">for</span> <span class="n">linter</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">linters</span><span class="p">],</span> <span class="p">[])</span>
|
||||
<span class="k">return</span> <span class="n">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> <span class="p">[</span><span class="n">dryrunonce</span><span class="p">(</span><span class="n">linter</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">filenames</span><span class="p">)</span> <span class="k">for</span> <span class="n">linter</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">linters</span><span class="p">],</span> <span class="p">[])</span></div></div>
|
||||
|
||||
|
||||
</div></div>
|
||||
<div class="viewcode-block" id="run_linters"><a class="viewcode-back" href="../../git_lint.html#git_lint.git_lint.run_linters">[docs]</a><span class="k">def</span> <span class="nf">run_linters</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">config</span><span class="p">,</span> <span class="n">extras</span><span class="o">=</span><span class="p">[]):</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">build_config_subset</span><span class="p">(</span><span class="n">keys</span><span class="p">):</span>
|
||||
|
|
@ -494,13 +494,13 @@
|
|||
<span class="k">if</span> <span class="n">cant_lint_filter</span><span class="p">(</span><span class="n">filename</span><span class="p">)]</span>
|
||||
|
||||
<span class="n">runner</span> <span class="o">=</span> <span class="n">WorkspaceRunner</span>
|
||||
<span class="k">if</span> <span class="s">'staging'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="s1">'staging'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="n">runner</span> <span class="o">=</span> <span class="n">StagingRunner</span>
|
||||
|
||||
<span class="n">linters</span> <span class="o">=</span> <span class="n">Linters</span><span class="p">(</span><span class="n">build_config_subset</span><span class="p">(</span><span class="n">working_linter_names</span><span class="p">),</span>
|
||||
<span class="nb">sorted</span><span class="p">(</span><span class="n">lintable_filenames</span><span class="p">))</span>
|
||||
|
||||
<span class="k">if</span> <span class="s">'dryrun'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="s1">'dryrun'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="n">dryrun_results</span> <span class="o">=</span> <span class="n">linters</span><span class="o">.</span><span class="n">dryrun</span><span class="p">()</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">dryrun_results</span><span class="p">,</span> <span class="n">unlintable_filenames</span><span class="p">,</span> <span class="n">cant_lint_filenames</span><span class="p">,</span>
|
||||
<span class="n">broken_linter_names</span><span class="p">,</span> <span class="n">unfindable_filenames</span><span class="p">)</span>
|
||||
|
|
@ -515,26 +515,23 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div id="searchbox" style="display: none">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -543,13 +540,13 @@
|
|||
<li class="right" >
|
||||
<a href="../../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li><a href="../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>git_lint.option_handler — Git Lint 0.0.4 documentation</title>
|
||||
<title>git_lint.option_handler — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../../static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -26,8 +26,8 @@
|
|||
<link rel="top" title="Git Lint 0.0.4 documentation" href="../../index.html" />
|
||||
<link rel="up" title="Module code" href="../index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -36,33 +36,33 @@
|
|||
<li class="right" >
|
||||
<a href="../../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li><a href="../index.html" accesskey="U">Module code</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for git_lint.option_handler</h1><div class="highlight"><pre>
|
||||
<span class="c"># Copyright (C) 2015 Elf M. Sternberg</span>
|
||||
<span class="c"># Author: Elf M. Sternberg</span>
|
||||
<span></span><span class="c1"># Copyright (C) 2015 Elf M. Sternberg</span>
|
||||
<span class="c1"># Author: Elf M. Sternberg</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="nb">reduce</span>
|
||||
<span class="kn">from</span> <span class="nn">functools</span> <span class="k">import</span> <span class="n">reduce</span>
|
||||
<span class="kn">import</span> <span class="nn">getopt</span>
|
||||
|
||||
<span class="c"># This was a lot shorter and smarter in Hy...</span>
|
||||
<span class="c1"># This was a lot shorter and smarter in Hy...</span>
|
||||
|
||||
<span class="c"># A lot of what you see here is separated from git_lint itself, since this will not be</span>
|
||||
<span class="c"># relevant to the operation of pre-commit.</span>
|
||||
<span class="c1"># A lot of what you see here is separated from git_lint itself, since this will not be</span>
|
||||
<span class="c1"># relevant to the operation of pre-commit.</span>
|
||||
|
||||
<span class="c"># ___ _ _ _</span>
|
||||
<span class="c"># / __|___ _ __ _ __ __ _ _ _ __| | | | (_)_ _ ___</span>
|
||||
<span class="c"># | (__/ _ \ ' \| ' \/ _` | ' \/ _` | | |__| | ' \/ -_)</span>
|
||||
<span class="c"># \___\___/_|_|_|_|_|_\__,_|_||_\__,_| |____|_|_||_\___|</span>
|
||||
<span class="c">#</span>
|
||||
<span class="c1"># ___ _ _ _</span>
|
||||
<span class="c1"># / __|___ _ __ _ __ __ _ _ _ __| | | | (_)_ _ ___</span>
|
||||
<span class="c1"># | (__/ _ \ ' \| ' \/ _` | ' \/ _` | | |__| | ' \/ -_)</span>
|
||||
<span class="c1"># \___\___/_|_|_|_|_|_\__,_|_||_\__,_| |____|_|_||_\___|</span>
|
||||
<span class="c1">#</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="cleanup_options"><a class="viewcode-back" href="../../git_lint.html#git_lint.option_handler.cleanup_options">[docs]</a><span class="k">def</span> <span class="nf">cleanup_options</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">commandline</span><span class="p">):</span>
|
||||
|
|
@ -87,9 +87,9 @@
|
|||
<span class="n">fullset</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
<span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
|
||||
<span class="n">fullset</span><span class="p">[</span><span class="s">'--'</span> <span class="o">+</span> <span class="n">option</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
|
||||
<span class="n">fullset</span><span class="p">[</span><span class="s1">'--'</span> <span class="o">+</span> <span class="n">option</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
|
||||
<span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
|
||||
<span class="n">fullset</span><span class="p">[</span><span class="s">'-'</span> <span class="o">+</span> <span class="n">option</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
|
||||
<span class="n">fullset</span><span class="p">[</span><span class="s1">'-'</span> <span class="o">+</span> <span class="n">option</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">=</span> <span class="n">option</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">streamliner</span><span class="p">(</span><span class="n">acc</span><span class="p">,</span> <span class="n">it</span><span class="p">):</span>
|
||||
<span class="n">acc</span><span class="p">[</span><span class="n">fullset</span><span class="p">[</span><span class="n">it</span><span class="p">[</span><span class="mi">0</span><span class="p">]]]</span> <span class="o">=</span> <span class="n">it</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
|
||||
|
|
@ -108,30 +108,30 @@
|
|||
|
||||
<span class="n">keys</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
|
||||
<span class="n">marked</span> <span class="o">=</span> <span class="p">[</span><span class="n">option</span> <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">options</span> <span class="k">if</span> <span class="n">option</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">in</span> <span class="n">keys</span><span class="p">]</span>
|
||||
<span class="n">exclude</span> <span class="o">=</span> <span class="nb">reduce</span><span class="p">(</span><span class="n">get_excluded_keys</span><span class="p">,</span> <span class="n">marked</span><span class="p">,</span> <span class="p">[])</span>
|
||||
<span class="n">exclude</span> <span class="o">=</span> <span class="n">reduce</span><span class="p">(</span><span class="n">get_excluded_keys</span><span class="p">,</span> <span class="n">marked</span><span class="p">,</span> <span class="p">[])</span>
|
||||
<span class="n">excluded</span> <span class="o">=</span> <span class="p">[</span><span class="n">key</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keys</span> <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">exclude</span><span class="p">]</span>
|
||||
<span class="n">cleaned</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">request</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keys</span>
|
||||
<span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">excluded</span><span class="p">}</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">cleaned</span><span class="p">,</span> <span class="n">excluded</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">shortoptstogo</span><span class="p">(</span><span class="n">i</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">i</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="p">((</span><span class="n">i</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="ow">and</span> <span class="s">':'</span><span class="p">)</span> <span class="ow">or</span> <span class="s">''</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">i</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="p">((</span><span class="n">i</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="ow">and</span> <span class="s1">':'</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">longoptstogo</span><span class="p">(</span><span class="n">i</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">i</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="p">((</span><span class="n">i</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="ow">and</span> <span class="s">'='</span><span class="p">)</span> <span class="ow">or</span> <span class="s">''</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">i</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="p">((</span><span class="n">i</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="ow">and</span> <span class="s1">'='</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">)</span>
|
||||
|
||||
<span class="n">optstringsshort</span> <span class="o">=</span> <span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">shortoptstogo</span><span class="p">(</span><span class="n">opt</span><span class="p">)</span> <span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="n">options</span><span class="p">])</span>
|
||||
<span class="n">optstringsshort</span> <span class="o">=</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">shortoptstogo</span><span class="p">(</span><span class="n">opt</span><span class="p">)</span> <span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="n">options</span><span class="p">])</span>
|
||||
<span class="n">optstringslong</span> <span class="o">=</span> <span class="p">[</span><span class="n">longoptstogo</span><span class="p">(</span><span class="n">opt</span><span class="p">)</span> <span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="n">options</span><span class="p">]</span>
|
||||
<span class="p">(</span><span class="n">chosen_options</span><span class="p">,</span> <span class="n">filenames</span><span class="p">)</span> <span class="o">=</span> <span class="n">getopt</span><span class="o">.</span><span class="n">getopt</span><span class="p">(</span><span class="n">commandline</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span>
|
||||
<span class="n">optstringsshort</span><span class="p">,</span>
|
||||
<span class="n">optstringslong</span><span class="p">)</span>
|
||||
|
||||
<span class="c"># Turns what getopt returns into something more human-readable</span>
|
||||
<span class="c1"># Turns what getopt returns into something more human-readable</span>
|
||||
<span class="n">streamline_options</span> <span class="o">=</span> <span class="n">make_option_streamliner</span><span class="p">(</span><span class="n">options</span><span class="p">)</span>
|
||||
|
||||
<span class="c"># Remove any options that are superseded by others.</span>
|
||||
<span class="c1"># Remove any options that are superseded by others.</span>
|
||||
<span class="p">(</span><span class="n">ret</span><span class="p">,</span> <span class="n">excluded</span><span class="p">)</span> <span class="o">=</span> <span class="n">remove_conflicted_options</span><span class="p">(</span>
|
||||
<span class="n">options</span><span class="p">,</span> <span class="nb">reduce</span><span class="p">(</span><span class="n">streamline_options</span><span class="p">,</span> <span class="n">chosen_options</span><span class="p">,</span> <span class="p">{}))</span>
|
||||
<span class="n">options</span><span class="p">,</span> <span class="n">reduce</span><span class="p">(</span><span class="n">streamline_options</span><span class="p">,</span> <span class="n">chosen_options</span><span class="p">,</span> <span class="p">{}))</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">(</span><span class="n">ret</span><span class="p">,</span> <span class="n">filenames</span><span class="p">,</span> <span class="n">excluded</span><span class="p">)</span></div>
|
||||
</pre></div>
|
||||
|
|
@ -139,26 +139,23 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div id="searchbox" style="display: none">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -167,13 +164,13 @@
|
|||
<li class="right" >
|
||||
<a href="../../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li><a href="../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>git_lint.reporters — Git Lint 0.0.4 documentation</title>
|
||||
<title>git_lint.reporters — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../../static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -26,8 +26,8 @@
|
|||
<link rel="top" title="Git Lint 0.0.4 documentation" href="../../index.html" />
|
||||
<link rel="up" title="Module code" href="../index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -36,29 +36,29 @@
|
|||
<li class="right" >
|
||||
<a href="../../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li><a href="../index.html" accesskey="U">Module code</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for git_lint.reporters</h1><div class="highlight"><pre>
|
||||
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">print_function</span>
|
||||
<span class="kn">from</span> <span class="nn">.git_lint</span> <span class="kn">import</span> <span class="n">load_config</span><span class="p">,</span> <span class="n">run_linters</span><span class="p">,</span> <span class="n">git_base</span>
|
||||
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
|
||||
<span class="kn">from</span> <span class="nn">.git_lint</span> <span class="k">import</span> <span class="n">load_config</span><span class="p">,</span> <span class="n">run_linters</span><span class="p">,</span> <span class="n">git_base</span>
|
||||
<span class="kn">import</span> <span class="nn">operator</span>
|
||||
<span class="kn">import</span> <span class="nn">gettext</span>
|
||||
<span class="n">_</span> <span class="o">=</span> <span class="n">gettext</span><span class="o">.</span><span class="n">gettext</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="base_file_cleaner"><a class="viewcode-back" href="../../git_lint.html#git_lint.reporters.base_file_cleaner">[docs]</a><span class="k">def</span> <span class="nf">base_file_cleaner</span><span class="p">(</span><span class="n">files</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="nb">file</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">git_base</span> <span class="o">+</span> <span class="s">'/'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="nb">file</span> <span class="ow">in</span> <span class="n">files</span><span class="p">]</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">file</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">git_base</span> <span class="o">+</span> <span class="s1">'/'</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">files</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<span class="c"># ICK. Mutation, references, and hidden assignment.</span></div>
|
||||
<span class="c1"># ICK. Mutation, references, and hidden assignment.</span>
|
||||
<div class="viewcode-block" id="group_by"><a class="viewcode-back" href="../../git_lint.html#git_lint.reporters.group_by">[docs]</a><span class="k">def</span> <span class="nf">group_by</span><span class="p">(</span><span class="n">iterable</span><span class="p">,</span> <span class="n">field_id</span><span class="p">):</span>
|
||||
<span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
<span class="n">keys</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
|
|
@ -69,89 +69,88 @@
|
|||
<span class="k">continue</span>
|
||||
<span class="n">keys</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="n">obj</span><span class="p">]</span>
|
||||
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">key</span><span class="p">,</span> <span class="n">keys</span><span class="p">[</span><span class="n">key</span><span class="p">]))</span>
|
||||
<span class="k">return</span> <span class="n">results</span>
|
||||
<span class="k">return</span> <span class="n">results</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="print_report"><a class="viewcode-back" href="../../git_lint.html#git_lint.reporters.print_report">[docs]</a><span class="k">def</span> <span class="nf">print_report</span><span class="p">(</span><span class="n">results</span><span class="p">,</span> <span class="n">unlintable_filenames</span><span class="p">,</span> <span class="n">cant_lint_filenames</span><span class="p">,</span>
|
||||
<span class="n">broken_linter_names</span><span class="p">,</span> <span class="n">unfindable_filenames</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="p">{</span><span class="s">'bylinter'</span><span class="p">:</span> <span class="bp">True</span><span class="p">}):</span>
|
||||
<span class="n">broken_linter_names</span><span class="p">,</span> <span class="n">unfindable_filenames</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="p">{</span><span class="s1">'bylinter'</span><span class="p">:</span> <span class="kc">True</span><span class="p">}):</span>
|
||||
<span class="n">sort_position</span> <span class="o">=</span> <span class="mi">1</span>
|
||||
<span class="n">grouping</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">'Linter: {}'</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="s">'byfile'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="n">grouping</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s1">'Linter: </span><span class="si">{}</span><span class="s1">'</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="s1">'byfile'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="n">sort_position</span> <span class="o">=</span> <span class="mi">0</span>
|
||||
<span class="n">grouping</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">'Filename: {}'</span><span class="p">)</span>
|
||||
<span class="n">grouping</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s1">'Filename: </span><span class="si">{}</span><span class="s1">'</span><span class="p">)</span>
|
||||
<span class="n">grouped_results</span> <span class="o">=</span> <span class="n">group_by</span><span class="p">(</span><span class="n">results</span><span class="p">,</span> <span class="n">sort_position</span><span class="p">)</span>
|
||||
|
||||
<span class="k">for</span> <span class="n">group</span> <span class="ow">in</span> <span class="n">grouped_results</span><span class="p">:</span>
|
||||
<span class="n">messages</span> <span class="o">=</span> <span class="nb">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> <span class="p">[</span><span class="n">item</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">group</span><span class="p">[</span><span class="mi">1</span><span class="p">]],</span> <span class="p">[])</span>
|
||||
<span class="n">messages</span> <span class="o">=</span> <span class="n">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> <span class="p">[</span><span class="n">item</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">group</span><span class="p">[</span><span class="mi">1</span><span class="p">]],</span> <span class="p">[])</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">messages</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
||||
<span class="k">continue</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="n">grouping</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">group</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="n">grouping</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">group</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
|
||||
<span class="k">for</span> <span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">lintername</span><span class="p">,</span> <span class="n">returncode</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span> <span class="ow">in</span> <span class="n">group</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
|
||||
<span class="k">if</span> <span class="n">text</span><span class="p">:</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">base_file_cleaner</span><span class="p">(</span><span class="n">text</span><span class="p">)))</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">''</span><span class="p">)</span>
|
||||
<span class="k">print</span> <span class="p">(</span><span class="s">''</span><span class="p">)</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">base_file_cleaner</span><span class="p">(</span><span class="n">text</span><span class="p">)))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">''</span><span class="p">)</span>
|
||||
<span class="nb">print</span> <span class="p">(</span><span class="s1">''</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">broken_linter_names</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">cant_lint_filenames</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="s">'verbose'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">)):</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'These linters could not be run:'</span><span class="p">),</span> <span class="s">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">broken_linter_names</span><span class="p">))</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">broken_linter_names</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">cant_lint_filenames</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="s1">'verbose'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">)):</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'Linters not found:'</span><span class="p">),</span> <span class="s1">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">broken_linter_names</span><span class="p">))</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cant_lint_filenames</span><span class="p">):</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'Files not linted:'</span><span class="p">))</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s">' {}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">cant_lint_filenames</span><span class="p">]))</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">''</span><span class="p">)</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">' '</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s1">'Files not linted:'</span><span class="p">))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s1">' </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">cant_lint_filenames</span><span class="p">]))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">''</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">unlintable_filenames</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="s">'verbose'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">):</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'No recognizeable linters for:'</span><span class="p">))</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s">' {}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">unlintable_filenames</span><span class="p">]))</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">''</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">unlintable_filenames</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="s1">'verbose'</span> <span class="ow">in</span> <span class="n">options</span><span class="p">):</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'No recognizeable linters for:'</span><span class="p">))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s1">' </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">unlintable_filenames</span><span class="p">]))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">''</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">unfindable_filenames</span><span class="p">):</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'Files not be found:'</span><span class="p">))</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s">' {}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">unfindable_filenames</span><span class="p">]))</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">''</span><span class="p">)</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'Files not found:'</span><span class="p">))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s1">' </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">unfindable_filenames</span><span class="p">]))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">''</span><span class="p">)</span></div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="viewcode-block" id="print_help"><a class="viewcode-back" href="../../git_lint.html#git_lint.reporters.print_help">[docs]</a><span class="k">def</span> <span class="nf">print_help</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'Usage: {} [options] [filenames]'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'Usage: </span><span class="si">{}</span><span class="s1"> [options] [filenames]'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
|
||||
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">' -{:<1} --{:<12} {}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">item</span><span class="p">[</span><span class="mi">3</span><span class="p">]))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">' -</span><span class="si">{:<1}</span><span class="s1"> --</span><span class="si">{:<12}</span><span class="s1"> </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">item</span><span class="p">[</span><span class="mi">3</span><span class="p">]))</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="print_version"><a class="viewcode-back" href="../../git_lint.html#git_lint.reporters.print_version">[docs]</a><span class="k">def</span> <span class="nf">print_version</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'{} {} Copyright (c) 2009, 2016 Kennth M. "Elf" Sternberg'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">version</span><span class="p">))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'</span><span class="si">{}</span><span class="s1"> </span><span class="si">{}</span><span class="s1"> Copyright (c) 2009, 2016 Kennth M. "Elf" Sternberg'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">version</span><span class="p">))</span></div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="viewcode-block" id="print_linters"><a class="viewcode-back" href="../../git_lint.html#git_lint.reporters.print_linters">[docs]</a><span class="k">def</span> <span class="nf">print_linters</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">broken_linter_names</span><span class="p">):</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">'Currently supported linters:'</span><span class="p">))</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'Currently supported linters:'</span><span class="p">))</span>
|
||||
<span class="k">for</span> <span class="n">linter</span> <span class="ow">in</span> <span class="n">config</span><span class="p">:</span>
|
||||
<span class="k">print</span><span class="p">(</span><span class="s">'{:<14} {}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">linter</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">{:<14}</span><span class="s1"> </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">linter</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="p">((</span><span class="n">linter</span><span class="o">.</span><span class="n">name</span> <span class="ow">in</span> <span class="n">broken_linter_names</span> <span class="ow">and</span>
|
||||
<span class="n">_</span><span class="p">(</span><span class="s">'(WARNING: executable not found)'</span><span class="p">)</span> <span class="ow">or</span>
|
||||
<span class="n">linter</span><span class="o">.</span><span class="n">linter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'comment'</span><span class="p">,</span> <span class="s">''</span><span class="p">)))))</span>
|
||||
</pre></div></div>
|
||||
<span class="n">_</span><span class="p">(</span><span class="s1">'(WARNING: executable not found)'</span><span class="p">)</span> <span class="ow">or</span>
|
||||
<span class="n">linter</span><span class="o">.</span><span class="n">linter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'comment'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)))))</span></div>
|
||||
|
||||
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div id="searchbox" style="display: none">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -160,13 +159,13 @@
|
|||
<li class="right" >
|
||||
<a href="../../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li><a href="../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Overview: module code — Git Lint 0.0.4 documentation</title>
|
||||
<title>Overview: module code — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -25,8 +25,8 @@
|
|||
<script type="text/javascript" src="../static/doctools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.4 documentation" href="../index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -35,14 +35,14 @@
|
|||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>All modules for which code is available</h1>
|
||||
<ul><li><a href="git_lint/git_lint.html">git_lint.git_lint</a></li>
|
||||
|
|
@ -53,26 +53,23 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div id="searchbox" style="display: none">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -81,12 +78,12 @@
|
|||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Python Module Index — Git Lint 0.0.4 documentation</title>
|
||||
<title>Python Module Index — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -28,8 +28,8 @@
|
|||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -38,14 +38,14 @@
|
|||
<li class="right" >
|
||||
<a href="#" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1>Python Module Index</h1>
|
||||
|
|
@ -55,34 +55,34 @@
|
|||
</div>
|
||||
|
||||
<table class="indextable modindextable" cellspacing="0" cellpadding="2">
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-g"><td></td><td>
|
||||
<strong>g</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td><img src="static/minus.png" class="toggler"
|
||||
id="toggle-1" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<a href="git_lint.html#module-git_lint"><tt class="xref">git_lint</tt></a></td><td>
|
||||
<a href="git_lint.html#module-git_lint"><code class="xref">git_lint</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="git_lint.html#module-git_lint.git_lint"><tt class="xref">git_lint.git_lint</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="git_lint.html#module-git_lint.git_lint"><code class="xref">git_lint.git_lint</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="git_lint.html#module-git_lint.option_handler"><tt class="xref">git_lint.option_handler</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="git_lint.html#module-git_lint.option_handler"><code class="xref">git_lint.option_handler</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="git_lint.html#module-git_lint.options"><tt class="xref">git_lint.options</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="git_lint.html#module-git_lint.options"><code class="xref">git_lint.options</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="git_lint.html#module-git_lint.reporters"><tt class="xref">git_lint.reporters</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="git_lint.html#module-git_lint.reporters"><code class="xref">git_lint.reporters</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -90,26 +90,23 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div id="searchbox" style="display: none">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -118,12 +115,12 @@
|
|||
<li class="right" >
|
||||
<a href="#" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
66
readme.html
66
readme.html
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Git Lint: README — Git Lint 0.0.4 documentation</title>
|
||||
<title>Git Lint: README — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -27,8 +27,8 @@
|
|||
<link rel="next" title="Installation" href="installation.html" />
|
||||
<link rel="prev" title="Welcome to Git Lint’s documentation!" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -43,14 +43,14 @@
|
|||
<li class="right" >
|
||||
<a href="index.html" title="Welcome to Git Lint’s documentation!"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="git-lint-readme">
|
||||
<h1>Git Lint: README<a class="headerlink" href="#git-lint-readme" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -81,14 +81,27 @@ pre-commit hook), that can be run at any time for any reason.</p>
|
|||
<dd><cite>git lint -s</cite></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="documentation">
|
||||
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Complete documentation for the project is available in the docs directory, or at <a class="reference external" href="https://elfsternberg.github.io/git-linter/index.html">Git
|
||||
Linter Docs</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="install">
|
||||
<h2>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This <em>ought</em> to work:</p>
|
||||
<blockquote>
|
||||
<div><cite>pip install git-linter</cite></div></blockquote>
|
||||
<p>You will need to copy the .git-lint configuration file to either your
|
||||
home directory or the repo`s base directory. Edit the configuration
|
||||
file as needed. You will also need any linters that you plan on
|
||||
running.</p>
|
||||
<p>As git-linter is still mostly alpha code, it might be better to install
|
||||
from source:</p>
|
||||
<blockquote>
|
||||
<div>``
|
||||
git clone <a class="reference external" href="https://github.com/elfsternberg/git-linter">https://github.com/elfsternberg/git-linter</a>
|
||||
python setup.py install
|
||||
``</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="features">
|
||||
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
|
||||
|
|
@ -109,10 +122,9 @@ same, so as not to confuse your build system or IDE.</li>
|
|||
</div>
|
||||
<div class="section" id="acknowledgements">
|
||||
<h2>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permalink to this headline">¶</a></h2>
|
||||
<p><cite>Git lint</cite> started life as a simple pre-commit hook. Most of the
|
||||
changes since were inspired by Steve Pulec’s <em>`Why You Need a Git
|
||||
Pre-Commit Hook and Why Most Are Wrong`_ ,</em> as well as just my own needs as
|
||||
a software developer.</p>
|
||||
<p><cite>Git lint</cite> started life as a simple pre-commit hook. Most of the changes since were
|
||||
inspired by Steve Pulec’s <a class="reference external" href="https://dzone.com/articles/why-your-need-git-pre-commit">Why You Need a Git Pre-Commit Hook and Why Most Are Wrong</a>, as well as just my own needs
|
||||
as a software developer.</p>
|
||||
</div>
|
||||
<div class="section" id="disclaimer">
|
||||
<h2>Disclaimer<a class="headerlink" href="#disclaimer" title="Permalink to this headline">¶</a></h2>
|
||||
|
|
@ -135,12 +147,13 @@ otherwise connected with the program is assumed by the user.</p>
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Git Lint: README</a><ul>
|
||||
<li><a class="reference internal" href="#usage">Usage</a></li>
|
||||
<li><a class="reference internal" href="#documentation">Documentation</a></li>
|
||||
<li><a class="reference internal" href="#install">Install</a></li>
|
||||
<li><a class="reference internal" href="#features">Features</a></li>
|
||||
<li><a class="reference internal" href="#acknowledgements">Acknowledgements</a></li>
|
||||
|
|
@ -155,29 +168,28 @@ otherwise connected with the program is assumed by the user.</p>
|
|||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="installation.html"
|
||||
title="next chapter">Installation</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/readme.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/readme.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -192,12 +204,12 @@ otherwise connected with the program is assumed by the user.</p>
|
|||
<li class="right" >
|
||||
<a href="index.html" title="Welcome to Git Lint’s documentation!"
|
||||
>previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
24
search.html
24
search.html
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — Git Lint 0.0.4 documentation</title>
|
||||
<title>Search — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -33,8 +33,8 @@
|
|||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -43,14 +43,14 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1 id="search-documentation">Search</h1>
|
||||
<div id="fallback" class="admonition warning">
|
||||
|
|
@ -79,13 +79,13 @@
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -94,12 +94,12 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -12,7 +12,7 @@ To install Git Lint, run this command in your terminal:
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install git_linter
|
||||
$ pip install git-linter
|
||||
|
||||
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
|
||||
you through the process.
|
||||
|
|
@ -30,13 +30,13 @@ You can either clone the public repository:
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone git://github.com/elfsternberg/git_linter
|
||||
$ git clone git://github.com/elfsternberg/git-linter
|
||||
|
||||
Or download the `tarball`_:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ curl -OL https://github.com/elfsternberg/git_linter/tarball/master
|
||||
$ curl -OL https://github.com/elfsternberg/git-linter/tarball/master
|
||||
|
||||
Once you have a copy of the source, you can install it with:
|
||||
|
||||
|
|
@ -44,9 +44,8 @@ Once you have a copy of the source, you can install it with:
|
|||
|
||||
$ python setup.py install
|
||||
|
||||
.. _Github repo: https://github.com/elfsternberg/git_linter
|
||||
.. _tarball: https://github.com/elfsternberg/git_linter/tarball/master
|
||||
.. _Github repo: https://github.com/elfsternberg/git-linter
|
||||
.. _tarball: https://github.com/elfsternberg/git-linter/tarball/master
|
||||
|
||||
Once installed, please copy the '.git-lint' example file. You may install this either in
|
||||
your home directory as ``.git-lint`` or in your project's git directory as
|
||||
``.git/lint/git-lint``
|
||||
your home or repository directory as ``.git-lint``.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -52,6 +52,8 @@ div.sphinxsidebar {
|
|||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
word-wrap: break-word;
|
||||
overflow-wrap : break-word;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
|
|
@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] {
|
|||
width: 170px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
width: 30px;
|
||||
}
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
|
|
@ -187,6 +185,13 @@ div.genindex-jumpbox {
|
|||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
-moz-hyphens: auto;
|
||||
-ms-hyphens: auto;
|
||||
-webkit-hyphens: auto;
|
||||
hyphens: auto;
|
||||
}
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
|
@ -197,7 +202,10 @@ h3:hover > a.headerlink,
|
|||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink {
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
|
|
@ -314,6 +322,13 @@ table.docutils {
|
|||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
|
|
@ -344,6 +359,25 @@ table.citation td {
|
|||
border-bottom: none;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
|
|
@ -406,6 +440,10 @@ dl.glossary dt {
|
|||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
|
@ -471,22 +509,51 @@ table.highlighttable td {
|
|||
padding: 0 0.5em 0 0.5em;
|
||||
}
|
||||
|
||||
tt.descname {
|
||||
div.code-block-caption {
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
div.code-block-caption + div > div.highlight > pre {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
padding: 1em 1em 0;
|
||||
}
|
||||
|
||||
div.literal-block-wrapper div.highlight {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
tt.descclassname {
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
tt.xref, a tt {
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,261 @@
|
|||
/*
|
||||
* default.css_t
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- default theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: sans-serif;
|
||||
font-size: 100%;
|
||||
background-color: #11303d;
|
||||
color: #000;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.document {
|
||||
background-color: #1c4e63;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 0 0 230px;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #ffffff;
|
||||
color: #000000;
|
||||
padding: 0 20px 30px 20px;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
color: #ffffff;
|
||||
width: 100%;
|
||||
padding: 9px 0 9px 0;
|
||||
text-align: center;
|
||||
font-size: 75%;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #ffffff;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.related {
|
||||
background-color: #133f52;
|
||||
line-height: 30px;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.related a {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
color: #ffffff;
|
||||
font-size: 1.4em;
|
||||
font-weight: normal;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h4 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
color: #ffffff;
|
||||
font-size: 1.3em;
|
||||
font-weight: normal;
|
||||
margin: 5px 0 0 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.topless {
|
||||
margin: 5px 10px 10px 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
margin: 10px;
|
||||
padding: 0;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #98dbcc;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* -- hyperlink styles ------------------------------------------------------ */
|
||||
|
||||
a {
|
||||
color: #355f7c;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:visited {
|
||||
color: #355f7c;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
background-color: #f2f2f2;
|
||||
font-weight: normal;
|
||||
color: #20435c;
|
||||
border-bottom: 1px solid #ccc;
|
||||
margin: 20px -20px 10px -20px;
|
||||
padding: 3px 0 3px 10px;
|
||||
}
|
||||
|
||||
div.body h1 { margin-top: 0; font-size: 200%; }
|
||||
div.body h2 { font-size: 160%; }
|
||||
div.body h3 { font-size: 140%; }
|
||||
div.body h4 { font-size: 120%; }
|
||||
div.body h5 { font-size: 110%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: #c60f0f;
|
||||
font-size: 0.8em;
|
||||
padding: 0 4px 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
background-color: #c60f0f;
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
text-align: justify;
|
||||
line-height: 130%;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title + p {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.admonition p {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.admonition pre {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.admonition ul, div.admonition ol {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #eee;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #ffc;
|
||||
border: 1px solid #ff6;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
div.warning {
|
||||
background-color: #ffe4e4;
|
||||
border: 1px solid #f66;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
p.admonition-title:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 5px;
|
||||
background-color: #eeffcc;
|
||||
color: #333333;
|
||||
line-height: 120%;
|
||||
border: 1px solid #ac9;
|
||||
border-left: none;
|
||||
border-right: none;
|
||||
}
|
||||
|
||||
code {
|
||||
background-color: #ecf0f3;
|
||||
padding: 0 1px 0 1px;
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
th {
|
||||
background-color: #ede;
|
||||
}
|
||||
|
||||
.warning code {
|
||||
background: #efc2c2;
|
||||
}
|
||||
|
||||
.note code {
|
||||
background: #d6d6d6;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
background-color: #f4debf;
|
||||
border-top: 1px solid #ac9;
|
||||
border-bottom: 1px solid #ac9;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
color: #efefef;
|
||||
background-color: #1c4e63;
|
||||
}
|
||||
|
|
@ -1,256 +1 @@
|
|||
/*
|
||||
* default.css_t
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- default theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: sans-serif;
|
||||
font-size: 100%;
|
||||
background-color: #11303d;
|
||||
color: #000;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.document {
|
||||
background-color: #1c4e63;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 0 0 230px;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #ffffff;
|
||||
color: #000000;
|
||||
padding: 0 20px 30px 20px;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
color: #ffffff;
|
||||
width: 100%;
|
||||
padding: 9px 0 9px 0;
|
||||
text-align: center;
|
||||
font-size: 75%;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #ffffff;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.related {
|
||||
background-color: #133f52;
|
||||
line-height: 30px;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.related a {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
color: #ffffff;
|
||||
font-size: 1.4em;
|
||||
font-weight: normal;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h4 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
color: #ffffff;
|
||||
font-size: 1.3em;
|
||||
font-weight: normal;
|
||||
margin: 5px 0 0 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.topless {
|
||||
margin: 5px 10px 10px 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
margin: 10px;
|
||||
padding: 0;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #98dbcc;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* -- hyperlink styles ------------------------------------------------------ */
|
||||
|
||||
a {
|
||||
color: #355f7c;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:visited {
|
||||
color: #355f7c;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
background-color: #f2f2f2;
|
||||
font-weight: normal;
|
||||
color: #20435c;
|
||||
border-bottom: 1px solid #ccc;
|
||||
margin: 20px -20px 10px -20px;
|
||||
padding: 3px 0 3px 10px;
|
||||
}
|
||||
|
||||
div.body h1 { margin-top: 0; font-size: 200%; }
|
||||
div.body h2 { font-size: 160%; }
|
||||
div.body h3 { font-size: 140%; }
|
||||
div.body h4 { font-size: 120%; }
|
||||
div.body h5 { font-size: 110%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: #c60f0f;
|
||||
font-size: 0.8em;
|
||||
padding: 0 4px 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
background-color: #c60f0f;
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
text-align: justify;
|
||||
line-height: 130%;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title + p {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.admonition p {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.admonition pre {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.admonition ul, div.admonition ol {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #eee;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #ffc;
|
||||
border: 1px solid #ff6;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
div.warning {
|
||||
background-color: #ffe4e4;
|
||||
border: 1px solid #f66;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
p.admonition-title:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 5px;
|
||||
background-color: #eeffcc;
|
||||
color: #333333;
|
||||
line-height: 120%;
|
||||
border: 1px solid #ac9;
|
||||
border-left: none;
|
||||
border-right: none;
|
||||
}
|
||||
|
||||
tt {
|
||||
background-color: #ecf0f3;
|
||||
padding: 0 1px 0 1px;
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
th {
|
||||
background-color: #ede;
|
||||
}
|
||||
|
||||
.warning tt {
|
||||
background: #efc2c2;
|
||||
}
|
||||
|
||||
.note tt {
|
||||
background: #d6d6d6;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
background-color: #f4debf;
|
||||
border-top: 1px solid #ac9;
|
||||
border-bottom: 1px solid #ac9;
|
||||
}
|
||||
@import url("classic.css");
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -91,6 +91,30 @@ jQuery.fn.highlightText = function(text, className) {
|
|||
});
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
|
|
@ -100,6 +124,7 @@ var Documentation = {
|
|||
this.fixFirefoxAnchorBug();
|
||||
this.highlightSearchWords();
|
||||
this.initIndexTable();
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
|
|
@ -152,9 +177,10 @@ var Documentation = {
|
|||
|
||||
/**
|
||||
* workaround a firefox stupidity
|
||||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash && $.browser.mozilla)
|
||||
if (document.location.hash)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
|
|
@ -227,6 +253,29 @@ var Documentation = {
|
|||
});
|
||||
var url = parts.join('/');
|
||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||
},
|
||||
|
||||
initOnKeyListeners: function() {
|
||||
$(document).keyup(function(event) {
|
||||
var activeElementType = document.activeElement.tagName;
|
||||
// don't navigate when in search box or textarea
|
||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
|
||||
switch (event.keyCode) {
|
||||
case 37: // left
|
||||
var prevHref = $('link[rel="prev"]').prop('href');
|
||||
if (prevHref) {
|
||||
window.location.href = prevHref;
|
||||
return false;
|
||||
}
|
||||
case 39: // right
|
||||
var nextHref = $('link[rel="next"]').prop('href');
|
||||
if (nextHref) {
|
||||
window.location.href = nextHref;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
|
|
@ -235,4 +284,4 @@ _ = Documentation.gettext;
|
|||
|
||||
$(document).ready(function() {
|
||||
Documentation.init();
|
||||
});
|
||||
});
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 368 B After Width: | Height: | Size: 347 B |
BIN
static/down.png
BIN
static/down.png
Binary file not shown.
|
Before Width: | Height: | Size: 363 B After Width: | Height: | Size: 347 B |
BIN
static/file.png
BIN
static/file.png
Binary file not shown.
|
Before Width: | Height: | Size: 392 B After Width: | Height: | Size: 358 B |
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
BIN
static/minus.png
BIN
static/minus.png
Binary file not shown.
|
Before Width: | Height: | Size: 199 B After Width: | Height: | Size: 173 B |
BIN
static/plus.png
BIN
static/plus.png
Binary file not shown.
|
Before Width: | Height: | Size: 199 B After Width: | Height: | Size: 173 B |
|
|
@ -4,8 +4,10 @@
|
|||
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
||||
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
|
||||
.highlight .o { color: #666666 } /* Operator */
|
||||
.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #007020 } /* Comment.Preproc */
|
||||
.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
|
||||
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
||||
|
|
@ -40,6 +42,7 @@
|
|||
.highlight .nv { color: #bb60d5 } /* Name.Variable */
|
||||
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
|
||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.highlight .mb { color: #208050 } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #208050 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
|
||||
|
|
|
|||
|
|
@ -2,14 +2,15 @@
|
|||
* searchtools.js_t
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilties for the full-text search.
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
|
|
@ -373,8 +374,7 @@ var Search = {
|
|||
}
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
|
||||
.concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
|
||||
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) {
|
||||
|
|
@ -439,7 +439,7 @@ var Search = {
|
|||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
if (data !== '') {
|
||||
if (data !== '' && data !== undefined) {
|
||||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
|
|
@ -538,23 +538,47 @@ var Search = {
|
|||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
performTermsSearch : function(searchterms, excluded, terms, score) {
|
||||
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
|
||||
var filenames = this._index.filenames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i, j, file, files;
|
||||
var i, j, file;
|
||||
var fileMap = {};
|
||||
var scoreMap = {};
|
||||
var results = [];
|
||||
|
||||
// perform the search on the required terms
|
||||
for (i = 0; i < searchterms.length; i++) {
|
||||
var word = searchterms[i];
|
||||
var files = [];
|
||||
var _o = [
|
||||
{files: terms[word], score: Scorer.term},
|
||||
{files: titleterms[word], score: Scorer.title}
|
||||
];
|
||||
|
||||
// no match but word was a required one
|
||||
if ((files = terms[word]) === undefined)
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
break;
|
||||
if (files.length === undefined) {
|
||||
files = [files];
|
||||
}
|
||||
// found search word in contents
|
||||
$u.each(_o, function(o) {
|
||||
var _files = o.files;
|
||||
if (_files === undefined)
|
||||
return
|
||||
|
||||
if (_files.length === undefined)
|
||||
_files = [_files];
|
||||
files = files.concat(_files);
|
||||
|
||||
// set score for the word in each file to Scorer.term
|
||||
for (j = 0; j < _files.length; j++) {
|
||||
file = _files[j];
|
||||
if (!(file in scoreMap))
|
||||
scoreMap[file] = {}
|
||||
scoreMap[file][word] = o.score;
|
||||
}
|
||||
});
|
||||
|
||||
// create the mapping
|
||||
for (j = 0; j < files.length; j++) {
|
||||
file = files[j];
|
||||
|
|
@ -576,7 +600,9 @@ var Search = {
|
|||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
if (terms[excluded[i]] == file ||
|
||||
$u.contains(terms[excluded[i]] || [], file)) {
|
||||
titleterms[excluded[i]] == file ||
|
||||
$u.contains(terms[excluded[i]] || [], file) ||
|
||||
$u.contains(titleterms[excluded[i]] || [], file)) {
|
||||
valid = false;
|
||||
break;
|
||||
}
|
||||
|
|
@ -584,6 +610,9 @@ var Search = {
|
|||
|
||||
// if we have still a valid result we can add it to the result list
|
||||
if (valid) {
|
||||
// select one (max) score for the file.
|
||||
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
|
||||
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
|
||||
results.push([filenames[file], titles[file], '', null, score]);
|
||||
}
|
||||
}
|
||||
|
|
@ -594,7 +623,7 @@ var Search = {
|
|||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words, hlwords is the list of normal, unstemmed
|
||||
* words. the first one is used to find the occurance, the
|
||||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(text, keywords, hlwords) {
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@
|
|||
* Once the browser is closed the cookie is deleted and the position
|
||||
* reset to the default (expanded).
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -0,0 +1,999 @@
|
|||
// Underscore.js 1.3.1
|
||||
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||
// Underscore is freely distributable under the MIT license.
|
||||
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||
// For all details and documentation:
|
||||
// http://documentcloud.github.com/underscore
|
||||
|
||||
(function() {
|
||||
|
||||
// Baseline setup
|
||||
// --------------
|
||||
|
||||
// Establish the root object, `window` in the browser, or `global` on the server.
|
||||
var root = this;
|
||||
|
||||
// Save the previous value of the `_` variable.
|
||||
var previousUnderscore = root._;
|
||||
|
||||
// Establish the object that gets returned to break out of a loop iteration.
|
||||
var breaker = {};
|
||||
|
||||
// Save bytes in the minified (but not gzipped) version:
|
||||
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
|
||||
|
||||
// Create quick reference variables for speed access to core prototypes.
|
||||
var slice = ArrayProto.slice,
|
||||
unshift = ArrayProto.unshift,
|
||||
toString = ObjProto.toString,
|
||||
hasOwnProperty = ObjProto.hasOwnProperty;
|
||||
|
||||
// All **ECMAScript 5** native function implementations that we hope to use
|
||||
// are declared here.
|
||||
var
|
||||
nativeForEach = ArrayProto.forEach,
|
||||
nativeMap = ArrayProto.map,
|
||||
nativeReduce = ArrayProto.reduce,
|
||||
nativeReduceRight = ArrayProto.reduceRight,
|
||||
nativeFilter = ArrayProto.filter,
|
||||
nativeEvery = ArrayProto.every,
|
||||
nativeSome = ArrayProto.some,
|
||||
nativeIndexOf = ArrayProto.indexOf,
|
||||
nativeLastIndexOf = ArrayProto.lastIndexOf,
|
||||
nativeIsArray = Array.isArray,
|
||||
nativeKeys = Object.keys,
|
||||
nativeBind = FuncProto.bind;
|
||||
|
||||
// Create a safe reference to the Underscore object for use below.
|
||||
var _ = function(obj) { return new wrapper(obj); };
|
||||
|
||||
// Export the Underscore object for **Node.js**, with
|
||||
// backwards-compatibility for the old `require()` API. If we're in
|
||||
// the browser, add `_` as a global object via a string identifier,
|
||||
// for Closure Compiler "advanced" mode.
|
||||
if (typeof exports !== 'undefined') {
|
||||
if (typeof module !== 'undefined' && module.exports) {
|
||||
exports = module.exports = _;
|
||||
}
|
||||
exports._ = _;
|
||||
} else {
|
||||
root['_'] = _;
|
||||
}
|
||||
|
||||
// Current version.
|
||||
_.VERSION = '1.3.1';
|
||||
|
||||
// Collection Functions
|
||||
// --------------------
|
||||
|
||||
// The cornerstone, an `each` implementation, aka `forEach`.
|
||||
// Handles objects with the built-in `forEach`, arrays, and raw objects.
|
||||
// Delegates to **ECMAScript 5**'s native `forEach` if available.
|
||||
var each = _.each = _.forEach = function(obj, iterator, context) {
|
||||
if (obj == null) return;
|
||||
if (nativeForEach && obj.forEach === nativeForEach) {
|
||||
obj.forEach(iterator, context);
|
||||
} else if (obj.length === +obj.length) {
|
||||
for (var i = 0, l = obj.length; i < l; i++) {
|
||||
if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
|
||||
}
|
||||
} else {
|
||||
for (var key in obj) {
|
||||
if (_.has(obj, key)) {
|
||||
if (iterator.call(context, obj[key], key, obj) === breaker) return;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// Return the results of applying the iterator to each element.
|
||||
// Delegates to **ECMAScript 5**'s native `map` if available.
|
||||
_.map = _.collect = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
results[results.length] = iterator.call(context, value, index, list);
|
||||
});
|
||||
if (obj.length === +obj.length) results.length = obj.length;
|
||||
return results;
|
||||
};
|
||||
|
||||
// **Reduce** builds up a single result from a list of values, aka `inject`,
|
||||
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
|
||||
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduce && obj.reduce === nativeReduce) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
|
||||
}
|
||||
each(obj, function(value, index, list) {
|
||||
if (!initial) {
|
||||
memo = value;
|
||||
initial = true;
|
||||
} else {
|
||||
memo = iterator.call(context, memo, value, index, list);
|
||||
}
|
||||
});
|
||||
if (!initial) throw new TypeError('Reduce of empty array with no initial value');
|
||||
return memo;
|
||||
};
|
||||
|
||||
// The right-associative version of reduce, also known as `foldr`.
|
||||
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
|
||||
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
|
||||
}
|
||||
var reversed = _.toArray(obj).reverse();
|
||||
if (context && !initial) iterator = _.bind(iterator, context);
|
||||
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
|
||||
};
|
||||
|
||||
// Return the first value which passes a truth test. Aliased as `detect`.
|
||||
_.find = _.detect = function(obj, iterator, context) {
|
||||
var result;
|
||||
any(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) {
|
||||
result = value;
|
||||
return true;
|
||||
}
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Return all the elements that pass a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `filter` if available.
|
||||
// Aliased as `select`.
|
||||
_.filter = _.select = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Return all the elements for which a truth test fails.
|
||||
_.reject = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
each(obj, function(value, index, list) {
|
||||
if (!iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Determine whether all of the elements match a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `every` if available.
|
||||
// Aliased as `all`.
|
||||
_.every = _.all = function(obj, iterator, context) {
|
||||
var result = true;
|
||||
if (obj == null) return result;
|
||||
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Determine if at least one element in the object matches a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `some` if available.
|
||||
// Aliased as `any`.
|
||||
var any = _.some = _.any = function(obj, iterator, context) {
|
||||
iterator || (iterator = _.identity);
|
||||
var result = false;
|
||||
if (obj == null) return result;
|
||||
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (result || (result = iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return !!result;
|
||||
};
|
||||
|
||||
// Determine if a given value is included in the array or object using `===`.
|
||||
// Aliased as `contains`.
|
||||
_.include = _.contains = function(obj, target) {
|
||||
var found = false;
|
||||
if (obj == null) return found;
|
||||
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
|
||||
found = any(obj, function(value) {
|
||||
return value === target;
|
||||
});
|
||||
return found;
|
||||
};
|
||||
|
||||
// Invoke a method (with arguments) on every item in a collection.
|
||||
_.invoke = function(obj, method) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return _.map(obj, function(value) {
|
||||
return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
|
||||
});
|
||||
};
|
||||
|
||||
// Convenience version of a common use case of `map`: fetching a property.
|
||||
_.pluck = function(obj, key) {
|
||||
return _.map(obj, function(value){ return value[key]; });
|
||||
};
|
||||
|
||||
// Return the maximum element or (element-based computation).
|
||||
_.max = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return -Infinity;
|
||||
var result = {computed : -Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed >= result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Return the minimum element (or element-based computation).
|
||||
_.min = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return Infinity;
|
||||
var result = {computed : Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed < result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Shuffle an array.
|
||||
_.shuffle = function(obj) {
|
||||
var shuffled = [], rand;
|
||||
each(obj, function(value, index, list) {
|
||||
if (index == 0) {
|
||||
shuffled[0] = value;
|
||||
} else {
|
||||
rand = Math.floor(Math.random() * (index + 1));
|
||||
shuffled[index] = shuffled[rand];
|
||||
shuffled[rand] = value;
|
||||
}
|
||||
});
|
||||
return shuffled;
|
||||
};
|
||||
|
||||
// Sort the object's values by a criterion produced by an iterator.
|
||||
_.sortBy = function(obj, iterator, context) {
|
||||
return _.pluck(_.map(obj, function(value, index, list) {
|
||||
return {
|
||||
value : value,
|
||||
criteria : iterator.call(context, value, index, list)
|
||||
};
|
||||
}).sort(function(left, right) {
|
||||
var a = left.criteria, b = right.criteria;
|
||||
return a < b ? -1 : a > b ? 1 : 0;
|
||||
}), 'value');
|
||||
};
|
||||
|
||||
// Groups the object's values by a criterion. Pass either a string attribute
|
||||
// to group by, or a function that returns the criterion.
|
||||
_.groupBy = function(obj, val) {
|
||||
var result = {};
|
||||
var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
|
||||
each(obj, function(value, index) {
|
||||
var key = iterator(value, index);
|
||||
(result[key] || (result[key] = [])).push(value);
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Use a comparator function to figure out at what index an object should
|
||||
// be inserted so as to maintain order. Uses binary search.
|
||||
_.sortedIndex = function(array, obj, iterator) {
|
||||
iterator || (iterator = _.identity);
|
||||
var low = 0, high = array.length;
|
||||
while (low < high) {
|
||||
var mid = (low + high) >> 1;
|
||||
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
|
||||
}
|
||||
return low;
|
||||
};
|
||||
|
||||
// Safely convert anything iterable into a real, live array.
|
||||
_.toArray = function(iterable) {
|
||||
if (!iterable) return [];
|
||||
if (iterable.toArray) return iterable.toArray();
|
||||
if (_.isArray(iterable)) return slice.call(iterable);
|
||||
if (_.isArguments(iterable)) return slice.call(iterable);
|
||||
return _.values(iterable);
|
||||
};
|
||||
|
||||
// Return the number of elements in an object.
|
||||
_.size = function(obj) {
|
||||
return _.toArray(obj).length;
|
||||
};
|
||||
|
||||
// Array Functions
|
||||
// ---------------
|
||||
|
||||
// Get the first element of an array. Passing **n** will return the first N
|
||||
// values in the array. Aliased as `head`. The **guard** check allows it to work
|
||||
// with `_.map`.
|
||||
_.first = _.head = function(array, n, guard) {
|
||||
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
|
||||
};
|
||||
|
||||
// Returns everything but the last entry of the array. Especcialy useful on
|
||||
// the arguments object. Passing **n** will return all the values in
|
||||
// the array, excluding the last N. The **guard** check allows it to work with
|
||||
// `_.map`.
|
||||
_.initial = function(array, n, guard) {
|
||||
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
|
||||
};
|
||||
|
||||
// Get the last element of an array. Passing **n** will return the last N
|
||||
// values in the array. The **guard** check allows it to work with `_.map`.
|
||||
_.last = function(array, n, guard) {
|
||||
if ((n != null) && !guard) {
|
||||
return slice.call(array, Math.max(array.length - n, 0));
|
||||
} else {
|
||||
return array[array.length - 1];
|
||||
}
|
||||
};
|
||||
|
||||
// Returns everything but the first entry of the array. Aliased as `tail`.
|
||||
// Especially useful on the arguments object. Passing an **index** will return
|
||||
// the rest of the values in the array from that index onward. The **guard**
|
||||
// check allows it to work with `_.map`.
|
||||
_.rest = _.tail = function(array, index, guard) {
|
||||
return slice.call(array, (index == null) || guard ? 1 : index);
|
||||
};
|
||||
|
||||
// Trim out all falsy values from an array.
|
||||
_.compact = function(array) {
|
||||
return _.filter(array, function(value){ return !!value; });
|
||||
};
|
||||
|
||||
// Return a completely flattened version of an array.
|
||||
_.flatten = function(array, shallow) {
|
||||
return _.reduce(array, function(memo, value) {
|
||||
if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
|
||||
memo[memo.length] = value;
|
||||
return memo;
|
||||
}, []);
|
||||
};
|
||||
|
||||
// Return a version of the array that does not contain the specified value(s).
|
||||
_.without = function(array) {
|
||||
return _.difference(array, slice.call(arguments, 1));
|
||||
};
|
||||
|
||||
// Produce a duplicate-free version of the array. If the array has already
|
||||
// been sorted, you have the option of using a faster algorithm.
|
||||
// Aliased as `unique`.
|
||||
_.uniq = _.unique = function(array, isSorted, iterator) {
|
||||
var initial = iterator ? _.map(array, iterator) : array;
|
||||
var result = [];
|
||||
_.reduce(initial, function(memo, el, i) {
|
||||
if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
|
||||
memo[memo.length] = el;
|
||||
result[result.length] = array[i];
|
||||
}
|
||||
return memo;
|
||||
}, []);
|
||||
return result;
|
||||
};
|
||||
|
||||
// Produce an array that contains the union: each distinct element from all of
|
||||
// the passed-in arrays.
|
||||
_.union = function() {
|
||||
return _.uniq(_.flatten(arguments, true));
|
||||
};
|
||||
|
||||
// Produce an array that contains every item shared between all the
|
||||
// passed-in arrays. (Aliased as "intersect" for back-compat.)
|
||||
_.intersection = _.intersect = function(array) {
|
||||
var rest = slice.call(arguments, 1);
|
||||
return _.filter(_.uniq(array), function(item) {
|
||||
return _.every(rest, function(other) {
|
||||
return _.indexOf(other, item) >= 0;
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
// Take the difference between one array and a number of other arrays.
|
||||
// Only the elements present in just the first array will remain.
|
||||
_.difference = function(array) {
|
||||
var rest = _.flatten(slice.call(arguments, 1));
|
||||
return _.filter(array, function(value){ return !_.include(rest, value); });
|
||||
};
|
||||
|
||||
// Zip together multiple lists into a single array -- elements that share
|
||||
// an index go together.
|
||||
_.zip = function() {
|
||||
var args = slice.call(arguments);
|
||||
var length = _.max(_.pluck(args, 'length'));
|
||||
var results = new Array(length);
|
||||
for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
|
||||
return results;
|
||||
};
|
||||
|
||||
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
|
||||
// we need this function. Return the position of the first occurrence of an
|
||||
// item in an array, or -1 if the item is not included in the array.
|
||||
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
|
||||
// If the array is large and already in sort order, pass `true`
|
||||
// for **isSorted** to use binary search.
|
||||
_.indexOf = function(array, item, isSorted) {
|
||||
if (array == null) return -1;
|
||||
var i, l;
|
||||
if (isSorted) {
|
||||
i = _.sortedIndex(array, item);
|
||||
return array[i] === item ? i : -1;
|
||||
}
|
||||
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
|
||||
for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
|
||||
_.lastIndexOf = function(array, item) {
|
||||
if (array == null) return -1;
|
||||
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
|
||||
var i = array.length;
|
||||
while (i--) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Generate an integer Array containing an arithmetic progression. A port of
|
||||
// the native Python `range()` function. See
|
||||
// [the Python documentation](http://docs.python.org/library/functions.html#range).
|
||||
_.range = function(start, stop, step) {
|
||||
if (arguments.length <= 1) {
|
||||
stop = start || 0;
|
||||
start = 0;
|
||||
}
|
||||
step = arguments[2] || 1;
|
||||
|
||||
var len = Math.max(Math.ceil((stop - start) / step), 0);
|
||||
var idx = 0;
|
||||
var range = new Array(len);
|
||||
|
||||
while(idx < len) {
|
||||
range[idx++] = start;
|
||||
start += step;
|
||||
}
|
||||
|
||||
return range;
|
||||
};
|
||||
|
||||
// Function (ahem) Functions
|
||||
// ------------------
|
||||
|
||||
// Reusable constructor function for prototype setting.
|
||||
var ctor = function(){};
|
||||
|
||||
// Create a function bound to a given object (assigning `this`, and arguments,
|
||||
// optionally). Binding with arguments is also known as `curry`.
|
||||
// Delegates to **ECMAScript 5**'s native `Function.bind` if available.
|
||||
// We check for `func.bind` first, to fail fast when `func` is undefined.
|
||||
_.bind = function bind(func, context) {
|
||||
var bound, args;
|
||||
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
|
||||
if (!_.isFunction(func)) throw new TypeError;
|
||||
args = slice.call(arguments, 2);
|
||||
return bound = function() {
|
||||
if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
|
||||
ctor.prototype = func.prototype;
|
||||
var self = new ctor;
|
||||
var result = func.apply(self, args.concat(slice.call(arguments)));
|
||||
if (Object(result) === result) return result;
|
||||
return self;
|
||||
};
|
||||
};
|
||||
|
||||
// Bind all of an object's methods to that object. Useful for ensuring that
|
||||
// all callbacks defined on an object belong to it.
|
||||
_.bindAll = function(obj) {
|
||||
var funcs = slice.call(arguments, 1);
|
||||
if (funcs.length == 0) funcs = _.functions(obj);
|
||||
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Memoize an expensive function by storing its results.
|
||||
_.memoize = function(func, hasher) {
|
||||
var memo = {};
|
||||
hasher || (hasher = _.identity);
|
||||
return function() {
|
||||
var key = hasher.apply(this, arguments);
|
||||
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
|
||||
};
|
||||
};
|
||||
|
||||
// Delays a function for the given number of milliseconds, and then calls
|
||||
// it with the arguments supplied.
|
||||
_.delay = function(func, wait) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return setTimeout(function(){ return func.apply(func, args); }, wait);
|
||||
};
|
||||
|
||||
// Defers a function, scheduling it to run after the current call stack has
|
||||
// cleared.
|
||||
_.defer = function(func) {
|
||||
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
|
||||
};
|
||||
|
||||
// Returns a function, that, when invoked, will only be triggered at most once
|
||||
// during a given window of time.
|
||||
_.throttle = function(func, wait) {
|
||||
var context, args, timeout, throttling, more;
|
||||
var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
|
||||
return function() {
|
||||
context = this; args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
if (more) func.apply(context, args);
|
||||
whenDone();
|
||||
};
|
||||
if (!timeout) timeout = setTimeout(later, wait);
|
||||
if (throttling) {
|
||||
more = true;
|
||||
} else {
|
||||
func.apply(context, args);
|
||||
}
|
||||
whenDone();
|
||||
throttling = true;
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function, that, as long as it continues to be invoked, will not
|
||||
// be triggered. The function will be called after it stops being called for
|
||||
// N milliseconds.
|
||||
_.debounce = function(func, wait) {
|
||||
var timeout;
|
||||
return function() {
|
||||
var context = this, args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
func.apply(context, args);
|
||||
};
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(later, wait);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will be executed at most one time, no matter how
|
||||
// often you call it. Useful for lazy initialization.
|
||||
_.once = function(func) {
|
||||
var ran = false, memo;
|
||||
return function() {
|
||||
if (ran) return memo;
|
||||
ran = true;
|
||||
return memo = func.apply(this, arguments);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns the first function passed as an argument to the second,
|
||||
// allowing you to adjust arguments, run code before and after, and
|
||||
// conditionally execute the original function.
|
||||
_.wrap = function(func, wrapper) {
|
||||
return function() {
|
||||
var args = [func].concat(slice.call(arguments, 0));
|
||||
return wrapper.apply(this, args);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that is the composition of a list of functions, each
|
||||
// consuming the return value of the function that follows.
|
||||
_.compose = function() {
|
||||
var funcs = arguments;
|
||||
return function() {
|
||||
var args = arguments;
|
||||
for (var i = funcs.length - 1; i >= 0; i--) {
|
||||
args = [funcs[i].apply(this, args)];
|
||||
}
|
||||
return args[0];
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will only be executed after being called N times.
|
||||
_.after = function(times, func) {
|
||||
if (times <= 0) return func();
|
||||
return function() {
|
||||
if (--times < 1) { return func.apply(this, arguments); }
|
||||
};
|
||||
};
|
||||
|
||||
// Object Functions
|
||||
// ----------------
|
||||
|
||||
// Retrieve the names of an object's properties.
|
||||
// Delegates to **ECMAScript 5**'s native `Object.keys`
|
||||
_.keys = nativeKeys || function(obj) {
|
||||
if (obj !== Object(obj)) throw new TypeError('Invalid object');
|
||||
var keys = [];
|
||||
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
|
||||
return keys;
|
||||
};
|
||||
|
||||
// Retrieve the values of an object's properties.
|
||||
_.values = function(obj) {
|
||||
return _.map(obj, _.identity);
|
||||
};
|
||||
|
||||
// Return a sorted list of the function names available on the object.
|
||||
// Aliased as `methods`
|
||||
_.functions = _.methods = function(obj) {
|
||||
var names = [];
|
||||
for (var key in obj) {
|
||||
if (_.isFunction(obj[key])) names.push(key);
|
||||
}
|
||||
return names.sort();
|
||||
};
|
||||
|
||||
// Extend a given object with all the properties in passed-in object(s).
|
||||
_.extend = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Fill in a given object with default properties.
|
||||
_.defaults = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
if (obj[prop] == null) obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Create a (shallow-cloned) duplicate of an object.
|
||||
_.clone = function(obj) {
|
||||
if (!_.isObject(obj)) return obj;
|
||||
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
|
||||
};
|
||||
|
||||
// Invokes interceptor with the obj, and then returns obj.
|
||||
// The primary purpose of this method is to "tap into" a method chain, in
|
||||
// order to perform operations on intermediate results within the chain.
|
||||
_.tap = function(obj, interceptor) {
|
||||
interceptor(obj);
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Internal recursive comparison function.
|
||||
function eq(a, b, stack) {
|
||||
// Identical objects are equal. `0 === -0`, but they aren't identical.
|
||||
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
|
||||
if (a === b) return a !== 0 || 1 / a == 1 / b;
|
||||
// A strict comparison is necessary because `null == undefined`.
|
||||
if (a == null || b == null) return a === b;
|
||||
// Unwrap any wrapped objects.
|
||||
if (a._chain) a = a._wrapped;
|
||||
if (b._chain) b = b._wrapped;
|
||||
// Invoke a custom `isEqual` method if one is provided.
|
||||
if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
|
||||
if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
|
||||
// Compare `[[Class]]` names.
|
||||
var className = toString.call(a);
|
||||
if (className != toString.call(b)) return false;
|
||||
switch (className) {
|
||||
// Strings, numbers, dates, and booleans are compared by value.
|
||||
case '[object String]':
|
||||
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
|
||||
// equivalent to `new String("5")`.
|
||||
return a == String(b);
|
||||
case '[object Number]':
|
||||
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
|
||||
// other numeric values.
|
||||
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
|
||||
case '[object Date]':
|
||||
case '[object Boolean]':
|
||||
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
|
||||
// millisecond representations. Note that invalid dates with millisecond representations
|
||||
// of `NaN` are not equivalent.
|
||||
return +a == +b;
|
||||
// RegExps are compared by their source patterns and flags.
|
||||
case '[object RegExp]':
|
||||
return a.source == b.source &&
|
||||
a.global == b.global &&
|
||||
a.multiline == b.multiline &&
|
||||
a.ignoreCase == b.ignoreCase;
|
||||
}
|
||||
if (typeof a != 'object' || typeof b != 'object') return false;
|
||||
// Assume equality for cyclic structures. The algorithm for detecting cyclic
|
||||
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
|
||||
var length = stack.length;
|
||||
while (length--) {
|
||||
// Linear search. Performance is inversely proportional to the number of
|
||||
// unique nested structures.
|
||||
if (stack[length] == a) return true;
|
||||
}
|
||||
// Add the first object to the stack of traversed objects.
|
||||
stack.push(a);
|
||||
var size = 0, result = true;
|
||||
// Recursively compare objects and arrays.
|
||||
if (className == '[object Array]') {
|
||||
// Compare array lengths to determine if a deep comparison is necessary.
|
||||
size = a.length;
|
||||
result = size == b.length;
|
||||
if (result) {
|
||||
// Deep compare the contents, ignoring non-numeric properties.
|
||||
while (size--) {
|
||||
// Ensure commutative equality for sparse arrays.
|
||||
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Objects with different constructors are not equivalent.
|
||||
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
|
||||
// Deep compare objects.
|
||||
for (var key in a) {
|
||||
if (_.has(a, key)) {
|
||||
// Count the expected number of properties.
|
||||
size++;
|
||||
// Deep compare each member.
|
||||
if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
|
||||
}
|
||||
}
|
||||
// Ensure that both objects contain the same number of properties.
|
||||
if (result) {
|
||||
for (key in b) {
|
||||
if (_.has(b, key) && !(size--)) break;
|
||||
}
|
||||
result = !size;
|
||||
}
|
||||
}
|
||||
// Remove the first object from the stack of traversed objects.
|
||||
stack.pop();
|
||||
return result;
|
||||
}
|
||||
|
||||
// Perform a deep comparison to check if two objects are equal.
|
||||
_.isEqual = function(a, b) {
|
||||
return eq(a, b, []);
|
||||
};
|
||||
|
||||
// Is a given array, string, or object empty?
|
||||
// An "empty" object has no enumerable own-properties.
|
||||
_.isEmpty = function(obj) {
|
||||
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
|
||||
for (var key in obj) if (_.has(obj, key)) return false;
|
||||
return true;
|
||||
};
|
||||
|
||||
// Is a given value a DOM element?
|
||||
_.isElement = function(obj) {
|
||||
return !!(obj && obj.nodeType == 1);
|
||||
};
|
||||
|
||||
// Is a given value an array?
|
||||
// Delegates to ECMA5's native Array.isArray
|
||||
_.isArray = nativeIsArray || function(obj) {
|
||||
return toString.call(obj) == '[object Array]';
|
||||
};
|
||||
|
||||
// Is a given variable an object?
|
||||
_.isObject = function(obj) {
|
||||
return obj === Object(obj);
|
||||
};
|
||||
|
||||
// Is a given variable an arguments object?
|
||||
_.isArguments = function(obj) {
|
||||
return toString.call(obj) == '[object Arguments]';
|
||||
};
|
||||
if (!_.isArguments(arguments)) {
|
||||
_.isArguments = function(obj) {
|
||||
return !!(obj && _.has(obj, 'callee'));
|
||||
};
|
||||
}
|
||||
|
||||
// Is a given value a function?
|
||||
_.isFunction = function(obj) {
|
||||
return toString.call(obj) == '[object Function]';
|
||||
};
|
||||
|
||||
// Is a given value a string?
|
||||
_.isString = function(obj) {
|
||||
return toString.call(obj) == '[object String]';
|
||||
};
|
||||
|
||||
// Is a given value a number?
|
||||
_.isNumber = function(obj) {
|
||||
return toString.call(obj) == '[object Number]';
|
||||
};
|
||||
|
||||
// Is the given value `NaN`?
|
||||
_.isNaN = function(obj) {
|
||||
// `NaN` is the only value for which `===` is not reflexive.
|
||||
return obj !== obj;
|
||||
};
|
||||
|
||||
// Is a given value a boolean?
|
||||
_.isBoolean = function(obj) {
|
||||
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
|
||||
};
|
||||
|
||||
// Is a given value a date?
|
||||
_.isDate = function(obj) {
|
||||
return toString.call(obj) == '[object Date]';
|
||||
};
|
||||
|
||||
// Is the given value a regular expression?
|
||||
_.isRegExp = function(obj) {
|
||||
return toString.call(obj) == '[object RegExp]';
|
||||
};
|
||||
|
||||
// Is a given value equal to null?
|
||||
_.isNull = function(obj) {
|
||||
return obj === null;
|
||||
};
|
||||
|
||||
// Is a given variable undefined?
|
||||
_.isUndefined = function(obj) {
|
||||
return obj === void 0;
|
||||
};
|
||||
|
||||
// Has own property?
|
||||
_.has = function(obj, key) {
|
||||
return hasOwnProperty.call(obj, key);
|
||||
};
|
||||
|
||||
// Utility Functions
|
||||
// -----------------
|
||||
|
||||
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
|
||||
// previous owner. Returns a reference to the Underscore object.
|
||||
_.noConflict = function() {
|
||||
root._ = previousUnderscore;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Keep the identity function around for default iterators.
|
||||
_.identity = function(value) {
|
||||
return value;
|
||||
};
|
||||
|
||||
// Run a function **n** times.
|
||||
_.times = function (n, iterator, context) {
|
||||
for (var i = 0; i < n; i++) iterator.call(context, i);
|
||||
};
|
||||
|
||||
// Escape a string for HTML interpolation.
|
||||
_.escape = function(string) {
|
||||
return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
|
||||
};
|
||||
|
||||
// Add your own custom functions to the Underscore object, ensuring that
|
||||
// they're correctly added to the OOP wrapper as well.
|
||||
_.mixin = function(obj) {
|
||||
each(_.functions(obj), function(name){
|
||||
addToWrapper(name, _[name] = obj[name]);
|
||||
});
|
||||
};
|
||||
|
||||
// Generate a unique integer id (unique within the entire client session).
|
||||
// Useful for temporary DOM ids.
|
||||
var idCounter = 0;
|
||||
_.uniqueId = function(prefix) {
|
||||
var id = idCounter++;
|
||||
return prefix ? prefix + id : id;
|
||||
};
|
||||
|
||||
// By default, Underscore uses ERB-style template delimiters, change the
|
||||
// following template settings to use alternative delimiters.
|
||||
_.templateSettings = {
|
||||
evaluate : /<%([\s\S]+?)%>/g,
|
||||
interpolate : /<%=([\s\S]+?)%>/g,
|
||||
escape : /<%-([\s\S]+?)%>/g
|
||||
};
|
||||
|
||||
// When customizing `templateSettings`, if you don't want to define an
|
||||
// interpolation, evaluation or escaping regex, we need one that is
|
||||
// guaranteed not to match.
|
||||
var noMatch = /.^/;
|
||||
|
||||
// Within an interpolation, evaluation, or escaping, remove HTML escaping
|
||||
// that had been previously added.
|
||||
var unescape = function(code) {
|
||||
return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
|
||||
};
|
||||
|
||||
// JavaScript micro-templating, similar to John Resig's implementation.
|
||||
// Underscore templating handles arbitrary delimiters, preserves whitespace,
|
||||
// and correctly escapes quotes within interpolated code.
|
||||
_.template = function(str, data) {
|
||||
var c = _.templateSettings;
|
||||
var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
|
||||
'with(obj||{}){__p.push(\'' +
|
||||
str.replace(/\\/g, '\\\\')
|
||||
.replace(/'/g, "\\'")
|
||||
.replace(c.escape || noMatch, function(match, code) {
|
||||
return "',_.escape(" + unescape(code) + "),'";
|
||||
})
|
||||
.replace(c.interpolate || noMatch, function(match, code) {
|
||||
return "'," + unescape(code) + ",'";
|
||||
})
|
||||
.replace(c.evaluate || noMatch, function(match, code) {
|
||||
return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
|
||||
})
|
||||
.replace(/\r/g, '\\r')
|
||||
.replace(/\n/g, '\\n')
|
||||
.replace(/\t/g, '\\t')
|
||||
+ "');}return __p.join('');";
|
||||
var func = new Function('obj', '_', tmpl);
|
||||
if (data) return func(data, _);
|
||||
return function(data) {
|
||||
return func.call(this, data, _);
|
||||
};
|
||||
};
|
||||
|
||||
// Add a "chain" function, which will delegate to the wrapper.
|
||||
_.chain = function(obj) {
|
||||
return _(obj).chain();
|
||||
};
|
||||
|
||||
// The OOP Wrapper
|
||||
// ---------------
|
||||
|
||||
// If Underscore is called as a function, it returns a wrapped object that
|
||||
// can be used OO-style. This wrapper holds altered versions of all the
|
||||
// underscore functions. Wrapped objects may be chained.
|
||||
var wrapper = function(obj) { this._wrapped = obj; };
|
||||
|
||||
// Expose `wrapper.prototype` as `_.prototype`
|
||||
_.prototype = wrapper.prototype;
|
||||
|
||||
// Helper function to continue chaining intermediate results.
|
||||
var result = function(obj, chain) {
|
||||
return chain ? _(obj).chain() : obj;
|
||||
};
|
||||
|
||||
// A method to easily add functions to the OOP wrapper.
|
||||
var addToWrapper = function(name, func) {
|
||||
wrapper.prototype[name] = function() {
|
||||
var args = slice.call(arguments);
|
||||
unshift.call(args, this._wrapped);
|
||||
return result(func.apply(_, args), this._chain);
|
||||
};
|
||||
};
|
||||
|
||||
// Add all of the Underscore functions to the wrapper object.
|
||||
_.mixin(_);
|
||||
|
||||
// Add all mutator Array functions to the wrapper.
|
||||
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
var wrapped = this._wrapped;
|
||||
method.apply(wrapped, arguments);
|
||||
var length = wrapped.length;
|
||||
if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
|
||||
return result(wrapped, this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Add all accessor Array functions to the wrapper.
|
||||
each(['concat', 'join', 'slice'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
return result(method.apply(this._wrapped, arguments), this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Start chaining a wrapped Underscore object.
|
||||
wrapper.prototype.chain = function() {
|
||||
this._chain = true;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Extracts the result from a wrapped and chained object.
|
||||
wrapper.prototype.value = function() {
|
||||
return this._wrapped;
|
||||
};
|
||||
|
||||
}).call(this);
|
||||
1257
static/underscore.js
1257
static/underscore.js
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 372 B After Width: | Height: | Size: 345 B |
BIN
static/up.png
BIN
static/up.png
Binary file not shown.
|
Before Width: | Height: | Size: 363 B After Width: | Height: | Size: 345 B |
|
|
@ -2,9 +2,9 @@
|
|||
* websupport.js
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* sphinx.websupport utilties for all documentation.
|
||||
* sphinx.websupport utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -50,51 +50,51 @@
|
|||
}
|
||||
|
||||
function initEvents() {
|
||||
$('a.comment-close').live("click", function(event) {
|
||||
$(document).on("click", 'a.comment-close', function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.vote').live("click", function(event) {
|
||||
$(document).on("click", 'a.vote', function(event) {
|
||||
event.preventDefault();
|
||||
handleVote($(this));
|
||||
});
|
||||
$('a.reply').live("click", function(event) {
|
||||
$(document).on("click", 'a.reply', function(event) {
|
||||
event.preventDefault();
|
||||
openReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.close-reply').live("click", function(event) {
|
||||
$(document).on("click", 'a.close-reply', function(event) {
|
||||
event.preventDefault();
|
||||
closeReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.sort-option').live("click", function(event) {
|
||||
$(document).on("click", 'a.sort-option', function(event) {
|
||||
event.preventDefault();
|
||||
handleReSort($(this));
|
||||
});
|
||||
$('a.show-proposal').live("click", function(event) {
|
||||
$(document).on("click", 'a.show-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
showProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.hide-proposal').live("click", function(event) {
|
||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.show-propose-change').live("click", function(event) {
|
||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
showProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.hide-propose-change').live("click", function(event) {
|
||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.accept-comment').live("click", function(event) {
|
||||
$(document).on("click", 'a.accept-comment', function(event) {
|
||||
event.preventDefault();
|
||||
acceptComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.delete-comment').live("click", function(event) {
|
||||
$(document).on("click", 'a.delete-comment', function(event) {
|
||||
event.preventDefault();
|
||||
deleteComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.comment-markup').live("click", function(event) {
|
||||
$(document).on("click", 'a.comment-markup', function(event) {
|
||||
event.preventDefault();
|
||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
||||
});
|
||||
|
|
@ -700,8 +700,8 @@
|
|||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
||||
<div class="comment-markup-box" id="mb<%id%>">\
|
||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
||||
<tt>``code``</tt>, \
|
||||
code blocks: <tt>::</tt> and an indented block after blank line</div>\
|
||||
<code>``code``</code>, \
|
||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<p class="propose-button">\
|
||||
|
|
|
|||
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Strategies — Git Lint 0.0.4 documentation</title>
|
||||
<title>Strategies — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -25,8 +25,8 @@
|
|||
<script type="text/javascript" src="static/doctools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -35,14 +35,14 @@
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="strategies">
|
||||
<h1>Strategies<a class="headerlink" href="#strategies" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -55,7 +55,7 @@ c. In the base directory as .git-lint/config?
|
|||
d. In the user’s home directory as .git-lint?
|
||||
e. In the user’s home directroy as .git-lint/config?</p>
|
||||
</li>
|
||||
<li><p class="first">Prune configuration with <tt class="docutils literal"><span class="pre">-o</span></tt> or <tt class="docutils literal"><span class="pre">-e</span></tt> options</p>
|
||||
<li><p class="first">Prune configuration with <code class="docutils literal"><span class="pre">-o</span></code> or <code class="docutils literal"><span class="pre">-e</span></code> options</p>
|
||||
</li>
|
||||
<li><p class="first">Determine which files to lint.
|
||||
a. Workspace or staging?</p>
|
||||
|
|
@ -68,10 +68,10 @@ a. Workspace or staging?</p>
|
|||
<li><dl class="first docutils">
|
||||
<dt>From this list:</dt>
|
||||
<dd><ol class="first last lowerroman simple">
|
||||
<li>All changed files <tt class="docutils literal"><span class="pre">-b</span></tt></li>
|
||||
<li>All changed files <code class="docutils literal"><span class="pre">-b</span></code></li>
|
||||
<li>All changed files in the current directory and down (default)</li>
|
||||
<li>All files in the current directory and down. <tt class="docutils literal"><span class="pre">-a</span></tt></li>
|
||||
<li>All files in the repository <tt class="docutils literal"><span class="pre">-a</span> <span class="pre">-b</span></tt></li>
|
||||
<li>All files in the current directory and down. <code class="docutils literal"><span class="pre">-a</span></code></li>
|
||||
<li>All files in the repository <code class="docutils literal"><span class="pre">-a</span> <span class="pre">-b</span></code></li>
|
||||
</ol>
|
||||
</dd>
|
||||
</dl>
|
||||
|
|
@ -83,7 +83,7 @@ a. Workspace or staging?</p>
|
|||
</ol>
|
||||
</li>
|
||||
<li><p class="first">For each file, run the appropriate linter.
|
||||
a. If in delta mode <tt class="docutils literal"><span class="pre">-d</span></tt>, only show differences that correspond to user changes.
|
||||
a. If in delta mode <code class="docutils literal"><span class="pre">-d</span></code>, only show differences that correspond to user changes.
|
||||
b. Capture failure output and failure status.</p>
|
||||
</li>
|
||||
<li><p class="first">Reduce failure status to pass/fail</p>
|
||||
|
|
@ -99,31 +99,30 @@ b. Capture failure output and failure status.</p>
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/strategies.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/strategies.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -132,12 +131,12 @@ b. Capture failure output and failure status.</p>
|
|||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
59
usage.html
59
usage.html
|
|
@ -6,9 +6,9 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Usage — Git Lint 0.0.4 documentation</title>
|
||||
<title>Usage — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
|
|
@ -27,8 +27,8 @@
|
|||
<link rel="next" title="Contributing" href="contributing.html" />
|
||||
<link rel="prev" title="Installation" href="installation.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -43,14 +43,14 @@
|
|||
<li class="right" >
|
||||
<a href="installation.html" title="Installation"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#id1">Usage</a><a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -108,19 +108,19 @@
|
|||
</div>
|
||||
<div class="section" id="as-a-pre-commit-hook">
|
||||
<h2><a class="toc-backref" href="#id4">As a pre-commit hook:</a><a class="headerlink" href="#as-a-pre-commit-hook" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="c">#!/usr/bin/env python</span>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>
|
||||
<span class="kn">import</span> <span class="nn">git_lint</span>
|
||||
<span class="n">git_lint</span><span class="o">.</span><span class="n">run_precommit</span><span class="p">(</span><span class="n">staging</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="n">timestamps</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Install this file in your project’s <tt class="docutils literal"><span class="pre">.git/hooks/pre-commit</span></tt>, and set
|
||||
the file’s executable flag to <tt class="docutils literal"><span class="pre">true</span></tt>:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre>chmod +x pre-commit
|
||||
<p>Install this file in your project’s <code class="docutils literal"><span class="pre">.git/hooks/pre-commit</span></code>, and set
|
||||
the file’s executable flag to <code class="docutils literal"><span class="pre">true</span></code>:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>chmod +x pre-commit
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Please see the <em class="xref std std-ref">api</em> for more details on options taken by the
|
||||
<tt class="docutils literal"><span class="pre">run_precommit()</span></tt> and <tt class="docutils literal"><span class="pre">run_gitlint</span></tt> commands.</p>
|
||||
<p>There is an example <tt class="docutils literal"><span class="pre">pre-commit</span></tt> script shipped with <tt class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></tt>.</p>
|
||||
<p>Please see the <span class="xref std std-ref">api</span> for more details on options taken by the
|
||||
<code class="docutils literal"><span class="pre">run_precommit()</span></code> and <code class="docutils literal"><span class="pre">run_gitlint</span></code> commands.</p>
|
||||
<p>There is an example <code class="docutils literal"><span class="pre">pre-commit</span></code> script shipped with <code class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -128,7 +128,7 @@ the file’s executable flag to <tt class="docutils literal"><span class="pr
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
|
|
@ -146,29 +146,28 @@ the file’s executable flag to <tt class="docutils literal"><span class="pr
|
|||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="contributing.html"
|
||||
title="next chapter">Contributing</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/usage.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="sources/usage.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
|
|
@ -183,12 +182,12 @@ the file’s executable flag to <tt class="docutils literal"><span class="pr
|
|||
<li class="right" >
|
||||
<a href="installation.html" title="Installation"
|
||||
>previous</a> |</li>
|
||||
<li><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in New Issue