mcdev 3.1.3 → 4.0.1

package/.eslintrc.json

@@ -4,8 +4,14 @@
         "node": true,
         "mocha": true
     },
-    "extends": ["eslint:recommended", "prettier", "ssjs"],
-    "plugins": ["mocha", "prettier"],
+    "extends": [
+        "eslint:recommended",
+        "ssjs",
+        "plugin:jsdoc/recommended",
+        "plugin:prettier/recommended",
+        "plugin:unicorn/recommended"
+    ],
+    "plugins": [],
     "globals": {
         "Atomics": "readonly",
         "SharedArrayBuffer": "readonly"
@@ -14,12 +20,57 @@
         "ecmaVersion": 2020,
         "sourceType": "module"
     },
+    "root": true,
+    "settings": {
+        "jsdoc": {
+            "mode": "jsdoc",
+            "preferredTypes": {
+                "array": "Array",
+                "array.<>": "[]",
+                "Array.<>": "[]",
+                "array<>": "[]",
+                "Array<>": "[]",
+                "Object": "object",
+                "object.<>": "Object.<>",
+                "object<>": "Object.<>",
+                "Object<>": "Object.<>",
+                "promise": "Promise",
+                "promise.<>": "Promise.<>",
+                "promise<>": "Promise.<>",
+                "Promise<>": "Promise.<>"
+            }
+        }
+    },
     "rules": {
+        "unicorn/better-regex": "off",
+        "unicorn/catch-error-name": [
+            "error",
+            {
+                "name": "ex"
+            }
+        ],
+        "unicorn/explicit-length-check": "off",
+        "unicorn/no-null": "off",
+        "unicorn/prefer-module": "off",
+        "unicorn/prevent-abbreviations": "off",
+        "unicorn/filename-case": "off",
+        "unicorn/no-array-callback-reference": "off",
+        "unicorn/no-array-reduce": "off",
+        "unicorn/no-await-expression-member": "off",
+        "unicorn/no-hex-escape": "off",
+        "unicorn/no-nested-ternary": "off",
+        "unicorn/no-static-only-class": "off",
+        "unicorn/no-unused-properties": "warn",
+        "unicorn/numeric-separators-style": "off",
+        "unicorn/prefer-array-some": "off",
+        "unicorn/prefer-set-has": "off",
+        "unicorn/prefer-spread": "off",
+        "unicorn/unicorn/no-lonely-if": "off",
         "arrow-body-style": ["error", "as-needed"],
         "curly": "error",
-        "mocha/no-exclusive-tests": "error",
-        "no-console": "off",
-        "require-jsdoc": [
+        "no-console": "error",
+        "jsdoc/check-line-alignment": 2,
+        "jsdoc/require-jsdoc": [
             "warn",
             {
                 "require": {
@@ -31,7 +82,6 @@
                 }
             }
         ],
-        "valid-jsdoc": "error",
         "spaced-comment": ["warn", "always", { "block": { "exceptions": ["*"], "balanced": true } }]
     },
     "overrides": [
@@ -40,7 +90,17 @@
             "rules": {
                 "no-var": "error",
                 "prefer-const": "error",
-                "prettier/prettier": "warn"
+                "prettier/prettier": "warn",
+                "prefer-arrow-callback": "warn"
+            }
+        },
+        {
+            "files": ["test/*.js"],
+
+            "extends": ["plugin:mocha/recommended"],
+            "plugins": ["mocha"],
+            "rules": {
+                "mocha/no-mocha-arrows": "off"
             }
         }
     ]

package/.github/ISSUE_TEMPLATE/bug.yml

@@ -39,7 +39,8 @@ body:
     label: Version
     description: What version of our software are you running? (mcdev --version)
     options:
-      - 3.2.0
+      - 4.0.0
+      - 3.1.3
       - 3.1.2
       - 3.1.1
       - 3.1.0

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -5,11 +5,13 @@
 _Please delete options that are not relevant._
 
 - [ ] Documentation update
-- [ ] Bug fix
+- [ ] Bugfix
 - [ ] New metadata support
 - [ ] Enhanced metadata
 - [ ] Add a CLI option
 - [ ] Add something to the core
+- [ ] Technical debt removed
+- [ ] Dependencies added / updated
 - [ ] Other, please explain:
 
 ## What changes did you make? (Give an overview)
@@ -23,8 +25,8 @@ _Please delete options that are not relevant._
 ## Checklist
 
 - [ ] I have performed a self-review of my own code
+- [ ] ran `npm run test` to with 0 tests failing
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] ESLint & Prettier are not outputting errors or warnings
 - [ ] README.md updated (if applicable)
-- [ ] CHANGELOG.md updated
-- [ ] ran `npm run docs` to update developer docs
+- [ ] Release Notes updated

package/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+    - package-ecosystem: 'npm' # See documentation for possible values
+      directory: '/' # Location of package manifests
+      schedule:
+          interval: 'daily'
+      target-branch: 'develop'
+      labels:
+          - 'dependencies'

package/.github/workflows/code-analysis.yml

@@ -0,0 +1,57 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: 'CodeAnalysis'
+
+on:
+    push:
+        branches: [main, develop]
+    pull_request:
+        # The branches below must be a subset of the branches above
+        branches: [main, develop]
+
+jobs:
+    analyzeAndTest:
+        name: Analyze & Test
+        runs-on: ubuntu-latest
+        permissions:
+            actions: read
+            contents: read
+            security-events: write
+
+        strategy:
+            fail-fast: false
+            matrix:
+                language: ['javascript']
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v2
+
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: 16
+                  registry-url: https://registry.npmjs.org/
+
+            - run: npm ci --ignore-scripts
+
+            - run: npm run lint
+
+            # Initializes the CodeQL tools for scanning.
+            - name: Initialize CodeQL
+              uses: github/codeql-action/init@v2
+              with:
+                  languages: ${{ matrix.language }}
+            - name: Perform CodeQL Analysis
+              uses: github/codeql-action/analyze@v2
+
+            # Assuming code passes, run tests
+            - run: npm run test

package/.husky/commit-msg

@@ -0,0 +1,10 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+INPUT_FILE=$1
+START_LINE=`head -n1 $INPUT_FILE`
+PATTERN="^(#[[:digit:]]|Merge)"
+
+if ! [[ "$START_LINE" =~ $PATTERN ]] ; then
+  echo "Bad commit message, see example: \"#431 commit message\", you provided: \"$START_LINE\""
+  exit 1
+fi

package/.husky/post-checkout

@@ -0,0 +1,5 @@
+#!/bin/sh
+git config commit.template .git/templatemessage
+TICKETID=`git rev-parse --abbrev-ref HEAD | LC_ALL=en_US.utf8 grep -oP '(?<=[feature|bugfix|task]\/)\d{2,5}'`
+echo "[POST_CHECKOUT] Setting template commit to $TICKETID"
+echo "#$TICKETID: " > ".git/templatemessage"

package/.husky/pre-commit

@@ -1,4 +1,5 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
-
+npm run docs
+git update-index --add docs/dist/documentation.md
 npx --no lint-staged

package/.prettierrc

@@ -21,6 +21,14 @@
             "options": {
                 "tabWidth": 2
             }
+        },
+        {
+            "files": "*.sql",
+            "options": {
+                "formatter": "sql-formatter",
+                "language": "tsql",
+                "uppercase": true
+            }
         }
     ]
 }

package/.vscode/settings.json

@@ -42,7 +42,7 @@
     "outline.showVariables": false,
     "breadcrumbs.showVariables": false,
     "breadcrumbs.showProperties": false,
-    "githubIssues.issueBranchTitle": "bugfix/i${issueNumber}-${sanitizedIssueTitle}",
+    "githubIssues.issueBranchTitle": "feature/${issueNumber}-${sanitizedIssueTitle}",
     "githubIssues.queries": [
         {
             "label": "My Issues",

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Accenture
+Copyright (c) 2022 Accenture
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.