[GH-1] typescript refactor

.gitignore

@@ -1,2 +1,5 @@
-node_modules
-*.local
+.nyc_output/
+coverage/
+dist/
+esm/
+node_modules/

.lefthook/pre-commit/branch-naming-policy

@@ -0,0 +1,19 @@
+
+#!/bin/sh
+
+BRANCH=$(git rev-parse --abbrev-ref HEAD)
+REGEX="^(head|main|(bugfix|chore|docs|feature|hotfix)\/[-_a-zA-Z0-9]+|release\/[0-9]+\.[0-9]+\.[0-9]+)(-[_a-zA-Z0-9]+)?$"
+
+if ! [[ $BRANCH =~ $REGEX ]]; then
+  echo "$BRANCH"
+  echo ""
+  echo "Invalid branch name. Valid patterns:"
+  echo "- main"
+  echo "- bugfix/[-_a-zA-Z0-9]+"
+  echo "- chore/[-_a-zA-Z0-9]+"
+  echo "- docs/[-_a-zA-Z0-9]+"
+  echo "- feature/[-_a-zA-Z0-9]+"
+  echo "- hotfix/[-_a-zA-Z0-9]+"
+  echo "- release/{semantic version}"
+  exit 1
+fi

.lefthook/prepare-commit-msg/add-issue

@@ -0,0 +1,8 @@
+FILE=$1
+MESSAGE=$(cat $FILE)
+TICKET=[$(git rev-parse --abbrev-ref HEAD | grep -Eo '^(\w+/)?(\w+[-_]|#)?[0-9]+' | grep -Eo '(\w+[-_]|#)?[0-9]+' | tr "[:lower:]" "[:upper:]")]
+if [[ $TICKET == "[]" || "$MESSAGE" == "$TICKET"* ]];then
+  exit 0;
+fi
+
+echo "$TICKET $MESSAGE" > $FILE

.mocharc.json

@@ -0,0 +1,21 @@
+{
+  "exclude": [
+    "./dist/**",
+    "./node_modules/**",
+    "./**/*.json"
+  ],
+  "extension": [
+    "ts"
+  ],
+  "node-option": [
+    "experimental-specifier-resolution=node",
+    "loader=ts-node/esm",
+    "no-warnings"
+  ],
+  "recursive": true,
+  "require": [
+    "jsdom-global",
+    "source-map-support"
+  ],
+  "spec": "./**/*.test.!(*.*)"
+}

.nycrc.json

@@ -0,0 +1,7 @@
+{
+  "all": true,
+  "include": ["src/**/*"],
+  "reporter": ["html", "lcov", "text", "text-summary"],
+  "skip-empty": true,
+  "skip-full": true
+}

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+    "singleQuote": true,
+    "endOfLine": "crlf"
+}

.vscode/extensions.json

@@ -1,8 +1,7 @@
 {
   "recommendations": [
     "dbaeumer.vscode-eslint",
-    "shyykoserhiy.git-autoconfig",
-    "hbenl.vscode-mocha-test-adapter",
-    "esbenp.prettier-vscode"
+    "esbenp.prettier-vscode",
+    "hbenl.vscode-mocha-test-adapter"
   ]
 }

.vscode/settings.json

@@ -1,20 +1,18 @@
 {
-  "git.autofetch": true,
   "diffEditor.ignoreTrimWhitespace": false,
-  "javascript.updateImportsOnFileMove.enabled": "always",
-  "git.enableSmartCommit": true,
-  "[javascript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "editor.formatOnSave": true,
-  "prettier.useTabs": false,
-  "prettier.singleQuote": true,
-  "editor.tabSize": 2,
-  "editor.formatOnPaste": true,
   "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.accessibilitySupport": "off",
+  "editor.formatOnPaste": true,
+  "editor.formatOnSave": true,
+  "git.autofetch": true,
+  "git.enableSmartCommit": true,
   "javascript.preferences.importModuleSpecifierEnding": "minimal",
-  "[markdown]": {
-    "editor.wordWrap": "bounded"
-  }
+  "javascript.updateImportsOnFileMove.enabled": "always",
+  "mochaExplorer.nodeArgv": [
+    "--loader=ts-node/esm",
+    "--no-warnings=ExperimentalWarning",
+    "--experimental-specifier-resolution=node"
+  ],
+  "testExplorer.mergeSuites": true,
+  "eslint.experimental.useFlatConfig": true
 }
+

README.md

@@ -39,7 +39,7 @@ The `map` object is a [POJO](https://masteringjs.io/tutorials/fundamentals/pojo)
 
 The transformation output will reflect the structure of your `map` object and include any static values. To add mapping logic, use a structured value that consists of an object with a single `$` key, like this:
 
-```js
+```ts
 const map = {
   foo: 'static value passed directly to output',
   // Structure passed directly to output.
@@ -112,46 +112,6 @@ const output = await jsonMap.transform(input);
 
 The [unit tests](https://github.com/karmaniverous/jsonmap/blob/main/lib/JsonMap/JsonMap.test.js) demonstrate this example in action.
 
-# API Documentation
-
-<a name="JsonMap"></a>
-
-## JsonMap
-JsonMap class to apply transformations to a JSON object
-
-**Kind**: global class  
-
-* [JsonMap](#JsonMap)
-    * [new JsonMap([map], [lib], [options])](#new_JsonMap_new)
-    * [.transform(input)](#JsonMap+transform) ⇒ <code>object</code>
-
-<a name="new_JsonMap_new"></a>
-
-### new JsonMap([map], [lib], [options])
-Creates an instance of JsonMap.
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [map] | <code>object</code> | The data mapping configuration. |
-| [lib] | <code>object</code> | A collection of function libraries. |
-| [options] | <code>object</code> | Options object |
-| [options.ignore] | <code>string</code> | Regex pattern of keys to ignore. Defaults to '^\\$'. |
-| [options.logger] | <code>string</code> | Logger object |
-
-<a name="JsonMap+transform"></a>
-
-### jsonMap.transform(input) ⇒ <code>object</code>
-Transforms the input data according to the map configuration.
-
-**Kind**: instance method of [<code>JsonMap</code>](#JsonMap)  
-**Returns**: <code>object</code> - - The transformed data.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| input | <code>object</code> | The input data to be transformed. |
-
-
 ---
 
 See more great templates and other tools on