Merge pull request #5 from Bullfrog1234/expanded-config

Introduce new expanded configuration

Author: lupas

.gitignore

@@ -1,2 +1,4 @@
 node_modules
-rules/*
+rules/*
+rulez.config.js
+firebase.json

README.md

@@ -17,21 +17,45 @@ Give it a go and feel free to add additional helper functions to the repository!
 
 Make sure you have Node.js installed on your system (the newer, the better).
 
-## Setup
+## Installation
 
-1. Install firestore-rulez in the folder where your firestore.rules file needs to be generated:
+NPM:
 
 ```bash
 npm i firestore-rulez --save-dev
 ```
 
-2. Create a subfolder called `/rules`.
+yarn:
 
-3. Add as many .rules files to the folder as you like.
+```bash
+yarn add firestore-rulez --dev
+```
+
+# Basic Usage
+
+1. Create a subfolder called `/rules`.
+
+2. Add as many .rules files to the folder as you like.
+
+3. Generate firestore.rules via the following command in your console:
+
+```bash
+firestore-rulez
+```
+
+# Advanced Usage
 
-## Run
+1. Create [config file](#configuration-file-syntax) at project root
 
-## Generate firestore.rules file
+2. Generate .rules files and helper functions inline with config file
+
+3. Generate firestore.rules via the following command in your console:
+
+```bash
+firestore-rulez
+```
+
+## Generate rules file
 
 You can run Firestore-Rulez by hitting `firestore-rulez` in your CLI.
 
@@ -45,67 +69,130 @@ This will create the firestore.rules file combining your files in the following
 service cloud.firestore {
 	match /databases/{database}/documents {
 
-    // -> HELPER FUNCTIONS, if enabled
+    // -> LIBRARY HELPER FUNCTIONS, if enabled
+
+    // -> YOUR HELPER FUNCTIONS, if enabled
 
-    // -> YOUR FILES
+    // -> YOUR RULES FILES
 
   }
 }
 ```
 
-## Config
+# Configuration File Syntax
+
+Firestore-Rulez can be configured by adding a rulez.config.js file to the `project root` or `./rules` folders.
+
+The file is to export a object with the following syntax:
+
+| Field | Default Value | Type | Description |
+| ----- | --------------- | ----- | ------------- |
+| helpers | `["authUserEmail", "authUserEmailIsVerified", "authUserUid", "existingData", "hasAmtOfWriteFields", "incomingData", "isAuthenticated"]` | array(strings) \| boolean | used to add helper functions to the output, this can be `true` to include all helper functions or `false` to include non of the helper functions or an array of the [function names](#helper-functions) |
+| custom_helpers_folder | `null` | `null` \| string | path to user defined helper functions |
+| rules_version | `"1"` | `"1"` \| `"2"` \| `1` \| `2` | which version is the rules written in |
+| rules_folder | `"rules"` | string | folder where the rule fragments can be found |
+| rules_output | `"firestore.rules"` | string  | name of the file to output to |
+| use_firebase_config | `false` | boolean | use the firebase config file `firebase.json` to get the rules output file name and location |
 
-Firestore-Rulez can be configured by adding a rulez.config.js file to the `./rules` folder. At this point, the file can contain following settings:
+## Default Configuration File
 
 ```js
 module.exports = {
-  // Enables helper functions as specified below
-  helpers: false,
-  rules_version: '1'
-}
+  helpers: [
+    "authUserEmail",
+    "authUserEmailIsVerified",
+    "authUserUid",
+    "existingData",
+    "hasAmtOfWriteFields",
+    "incomingData",
+    "isAuthenticated",
+  ],
+  custom_helpers_folder: null,
+  rules_version: 1,
+  rules_folder: "rules",
+  rules_output: "firestore.rules",
+  use_firebase_config: false,
+};
 ```
 
 # Helper Functions
 
-The following helper functions are present, if the helpers option is enabled:
+The following helper functions are present, if the helpers option is enabled or the function is included:
+| name | description |
+| --- | ---|
+| isAuthenticated | Checks if user is authenticated |
+| authUserUid | Returns Current Auth User's Uid |
+| authUserEmail | Returns Current Auth User's Email |
+| authUserEmailIsVerified | Returns wether Current Auth User's Email is verified |
+| existingData | Returns the existing data |
+| incomingData | Returns the incoming data |
+| hasAmtOfWriteFields | Checks if the request has X write fields |
+
+Use the name of the functionin the rules files and in the configuration file to enable them in the configuration or set the helpers function to true to include them all.
+
+## isAuthenticated
 
 ```js
 // Checks if user is authenticated
 function isAuthenticated() {
-  return request.auth != null
+  return request.auth != null;
 }
+```
+
+## authUserUid
 
+```js
 // Returns Current Auth User's Uid
 function authUserUid() {
-  return request.auth.uid
+  return request.auth.uid;
 }
+```
+
+## authUserEmail
 
+```js
 // Returns Current Auth User's Email
 function authUserEmail() {
-  return request.auth.token.email
+  return request.auth.token.email;
 }
+```
+
+## authUserEmailIsVerified
 
+```js
 // Returns wether Current Auth User's Email is verified
 function authUserEmailIsVerified() {
-  return request.auth.token.email_verified
+  return request.auth.token.email_verified;
 }
+```
+
+## existingData
 
+```js
 // Returns the existing data
 function existingData() {
-  return resource.data
+  return resource.data;
 }
+```
 
+## incomingData
+
+```js
 // Returns the incoming data
 function incomingData() {
-  return request.resource.data
+  return request.resource.data;
 }
+```
 
+## hasAmtOfWriteFields
+
+```js
 // Checks if the request has X write fields
 function hasAmtOfWriteFields(size) {
-  return request.writeFields.size() == size
+  return request.writeFields.size() == size;
 }
 ```
 
-### Credits
+# Credits
 
 Thanks to [OneLunch Man](https://stackoverflow.com/users/10747134/onelunch-man) for inspiring me to build this module on Stack Overflow.

package-lock.json

@@ -18,8 +18,11 @@
     "access": "public"
   },
   "dependencies": {
+    "chalk": "^4.1.0",
     "concat": "^1.0.3",
-    "glob": "^7.1.6"
+    "figlet": "^1.5.0",
+    "glob": "^7.1.6",
+    "yup": "^0.29.3"
   },
   "bin": {
     "firestore-rulez": "./src/index.js"