refactor: migrate package (#3)

* refactor: migrate package

* chore(deps): bump version technology-studio-forks/markdown-embed-code@v1.1.4

* chore: upgrade checkout action to v3


---------

Co-authored-by: github-actions <github-actions@github.com>

.boilerplate-version

@@ -0,0 +1 @@
+fbb58dd35ba36ecc8dad791268120463b53a6815

.eslintignore

@@ -1,2 +1,4 @@
-packages/**/node_modules/**
-packages/**/lib/**
+commitlint.config.js
+jest.config.js
+lib
+release.config.js

.eslintrc.json

@@ -3,5 +3,11 @@
     "txo-typescript",
     "plugin:jest/recommended"
   ],
-  "parser": "@typescript-eslint/parser"
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": [
+      "./tsconfig.json",
+      "./__tests__/tsconfig.json"
+    ]
+  }
 }

.github/workflows/code-style.yml

@@ -0,0 +1,21 @@
+name: 'Code style'
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+          node-version-file: '.nvmrc'
+      - run: yarn install --frozen-lockfile
+      - run: yarn lint

.github/workflows/pr.yml

@@ -0,0 +1,17 @@
+name: "PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Ensure semantic PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+          node-version-file: '.nvmrc'
+      - run: yarn install --frozen-lockfile
+      - run: yarn test --coverage
+      - uses: codecov/codecov-action@v3
+      - run: yarn semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELASE_GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          SLACK_WEBHOOK: ${{ secrets.SEMANTIC_RELEASE_SLACK_WEBHOOK }}

.github/workflows/resolve-yarn-lock-caller.yml

@@ -0,0 +1,13 @@
+name: Resolve yarn.lock
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  resolve-yarn-lock-on-comment:
+    if: contains(github.event.comment.body, '/resolve yarn.lock')
+    uses: technology-studio/github-workflows/.github/workflows/resolve-yarn-lock.yml@main
+    with:
+      pr-number: ${{ github.event.issue.number }}
+      repo: ${{ github.repository }}

.github/workflows/sync-code-in-readme.yaml

@@ -1,4 +1,4 @@
-name: Embed code in README
+name: Embed code in README (test)
 
 on:
   push:
@@ -12,11 +12,11 @@ jobs:
   embed-code:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           persist-credentials: false
           fetch-depth: 0
-      - uses: technology-studio-forks/markdown-embed-code@v1.1.0
+      - uses: technology-studio-forks/markdown-embed-code@v1.1.4
         with:
           markdown: "README.md"
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: 'Test'
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  test:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+          node-version-file: '.nvmrc'
+      - run: yarn install --frozen-lockfile
+      - run: yarn test --coverage
+      - uses: codecov/codecov-action@v3

.gitignore

@@ -6,6 +6,7 @@
 # node.js
 #
 node_modules/
+.eslintcache
 npm-debug.log
 yarn-error.log
 lib

.husky/pre-push → .husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn git-hook
+yarn commitlint --edit "${1}"

.husky/pre-commit

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

.husky/prepare-commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit || exec < /dev/tty && yarn cz --hook > /dev/null 2>&1 || true

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*.{js,jsx,ts,tsx}": "eslint --cache --format=node_modules/eslint-formatter-pretty --ext .ts,.tsx"
+}

.ncurc.json

@@ -0,0 +1,3 @@
+{
+  "dep": "dev,prod,peer"
+}

.npmignore

@@ -0,0 +1,7 @@
+**
+!/src/
+!/src/**/*
+!/lib/
+!/lib/**/*
+!/*.md
+!/package.json

.nvmrc

@@ -1 +1 @@
-lts/fermium
+lts/*

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Jest Tests",
+      "type": "node",
+      "request": "launch",
+      "runtimeArgs": ["--inspect-brk", "${workspaceRoot}/node_modules/.bin/jest", "--runInBand", "--coverage", "false"],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    },
+  ]
+}

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib"
-}
+}

__tests__/Config/LogConfig.ts

@@ -15,13 +15,14 @@ configManager.update({
   loggerConfigMap: {
     [ConsoleLogger.LOGGER_KEY]: {
       writeLog: ConsoleLogger.writeLog,
-      nodeEnvironmentList: ['production', 'development'],
+      nodeEnvironmentList: ['production', 'development', 'test'],
     },
     // [ReactotronLogger.LOGGER_KEY]: {
     //   writeLog: ReactotronLogger.writeLog,
     //   nodeEnvironmentList: ['development'],
     // },
   },
+  payloadProcessor: () => (payload: Record<string, unknown>) => JSON.stringify(payload, null, 2),
   defaultLevelForNodeEnvironmentMap: {
     production: Level.ERROR,
     development: Level.INFO,

__tests__/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig-base.json",
+  "compilerOptions": {
+  },
+  "include": [
+    "./**/*.ts"
+  ]
+}

commitlint.config.js

@@ -0,0 +1,19 @@
+/**
+ * @Author: Rostislav Simonik <rostislav.simonik@technologystudio.sk>
+ * @Date: 2022-08-21T12:08:59+02:00
+ * @Copyright: Technology Studio
+**/
+
+const automaticCommitPattern = /^chore\(release\):.*\[skip ci]/
+
+const commitlintConfig = {
+  extends: [
+    '@commitlint/config-conventional',
+  ],
+
+  ignores: [
+    commitMsg => automaticCommitPattern.test(commitMsg),
+  ],
+}
+
+module.exports = commitlintConfig

jest.config.js

@@ -0,0 +1,36 @@
+/**
+ * @Author: Rostislav Simonik <rostislav.simonik@technologystudio.sk>
+ * @Date: 2021-05-15T12:05:47+02:00
+ * @Copyright: Technology Studio
+**/
+
+const { pathsToModuleNameMapper } = require('ts-jest')
+const { compilerOptions } = require('./tsconfig.json');
+
+const { defaults } = require('jest-config');
+
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: [
+    '<rootDir>/__tests__/Tests/**/?(*.)(spec|test).ts'
+  ],
+  transformIgnorePatterns: [
+    '/node_modules/(?!@txo).+\\.js$'
+  ],
+  testPathIgnorePatterns: [
+    '/node_modules/'
+  ],
+  setupFiles: [
+    '<rootDir>/__tests__/Setup.ts'
+  ],
+  moduleFileExtensions: [
+    ...defaults.moduleFileExtensions,
+  ],
+  transform: {
+    '^.+\\.tsx?$': ['ts-jest', {
+      tsconfig: './tsconfig.json'
+    }]
+  },
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths , { prefix: '<rootDir>/' } ),
+}