-
-

Welcome to Git Lint’s documentation!

+
+

Git Lint

+

Git Lint provides a new git command that automatically runs identifiable linters (style +and syntax quality assurance programs) against changed files in your current git +repository or staging area.

Contents:

    @@ -110,7 +113,7 @@

    Table Of Contents

    diff --git a/objects.inv b/objects.inv index c27d3fef73b10919c2f5f2c3d50b1700009c6ff0..0d1f93b533e171e6d9bfcdd5d9841450cb02ad06 100644 GIT binary patch delta 626 zcmV-&0*(Fn1?2^het(bKAP~LtE0Eeldx+IsqpDKXZa<_(s&-ZNhzOow6bu&NZu0Lt zfF0Ybs$G*_Eaow9c#N3=sRGl=1lnD8t*v_v^bM5*ST&*5FEYG&NjKy=A#bBq-|z#@ zN4n75d%AtX{wuAj-Np4LEe@fv^-4MzVQXN%0j*gJ-g5~_i+>M1C{Yv>^)NW&&~Tk* z!2O4a*1&DS_B@E@lhQ+kHOZb)tCpXDwGm*)gk+;w)rTGo0?O!c z2GIw8(11To`H=qnu{Rs^h&nxv?@Ivwu?TjLESo6_KMqONv?zjZu*X8*sm4gSFY}$vu;dT39pK!oLT}) z()0eGCwU4Yoy9#LE+yQ~p^Ys;cjfHW=jLgEY?t$Y;eRla{uO{b*|%V@{rgbwYAfhw zORr$^qi>C+K?M!(2=DQFb4%w8W!Dc5Y85=evJFlh`hb04?mWi_#tb163|=X4P87`# zpd)ESGvR9-UN=4uzStd|9%o#f@M%LDyke}o%ozie316~7CIy4nZ1K-3(D*VzC+xFY z^OV?y?`wpQdMAWnE9$wP6Ebp@yor)uZC?{Cl0T%PyKKgZOxfoW%Sp+FwfH*&v`h(c zc;B@!_shs~lRJ8U_x|Jlj(FfsG)pBJ%Y=tK|2<~e2gd_QwUjZT1LJCwKE6BWz6r=~ MKjM)52G3zU4 delta 645 zcmV;00($-B1^5M!et(PGFc7`_SE#hm_7KxtLn)MY`vDDyt$U8^fEfxIJi50;H<<;w(bUXe|4ov7E*${+Xv zV*{N_W-Zx1V*iy^R_0>7ia!U}=xQMy6xS6{+klj`1#4LiF@F~8m=iop6XT(9#-U;| z&Vcz3idw-su|0FV`66Vmu%y@%YT2?A&^7?{7?EUThjr&zEmVE$m0BLyy*4M?F%Efj zI0N^N9VFm_3G3p@AHCvEX!T5uqfiy)S{+3l3IZ7tHMmHX7(ymJ7zbuy1-$`Qt)LsQ zomQ(N7$m4+4}Y05>4ea*553LQNX=knJ`cDvaa#`oDb_+xJW{h^cV)0c-v|cRZOc@Z zsUXJ=y^w7?DROs*?t%|(Fm9Pn_JZ4GPA<6wrhG>eY?lUM7yjKqr_E5Z99|iYa%>4S zhMw|&UdW?JZ8YY5xa4p8GjrzzCD%^|D&cH_$JQBf@DBUH)Om{cj0sZIpzun8bEHUi z02xRFnh4*+@S6Bke3l&IkJd6?T8CSdT;Y~XAjX-ky6^6whj7&yTbL1^b diff --git a/readme.html b/readme.html index 79de3d4..720afd1 100644 --- a/readme.html +++ b/readme.html @@ -25,7 +25,7 @@ - +
@@ -164,7 +164,7 @@ otherwise connected with the program is assumed by the user.

Previous topic

Welcome to Git Lint’s documentation!

+ title="previous chapter">Git Lint

Next topic

Installation

@@ -202,7 +202,7 @@ otherwise connected with the program is assumed by the user.

next |
  • - previous |
  • Git Lint 0.0.6 documentation »
    • diff --git a/searchindex.js b/searchindex.js index 25725c7..a3f57f9 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:49,filenames:["arguments","authors","contributing","git_lint","history","index","installation","manual","modules","readme","strategies","usage"],objects:{"":{git_lint:[3,0,0,"-"]},"git_lint.git_lint":{Linters:[3,1,1,""],MatchFilter:[3,1,1,""],StagingRunner:[3,1,1,""],WorkspaceRunner:[3,1,1,""],executable_exists:[3,4,1,""],find_config_file:[3,4,1,""],get_filelist:[3,4,1,""],get_git_base:[3,4,1,""],get_git_head:[3,4,1,""],get_git_response:[3,4,1,""],get_git_response_raw:[3,4,1,""],get_linter_status:[3,4,1,""],get_shell_response:[3,4,1,""],get_working_linter_names:[3,4,1,""],load_config:[3,4,1,""],run_git_command:[3,4,1,""],run_linters:[3,4,1,""],split_git_response:[3,4,1,""]},"git_lint.git_lint.Linters":{dryrun:[3,2,1,""],encode_shell_messages:[3,3,1,""],run_external_linter:[3,3,1,""],run_one_linter:[3,3,1,""]},"git_lint.git_lint.MatchFilter":{make_match_filter_matcher:[3,3,1,""]},"git_lint.option_handler":{cleanup_options:[3,4,1,""]},"git_lint.reporters":{base_file_cleaner:[3,4,1,""],group_by:[3,4,1,""],print_help:[3,4,1,""],print_linters:[3,4,1,""],print_report:[3,4,1,""],print_version:[3,4,1,""]},git_lint:{git_lint:[3,0,0,"-"],option_handler:[3,0,0,"-"],options:[3,0,0,"-"],reporters:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","staticmethod","Python static method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:staticmethod","4":"py:function"},terms:{"boolean":3,"class":3,"default":[0,7,10,11],"function":2,"import":11,"long":[0,3,7,11],"new":2,"public":6,"return":[3,7],"short":[0,7,11],"static":3,"true":[3,7,11],"while":9,about:2,accordingli:9,acknowledg:5,action:9,actual:[0,7,11],add:[2,10],against:[3,7,9],agre:9,all:[0,2,7,9,10,11],allow:3,along:3,alpha:9,alphanumer:7,also:9,alwai:2,ani:[3,7,9,10],any:2,anyth:[0,2,7,9,11],api:11,appear:[0,3,7,11],appreci:2,appropri:10,area:[0,7,9,11],argument:3,aris:9,articl:2,asciibetic:7,aside:7,associ:9,assum:9,assume:2,author:9,automat:9,avail:9,base:[0,3,7,9,10,11],base_file_clean:3,been:9,befor:[2,7],best:2,better:9,bin:11,bit:2,blog:2,both:9,branch:2,broken:9,broken_linter_nam:3,bugfix:2,build:9,byfil:[0,7,11],bylint:[0,3,7,11],can:[2,6,7,9],cant_lint_filenam:3,captur:10,central:9,chang:[0,2,7,9,10,11],check:[0,2,7,9,11],checker:9,checkout:2,chmod:11,choos:7,cleanup_opt:3,clone:[2,6,9],cmake:9,cmd:3,code:[3,7,9],com:[1,2,6,9],combin:3,comma:[0,7,11],command:[3,5,6,7,9,10],commandlin:3,comment:7,commit:[0,2,4,5,7,9,10],complet:[7,9],complex:9,condit:[3,7],config:[0,3,7,10,11],configur:[0,3,7,9,10,11],confus:9,connect:9,consequenti:9,contract:9,copi:[2,6,9],correspond:10,could:2,coupl:10,creat:[2,3,9],criteria:10,curl:6,current:[0,3,7,9,10,11],custom:9,damag:9,data:9,deem:9,delta:10,descript:2,detail:[2,7,11],determin:10,dictionari:3,differ:[7,10],direct:9,directli:9,directori:[0,3,6,7,9,10,11],directroi:10,disclaim:5,doc:[2,9],docstr:2,don:[0,6,7,9,11],done:2,down:[0,7,9,10,11],download:6,driven:2,dryrun:[0,3,7,11],each:[3,7,9,10],easier:2,edit:9,either:[6,9],elf:1,elfsternberg:[2,6,9],encode_shell_messag:3,ensur:9,entir:9,env:11,error:[3,7],even:[2,7],event:9,everi:[0,2,7,11],everyth:9,exampl:[6,11],exclud:[0,7,11],execut:11,executable_exist:3,exit:10,explain:2,extens:[3,7,9],extra:3,extract:3,fact:9,fail:[0,3,7,10,11],failur:[3,7,10],field_id:3,file:[0,2,3,6,7,9,10,11],filenam:[3,7,11],filter:[3,10],find_config_fil:3,first:[0,1,7,11],fit:9,flag:11,flake8:2,flip:7,follow:7,fork:2,found:3,free:9,from:[0,3,5],fullcmd:3,get_filelist:3,get_git_bas:3,get_git_head:3,get_git_respons:3,get_git_response_raw:3,get_linter_statu:3,get_shell_respons:3,get_working_linter_nam:3,git:[0,2,3,4],git_dir:[0,7,11],git_lint:2,github:[2,6,9],given:2,global:9,gmail:1,greatli:2,group:[0,7,11],group_bi:3,grunt:9,guid:6,have:[0,2,3,6,7,9,11],hell:4,help:[0,2,3,7,11],here:2,highli:9,home:[3,6,9,10],hook:[5,9],how:[2,9],http:[2,6,9],ide:9,identifi:9,impli:9,includ:[2,7,9],index:5,indirect:9,individu:9,inform:[0,7,11],ini:7,inspir:9,instal:[2,6,9],install:[2,5],installat:5,issu:2,iter:3,just:[0,2,7,9,11],keep:[2,3],kenneth:1,label:3,let:7,letter:3,liabl:9,licens:9,life:9,like:9,line:[3,5,7,9,10],lint:[0,2,3,4],linter:[0,3,6,7,9,10,11],linter_nam:3,list:[0,2,3,7,10,11],littl:2,load:[3,10],load_config:3,local:2,locat:3,look:2,loss:9,mai:[6,9],make:[2,9],make_match_filter_match:3,mani:2,master:6,match:[3,7,10],matchfilt:3,materi:9,maxim:7,meet:2,merchant:9,messag:[0,3,7,10,11],might:[2,9],minu:7,mit:9,mkvirtualenv:2,mode:10,more:[0,2,7,11],most:9,mostli:9,move:4,name:[2,3],narrow:2,need:9,neglig:9,none:1,noth:3,now:2,npm:9,object:3,offici:2,once:6,one:3,onli:[0,3,7,9,10,11],only:9,open:2,oper:2,order:7,org:2,origin:2,other:[2,9],otherwis:[3,9],ought:9,out:[4,9],output:3,overriden:9,own:9,page:5,param:3,part:2,pass:[0,2,7,10,11],path:[0,7,11],per:[3,9],perform:[3,9],person:9,phase:10,pip:[2,6,9],plan:9,pleas:[2,6,11],possibl:[2,9],post:2,pre:[0,4,5,7,9,10],prefix:[3,7],print:[0,7,10,11],print_help:3,print_lint:3,print_report:3,print_vers:3,priorit:3,process:[3,6],produc:[0,7,11],profit:9,program:9,project:[2,3,9,11],propos:2,provid:9,prune:10,pulec:9,pull_request:2,push:2,put:2,pypi:2,python:[2,6,9,11],qualiti:9,quiet:[0,7,11],readi:2,readme:[2,5],reason:9,receiv:3,recent:9,record:10,reduc:10,releas:5,rememb:2,replac:3,repo:[2,6,9],repodir:3,report:0,repositori:[3,6,7,9,10],reproduc:2,requir:9,restor:[9,10],result:[3,7,9,10],risk:9,root:3,rst:2,run:[0,2,3,6,7,9,10,11],run_external_lint:3,run_git_command:3,run_gitlint:11,run_lint:3,run_one_lint:3,run_precommit:11,safeconfigpars:3,same:9,scan:[0,7,11],scope:2,script:[3,11],search:5,second:[0,7,11],section:7,see:11,send:2,separ:[0,7,11],set:[2,3,7,9,11],setup:[2,6,9],shall:9,shell:9,ship:11,should:2,show:[0,7,10,11],simpl:9,sinc:9,skip:[0,7,11],slightli:[0,7,11],softwar:9,some:9,sort:7,sourc:[3,5],special:9,specif:3,specifi:[3,7],split_git_respons:3,sponsor:9,stabl:5,stage:[0,7,9,10,11],stagingrunn:3,standard:7,stash:[9,10],statu:[7,10],step:2,sternberg:1,steve:9,still:9,string:3,style:[7,9],subset:2,substitut:3,succe:7,success:3,supersed:3,support:2,sure:2,syntax:9,system:[2,9],tabl:3,tag:2,take:3,taken:11,tarbal:6,termin:6,test:2,test_git_lint:2,text:[3,7],thei:[0,2,7,11],them:2,thi:[2,3,6,7,9,10,11],those:[0,3,7,11],through:[2,6],time:9,timestamp:[9,10,11],token:7,tortiou:9,touch:10,tox:2,travi:2,troubleshoot:2,tupl:3,understand:9,understood:9,unfindable_filenam:3,unlintable_filenam:3,unstag:10,updat:2,upon:9,usage:5,used:9,user:[3,9,10],usr:11,vcs:9,verbos:[0,7,11],vers:7,version:[0,2,3,4,7,11],virtualenv:2,virtualenvwrapp:2,volunt:2,wai:[2,9],want:[2,9],warranti:9,web:2,websit:2,welcom:2,well:9,were:9,what:[0,7,9,10,11],whatev:9,whatsoev:9,when:[2,7,9],whether:[2,9],which:[3,7,10],whoever:2,why:[1,9],without:9,work:[2,7,9],workspac:[0,7,9,10,11],workspacerunn:3,would:[0,2,7,11],wrapper:9,wrong:9,yet:1,you:[2,6,7,9],your:[2,6,7,9,11],your_name_her:2,zero:7},titles:["<no title>","Credits","Contributing","git_lint package","History","Welcome to Git Lint’s documentation!","Installation","git-lint(1)","git_lint","Git Lint: README","Strategies","Usage"],titleterms:{acknowledg:9,bug:2,command:11,commit:11,configuration:7,content:[3,11],contribut:2,contributor:1,credit:1,description:7,develop:1,disclaim:9,document:[2,5,9],featur:[2,9],feedback:2,fix:2,from:6,get:2,git:[5,7,9],git_lint:[3,8],guidelin:2,histori:4,hook:11,implement:2,indice:5,install:9,installat:6,lead:1,line:11,lint:[5,7,9],modul:3,name:7,option:[3,11],option_handl:3,options:7,output:7,packag:3,pre:11,pull:2,readme:9,releas:6,report:[2,3],request:2,sourc:6,stabl:6,start:2,strategi:10,submit:2,submodul:3,synopsis:7,tabl:5,tip:2,type:2,usage:[9,11],welcom:5,write:2}}) \ No newline at end of file +Search.setIndex({envversion:49,filenames:["arguments","authors","contributing","git_lint","history","index","installation","manual","modules","readme","strategies","usage"],objects:{"":{git_lint:[3,0,0,"-"]},"git_lint.git_lint":{Linters:[3,1,1,""],MatchFilter:[3,1,1,""],StagingRunner:[3,1,1,""],WorkspaceRunner:[3,1,1,""],executable_exists:[3,4,1,""],find_config_file:[3,4,1,""],get_filelist:[3,4,1,""],get_git_base:[3,4,1,""],get_git_head:[3,4,1,""],get_git_response:[3,4,1,""],get_git_response_raw:[3,4,1,""],get_linter_status:[3,4,1,""],get_shell_response:[3,4,1,""],get_working_linter_names:[3,4,1,""],load_config:[3,4,1,""],run_git_command:[3,4,1,""],run_linters:[3,4,1,""],split_git_response:[3,4,1,""]},"git_lint.git_lint.Linters":{dryrun:[3,2,1,""],encode_shell_messages:[3,3,1,""],run_external_linter:[3,3,1,""],run_one_linter:[3,3,1,""]},"git_lint.git_lint.MatchFilter":{make_match_filter_matcher:[3,3,1,""]},"git_lint.option_handler":{cleanup_options:[3,4,1,""]},"git_lint.reporters":{base_file_cleaner:[3,4,1,""],group_by:[3,4,1,""],print_help:[3,4,1,""],print_linters:[3,4,1,""],print_report:[3,4,1,""],print_version:[3,4,1,""]},git_lint:{git_lint:[3,0,0,"-"],option_handler:[3,0,0,"-"],options:[3,0,0,"-"],reporters:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","staticmethod","Python static method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:staticmethod","4":"py:function"},terms:{"boolean":3,"class":3,"default":[0,7,10,11],"function":2,"long":[0,3,7,11],"new":[2,5],"public":6,"return":[3,7],"short":[0,7,11],"static":3,"true":[3,7],"while":9,about:2,accordingli:9,acknowledg:5,action:9,actual:[0,7,11],add:[2,10],against:[3,5,7,9],agre:9,all:[0,2,7,9,10,11],allow:3,along:3,alpha:9,alphanumer:7,also:9,alwai:2,ani:[3,7,9,10],any:2,anyth:[0,2,7,9,11],appear:[0,3,7,11],appreci:2,appropri:10,area:[0,5,7,9,11],argument:3,aris:9,articl:2,asciibetic:7,aside:7,associ:9,assum:9,assume:2,assur:5,author:9,automat:[5,9],avail:9,base:[0,3,7,9,10,11],base_file_clean:3,been:9,befor:[2,7],best:2,better:9,bin:11,bit:2,blog:2,both:9,branch:2,broken:9,broken_linter_nam:3,bugfix:2,build:9,byfil:[0,7,11],bylint:[0,3,7,11],can:[2,6,7,9,11],cant_lint_filenam:3,captur:10,care:11,central:9,chang:[0,2,5,7,9,10,11],check:[0,2,7,9,11],checker:9,checkout:2,chmod:11,choos:7,cleanup_opt:3,clone:[2,6,9],cmake:9,cmd:3,code:[3,7,9],com:[1,2,6,9],combin:3,comma:[0,7,11],command:[3,5,6,7,9,10],commandlin:3,comment:7,commit:[0,2,4,5,7,9,10],complet:[7,9],complex:9,condit:[3,7],config:[0,3,7,10,11],configur:[0,3,7,9,10,11],confus:9,connect:9,consequenti:9,contract:9,copi:[2,6,9],correspond:10,could:2,coupl:10,creat:[2,3,9],criteria:10,curl:6,current:[0,3,5,7,9,10,11],custom:9,damag:9,data:9,deem:9,delta:10,descript:2,detail:[2,7],determin:10,dictionari:3,differ:[7,10],direct:9,directli:9,directori:[0,3,6,7,9,10,11],directroi:10,disclaim:5,doc:[2,9],docstr:2,don:[0,6,7,9,11],done:2,down:[0,7,9,10,11],download:[6,11],driven:2,dryrun:[0,3,7,11],each:[3,7,9,10],easier:2,edit:9,either:[6,9],elf:1,elfsternberg:[2,6,9],encode_shell_messag:3,ensur:9,entir:9,error:[3,7],even:[2,7],event:9,everi:[0,2,7,11],everyth:9,exampl:6,exclud:[0,7,11],executable_exist:3,exit:10,experiment:11,explain:2,extens:[3,7,9],extra:3,extract:3,fact:9,fail:[0,3,7,10,11],failur:[3,7,10],field_id:3,file:[0,2,3,5,6,7,9,10,11],filenam:[3,7,11],filter:[3,10],find_config_fil:3,first:[0,1,7,11],fit:9,flake8:2,flip:7,follow:7,fork:2,found:3,free:9,from:[0,3,5],fullcmd:3,get_filelist:3,get_git_bas:3,get_git_head:3,get_git_respons:3,get_git_response_raw:3,get_linter_statu:3,get_shell_respons:3,get_working_linter_nam:3,git:[0,2,3,4],git_dir:[0,7,11],git_lint:2,github:[2,6,9,11],given:2,global:9,gmail:1,greatli:2,group:[0,7,11],group_bi:3,grunt:9,guid:6,have:[0,2,3,6,7,9,11],hell:4,help:[0,2,3,7,11],here:2,highli:9,home:[3,6,9,10],hook:[5,9],how:[2,9],http:[2,6,9],ide:9,identifi:[5,9],impli:9,includ:[2,7,9],index:5,indirect:9,individu:9,inform:[0,7,11],ini:7,inspir:9,instal:[2,6,9],install:[2,5],installat:5,issu:2,iter:3,just:[0,2,7,9,11],keep:[2,3],kenneth:1,label:3,let:7,letter:3,liabl:9,licens:9,life:9,like:9,line:[3,5,7,9,10],lint:[0,2,3,4],linter:[0,3,5,6,7,9,10,11],linter_nam:3,list:[0,2,3,7,10,11],littl:2,load:[3,10],load_config:3,local:2,locat:3,look:2,loss:9,mai:[6,9],make:[2,9],make_match_filter_match:3,mani:2,master:6,match:[3,7,10],matchfilt:3,materi:9,maxim:7,meet:2,merchant:9,messag:[0,3,7,10,11],might:[2,9],minu:7,mit:9,mkvirtualenv:2,mode:10,more:[0,2,7,11],most:9,mostli:9,move:4,name:[2,3],narrow:2,need:9,neglig:9,none:1,noth:3,now:2,npm:9,object:3,offici:2,once:6,one:3,onli:[0,3,7,9,10,11],only:9,open:2,oper:2,order:7,org:2,origin:2,other:[2,9],otherwis:[3,9],ought:9,out:[4,9],output:3,overriden:9,own:9,page:5,param:3,part:2,pass:[0,2,7,10,11],path:[0,7,11],per:[3,9],perform:[3,9],person:9,phase:10,pip:[2,6,9],plan:9,pleas:[2,6,11],possibl:[2,9],post:2,pre:[0,4,5,7,9,10],prefix:[3,7],print:[0,7,10,11],print_help:3,print_lint:3,print_report:3,print_vers:3,priorit:3,process:[3,6],produc:[0,7,11],profit:9,program:[5,9],project:[2,3,9,11],propos:2,provid:[5,9],prune:10,pulec:9,pull_request:2,push:2,put:2,pypi:2,python:[2,6,9],qualiti:[5,9],quiet:[0,7,11],readi:2,readme:[2,5],reason:9,receiv:3,recent:9,record:10,reduc:10,releas:5,rememb:2,replac:3,repo:[2,6,9],repodir:3,report:0,repositori:[3,5,6,7,9,10,11],reproduc:2,requir:9,restor:[9,10],result:[3,7,9,10],risk:9,root:3,rst:2,run:[0,2,3,5,6,7,9,10,11],run_external_lint:3,run_git_command:3,run_lint:3,run_one_lint:3,safeconfigpars:3,same:9,scan:[0,7,11],scope:2,script:3,search:5,second:[0,7,11],section:7,send:2,separ:[0,7,11],set:[2,3,7,9],setup:[2,6,9],shall:9,shell:9,should:2,show:[0,7,10,11],simpl:9,sinc:9,skip:[0,7,11],slightli:[0,7,11],softwar:9,some:9,sort:7,sourc:[3,5],special:9,specif:3,specifi:[3,7],split_git_respons:3,sponsor:9,stabl:5,stage:[0,5,7,9,10,11],stagingrunn:3,standard:7,stash:[9,10],statu:[7,10],step:2,sternberg:1,steve:9,still:9,string:3,style:[5,7,9],subset:2,substitut:3,succe:7,success:3,supersed:3,support:2,sure:2,syntax:[5,9],system:[2,9],tabl:3,tag:2,take:3,tarbal:6,termin:6,test:2,test_git_lint:2,text:[3,7],thei:[0,2,7,11],them:2,thi:[2,3,6,7,9,10],those:[0,3,7,11],through:[2,6],time:9,timestamp:[9,10],token:7,tortiou:9,touch:10,tox:2,travi:2,troubleshoot:2,tupl:3,understand:9,understood:9,unfindable_filenam:3,unlintable_filenam:3,unstag:10,updat:2,upon:9,usage:5,used:9,user:[3,9,10],vcs:9,verbos:[0,7,11],vers:7,version:[0,2,3,4,7,11],virtualenv:2,virtualenvwrapp:2,volunt:2,wai:[2,9],want:[2,9],warranti:9,web:2,websit:2,welcom:2,well:9,were:9,what:[0,7,9,10,11],whatev:9,whatsoev:9,when:[2,7,9],whether:[2,9],which:[3,7,10],whoever:2,why:[1,9],without:9,work:[2,7,9],workspac:[0,7,9,10,11],workspacerunn:3,would:[0,2,7,11],wrapper:9,wrong:9,yet:1,you:[2,6,7,9,11],your:[2,5,6,7,9],your_name_her:2,zero:7},titles:["<no title>","Credits","Contributing","git_lint package","History","Git Lint","Installation","git-lint(1)","git_lint","Git Lint: README","Strategies","Usage"],titleterms:{acknowledg:9,bug:2,command:11,commit:11,configuration:7,content:[3,11],contribut:2,contributor:1,credit:1,description:7,develop:1,disclaim:9,document:[2,9],featur:[2,9],feedback:2,fix:2,from:6,get:2,git:[5,7,9],git_lint:[3,8],guidelin:2,histori:4,hook:11,implement:2,indice:5,install:9,installat:6,lead:1,line:11,lint:[5,7,9],modul:3,name:7,option:[3,11],option_handl:3,options:7,output:7,packag:3,pre:11,pull:2,readme:9,releas:6,report:[2,3],request:2,sourc:6,stabl:6,start:2,strategi:10,submit:2,submodul:3,synopsis:7,tabl:5,tip:2,type:2,usage:[9,11],write:2}}) \ No newline at end of file diff --git a/sources/index.txt b/sources/index.txt index 6375eae..44135d7 100644 --- a/sources/index.txt +++ b/sources/index.txt @@ -3,8 +3,12 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Git Lint's documentation! -====================================== +Git Lint +======== + +Git Lint provides a new git command that automatically runs identifiable linters (style +and syntax quality assurance programs) against changed files in your current git +repository or staging area. Contents: diff --git a/sources/usage.txt b/sources/usage.txt index 6c09e7a..a1bb28b 100644 --- a/sources/usage.txt +++ b/sources/usage.txt @@ -17,20 +17,8 @@ Options As a pre-commit hook: --------------------- -.. code-block:: python +There's a file, pre-commit, in the /bin directory with the project. (Or you can download +it from the github repository.) Install it in you .git/hooks/pre-commit file, and +chmod +x .git/hooks/pre-commit. - #!/usr/bin/env python - import git_lint - git_lint.run_precommit(staging = True, timestamps = True) - -Install this file in your project's ``.git/hooks/pre-commit``, and set -the file's executable flag to ``true``: - -.. code-block:: shell - - chmod +x pre-commit - -Please see the :ref:`api` for more details on options taken by the -``run_precommit()`` and ``run_gitlint`` commands. - -There is an example ``pre-commit`` script shipped with ``git lint``. +The pre-commit hook is *experimental*. Please be careful with it. diff --git a/usage.html b/usage.html index 0e40992..f8394bb 100644 --- a/usage.html +++ b/usage.html @@ -108,19 +108,10 @@

    As a pre-commit hook:

    -
    #!/usr/bin/env python
-import git_lint
-git_lint.run_precommit(staging = True, timestamps = True)
-
    -
    -

    Install this file in your project’s .git/hooks/pre-commit, and set -the file’s executable flag to true:

    -
    chmod +x pre-commit
-
    -
    -

    Please see the api for more details on options taken by the -run_precommit() and run_gitlint commands.

    -

    There is an example pre-commit script shipped with git lint.

    +

    There’s a file, pre-commit, in the /bin directory with the project. (Or you can download +it from the github repository.) Install it in you .git/hooks/pre-commit file, and +chmod +x .git/hooks/pre-commit.

    +

    The pre-commit hook is experimental. Please be careful with it.