qfpm 1.0.24 → 1.1.1

package/README.md

@@ -2,8 +2,17 @@
 
 ## 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
+
+- 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
+
+- WSL support seems to be working though with a big salesforce asterisk down in the AT4DX example
 
 ## Install
 
@@ -34,6 +43,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
@@ -63,6 +74,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,15 +93,21 @@
     ```bash
     npm install --save qfpm
     ```
-1. install the the fflib commons
+1. install the at4dx libraries
     ```bash
     npm install --save npm-at4dx
     ```
-1. setup scratch org and install all
+1. setup scratch org and install all*
     ```bash
     npm run setup
     ```
 
+*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
 
 1. Build source into metadata format

package/bin/postinstall.js

@@ -23,7 +23,7 @@ if(!pack.scripts){
     pack.scripts = {}
 }
 scripts.forEach(script => {
-    pack.scripts[script.name] = './node_modules/.bin/'+script.run
+    pack.scripts[script.name] = script.run
 })
 fs.writeFileSync(path.resolve(installPath,'package.json'),JSON.stringify(pack,null,4))
 console.log('[!] finished package.json update!')

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.0.24",
-    "description": "installs the NPM SFDX Package Dependancy Resolution Proof of Concept scripts",
+    "version": "1.1.1",
+    "description": "Salesforce package management tool set for mananging dependencies between packages",
     "main": "index.js",
+    "man": "./README.md",
     "keywords": [
         "salesforce",
         "package",