Skip to main content

lint-along

Project description

Copyright (c) 2018 Fowbi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: lint-along
===============

Lint and commit with an adjusted linting song as message.


Why?
----

I always make some stupid mistakes against the style guide, and because I never bothered to fix my half-baked linter
setup for VIM and I apparently feel too smart for githooks, I always end up linting my code after I made it into a PR.

So instead of giving those commits a bland message I opted for some music inspired titles, and lint-along was born.


Installation
------------

pip:

.. code:: bash

pip install lint-along

From source:

.. code:: bash

python setup.py install

Usage
-----

Execute `lint-along` in a git enabled directory.

.. code:: bash

lint-along


Playlist
--------

The hits that make bland linting commits :sparkles:

`Spotify <https://open.spotify.com/user/tobi.beernaert/playlist/7e3T6T18e4JVl01Vasgf3m?si=qvLwEknoQqSD5kMabwxoEA>`_

Todo
====

- Pass the linter command via [yet another] config file.
- Some documentation would be nice
- Some tests would also be nice
- Add more songs




disclaimer: probably really buggy, so use with cautious.

Keywords: lint-along
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: PythonProgramming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lint-along-0.0.2.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

lint_along-0.0.2-py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page