Class: GitCommitFooter

Inherits:
Object
  • Object
show all
Defined in:
sig/kettle/dev/git_commit_footer.rbs

Constant Summary collapse

NAME_ASSIGNMENT_REGEX =

Returns:

  • (::Regexp) 

      
        
        

      
        
SENTINEL =
          

  

    

  





  

Returns:


    
  
    
  • 
      
      
        (String, nil)
      
      
      
    
    • 
  





        

        

      
    

  







  
    

      Class Method Summary
      collapse
    


    
    
  
    

      Instance Method Summary
      collapse
    


    
    
  



  
Constructor Details

  
    

  

  
    #initialize  ⇒ GitCommitFooter 
  

  

  




  

    
Returns a new instance of GitCommitFooter.


  





  



  

    
      


14

    		
    
      
# File 'sig/kettle/dev/git_commit_footer.rbs', line 14

def initialize: () -> void

    		
  





  




  

    
Class Method Details


    
      

  

  
    .commit_goalie_path  ⇒ String 
  

  

  




  

    

  





  

Returns:


    
  
    
  • 
      
      
        (String)
      
      
      
    
    • 
  





  

    
      


10

    		
    
      
# File 'sig/kettle/dev/git_commit_footer.rbs', line 10

def self.commit_goalie_path: () -> String

    		
  





    
      

  

  
    .git_toplevel  ⇒ String? 
  

  

  




  

    

  





  

Returns:


    
  
    
  • 
      
      
        (String, nil)
      
      
      
    
    • 
  





  

    
      


6

    		
    
      
# File 'sig/kettle/dev/git_commit_footer.rbs', line 6

def self.git_toplevel: () -> String?

    		
  





    
      

  

  
    .global_hooks_dir  ⇒ String 
  

  

  




  

    

  





  

Returns:


    
  
    
  • 
      
      
        (String)
      
      
      
    
    • 
  





  

    
      


8

    		
    
      
# File 'sig/kettle/dev/git_commit_footer.rbs', line 8

def self.global_hooks_dir: () -> String

    		
  





    
      

  

  
    .goalie_allows_footer?  ⇒ Boolean 
  

  

  




  

    

  





  
Parameters:


    
  
    
  • 
      
        subject_line
      
      
        (String)
      
      
      
    
    • 
  




Returns:


    
  
    
  • 
      
      
        (Boolean)
      
      
      
    
    • 
  





  

    
      


11

    		
    
      
# File 'sig/kettle/dev/git_commit_footer.rbs', line 11

def self.goalie_allows_footer?: (String subject_line) -> bool

    		
  





    
      

  

  
    .hooks_path_for  ⇒ String 
  

  

  




  

    

  





  
Parameters:


    
  
    
  • 
      
        filename
      
      
        (String)
      
      
      
    
    • 
  




Returns:


    
  
    
  • 
      
      
        (String)
      
      
      
    
    • 
  





  

    
      


9

    		
    
      
# File 'sig/kettle/dev/git_commit_footer.rbs', line 9

def self.hooks_path_for: (String filename) -> String

    		
  





    
      

  

  
    .local_hooks_dir  ⇒ String? 
  

  

  




  

    

  





  

Returns:


    
  
    
  • 
      
      
        (String, nil)
      
      
      
    
    • 
  





  

    
      


7

    		
    
      
# File 'sig/kettle/dev/git_commit_footer.rbs', line 7

def self.local_hooks_dir: () -> String?

    		
  





    
      

  

  
    .render  ⇒ void 
  

  

  




  

    
This method returns an undefined value.


  





  
Parameters:


    
  
    
  • 
      
        
      
      
        (Array[String])
      
      
      
    
    • 
  






  

    
      


12

    		
    
      
# File 'sig/kettle/dev/git_commit_footer.rbs', line 12

def self.render: (*Array[String]) -> void

    		
  





    
  


  

    
Instance Method Details


    
      

  

  
    #render  ⇒ String 
  

  

  




  

    

  





  

Returns:


    
  
    
  • 
      
      
        (String)
      
      
      
    
    • 
  





  

    
      


15

    		
    
      
# File 'sig/kettle/dev/git_commit_footer.rbs', line 15

def render: () -> String