feat: improve implementation and documentation (#7)

Author: scolladon

.github/workflows/main.yml

@@ -23,7 +23,7 @@ jobs:
           ./sfdx-cli/install
 
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: "Populate auth file with CI_URL secret"
         shell: bash

.github/workflows/pull-request.yml

@@ -9,7 +9,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout source code"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - uses: actions/cache@v2
         with:
@@ -23,21 +25,24 @@ jobs:
             echo "SFDX_DISABLE_AUTOUPDATE=true" >> $GITHUB_ENV
             echo "SFDX_DISABLE_TELEMETRY=true" >> $GITHUB_ENV
       
-      - name: Install Salesforce CLI
+      - name: Install SFDX CLI and Scanner
         run: |
-          wget https://developer.salesforce.com/media/salesforce-cli/sfdx-linux-amd64.tar.xz
-          mkdir sfdx-cli
-          tar xJf sfdx-linux-amd64.tar.xz -C sfdx-cli --strip-components 1
-          ./sfdx-cli/install
+          npm install sfdx-cli
+          node_modules/sfdx-cli/bin/run plugins:install @salesforce/sfdx-scanner
 
       - name: "Install npm dependencies"
         run: npm install
 
       - name: "Code formatting verification with Prettier"
         run: npm run prettier:verify
 
-      - name: Execute Static Analysis
-        run: npm run lint
+      - name: "Apex static analysis"
+        uses: mitchspano/sfdx-scan-pull-request@v0.1.3
+        with:
+          pmdconfig: apex-ruleset.xml
+          severity-threshold: 4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   ci-build:
     runs-on: ubuntu-latest
@@ -56,7 +61,7 @@ jobs:
           ./sfdx-cli/install
 
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: "Populate auth file with CI_URL secret"
         shell: bash

.gitignore

@@ -1,4 +1,47 @@
-.vscode
-.sfdx
+# 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
+
+# Salesforce cache
+.sf/
+.sfdx/
+.vscode/
+.localdevserver/
+deploy-options.json
+
+# SFDX
 tests
-node_modules/
+
+# LWC VSCode autocomplete
+**/lwc/jsconfig.json
+
+# LWC Jest coverage reports
+coverage/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Dependency directories
+node_modules/
+
+# Eslint cache
+.eslintcache
+
+# MacOS system files
+.DS_Store
+
+# Windows system files
+Thumbs.db
+ehthumbs.db
+[Dd]esktop.ini
+$RECYCLE.BIN/
+
+# Local environment variables
+.env
+
+# SFDX
+tests/

.lintstagedrc

@@ -1,8 +1,5 @@
 {
-    "**/*.{cls,cmp,component,css,html,js,json,md,page,trigger,yaml,yml}": [
-      "prettier --write"
-    ],
-    "**/classes/*.cls": [
-      "sfdx scanner:run -v -f table -c 'Async-Linkable' -t "
-    ]
-}
+  "**/*.{cls,cmp,component,css,html,js,json,md,page,trigger,yaml,yml}": [
+    "prettier --write"
+  ]
+}

.prettierignore

@@ -1,5 +1,6 @@
-.sfdx
 .github
+.sf
+.sfdx
 .vscode
 coverage/
 tests/