[TASK] code refactoring (#1)

Author: dmh

.editorconfig

@@ -14,7 +14,7 @@ indent_style = space
 indent_size = 4
 
 # TypeScript/JavaScript/JSON files
-[*.{ts,js,json}]
+[*.{ts,js,json,mjs}]
 indent_size = 2
 
 # XLF/XML files
@@ -25,15 +25,6 @@ indent_style = tab
 [*.{yaml,yml}]
 indent_size = 2
 
-# ReST-Files
-[*.rst]
-indent_size = 3
-
-# SQL files
-[*.sql]
-indent_style = tab
-indent_size = 2
-
 # HTML files
 [*.html]
 indent_size = 2

.github/workflows/git-commit.yml

@@ -9,6 +9,7 @@ jobs:
   check-commit-message:
     name: Check Commit Message
     runs-on: ubuntu-latest
+    timeout-minutes: 30
 
     steps:
       - name: Check Commit Type

.github/workflows/publish-npm.yml

@@ -0,0 +1,22 @@
+name: Publish NPM Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: 'npm'
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm test
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}

.github/workflows/test.yml

@@ -4,42 +4,22 @@ on: [push, pull_request]
 
 jobs:
 
-  main:
-    name: Run tests
+  build:
+    name: Node
     runs-on: ubuntu-latest
-
+    timeout-minutes: 30
     strategy:
       matrix:
-        node-version: [16.x]
-
+        node: [18, 20]
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Node.js v${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Get npm cache directory
-        id: npm-cache
-        run: |
-          echo "::set-output name=dir::$(npm config get cache)"
-
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v3
+      - name: Setup Node.js v${{ matrix.node }}
+        uses: actions/setup-node@v3
         with:
-          path: ${{ steps.npm-cache.outputs.dir }}
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - name: Install npm@^8
-        run: npm install -g npm@^8
-
-      - name: Install npm dependencies
-        run: npm ci
-
-      - name: Run npm test
-        run: npm test
+          node-version: ${{ matrix.node }}
+          cache: 'npm'
+      - run: npm ci
+      - run: npm test
 
       - name: PKG versions
         run: |

.gitignore

@@ -5,3 +5,8 @@ node_modules
 .env*
 .idea
 .tmp
+temp
+.DS_Store
+npm-debug.log
+*.sublime-*
+validation-status.json

.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npm test

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Resultify <info@resultify.se> (https://www.resultify.se/)
+Copyright (c) 2022 - present Resultify
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

bin/rh-cli.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
-import { init } from '../lib/cli.js'
+import { init } from '../lib/init.js'
 await init()

jsconfig.json

@@ -1,8 +1,12 @@
 {
   "compilerOptions": {
-    "target": "esnext",
     "module": "esnext",
+    "target": "esnext",
+    "strict": true,
     "checkJs": true,
+    "forceConsistentCasingInFileNames": true,
+    "useUnknownInCatchVariables": false,
     "moduleResolution": "node"
-  }
+  },
+  "include": ["lib/**/*", "bin/**/*"],
 }

jsdoc.json

@@ -0,0 +1,22 @@
+{
+  "plugins": ["plugins/markdown"],
+  "source": {
+    "include": ["lib/"]
+  },
+  "templates": {
+    "cleverLinks": true,
+    "default": {
+      "includeDate": false
+    }
+  },
+  "opts": {
+    "template": "node_modules/modern-jsdoc-template/default",
+    "readme": "./README.md",
+    "destination": "./docs/",
+    "recurse": true,
+    "verbose": true
+  },
+  "markdown": {
+    "idInHeadings": true
+  }
+}