elf
/
git-linter
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
git-linter/README.rst

92 lines
3.1 KiB
ReStructuredText
Raw Normal View History

Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
===============================
Fixed reportage matrix. Now it doesn't print things the user doesn't care about, like empty lint passes, or broken linters that aren't relevant to the current project. Added a test pass to ensure it doesn't blow up when running against an empty stage.
2016-10-03 19:13:35 +00:00
Git Lint: README
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
===============================
A git command that automatically runs identifiable linters against
Fixed reportage matrix. Now it doesn't print things the user doesn't care about, like empty lint passes, or broken linters that aren't relevant to the current project. Added a test pass to ensure it doesn't blow up when running against an empty stage.
2016-10-03 19:13:35 +00:00
changed files in your current git repository or staging area.
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
* Free software: MIT license
**Git Lint** runs a configurable set of syntax, style, and complexity
checkers against changed files in your current working directory or
Fixed reportage matrix. Now it doesn't print things the user doesn't care about, like empty lint passes, or broken linters that aren't relevant to the current project. Added a test pass to ensure it doesn't blow up when running against an empty stage.
2016-10-03 19:13:35 +00:00
staging area. It can be configured to work with any `lint`-like
command. Some commands may require shell wrappers.
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Adding a check for readability.
2016-09-30 01:36:27 +00:00
While it may be possible to create a custom lint command in your npm,
Fixed reportage matrix. Now it doesn't print things the user doesn't care about, like empty lint passes, or broken linters that aren't relevant to the current project. Added a test pass to ensure it doesn't blow up when running against an empty stage.
2016-10-03 19:13:35 +00:00
grunt, Make, CMake, or whatever, the fact is we all use a VCS, and most
of us use git. Having a centralized repository for what we want checked
and how we want it checked, associated with git (and by extension, as a
pre-commit hook), that can be run at any time for any reason.
Usage
-----
To lint only what's changed recently in your current working directory:
`git lint`
To lint everything, changed or otherwise, from the current directory down:
`git lint -a`
To lint what's changed from the repo's base:
`git lint -b`
To lint what's in your staging directory:
`git lint -s`
Install
-------
`pip install git-linter`
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.
Adding a check for readability.
2016-09-30 01:36:27 +00:00
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Features
--------
* Highly configurable - configuration files, both for git-lint and
individual linters, can be global or per-project.
Adding a check for readability.
2016-09-30 01:36:27 +00:00
* Only checks files that have been changed, but this can be overriden
from the command line.
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
* Can be used directly as a pre-commit hook, to ensure you personally
don't check in anything broken.
Adding a check for readability.
2016-09-30 01:36:27 +00:00
* Used this way, it checks the *staging* area, not your workspace.
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Adding a check for readability.
2016-09-30 01:36:27 +00:00
* When using the staging area, it stashes your current work. Upon
restoration of your workspace, it ensures the timestamps are the
same, so as not to confuse your build system or IDE.
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Fixed reportage matrix. Now it doesn't print things the user doesn't care about, like empty lint passes, or broken linters that aren't relevant to the current project. Added a test pass to ensure it doesn't blow up when running against an empty stage.
2016-10-03 19:13:35 +00:00
Acknowledgements
----------------
`Git lint` started life as a simple pre-commit hook. Most of the
Fixing reference in Readme.
2016-10-03 20:18:45 +00:00
changes since were inspired by Steve Pulec's *Why You Need a Git
Pre-Commit Hook and Why Most Are Wrong_,* as well as just my own needs as
Fixed reportage matrix. Now it doesn't print things the user doesn't care about, like empty lint passes, or broken linters that aren't relevant to the current project. Added a test pass to ensure it doesn't blow up when running against an empty stage.
2016-10-03 19:13:35 +00:00
a software developer.
Fixing reference in Readme.
2016-10-03 20:18:45 +00:00
.. _Wrong: https://dzone.com/articles/why-your-need-git-pre-commit
Fixed reportage matrix. Now it doesn't print things the user doesn't care about, like empty lint passes, or broken linters that aren't relevant to the current project. Added a test pass to ensure it doesn't blow up when running against an empty stage.
2016-10-03 19:13:35 +00:00
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Disclaimer
----------
This software, including provided configuration and documentation
materials, is provided "as is" without any warranties, including any
Fixed a typo.
2016-09-19 21:44:53 +00:00
implied warranties of merchantability, fitness, performance, or
quality. In no event shall the author or sponsor be liable for any
special, direct, indirect, or consequential damages or any damages
whatsoever resulting from loss of use, data or profits, whether in an
action of contract, negligence or other tortious action, arising out
of or in connection with the use or performance of this software.
Each user of the program will agree and understand, and be deemed to
have agreed and understood, that there is no warranty whatsoever for
the program and, accordingly, the entire risk arising from or
otherwise connected with the program is assumed by the user.