com.facebook.buck.support.cli.config

Class BuckConfigWriter

java.lang.Object

com.facebook.buck.support.cli.config.BuckConfigWriter

public class BuckConfigWriter
extends Object

Simple class that writes out the BuckConfig to a file for a specific invocation

Method Summary

Modifier and Type	Method and Description
static void	writeConfig(Path rootPath, InvocationInfo info, BuckConfig config) Writes the configuration out to a standard location as json for a specific command

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

writeConfig

public static void writeConfig(Path rootPath,
                               InvocationInfo info,
                               BuckConfig config)
                        throws IOException

Writes the configuration out to a standard location as json for a specific command

Currently this is of the form:

   {
     "settings": {
       "section": {
         "key": "value"
         "key2": "value2"
       },
       "other_section": {
         "key3": "value3",
         "key4": "true"
     }
   }
 

In the future, the source of each setting will be visible with a structure like this:

   {
     "settings": {
       "section": {
         "key": "value"
         "key2": "value2"
       },
       "other_section": {
         "key3": "value3",
         "key4": "true"
     },
     "sources": {
       "$path_to_config_file": {
         "section": {
           "key": "value"
           "key2": "value2"
         }
       }
     }
   }
 

Parameters:

rootPath - The root of the project that contains buck-out

info - The invocation info. Used to find the log directories to write into

config - The configuration to write to disk

Throws:

IOException - The file could not be written to