New Log__c & LoggerSettings__c fields

.eslintrc.json

@@ -12,15 +12,66 @@
     "plugins": ["@lwc/eslint-plugin-lwc", "@salesforce/eslint-plugin-aura"],
     "extends": ["@salesforce/eslint-config-lwc/recommended"],
     "rules": {
-        "eqeqeq": "warn",
-        "no-console": "off",
-        "no-unused-expressions": "warn",
-        "semi": "warn",
         "@lwc/lwc/consistent-component-name": "error",
-        "@lwc/lwc/no-api-reassignments": "off",
-        "@lwc/lwc/no-async-operation": "warn",
+        "@lwc/lwc/no-api-reassignments": "error",
+        "@lwc/lwc/no-async-operation": "error",
+        "@lwc/lwc/no-attributes-during-construction": "error",
         "@lwc/lwc/no-deprecated": "error",
         "@lwc/lwc/no-document-query": "error",
-        "@lwc/lwc/valid-api": "error"
+        "@lwc/lwc/no-dupe-class-members": "error",
+        "@lwc/lwc/no-inner-html": "error",
+        "@lwc/lwc/no-leading-uppercase-api-name": "error",
+        "@lwc/lwc/prefer-custom-event": "error",
+        "@lwc/lwc/valid-api": "error",
+        "array-callback-return": "error",
+        "consistent-return": "error",
+        "default-case": "error",
+        "eqeqeq": "error",
+        "guard-for-in": "error",
+        "handle-callback-err": "error",
+        "no-alert": "error",
+        "no-caller": "error",
+        "no-confusing-arrow": "error",
+        "no-console": "error",
+        "no-else-return": "error",
+        "no-extend-native": "error",
+        "no-extra-bind": "error",
+        "no-floating-decimal": "error",
+        "no-implied-eval": "error",
+        "no-iterator": "error",
+        "no-label-var": "error",
+        "no-labels": "error",
+        "no-loop-func": "error",
+        "no-multi-str": "error",
+        "no-new-func": "error",
+        "no-new-object": "error",
+        "no-new-wrappers": "error",
+        "no-new": "error",
+        "no-octal-escape": "error",
+        "no-proto": "error",
+        "no-return-assign": "error",
+        "no-return-await": "error",
+        "no-script-url": "error",
+        "no-self-compare": "error",
+        "no-sequences": "error",
+        "no-shadow-restricted-names": "error",
+        "no-shadow": "error",
+        "no-throw-literal": "error",
+        "no-undef-init": "error",
+        "no-unused-expressions": "error",
+        "no-unused-vars": "error",
+        "no-use-before-define": "error",
+        "no-useless-computed-key": "error",
+        "no-useless-concat": "error",
+        "no-useless-constructor": "error",
+        "no-useless-escape": "error",
+        "no-useless-rename": "error",
+        "no-useless-return": "error",
+        "no-void": "error",
+        "no-with": "error",
+        "radix": "error",
+        "semi": "error",
+        "vars-on-top": "error",
+        "wrap-iife": "error"
     }
 }

.github/workflows/deploy.yml

@@ -5,6 +5,7 @@ on:
     push:
         branches:
             - main
+            - 'devops/**'
         paths-ignore:
             - 'content/**'
             - 'docs/**'
@@ -14,7 +15,7 @@ on:
             - '.gitignore'
             - '.prettierignore'
             - '.prettierrc'
-            - 'Contributing.md'
+            - 'CONTRIBUTING.md'
             - 'LICENSE'
             - 'package.json'
             - 'README.md'
@@ -31,7 +32,7 @@ on:
             - '.gitignore'
             - '.prettierignore'
             - '.prettierrc'
-            - 'Contributing.md'
+            - 'CONTRIBUTING.md'
             - 'LICENSE'
             - 'package.json'
             - 'README.md'
@@ -40,7 +41,7 @@ on:
 
 jobs:
     code-quality-tests:
-        name: 'Code Quality Tests'
+        name: 'Run Code Quality Tests'
         runs-on: ubuntu-latest
         environment: Test
         steps:
@@ -64,17 +65,29 @@ jobs:
             - name: 'Install Salesforce CLI'
               run: npm install sfdx-cli --global
 
-            - name: 'LWC Lint verification'
+            - name: 'Verify package version number is updated'
+              run: |
+                  echo ${{ env.DEVHUB_SFDX_URL }} > ./DEVHUB_SFDX_URL.txt
+                  sfdx auth:sfdxurl:store --sfdxurlfile ./DEVHUB_SFDX_URL.txt --setalias nebula-logger-packaging --setdefaultdevhubusername
+                  rm ./DEVHUB_SFDX_URL.txt
+                  npm run package:version:number:verify
+              env:
+                  DEVHUB_SFDX_URL: ${{ secrets.DEVHUB_SFDX_URL }}
+
+            - name: 'Verify LWC with ESLint'
               run: npm run lint:verify
 
-            - name: 'Apex SFDX Scanner verification'
-              run: npm run prepare && npm run scan
+            - name: 'Verify Apex with SFDX Scanner'
+              run: npm run scan
+
+            - name: 'Verify docs are updated'
+              run: npm run docs:verify
 
-            - name: 'Prettier formatting verification'
+            - name: 'Verify formatting with Prettier'
               run: npm run prettier:verify
 
     lwc-tests:
-        name: 'LWC Tests'
+        name: 'Run LWC Tests'
         needs: [code-quality-tests]
         runs-on: ubuntu-latest
         environment: Test
@@ -106,7 +119,7 @@ jobs:
                   flags: LWC
 
     scratch-org-tests:
-        name: 'Scratch Org Tests'
+        name: 'Run Scratch Org Tests'
         needs: [code-quality-tests]
         runs-on: ubuntu-latest
         environment: Test
@@ -181,15 +194,17 @@ jobs:
               run: npm run org:delete:noprompt
               if: ${{ always() }}
 
-    create-and-install-test-package-version:
-        name: 'Create & Install Test Package Version'
+    create-and-install-package-version:
+        name: 'Create & Install Package Version'
         needs: [lwc-tests, scratch-org-tests]
         if: ${{ github.event_name == 'pull_request' }}
         runs-on: ubuntu-latest
         environment: Test
         steps:
             - name: 'Checkout source code'
               uses: actions/checkout@v2
+              with:
+                  ref: ${{ github.event.pull_request.head.ref }}
 
             - name: 'Restore node_modules cache'
               id: cache-npm
@@ -222,11 +237,14 @@ jobs:
                   sfdx auth:sfdxurl:store --sfdxurlfile ./DEVHUB_SFDX_URL.txt --setalias nebula-logger-packaging --setdefaultdevhubusername
                   sfdx auth:sfdxurl:store --sfdxurlfile ./NEBULA_PKG_DEMO_SANDBOX_SFDX_URL.txt --setalias nebula-logger-package-demo
 
-            - name: 'Create & Install Unvalidated Package Version'
-              run: npx pwsh ./scripts/create-and-install-unvalidated-package-version.ps1 -targetusername nebula-logger-package-demo
+            - name: 'Create & Install Package Version'
+              run: npx pwsh ./scripts/build/create-and-install-package-version.ps1 -targetusername nebula-logger-package-demo
 
-            - name: 'Reinstall Latest Released Package Version'
-              run: npx pwsh ./scripts/install-latest-released-unlocked-package-version.ps1 -targetusername nebula-logger-package-demo
-
-            - name: 'Delete Unvalidated Package Version'
-              run: npx pwsh ./scripts/delete-unvalidated-package-version.ps1
+            - name: 'Commit New Package Version'
+              run: |
+                  git config --local user.email "[email protected]"
+                  git config --local user.name "GitHub Action Bot"
+                  npx prettier --write ./sfdx-project.json
+                  git add ./sfdx-project.json
+                  git commit -m "Created new package version"
+                  git push

CONTRIBUTING.md

@@ -1,9 +1,27 @@
-# Contributing / Development
+# Contributing
 
-Contributions to Nebula Logger are welcome, however we ask that Apex Prettier be run on prior to any pull requests being submitted to this repo.
+Contributions to Nebula Logger are welcome - following these guidelines will help make it easier & faster to review & merge any changes you want to contribute. When contributing, the typical process is:
 
-When developing, to get started:
+1. Familiarize yourself with the codebase - you can check out the [wiki](https://github.com/jongpie/NebulaLogger/wiki) and the [Apex docs site](https://jongpie.github.io/NebulaLogger/) to learn more about the code.
+2. Before starting your work, create a new issue (or add a comment to an existing issue you want to contribute to) so that we can keep track of who is actively working on an item.
+3. Fork this repository.
+4. Create a `feature` or `bugfix` branch in your fork based on the `main` branch.
+5. Edit the code/metadata in your fork.
+6. Send us a pull request when you are done. We'll review your code, provide feedback for any suggestions or required changes, and then merge it when everything is ready.
 
--   run `npm -i` or `npm install` or `yarn` to grab the latest version of our dependencies
--   when using VS Code: ensure that your "Format On Save" editor option is set to `true` (in `settings.json`: `"editor.formatOnSave": true`)
--   all unit tests should be run and passing prior to submitting a PR
+# Development
+
+Once you're ready to start working on an issue, you can develop your changes in any scratch org, sandbox, or developer-edition org of your choosing. Using SFDX (Salesforce CLI), VS Code and npm are recommended - this repository includes several scripts and automations using these tools. However, you can use any tools that you prefer, so long as the resulting code changes still conform to the repository's coding standards.
+
+-   Clone your fork of the Nebula Logger repository locally
+-   Run `npm -i` or `npm install` to grab the latest version of our dependencies, and setup the repository's git hooks
+-   When committing your changes in `git`, the repository's git hooks automatically run to:
+    1. Automatically fix/standardize some quality standards - for example, all Apex files will automatically be formatted using `prettier`
+    2. Automatically verify coding standards - for example, all Apex files will be automatically scanned for PMD rule violations, based on the repository's configured PMD rules.
+-   Run all unit tests for LWC and Apex, and verify everything is passing prior to submitting a pull request
+
+# Pull Requests
+
+-   All pull requests should use the `main` branch as the base branch
+-   Your pull request should have a detailed description that describes your changes, and include any screenshots of noteworthy UI changes (when applicable)
+-   Pull request merging is restricted to only 'squash and merge'

README.md

@@ -5,15 +5,23 @@
 
 Designed for Salesforce admins, developers & architects. A robust logger for Apex, Lightning Components, Flow, Process Builder & Integrations.
 
-[![Install Unlocked Package](./content/btn-install-unlocked-package.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015kqtQAA)
-[![Install Managed Package](./content/btn-install-managed-package.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015keOQAQ)
+## Unlocked Package v4.6.10
+
+[![Install Unlocked Package](./content/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015l27QAA)
+[![Install Unlocked Package](./content/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015l27QAA)
 [![View Documentation](./content/btn-view-documentation.png)](https://jongpie.github.io/NebulaLogger/)
 
+## Managed Package v4.6.0
+
+[![Install Managed Package](./content/btn-install-managed-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015keOQAQ)
+[![Install Managed Package](./content/btn-install-managed-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015keOQAQ)
+[![View Milestone](./content/btn-view-managed-package-milestone.png)](https://github.com/jongpie/NebulaLogger/milestone/6)
+
 ---
 
 ## Features
 
-1. Easily add log entries via Apex, Lightning Components (lwc & aura), Flow & Process Builder to generate 1 consolidate log
+1. Easily add log entries via Apex, Lightning Components (lwc & aura), Flow & Process Builder to generate 1 consolidated, unified log
 2. Manage & report on logging data using the `Log__c` and `LogEntry__c` objects
 3. Leverage `LogEntryEvent__e` platform events for real-time monitoring & integrations
 4. Enable logging and set the logging level for different users & profiles using `LoggerSettings__c` custom hierarchy setting
@@ -683,8 +691,6 @@ Once you've created your Apex or Flow plugin(s), you will also need to configure
 -   'Logger Plugin' - use the custom metadata type `LoggerPlugin__mdt` to define your plugin, including the plugin type (Apex or Flow) and the API name of your plugin's Apex class or Flow
 -   'Logger Parameter' - use the custom metadata type `LoggerParameter__mdt` to define any configurable parameters needed for your plugin, such as environment-specific URLs and other similar configurations
 
-![Logger plugin: configuration](./content/slack-plugin-configuration.png)
-
 Note: the logger plugin framework is not available in the managed package due to some platform limitations & considerations with some of the underlying code. The unlocked package is recommended (instead of the managed package) when possible, including if you want to be able to leverage the plugin framework in your org.
 
 ### Beta Plugin: Slack Integration
@@ -698,7 +704,7 @@ The optional [Slack plugin](./nebula-logger-plugins/Slack/) leverages the Nebula
 
 Check out the [Slack plugin](./nebula-logger-plugins/Slack/) for more details on how to install & customize the plugin
 
-![Slack plugin: notification](./content/slack-plugin-notification.png)
+![Slack plugin: notification](./nebula-logger-plugins/Slack/.content/slack-plugin-notification.png)
 
 ---
 

config/pmd-ruleset.xml

@@ -14,31 +14,14 @@
       <exclude name="AvoidLogicInTrigger" />
     </rule>
     <rule ref="category/apex/codestyle.xml">
-      <exclude name="FieldNamingConventions" />
-      <exclude name="MethodNamingConventions" />
-      <exclude name="PropertyNamingConventions" />
-      <exclude name="VariableNamingConventions" />
     </rule>
     <rule ref="category/apex/design.xml">
-      <exclude name="AvoidDeeplyNestedIfStmts" />
-      <exclude name="CognitiveComplexity" />
-      <exclude name="CyclomaticComplexity" />
-      <exclude name="ExcessiveClassLength" />
-      <exclude name="ExcessiveParameterList" />
-      <exclude name="ExcessivePublicCount" />
-      <exclude name="NcssConstructorCount" />
-      <exclude name="NcssMethodCount" />
-      <exclude name="StdCyclomaticComplexity" />
-      <exclude name="TooManyFields" />
     </rule>
     <rule ref="category/apex/documentation.xml">
-      <exclude name="ApexDoc" />
     </rule>
     <rule ref="category/apex/errorprone.xml">
-      <exclude name="EmptyStatementBlock" />
     </rule>
     <rule ref="category/apex/performance.xml">
-      <exclude name="AvoidDebugStatements" />
     </rule>
     <rule ref="category/apex/security.xml">
     </rule>

docs/configuration/LoggerParameter.md

@@ -12,14 +12,24 @@ Provides a centralized way to load parameters for SObject handlers & plugins
 
 #### `CALL_STATUS_API` → `Boolean`
 
+Indicates if Logger will make an async callout to https://api.status.salesforce.com to get additional details about the current org, which is then stored on the Log\_\_c record. Controlled by the custom metadata record LoggerParamer.CallStatusApi @return The configured value, or `false` as the default
+
 #### `ENABLE_SYSTEM_MESSAGES` → `Boolean`
 
+Indicates if Logger will append its own log entries about the logging system. Controlled by the custom metadata record LoggerParamer.EnableLoggerSystemMessages @return The configured value, or `false` as the default
+
 #### `SYSTEM_DEBUG_MESSAGE_FORMAT` → `String`
 
+The merge-field syntax to use when calling System.debug(). Controlled by the custom metadata record LoggerParamer.SystebugMessageFormat @return The configured value, or `{OriginLocation__c}\n{Message__c}` as the default
+
 #### `TAGGING_IS_ENABLED` → `Boolean`
 
+Indicates if Logger's tagging system is enabled. Controlled by the custom metadata record LoggerParamer.EnableTagging @return The configured value, or `true` as the default
+
 #### `TAG_USING_TOPICS` → `Boolean`
 
+Indicates if Logger's tagging will use Topic and TopicAssignment for storing tags @return The configured value, or `false` as the default
+
 ---
 
 ### Methods

docs/logger-engine/ComponentLogger.md

@@ -104,6 +104,10 @@ The value to use as the log entry's message
 
 (Optional) The record ID to relate to the log entry
 
+###### `scenario` → `String`
+
+Optionally specify the name to use for the current transaction's scenario
+
 ###### `stack` → `String`
 
 The JavaScript stack trace from when the log entry was created
@@ -126,17 +130,21 @@ A DTO object used for passing `LoggerSettings__c` details to lightning component
 
 ##### Properties
 
+###### `isConsoleLoggingEnabled` → `Boolean`
+
+Indicates if logging via the browser's `console.log()` is enabled for the current user, based on `Logger.IsComponentConsoleLoggingEnabled__c`
+
 ###### `isEnabled` → `Boolean`
 
-Indicates if logging is enabled for the current user, based on `Logger.isEnabled()`
+Indicates if logging is enabled for the current user, based on `LoggerSettings__c.IsEnabled__c`
 
 ###### `supportedLoggingLevels` → `Map<String, Integer>`
 
 A map of the supported `LoggingLevel` enum values
 
 ###### `userLoggingLevel` → `ComponentLoggingLevel`
 
-The configured `LoggingLevel` for the current user, based on `Logger.getUserLoggingLevel()`
+The configured `LoggingLevel` for the current user, based on `LoggerSettings__c.LoggingLevel__c`
 
 ---
 

docs/logger-engine/FlowCollectionLogEntry.md

@@ -46,6 +46,10 @@ The records to relate to this log entry - the records' JSON is automaticall
 
 Optionally choose to save any pending log entries
 
+#### `scenario` → `String`
+
+Optionally specify the name to use for the current transaction's scenario
+
 #### `tagsString` → `String`
 
 Optionally provide a comma-separated String of tags to dynamically assign to the log entry

docs/logger-engine/FlowLogEntry.md

@@ -46,6 +46,10 @@ Optionally relate the log entry to a particular record ID
 
 Optionally choose to save any pending log entries.
 
+#### `scenario` → `String`
+
+Optionally specify the name to use for the current transaction's scenario
+
 #### `tagsString` → `String`
 
 Optionally provide a comma-separated String of tags to dynamically assign to the log entry

docs/logger-engine/FlowLogger.md

@@ -74,6 +74,10 @@ General message to log.
 
 boolean used to determine if logs are saved to Salesforce.
 
+###### `scenario` → `String`
+
+Optionally specify the name to use for the current transaction's scenario
+
 ###### `tagsString` → `String`
 
 String of tags / topics.