Merge branch 'develop'

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGE-LOG
 
+## 0.3.0
+- Add `getFlavor` macro
+- Fix the unmet dependency warnings on installing the library
+
 ## 0.2.1
 - Update readme
 - Update description key in package.json

README.md

@@ -20,6 +20,8 @@ $ yarn add flavors.macro
 ```
 
 ## Usage
+
+### Flavors 
 A placholder for a flavor, called a flavor-key, needs to be configured. This key can be used in the import statements in the app. Against this key, flavors can be added.
 
 Add the following into the `.babel-plugin-macrosrc.json` at the root of the project.
@@ -42,7 +44,7 @@ You can then use the flavor-key in any class by adding the macro-key as the last
 ```js
 import flavors from 'flavors.macro'
 import Hello from './hello.layout-theme.js'
-import Bye from './hello.layout-theme'
+import Bye from './bye.layout-theme'
 // ... other imports
 
 // Add this right after all the imports are declared
@@ -52,13 +54,39 @@ When the application is built, the above class will evaluate to -
 
 ```js
 import Hello from './hello.green.js'
-import Bye from './hello.green'
+import Bye from './bye.green'
 // ... other imports
 ```
 
 NOTE: After adding/editing the configuration file(`.babel-plugin-macrosrc.json` or if any of the other equivalents being used), the npm server needs to be manually restarted.
 
 Multiple flavor-keys can be added to the `flavorsMap`. If there are no flavor-keys, then a default key `defaultFlavor` is assumed, which will be replaced by an empty string.
 
+### getFlavor
+If the difference between flavors is really small/subtle or if there is already existing code, in which the flavors need to be created for a small portion of it, creating separate files for all of the different flavors can be cumbersome. 
+
+The `getFlavor()` macro call-expression can be used to fetch the flavor for the corresponding flavor-key.
+
+So for the configuration from the above examples - 
+```js
+import { getFlavor } from 'flavors.macro'
+
+// ... Rest of the code
+var currFlavor = getFlavor("layout-theme")
+switch (currFlavor) {
+    case "green":
+        console.log("Using green flavor")
+        break;
+    case "red":
+        console.log("Using red flavor")
+        break;
+    case "":
+    default:
+        console.log("No such flavor found")
+}
+```
+`getFlavor` will return an empty string if the flavor-key is incorrect. 
+
+
 ## License
 MIT. See license file

example-app/package.json

@@ -31,4 +31,4 @@
             }
         }
     }
-}
+}

example-app/src/hello.green.js

@@ -1,11 +1,12 @@
 import React from 'react'
+import { getFlavor } from 'flavors.macro'
 
 export default class Hello extends React.Component {
     render() {
         document.body.style.background = "#0F0";
         return (
             <div style={{ color: "#F00" }}>
-                Hello green!
+                Hello {getFlavor("layout-theme")}!
             </div>
         )
     }