refactoring

Author: pgajek2

.eslintignore

@@ -1,13 +1,23 @@
-# This file is used for Git repositories to specify intentionally untracked files that Git should ignore. 
+# This file is used for Git repositories to specify intentionally untracked files that Git should ignore.
 # If you are not using git, you can delete this file. For more information see: https://git-scm.com/docs/gitignore
 # For useful gitignore templates see: https://github.com/github/gitignore
 
+# IDE
+.idea/
+.project/
+.nx-cache
+.vscode/
+.prettierrc
+
 # Salesforce cache
 .sf/
 .sfdx/
 .localdevserver/
 deploy-options.json
 
+# CumulusCI
+.cci/
+
 # LWC VSCode autocomplete
 **/lwc/jsconfig.json
 
@@ -20,6 +30,7 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+-local-*
 
 # Dependency directories
 node_modules/
@@ -37,4 +48,10 @@ ehthumbs.db
 $RECYCLE.BIN/
 
 # Local environment variables
-.env
+.env
+
+# SOQL Query Results
+**/scripts/soql/query-results
+
+#Private keys
+*.key

.forceignore

@@ -1,9 +1,27 @@
-[More details TBD]
-
 # Consts
 
 The framework that allows keeping your apex's consts in an ordered way.
 
+## Example
+
+```java
+Account acc = new Account(
+    Name = 'My Account',
+    Type = Consts.ACCOUNT.TYPE.PROSPECT,
+    Rating = Consts.ACCOUNT.RATING.HOT
+);
+```
+
+```java
+System.debug(Consts.ACCOUNT.TYPE.PROSPECT); // 'Prospect'
+System.debug(Consts.ACCOUNT.RATING.HOT); // 'Hit'
+
+System.debug(Consts.CONTACT.API_NAME); // 'Contact'
+System.debug(Consts.CONTACT.LEAD_SOURCE.WEB); // 'Web'
+
+System.debug(Consts.OPPORTUNITY.TYPE.EXISTING_CUSTOMER_DOWNGRADE); // 'Existing Customer - Downgrade'
+```
+
 ## How it works?
 
 All concrete classes are created as a *singleton*, so each class is initialized once during the transaction. To decrease heap size getters and setters are in use. It means that class will be *initialized on demand*, not always. e.g execution of `Consts.ACCOUNT.TYPE.PROSPECT` will create instance of `AccountConsts` only, without creating `ContactConsts`.
@@ -12,12 +30,36 @@ Code Architecture is following *Open/Close* and *Single Responsibility Principle
 
 ## How to use?
 
+### Create concrete consts class
+
+- Create `INSTANCE` variable to keep class instance (singleton).
+- Create inner classes to order values.
+
 ```java
-    System.debug(Consts.ACCOUNT.TYPE.PROSPECT); // 'Prospect'
-    System.debug(Consts.ACCOUNT.RATING.HOT); // 'Hit'
+public class ContactConsts {
+    public static final ContactConsts INSTANCE = new ContactConsts();
+
+    public final String API_NAME = Contact.sObjectType.getDescribe().getName();
+
+    public final Status STATUS = new Status();
 
-    System.debug(Consts.CONTACT.API_NAME); // 'Contact'
-    System.debug(Consts.CONTACT.LEAD_SOURCE.WEB); // 'Web'
+    public class Status {
+        public final String IN_APPROVAL_PROCESS = 'In Approval Process';
+        public final String ACTIVATED = 'Activated';
+        public final String DRAFT = 'Draft';
+    }
+}
+```
+
+### Add concrete consts class to `Consts`
+
+```java
+public class Consts {
 
-    System.debug(Consts.OPPORTUNITY.TYPE.EXISTING_CUSTOMER_DOWNGRADE); // 'Existing Customer - Downgrade'
+    public static final ContactConsts CONTACT {
+        get {
+            return ContactConsts.INSTANCE;
+        }
+    }
+}
 ```

.gitignore

@@ -1,4 +1,4 @@
-public with sharing class Consts {
+public class Consts {
 
     public static final AccountConsts ACCOUNT {
         get {

.prettierignore

@@ -0,0 +1,23 @@
+@IsTest
+public class ConstsTest {
+
+    @IsTest
+    static void accountConsts() {
+        Assert.areNotEqual(null, Consts.ACCOUNT);
+    }
+
+    @IsTest
+    static void contactConsts() {
+        Assert.areNotEqual(null, Consts.CONTACT);
+    }
+
+    @IsTest
+    static void opportunityConsts() {
+        Assert.areNotEqual(null, Consts.OPPORTUNITY);
+    }
+
+    @IsTest
+    static void profileConsts() {
+        Assert.areNotEqual(null, Consts.PROFILE);
+    }
+}