feat: repo template additions

.eslintrc.json

@@ -0,0 +1,14 @@
+{
+    "extends": ["@salesforce/eslint-config-lwc/recommended"],
+    "overrides": [
+        {
+            "files": ["*.test.js"],
+            "rules": {
+                "@lwc/lwc/no-unexpected-wire-adapter-usages": "off"
+            },
+            "env": {
+                "node": true
+            }
+        }
+    ]
+}

.github/workflows/code-analyze.yml

@@ -0,0 +1,61 @@
+name: Salesforce Code Quality
+
+on:
+    workflow_dispatch:
+    workflow_call:
+
+jobs:
+    PMD:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v3
+            - name: Setup Salesforce CLI
+              run: |
+                  yarn global add @salesforce/cli
+                  sf plugins:install @salesforce/sfdx-scanner
+            - name: SF Code Analyzer - PMD
+              run: |
+                  sf scanner:run --engine pmd --target force-app --pmdconfig=config/pmd/ruleset.xml --format table --severity-threshold 3
+
+    RetireJS:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v3
+            - name: Setup Salesforce CLI
+              run: |
+                  yarn global add @salesforce/cli
+                  sf plugins:install @salesforce/sfdx-scanner
+            - name: SF Code Analyzer - RetireJS
+              run: |
+                  sf scanner:run --engine "retire-js" --target force-app --format table --severity-threshold 3
+
+    GraphEngine:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v3
+            - name: Setup Salesforce CLI
+              run: |
+                  yarn global add @salesforce/cli
+                  sf plugins:install @salesforce/sfdx-scanner
+            - name: SF Code Analyzer - Data Flow Analysis
+              run: |
+                  sf scanner:run:dfa --target force-app --projectdir force-app --format table --severity-threshold 3
+
+    ESLint:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v3
+            - name: Setup Salesforce CLI
+              run: |
+                  yarn global add @salesforce/cli
+                  sf plugins:install @salesforce/sfdx-scanner
+            - name: Install deps
+              run: |
+                  yarn install
+            - name: SF Code Analyzer - ESLint
+              run: |
+                  sf scanner:run --engine eslint --eslintconfig=.eslintrc.json --target "force-app/**/*.js" --format table --severity-threshold 3

.github/workflows/incremental-deploy.yml

@@ -0,0 +1,65 @@
+# Based on https://github.com/mehdisfdc/sfdx-GitHub-actions/blob/main/.github/workflows/main.yml
+name: Incremental deployment
+
+on:
+    workflow_dispatch:
+        inputs:
+            validateOnly:
+                description: 'Perform a validation deployment only'
+            baseRef:
+                description: 'Git base ref'
+                required: true
+            targetRef:
+                description: 'Git target ref'
+                required: true
+    workflow_call:
+        inputs:
+            validateOnly:
+                description: 'Perform a validation deployment only'
+                type: boolean
+            baseRef:
+                description: 'Git base ref'
+                type: string
+                required: true
+            targetRef:
+                description: 'Git target ref'
+                type: string
+                required: true
+
+jobs:
+    default:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+            - name: Install Salesforce CLI
+              run: |
+                  yarn global add @salesforce/cli
+                  sf version
+            - name: Generate delta
+              run: |
+                  echo y | sf plugins:install sfdx-git-delta
+                  if [ "${{ inputs.validateOnly }}" = "true" ]; then
+                    git merge "${{ inputs.baseRef }}"
+                  fi
+                  mkdir -p deltas
+                  sf sgd source delta --from "${{ inputs.baseRef }}" --to "${{ inputs.targetRef }}" --output deltas --generate-delta --ignore .forceignore
+                  echo "# package.xml"
+                  cat deltas/package/package.xml; echo ""
+                  echo "# destructiveChanges.xml"
+                  cat deltas/destructiveChanges/destructiveChanges.xml; echo ""
+            - name: Deploy changes to target org
+              run: |
+                  sf org login sfdx-url --set-default --sfdx-url-file <(echo "${{ secrets.SFDX_AUTH_URL_TARGET_ORG }}")
+                  deployFlags=(
+                    --manifest deltas/package/package.xml
+                    --post-destructive-changes deltas/destructiveChanges/destructiveChanges.xml
+                    --wait 30
+                    --test-level RunLocalTests
+                    --verbose
+                  )
+                  if [ "${{ inputs.validateOnly }}" = "true" ]; then
+                    deployFlags+=( --dry-run )
+                  fi
+                  sf project deploy start "${deployFlags[@]}"

.github/workflows/main.yml

@@ -0,0 +1,21 @@
+name: Main
+
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    code-analyze:
+        name: Run Salesforce Code Analyzer
+        uses: ./.github/workflows/code-analyze.yml
+        secrets: inherit
+
+    incremental-deploy:
+        name: Deploy delta changes
+        uses: ./.github/workflows/incremental-deploy.yml
+        secrets: inherit
+        with:
+            # Note: This requires the merged PR to only have a single commit or merge commit
+            baseRef: 'HEAD~1'
+            targetRef: 'HEAD'

.github/workflows/pr.yml

@@ -0,0 +1,19 @@
+name: Pull Request
+
+on:
+    pull_request:
+
+jobs:
+    code-analyze:
+        name: Run Salesforce Code Analyzer
+        uses: ./.github/workflows/code-analyze.yml
+        secrets: inherit
+
+    incremental-deploy:
+        name: Validate deployment delta changes
+        uses: ./.github/workflows/incremental-deploy.yml
+        secrets: inherit
+        with:
+            baseRef: 'origin/${GITHUB_BASE_REF}'
+            targetRef: 'HEAD'
+            validateOnly: true

.gitignore

@@ -43,3 +43,11 @@ $RECYCLE.BIN/
 **/__pycache__/
 **/.venv/
 **/venv/
+
+# SFDMU
+/data/source/
+/data/target/
+/data/logs/
+
+# SGD
+deltas*

.husky/pre-commit

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 . "$(dirname "$0")/_/husky.sh"
 
 npm run precommit

.lintstagedrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+    '**/*.{auradoc,cls,cmp,component,css,design,html,js,json,md,page,trigger,xml,yaml,yml}': 'prettier --write'
+};

.prettierignore

@@ -5,6 +5,5 @@
 **/staticresources/**
 .localdevserver
 .sfdx
-.vscode
-
-coverage/
+*.md
+coverage/

.prettierrc

@@ -1,13 +1,23 @@
 {
-  "trailingComma": "none",
-  "overrides": [
-    {
-      "files": "**/lwc/**/*.html",
-      "options": { "parser": "lwc" }
-    },
-    {
-      "files": "*.{cmp,page,component}",
-      "options": { "parser": "html" }
-    }
-  ]
+    "singleQuote": true,
+    "printWidth": 120,
+    "requireConfig": false,
+    "useTabs": false,
+    "trailingComma": "none",
+    "bracketSpacing": true,
+    "jsxBracketSameLine": false,
+    "semi": true,
+    "tabWidth": 4,
+    "editor.formatOnSave": true,
+    "overrides": [
+        {
+            "files": "**/lwc/**/*.html",
+            "options": { "parser": "lwc" }
+        },
+        {
+            "files": "*.{cmp,page,component}",
+            "options": { "parser": "html" }
+        }
+    ],
+    "plugins": ["prettier-plugin-apex", "@prettier/plugin-xml"]
 }

.vscode/extensions.json

@@ -1,9 +1,12 @@
 {
-  "recommendations": [
-    "salesforce.salesforcedx-vscode",
-    "redhat.vscode-xml",
-    "dbaeumer.vscode-eslint",
-    "esbenp.prettier-vscode",
-    "financialforce.lana"
-  ]
+    "recommendations": [
+        "salesforce.salesforcedx-vscode",
+        "redhat.vscode-xml",
+        "dbaeumer.vscode-eslint",
+        "esbenp.prettier-vscode",
+        "financialforce.lana",
+        "mhutchie.git-graph",
+        "eamodio.gitlens",
+        "DavidAnson.vscode-markdownlint"
+    ]
 }

.vscode/launch.json

@@ -1,16 +1,16 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Launch Apex Replay Debugger",
-      "type": "apex-replay",
-      "request": "launch",
-      "logFile": "${command:AskForLogFileName}",
-      "stopOnEntry": true,
-      "trace": true
-    }
-  ]
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch Apex Replay Debugger",
+            "type": "apex-replay",
+            "request": "launch",
+            "logFile": "${command:AskForLogFileName}",
+            "stopOnEntry": true,
+            "trace": true
+        }
+    ]
 }

.vscode/settings.json

@@ -1,7 +1,24 @@
 {
-  "search.exclude": {
-    "**/node_modules": true,
-    "**/bower_components": true,
-    "**/.sfdx": true
-  }
+    "search.exclude": {
+        "**/node_modules": true,
+        "**/bower_components": true,
+        "**/.sfdx": true
+    },
+    "apexPMD.rulesets": ["config/pmd/ruleset.xml"],
+    "[xml]": {
+        "editor.defaultFormatter": "redhat.vscode-xml"
+    },
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.insertSpaces": true,
+    "editor.detectIndentation": false,
+    "editor.renderWhitespace": "all",
+    "editor.tabSize": 4,
+    "prettier.tabWidth": 4,
+    "prettier.enable": true,
+    "prettier.useTabs": false,
+    "prettier.printWidth": 120,
+    "prettier.singleQuote": true,
+    "prettier.semi": true,
+    "prettier.trailingComma": "none"
 }

README.md

@@ -1,9 +1,29 @@
-This repository contains 
+# This repository contains
 
-- a skeleton SF project created with  ```sf project generate```
-- a custom Salesforce theme
+## Skeleton SF Project
+
+Created with  ```sf project generate```, with
+
+- a custom Salesforce theme, a sample Apex class and LWC
 - an exemplatory Hutte configuration file (hutte.yml) which applies the custom Salesforce theme after Scratch Org creation, and creates a custom button to run a data import
-- a sample data set to demonstrate data import via Hutte custom button
+- sample data set to demonstrate data import via Hutte custom button
+
+## Main Hutte Recipes
+
+- [incremental deployment recipe](https://github.com/hutte-recipes/cicd-incremental-deployment)
+- [salesforce code analyzer recipe](https://github.com/hutte-recipes/cicd-sf-code-analyzer)
+- [sfdmu recipe](https://github.com/hutte-recipes/hutte-sfdmu) (including custom button)
+
+## VSCode Presets
+
+- VSCode pre-build settings for editor, PMD and prettier
+- VSCode set of recommended extension for Salesforce development
+
+## Code Quality Tools Configuration
 
-Please check https://docs.hutte.io in order to learn more about setting up and using Hutte.
+- Prettier baseline configuration
+- PMD baseline configuration
+- ESLint baseline configuration
+- Precommit Husky hook configured with prettier formating
 
+Please check https://docs.hutte.io in order to learn more about setting up and using Hutte.

config/data/Account.csv

@@ -0,0 +1,2 @@
+Name,Type,BillingStreet,BillingCity,BillingState,BillingPostalCode,BillingCountry,BillingLatitude,BillingLongitude,BillingGeocodeAccuracy,ShippingStreet,ShippingCity,ShippingState,ShippingPostalCode,ShippingCountry,ShippingLatitude,ShippingLongitude,ShippingGeocodeAccuracy,Phone,Fax,AccountNumber,Website,Sic,Industry,AnnualRevenue,NumberOfEmployees,Ownership,TickerSymbol,Description,Rating,Site,Jigsaw,CleanStatus,AccountSource,DunsNumber,Tradestyle,NaicsCode,NaicsDesc,YearStarted,SicDesc,Parent.Name,OperatingHours.Name
+Sample Account for Entitlements,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,Pending,,,,,,,,,

config/data/export.json

@@ -0,0 +1,15 @@
+{
+    "objects": [
+        {
+            "query": "SELECT readonly_false FROM Account ORDER BY Name ASC",
+            "operation": "Upsert",
+            "externalId": "Name"
+        },
+        {
+            "query": "SELECT readonly_false FROM Contact ORDER BY Email,LastName,FirstName ASC",
+            "operation": "Upsert",
+            "externalId": "Email;LastName;FirstName"
+        }
+    ],
+    "excludeIdsFromCSVFiles": true
+}

config/data/target/Account_upsert_target.csv

@@ -0,0 +1,2 @@
+Name,Type,BillingStreet,BillingCity,BillingState,BillingPostalCode,BillingCountry,BillingLatitude,BillingLongitude,BillingGeocodeAccuracy,ShippingStreet,ShippingCity,ShippingState,ShippingPostalCode,ShippingCountry,ShippingLatitude,ShippingLongitude,ShippingGeocodeAccuracy,Phone,Fax,AccountNumber,Website,Sic,Industry,AnnualRevenue,NumberOfEmployees,Ownership,TickerSymbol,Description,Rating,Site,Jigsaw,CleanStatus,AccountSource,DunsNumber,Tradestyle,NaicsCode,NaicsDesc,YearStarted,SicDesc,Parent.Name,OperatingHours.Name
+Sample Account for Entitlements,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,Pending,,,,,,,,,