first import

.cfformat.json

@@ -0,0 +1,62 @@
+{
+	"array.empty_padding": false,
+	"array.padding": true,
+	"array.multiline.min_length": 40,
+	"array.multiline.element_count": 2,
+	"array.multiline.leading_comma.padding": true,
+	"array.multiline.leading_comma": false,
+	"alignment.consecutive.assignments": true,
+	"alignment.consecutive.properties": true,
+	"alignment.consecutive.params": true,
+	"brackets.padding": true,
+	"comment.asterisks": "align",
+	"binary_operators.padding": true,
+	"for_loop_semicolons.padding": true,
+	"function_call.empty_padding": false,
+	"function_call.padding": true,
+	"function_call.multiline.leading_comma.padding": true,
+	"function_call.casing.builtin": "cfdocs",
+	"function_call.casing.userdefined": "camel",
+	"function_call.multiline.element_count": 2,
+	"function_call.multiline.leading_comma": false,
+	"function_call.multiline.min_length": 40,
+	"function_declaration.padding": true,
+	"function_declaration.empty_padding": false,
+	"function_declaration.multiline.leading_comma": false,
+	"function_declaration.multiline.leading_comma.padding": true,
+	"function_declaration.multiline.element_count": 2,
+	"function_declaration.multiline.min_length": 40,
+	"function_declaration.group_to_block_spacing": "compact",
+	"function_anonymous.empty_padding": false,
+	"function_anonymous.group_to_block_spacing": "compact",
+	"function_anonymous.multiline.element_count": 2,
+	"function_anonymous.multiline.leading_comma": false,
+	"function_anonymous.multiline.leading_comma.padding": true,
+	"function_anonymous.multiline.min_length": 40,
+	"function_anonymous.padding": true,
+	"indent_size": 4,
+	"keywords.block_to_keyword_spacing": "spaced",
+	"keywords.group_to_block_spacing": "spaced",
+	"keywords.padding_inside_group": true,
+	"keywords.spacing_to_block": "spaced",
+	"keywords.spacing_to_group": true,
+	"keywords.empty_group_spacing": false,
+	"max_columns": 120,
+	"metadata.multiline.element_count": 3,
+	"metadata.multiline.min_length": 40,
+	"method_call.chain.multiline" : 3,
+	"newline":"\n",
+	"property.multiline.element_count": 3,
+	"property.multiline.min_length": 40,
+	"parentheses.padding": true,
+	"strings.quote": "double",
+	"strings.attributes.quote": "double",
+	"struct.separator": " : ",
+	"struct.padding": true,
+	"struct.empty_padding": false,
+	"struct.multiline.leading_comma": false,
+	"struct.multiline.leading_comma.padding": true,
+	"struct.multiline.element_count": 2,
+	"struct.multiline.min_length": 40,
+	"tab_indent": true
+}

.cflintrc

@@ -0,0 +1,62 @@
+{
+    "rule": [],
+    "includes": [
+        { "code": "AVOID_USING_CFINCLUDE_TAG" },
+		{ "code": "AVOID_USING_CFABORT_TAG" },
+		{ "code": "AVOID_USING_CFEXECUTE_TAG" },
+		{ "code": "AVOID_USING_DEBUG_ATTR" },
+		{ "code": "AVOID_USING_ABORT" },
+		{ "code": "AVOID_USING_ISDATE" },
+		{ "code": "AVOID_USING_ISDEBUGMODE" },
+		{ "code": "AVOID_USING_CFINSERT_TAG" },
+		{ "code": "AVOID_USING_CFUPDATE_TAG" },
+		{ "code": "ARG_VAR_CONFLICT" },
+		{ "code": "ARG_VAR_MIXED" },
+		{ "code": "ARG_HINT_MISSING" },
+		{ "code": "ARG_HINT_MISSING_SCRIPT" },
+		{ "code" : "ARGUMENT_INVALID_NAME" },
+		{ "code" : "ARGUMENT_ALLCAPS_NAME" },
+		{ "code" : "ARGUMENT_TOO_WORDY" },
+		{ "code" : "ARGUMENT_IS_TEMPORARY" },
+        { "code": "CFQUERYPARAM_REQ" },
+        { "code": "COMPARE_INSTEAD_OF_ASSIGN" },
+		{ "code": "COMPONENT_HINT_MISSING" },
+		{ "code" : "COMPONENT_INVALID_NAME" },
+		{ "code" : "COMPONENT_ALLCAPS_NAME" },
+		{ "code" : "COMPONENT_TOO_SHORT" },
+		{ "code" : "COMPONENT_TOO_LONG" },
+		{ "code" : "COMPONENT_TOO_WORDY" },
+		{ "code" : "COMPONENT_IS_TEMPORARY" },
+		{ "code" : "COMPONENT_HAS_PREFIX_OR_POSTFIX" },
+		{ "code": "COMPLEX_BOOLEAN_CHECK" },
+        { "code": "EXCESSIVE_FUNCTION_LENGTH" },
+        { "code": "EXCESSIVE_COMPONENT_LENGTH" },
+        { "code": "EXCESSIVE_ARGUMENTS" },
+		{ "code": "EXCESSIVE_FUNCTIONS" },
+		{ "code": "EXPLICIT_BOOLEAN_CHECK" },
+        { "code": "FUNCTION_TOO_COMPLEX" },
+		{ "code": "FUNCTION_HINT_MISSING" },
+		{ "code": "FILE_SHOULD_START_WITH_LOWERCASE" },
+        { "code": "LOCAL_LITERAL_VALUE_USED_TOO_OFTEN" },
+        { "code": "GLOBAL_LITERAL_VALUE_USED_TOO_OFTEN" },
+		{ "code": "MISSING_VAR" },
+		{ "code" : "METHOD_INVALID_NAME" },
+		{ "code" : "METHOD_ALLCAPS_NAME" },
+		{ "code" : "METHOD_IS_TEMPORARY" },
+		{ "code": "NESTED_CFOUTPUT" },
+		{ "code": "NEVER_USE_QUERY_IN_CFM" },
+		{ "code": "OUTPUT_ATTR" },
+		{ "code" : "QUERYPARAM_REQ" },
+        { "code": "UNUSED_LOCAL_VARIABLE" },
+        { "code": "UNUSED_METHOD_ARGUMENT" },
+		{ "code": "SQL_SELECT_STAR" },
+		{ "code": "SCOPE_ALLCAPS_NAME" },
+		{ "code": "VAR_ALLCAPS_NAME" },
+		{ "code": "VAR_INVALID_NAME" },
+		{ "code": "VAR_TOO_WORDY" }
+    ],
+    "inheritParent": false,
+    "parameters": {
+		"TooManyFunctionsChecker.maximum" : 20
+	}
+}

.editorconfig

@@ -0,0 +1,20 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false
+indent_style = tab
+indent_size = 4
+tab_width = 4
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.{md,markdown}]
+trim_trailing_whitespace = false
+insert_final_newline = false

.gitattributes

@@ -0,0 +1,17 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

.github/workflows/ci.yml

@@ -0,0 +1,121 @@
+name: @module_name@ CI
+
+# Only on Development we build snapshots
+on:
+  push:
+    branches:
+      - development
+      - master
+
+jobs:
+  #############################################
+  # Build Module
+  #############################################
+  build:
+    name: Build & Publish
+    runs-on: ubuntu-20.04
+    env:
+      MODULE_ID: @module_id@
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Setup Java
+        uses: actions/setup-java@v2
+        with:
+          distribution: "adopt"
+          java-version: "11"
+
+      - name: Cache CommandBox Dependencies
+        uses: actions/cache@v1
+        if: ${{ true }}
+        with:
+          path: ~/.CommandBox/artifacts
+          key: ${{ runner.OS }}-commandbox-cache-${{ hashFiles( 'box.json' ) }}
+          restore-keys: |
+            ${{ runner.OS }}-commandbox-cache-${{ hashFiles( 'box.json' ) }}
+
+      - name: Setup CommandBox
+        uses: elpete/[email protected]
+        with:
+          forgeboxAPIKey: ${{ secrets.FORGEBOX_API_TOKEN }}
+
+      - name: Install Build Dependencies
+        run: |
+          box install
+
+      - name: Setup Environment For Build Process
+        id: current_version
+        run: |
+          # Get latest version from box.json
+          echo "VERSION=`cat box.json | jq '.version' -r`" >> $GITHUB_ENV
+          echo "Building v$VERSION"
+          # master or snapshot
+          echo "BRANCH=master" >> $GITHUB_ENV
+          if [[ "{{ GITHUB_REF }}" == "refs/heads/development" ]] ; then
+            echo "BRANCH=development" >> $GITHUB_ENV
+          fi
+          echo "Building ${{ env.MODULE_ID }} for $BRANCH"
+          # Replace version so builder can issue it
+          box package set [email protected]@[email protected]@
+
+      - name: Build ${{ env.MODULE_ID }}
+        run: |
+          # Create the CommandBox modules folder, for some reason it is not created
+          mkdir -p ~/.CommandBox/cfml/modules
+          # Link up the module so we can do testing!
+          box link --force
+          # Build Project
+          box task run taskfile=build/Build :version=${{ env.VERSION }} :projectName=${{ env.MODULE_ID }} :buildID=${{ github.run_number }} :branch=${{ env.BRANCH }}
+
+      - name: Failure Logs
+        if: failure()
+        run: cat `box system-log`
+
+      - name: Upload Build Artifacts
+        if: success()
+        uses: actions/upload-artifact@v2
+        with:
+          name: Module Artifacts
+          path: |
+            .artifacts/**/*
+
+      - name: Upload Binaries to S3
+        uses: jakejarvis/s3-sync-action@master
+        with:
+          args: --acl public-read
+        env:
+          AWS_S3_BUCKET: "downloads.ortussolutions.com"
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_ACCESS_SECRET }}
+          SOURCE_DIR: ".artifacts/${{ env.MODULE_ID }}"
+          DEST_DIR: "ortussolutions/commandbox-modules/${{ env.MODULE_ID }}"
+
+      - name: Upload API Docs to S3
+        uses: jakejarvis/s3-sync-action@master
+        with:
+          args: --acl public-read
+        env:
+          AWS_S3_BUCKET: "apidocs.ortussolutions.com"
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_ACCESS_SECRET }}
+          SOURCE_DIR: ".tmp/apidocs"
+          DEST_DIR: "commandbox-modules/${{ env.MODULE_ID }}/${{ env.VERSION }}"
+
+      - name: Publish To ForgeBox
+        run: |
+          cd .tmp/${{ env.MODULE_ID }}
+          cat box.json
+          box forgebox publish
+
+      - name: Inform Slack
+        if: ${{ always() }}
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: coding
+          SLACK_COLOR: ${{ job.status }} # or a specific color like 'green' or '#ff00ff'
+          SLACK_ICON_EMOJI: ":bell:"
+          SLACK_MESSAGE: '${{ env.MODULE_ID }} Built with ${{ job.status }}!'
+          SLACK_TITLE: "${{ env.MODULE_ID }} Build"
+          SLACK_USERNAME: CI
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}

.github/workflows/pr.yml

@@ -0,0 +1,72 @@
+name: Pull Requests
+
+on:
+  push:
+    branches-ignore:
+      - "main"
+      - "master"
+      - "development"
+  pull_request:
+    branches:
+      - development
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Setup Java
+        uses: actions/setup-java@v2
+        with:
+          distribution: "adopt"
+          java-version: "11"
+
+      - name: Setup CommandBox
+        uses: elpete/[email protected]
+
+      - name: Install Dependencies
+        run: |
+          box install
+
+      - name: Run Tests
+        run: |
+          # Create the CommandBox modules folder, for some reason it is not created
+          mkdir -p ~/.CommandBox/cfml/modules
+          # Link up the module so we can do testing!
+          box link --force
+          # Test
+          box task run taskfile=build/Build target="runTests"
+
+      - name: Failure Logs
+        if: failure()
+        run: cat `box system-log`
+
+  format:
+    name: Format
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Setup Java
+        uses: actions/setup-java@v2
+        with:
+          distribution: "adopt"
+          java-version: "11"
+
+      - name: Set Up CommandBox
+        uses: elpete/[email protected]
+
+      - name: Install CFFormat
+        run: box install commandbox-cfformat
+
+      - name: Run CFFormat
+        run: box run-script format
+
+      - name: Commit Format Changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Apply cfformat changes

.gitignore

@@ -0,0 +1,7 @@
+# Dependencies
+/docbox/**
+
+# Build Artifacts
+.tmp/**
+.artifacts/**
+changelog-latest.md

.markdownlint.json

@@ -0,0 +1,15 @@
+{
+	"line-length": false,
+	"single-h1": false,
+	"no-hard-tabs" : false,
+	"fenced-code-language" : false,
+	"no-bare-urls" : false,
+	"first-line-h1": false,
+	"no-multiple-blanks": {
+		"maximum": 2
+	},
+	"no-duplicate-header" : {
+		"siblings_only" : true
+	},
+	"no-inline-html" : false
+}