qfpm 1.1.0 → 1.1.2

package/.forceignore

@@ -0,0 +1,8 @@
+# List files or directories below to ignore them when running force:source:push, force:source:pull, and force:source:status
+# More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
+#
+
+package.xml
+bin/
+etc/
+src/

package/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# CONTRIBUTING
+
+If I was to update this I'd likely re-write it into javascript and possibly a sfdx plugin, but if one does want to contribute to this in its frankenstien bash javascript form.
+
+1. Clone
+2. Edit
+3. Submit Pull Request
+4. Wait untill it is looked at it
+5. Repeat as needed

package/README.md

@@ -1,12 +1,20 @@
+[![NPM](https://img.shields.io/npm/v/qfpm.svg)](https://www.npmjs.com/package/qfpm)
+[![Downloads/week](https://img.shields.io/npm/dw/qfpm.svg)](https://npmjs.org/package/qfpm)
+![QFPM Tests](https://github.com/gussamer/qfpm/actions/workflows/qfpmtest.yml/badge.svg)
+[![qfpm](https://snyk.io/advisor/npm-package/qfpm/badge.svg)](https://snyk.io/advisor/npm-package/qfpm)
+[![License](https://img.shields.io/badge/ISC-blue.svg)](https://raw.githubusercontent.com/gussamer/qfpm/master/LICENSE)
 # QFPM
 
 ## QRFDev Package Manager
 
-### Installs the NPM SFDX Package Dependancy Resolution Proof of Concept scripts
-======================================
+### A blend of NPM and SFDX into a Salesforce package dependancy management tool set
+
+The package mangement methodology intended with qfpm is meant to aid with the dependancy management side of salesforce packages. Currently this could be implmented with a private npm service to benefit from the npm dependancy resolution applied to a teams salesforce metadata libraries as they are broken down into packages with a dependancy hierarchy. QFPM could be extended to support the management of sfdx package2 building and installation with dependencies, as well converted to sfdx plugin, if I ever get around to doing it.  
 
 ## Updates
 
+- Updated the commands for the new sf structure
+
 - The removal of the bin/qfpm script dependancy complete, automated removal doesn't seem to work so feel free to delete them after upgrading
 
 - Conversion to using native npm bin definition seems stable and opens up better linux support
@@ -19,7 +27,7 @@
 1. Navigate to folder you want your project
 1. Create a SFDX project with
     ```bash
-    sfdx force:project:create -n newsfdxproject
+    sf force project create -n newsfdxproject
     ```
 1. Move into the project folder with
     ```bash
@@ -34,7 +42,7 @@
     npm run setup
     ```
 
- \* qfpm has no external dependancies all warnings are due to packages salesforce uses in their default project package.json
+ \* all warnings are due to packages salesforce uses in their default project package.json
 
 ## Use
 
@@ -42,6 +50,8 @@
 
 #### Setup FFLIB commons sample code with dependancies
 
+This example demonstates facilitating two layers of dependancies required to get started with the fflib apex common sample code library. The sample code requries the fflib apex commons library which intern is dependant on the fflib apex mocks library. With example npm packages for both the commons and mocks published publicly to npm, qfpm is able to install all dependancies via soap to avoid source tracking and then push the sample code for work tracked in the scratch org. 
+
 1. Navigate to the [fflib sample code](https://github.com/apex-enterprise-patterns/fflib-apex-common-samplecode)
 1. Clone the repo locally
     ```bash
@@ -51,9 +61,9 @@
     ```bash
     cd fflib-apex-common-samplecode
     ```
-1. init npm and hit enter through all questions
+1. init npm to create package.json
     ```bash
-    npm init
+    npm init -y
     ```
 1. install the qfpm tools
     ```bash
@@ -71,6 +81,8 @@
 
 #### Setup AT4DX sample code with dependancies
 
+This example expands on the previous fflib sample code to satisfy the requirments of the at4dx sample code. As before the multi layered fflib commons and mocks are required by the at4dx requirement which also has a parallel dependancy of force-di. All of which are installed via soap into a scratch org with the at4dx sample code pushed for tracking.
+
 1. Navigate to the [at4dx sample code](https://github.com/apex-enterprise-patterns/at4dx-samplecode)
 1. Clone the repo locally
     ```bash
@@ -80,9 +92,9 @@
     ```bash
     cd at4dx-samplecode
     ```
-1. init npm and hit enter through all questions
+1. init npm to create package.json
     ```bash
-    npm init
+    npm init -y
     ```
 1. install the qfpm tools
     ```bash
@@ -97,7 +109,11 @@
     npm run setup
     ```
 
-*sfdx on WSL(maybe linux in general) seems to have an issue with the README.md inside the sfdx source dirs so I moved them in the npm package
+*sfdx on WSL(maybe linux in general) seems to have an issue thinking the README.md inside the sfdx source dirs is a custom metadata type, so I removed them in the npm package as they just said put stuff here. You can run this command after cloning to delete all the offending README.md files in this repo as a work around.
+
+  ```bash
+  for x in $(find ./sfdx-source/ -name README.md); do rm -f $x; done
+  ```
 
 ### Commands
 

package/SECURITY.md

@@ -0,0 +1,4 @@
+# Security
+___
+
+Please report any vulnerabilities in the issues here on github as soon as possible. QFPM only depends on SFDX... and NPM and NODE but otherwise has no production dependancies to reduce possible issues but that doesn't preclude the possibility.

package/etc/help.txt

@@ -1,9 +1,48 @@
 QRFDev Package Manager
 
-Welcome!
+Commands
 
-Running this does nothing at all.
+Build source into metadata format
 
-The npm install command writes scripts to the bin folder
+- executes sfdx source convert
 
-The package.json is updated with the script locations
+  npm run build
+
+Clean up scratch org
+
+- marks projects scratch org for deletion
+
+  npm run clean
+
+Deploy whole project directly as metadata format
+
+- executes sfdx source deploy
+- bypasses source tracking
+
+  npm run deploy
+
+Push source to scratch org
+
+- executes sfdx source push
+
+  npm run push
+
+Scratch a new org
+
+- creates new scratch org from config
+- checks if org already exists
+
+  npm run scratch
+
+Setup current project for development
+
+- setups up a scratch org
+- deploys all dependancies to scratch org
+
+  npm run setup
+
+Test project
+
+- runs all tests in scratch org
+
+  npm run test

package/package.json

@@ -1,8 +1,9 @@
 {
     "name": "qfpm",
-    "version": "1.1.0",
-    "description": "installs the NPM SFDX Package Dependancy Resolution Proof of Concept scripts",
+    "version": "1.1.2",
+    "description": "Salesforce package management tool set for mananging dependencies between packages",
     "main": "index.js",
+    "man": "./README.md",
     "keywords": [
         "salesforce",
         "package",

package/sfdx-project.json

@@ -0,0 +1,11 @@
+{
+    "packageDirectories": [
+        {
+            "path": "test",
+            "default": true
+        }
+    ],
+    "namespace": "",
+    "sfdcLoginUrl": "https://login.salesforce.com",
+    "sourceApiVersion": "55.0"
+}

package/src/build.sh

@@ -12,5 +12,5 @@ if [ "$DXPM_CURRENT_PACKAGE_NAME" = "" ]; then
   DXPM_CURRENT_PACKAGE_NAME="$($DXPM_NODE_MOD/.bin/qgetprojectname)"
 fi
 echo "[+] converting source for $DXPM_CURRENT_PACKAGE_NAME"
-sfdx force:source:convert -d "./manifest" -n "$DXPM_CURRENT_PACKAGE_NAME" -p "$($DXPM_NODE_MOD/.bin/qgetsrcfolders)" && wait
+sf force source convert -d "./manifest" -n "$DXPM_CURRENT_PACKAGE_NAME" -p "$($DXPM_NODE_MOD/.bin/qgetsrcfolders)" && wait
 echo "[+] finished converting source for $DXPM_CURRENT_PACKAGE_NAME"

package/src/clean.sh

@@ -12,5 +12,5 @@ if [ "$DXPM_SETUP_PACKAGE_NAME" = "" ]; then
   DXPM_SETUP_PACKAGE_NAME="$($DXPM_NODE_MOD/.bin/qgetprojectname)"
 fi
 echo "[+] checking if $DXPM_SETUP_PACKAGE_NAME scrach org exists and deleting it"
-$DXPM_NODE_MOD/.bin/qisscratched && sfdx force:org:delete -u "$DXPM_SETUP_PACKAGE_NAME" -p && wait
+$DXPM_NODE_MOD/.bin/qisscratched && sf org delete scratch -o "$DXPM_SETUP_PACKAGE_NAME" -p && wait
 echo "[+] finished cleaning $DXPM_SETUP_PACKAGE_NAME scrach org"

package/src/deploy.sh

@@ -16,5 +16,5 @@ if [ "$DXPM_CURRENT_PACKAGE_NAME" = "" ]; then
 fi
 echo "[+] deploying $DXPM_CURRENT_PACKAGE_NAME metadata to scratch org $DXPM_SETUP_PACKAGE_NAME"
 #todo: read package.json for all folder locations
-sfdx force:source:deploy -p "$($DXPM_NODE_MOD/.bin/qgetsrcfolders)" -w 10 -u "$DXPM_SETUP_PACKAGE_NAME" && wait
+sf force source deploy -p "$($DXPM_NODE_MOD/.bin/qgetsrcfolders)" -w 10 -u "$DXPM_SETUP_PACKAGE_NAME" && wait
 echo "[+] finished deploying $DXPM_CURRENT_PACKAGE_NAME metadata to scratch org $DXPM_SETUP_PACKAGE_NAME"

package/src/isscratched.js

@@ -5,7 +5,7 @@ if(process.argv[2]==undefined){
   var pack = JSON.parse(packageJSON)
   scratchName=pack.name
 }else scratchName=process.argv[2]
-var orgsJSON = require('child_process').execSync('sfdx force:org:list --json')
+var orgsJSON = require('child_process').execSync('sf force org list --json')
 var orgs = JSON.parse(orgsJSON).result
 orgs.scratchOrgs.forEach(org => {
   if(org.alias==scratchName) process.exit()

package/src/push.sh

@@ -11,5 +11,5 @@ if [ "$DXPM_SETUP_PACKAGE_NAME" = "" ]; then
   DXPM_SETUP_PACKAGE_NAME="$($DXPM_NODE_MOD/.bin/qgetprojectname)"
 fi
 echo "[+] pushing source to scratch org $DXPM_SETUP_PACKAGE_NAME"
-sfdx force:source:push -f -w 10 -u "$DXPM_SETUP_PACKAGE_NAME" && wait
+sf force source push -f -w 10 -o "$DXPM_SETUP_PACKAGE_NAME" && wait
 echo "[+] finished pushing source to scratch org $DXPM_SETUP_PACKAGE_NAME"

package/src/scratch.sh

@@ -11,8 +11,8 @@ if [ "$DXPM_SETUP_PACKAGE_NAME" = "" ]; then
   DXPM_SETUP_PACKAGE_NAME="$($DXPM_NODE_MOD/.bin/qgetprojectname)"
 fi
 echo "[+] setting up scratch org $DXPM_SETUP_PACKAGE_NAME"
-sfdx force:org:create -f $PWD/config/project-scratch-def.json -a "$DXPM_SETUP_PACKAGE_NAME" -d 1 -w 5 && wait
+sf force org create -f $PWD/config/project-scratch-def.json -a "$DXPM_SETUP_PACKAGE_NAME" -d 1 -w 5 && wait
 echo "[+] finished setting up scratch org $DXPM_SETUP_PACKAGE_NAME"
 echo "[+] setting scratch org $DXPM_SETUP_PACKAGE_NAME as default locally"
-sfdx force:config:set defaultusername=$DXPM_SETUP_PACKAGE_NAME
+sf force config set target-org $DXPM_SETUP_PACKAGE_NAME
 echo "[+] finished setting scratch org $DXPM_SETUP_PACKAGE_NAME as default username locally"

package/src/test.sh

@@ -11,5 +11,5 @@ if [ "$DXPM_SETUP_PACKAGE_NAME" = "" ]; then
   DXPM_SETUP_PACKAGE_NAME="$($DXPM_NODE_MOD/.bin/qgetprojectname)"
 fi
 echo "[+] running tests for $DXPM_SETUP_PACKAGE_NAME"
-sfdx force:apex:test:run -l RunLocalTests -d ./test_results -r json -w 10 -u "$DXPM_SETUP_PACKAGE_NAME" && wait
+sf force apex test run -l RunLocalTests -d ./test_results -r json -w 10 -o "$DXPM_SETUP_PACKAGE_NAME" && wait
 echo "[+] finished running tests for $DXPM_SETUP_PACKAGE_NAME"