Add source format checking with prettier (#19)

* Add source format checking with prettier

* add craft first dependency

* add craft first plugin

Author: nbatterham

.github/workflows/format-source-code.yml

@@ -0,0 +1,35 @@
+# Unique name for this workflow
+name: Validate Source Code
+
+# Definition when the workflow should run
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [opened, synchronize]
+
+# Jobs to be executed
+jobs:
+  validate-source-code-format:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the code in the PR
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      # Install Node JS
+      - name: Install NodeJS
+        uses: actions/setup-node@v2
+        with:
+          node-version: "14"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci --no-audit --prefer-offline
+
+      # Verify Source Format with Prettier
+      - name: Check format with Prettier
+        run: |
+          git diff -z --name-only --diff-filter=ACMRT ${{ github.event.pull_request.base.sha}}...${{ github.event.pull_request.head.sha }} | xargs -0 -I {} npx prettier --ignore-unknown --validate "{}"

.prettierignore

@@ -6,4 +6,35 @@
 .localdevserver
 .sfdx
 
-coverage/
+coverage/
+bower_components/
+node_modules/
+jspm_packages/
+dist/
+build/
+lib-cov
+.nyc_output
+.gitattributes
+.gitignore
+.env
+.env.build
+.env.test
+.npm
+.npmrc
+yarn
+.yarn-integrity
+.yarnclean
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+yarn.lock
+package-lock.json
+logs
+*.log
+*.min.js
+*.min.css
+.editorconfig
+.eslintignore
+.markdownlintignore
+.prettierignore
+.sfdx/

.prettierrc

@@ -1,13 +1,34 @@
 {
   "trailingComma": "none",
+  "useTabs": true,
   "overrides": [
     {
       "files": "**/lwc/**/*.html",
-      "options": { "parser": "lwc" }
+      "options": {
+        "parser": "lwc"
+      }
     },
     {
       "files": "*.{cmp,page,component}",
-      "options": { "parser": "html" }
+      "options": {
+        "parser": "html"
+      }
+    },
+    {
+      "files": "*.md",
+      "options": {
+        "printWidth": 70,
+        "useTabs": false,
+        "trailingComma": "none",
+        "arrowParens": "avoid",
+        "proseWrap": "never"
+      }
+    },
+    {
+      "files": "*.{json,babelrc,eslintrc,remarkrc,prettierrc}",
+      "options": {
+        "useTabs": false
+      }
     }
   ]
 }