https://github.com/stagas/pull-configs

pulls configuration files from a remote location and merges them with local
https://github.com/stagas/pull-configs

config dotfiles package project scripts

Last synced: 6 days ago
JSON representation

pulls configuration files from a remote location and merges them with local

• Host: GitHub
• URL: https://github.com/stagas/pull-configs
• Owner: stagas
• License: mit
• Created: 2022-01-22T04:24:43.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-21T06:16:25.000Z (about 2 years ago)
• Last Synced: 2024-10-08T00:43:28.452Z (29 days ago)
• Topics: config, dotfiles, package, project, scripts
• Language: TypeScript
• Homepage:
• Size: 21.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


pull-configs    





pulls configuration files from a remote location and merges them with local





npm i pull-configs 


pnpm add pull-configs 

yarn add pull-configs

## API

  #  pullConfigs(remote, local)      src/index.ts#L22  
    
    #  remote        


string
        
#  local        


string
        
  


pullConfigs(remote, local)   =>  

{
  #  assign      src/index.ts#L89  


{

    #  target        


T
        
#  source        


U
        
  


<T, U>(target, source)   =>  



T & U



  #  target        


T
        

#  source1        


U
        

#  source2        


V
        
  
<T, U, V>(target, source1, source2)   =>  



T & U & V





  #  target        


T
        
#  source1        


U
        
#  source2        


V
        
#  source3        


W
        
  
<T, U, V, W>(target, source1, source2, source3)   =>  


T & U & V & W

  #  target        


object
        
#  sources        


any  []
        
  
(target, sources)   =>  
any
}        #  merge      src/index.ts#L89  


#  (file, replacer)        
    
    #  file        


string
        
#  replacer(prev, next)        
    
    #  prev        


any
        
#  next        


any
        
  


replacer(prev, next)   =>  

void



    
  
(file, replacer)   =>  


Promise<void>
            #  omit      src/index.ts#L89  


#  (obj, keys)        
    
    #  obj        


Record<string, any>
        
#  keys        


string  []
        
  


(obj, keys)   =>  



Record<string, any>

    
        #  pick      src/index.ts#L89  


#  (obj, keys)        
    
    #  obj        


Record<string, any>
        
#  keys        


string  []
        
  


(obj, keys)   =>  



Record<string, any>

    
        #  replace      src/index.ts#L89  


#  (file)        
    
    #  file        


string
        
  


(file)   =>  



Promise<void>

    
        #  sort      src/index.ts#L89  


#  (data)        
    
    #  data        


any
        
  


(data)   =>  

any

    
        }    #  pullConfigs(remote, local)      src/index.ts#L22  
    
    #  remote        


string
        
#  local        


string
        
  


pullConfigs(remote, local)   =>  

{
  #  assign      src/index.ts#L89  


{

    #  target        


T
        
#  source        


U
        
  


<T, U>(target, source)   =>  



T & U



  #  target        


T
        

#  source1        


U
        

#  source2        


V
        
  
<T, U, V>(target, source1, source2)   =>  



T & U & V

  #  target        


T
        

#  source1        


U
        

#  source2        


V
        

#  source3        


W
        
  
<T, U, V, W>(target, source1, source2, source3)   =>  



T & U & V & W

  #  target        


object
        

#  sources        


any  []
        
  
(target, sources)   =>  

any
}        

#  merge      src/index.ts#L89  


#  (file, replacer)        
    
    #  file        


string
        
#  replacer(prev, next)        
    
    #  prev        


any
        
#  next        


any
        
  


replacer(prev, next)   =>  

void



    
  
(file, replacer)   =>  


Promise<void>
            #  omit      src/index.ts#L89  


#  (obj, keys)        
    
    #  obj        


Record<string, any>
        
#  keys        


string  []
        
  


(obj, keys)   =>  



Record<string, any>

    
        #  pick      src/index.ts#L89  


#  (obj, keys)        
    
    #  obj        


Record<string, any>
        
#  keys        


string  []
        
  


(obj, keys)   =>  



Record<string, any>

    
        #  replace      src/index.ts#L89  


#  (file)        
    
    #  file        


string
        
  


(file)   =>  



Promise<void>

    
        #  sort      src/index.ts#L89  


#  (data)        
    
    #  data        


any
        
  


(data)   =>  

any

    
        }    


## Credits

- [json-diff](https://npmjs.org/package/json-diff) by [Andrey Tarantsov](https://github.com/andreyvit) – JSON diff

## Contributing

[Fork](https://github.com/stagas/pull-configs/fork) or [edit](https://github.dev/stagas/pull-configs) and submit a PR.

All contributions are welcome!

## License

MIT © 2022 [stagas](https://github.com/stagas)