chore: update eslint setup and sync boilerplate changes

.boilerplate-version

@@ -0,0 +1 @@
+d769f2d57af542dd1ef245dc3594d9e5ac6e31dc

.github/workflows/release.yml

@@ -6,6 +6,6 @@ on:
 
 jobs:
   release:
-    name: '/'
+    name: 'Release'
     uses: technology-studio/github-workflows/.github/workflows/_release.yml@main
     secrets: inherit

.ncurc.json

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

.nvmrc

@@ -1 +1 @@
-lts/*
+22.13.1

.vscode/launch.json

@@ -8,7 +8,7 @@
       "name": "Debug Jest Tests",
       "type": "node",
       "request": "launch",
-      "runtimeArgs": [ "--inspect-brk", "${workspaceRoot}/node_modules/.bin/jest", "--runInBand", "--coverage", "false", "${file}" ],
+      "runtimeArgs": ["--inspect-brk", "${workspaceRoot}/node_modules/.bin/jest", "--runInBand", "--coverage", "false", "${file}"],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen"
     },
@@ -17,8 +17,8 @@
       "type": "node",
       "request": "launch",
       "runtimeExecutable": "yarn",
-      "args": [ "test", "--runInBand", "--coverage=false", "${file}" ],
-      "runtimeArgs": [ "--inspect-brk" ],
+      "args": ["test", "--runInBand", "--coverage=false", "${file}"],
+      "runtimeArgs": ["--inspect-brk"],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen"
     },

__tests__/Tests/Lint.test.ts

@@ -9,8 +9,6 @@ import { ESLint } from 'eslint'
 test('shoud not have lint issues', async () => {
   const eslint = new ESLint()
   const results = await eslint.lintFiles(['test/**/*.tsx'])
-  // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- result should have no errors
   const isWithoutError = results.every((result: { errorCount: number }) => result.errorCount === 0)
   expect(isWithoutError).toBe(true)
-  // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- we want to make the timeout longer
 }, 20000)

__tests__/tsconfig.json

@@ -1,6 +1,13 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
+    "paths": {
+      "Config/*": [ "./__tests__/Config/*" ],
+      "Data/*": [ "./__tests__/Data/*" ],
+      "Utils/*": [ "./__tests__/Utils/*" ],
+      "src": [ "./src" ],
+      "src/*": [ "./src/*" ]
+    }
   },
   "include": [
     "./**/*.ts"

eslint-ci-rules.json

@@ -0,0 +1 @@
+[]

eslint-ci.config.js

@@ -0,0 +1,13 @@
+import ciRules from './eslint-ci-rules.json' with { type: 'json' }
+
+export default (async function config() {
+  const { default: defaultConfigPromise } = await import('./eslint.config.js')
+  const defaultConfig = await defaultConfigPromise
+  return [
+    ...defaultConfig,
+    {
+      files: ['**/*.ts', '**/*.tsx'],
+      rules: ciRules.reduce((acc, rule) => ({ ...acc, [rule]: 'warn' }), {}),
+    },
+  ]
+})()

eslint.config.js

@@ -1,6 +1,7 @@
 import {
-  typescriptConfigList,
+  jestConfig,
   stylisticConfig,
+  typescriptConfigList,
   typescriptEslintConfig
 } from 'eslint-config-txo-typescript'
 import {
@@ -13,12 +14,23 @@ export default typescriptEslintConfig(
     files: ['**/*.ts', '**/*.tsx'],
     extends: [
       ...typescriptConfigList,
+      // TODO: remove after migrating to prettier
       stylisticConfig,
       reactConfig,
     ]
   },
+  {
+    files: ['__tests__/**/*.ts', '__tests__/**/*.tsx'],
+    extends: [
+      jestConfig,
+    ]
+  },
   {
     ignores: [
+      'commitlint.config.js',
+      'jest.config.js',
+      '.releaserc.js',
+      'eslint.config.js',
       'coverage',
       'lib',
       'node_modules',

jest.config.js

@@ -4,8 +4,11 @@
  * @Copyright: Technology Studio
 **/
 
+import { pathsToModuleNameMapper } from 'ts-jest'
 import { defaults } from 'jest-config'
 
+import tsconfig from './__tests__/tsconfig.json' with { type: 'json' }
+
 export default {
   preset: 'ts-jest',
   cache: true,
@@ -28,4 +31,5 @@ export default {
       tsconfig: '<rootDir>/__tests__/tsconfig.json'
     }]
   },
+  moduleNameMapper: pathsToModuleNameMapper(tsconfig.compilerOptions.paths, { prefix: '<rootDir>/' }),
 }

package.json

@@ -21,23 +21,26 @@
     "build:lib": "yarn tsc",
     "build:watch": "yarn tsc --watch",
     "build": "yarn build:clean && yarn build:lib",
+    "compare-boilerplate-version": "./scripts/compare-boilerplate-version.sh",
     "coverage": "jest --coverage && open coverage/lcov-report/index.html || xdg-open coverage/lcov-report/index.html",
-    "lint:ci": "yarn lint",
+    "lint:ci": "yarn eslint -c eslint-ci.config.js --cache . && yarn txo-eslint ccr --cache",
     "lint:fix": "eslint . --fix",
     "lint": "eslint --max-warnings 0 .",
     "prepare": "husky && yarn build",
-    "sanity": "yarn build && yarn lint:ci && tsc --noEmit && yarn test --coverage && echo 'success'",
+    "print-txo-packages": "yarn list 2> /dev/null|grep @txo|sed 's/.*\\(@txo[^@]*\\)@^*\\([^ ]*\\).*/\\1@\\2/g'|sort|uniq",
+    "sanity": "yarn build && yarn lint:ci && tsc --noEmit && yarn test --coverage && yarn compare-boilerplate-version && echo 'success'",
     "semantic-release": "semantic-release",
     "test:watch": "concurrently \"yarn build:watch\" \"yarn test --watch\"",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-    "type-check": "tsc --noEmit"
+    "type-check": "tsc --noEmit",
+    "update-boilerplate-version": "./scripts/update-boilerplate-version.sh"
   },
   "engines": {
     "node": ">=18.0.0"
   },
   "dependencies": {
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^5.1.0"
   },
   "devDependencies": {
@@ -47,10 +50,11 @@
     "@types/eslint": "^9.6.1",
     "@types/jest": "^29.5.14",
     "@types/react": "^18.3.24",
-    "eslint-config-txo-typescript": "^7.3.8",
+    "eslint-config-txo-typescript": "^7.4.10",
     "husky": "^9.1.7",
     "jest": "^29.7.0",
     "lint-staged": "^16.1.6",
+    "npm-check-updates": "^17.1.14",
     "react": "^18.3.1",
     "rimraf": "^6.0.1",
     "ts-jest": "^29.4.4",

scripts/compare-boilerplate-version.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+LATEST=$(
+  git ls-remote -h git@github.com:technology-studio/test-boilerplate-typescript.git |
+  grep refs/heads/master | awk '{ print $1 }'
+)
+CURRENT=$(cat .boilerplate-version)
+echo "Latest version: $LATEST"
+echo "Current version: $CURRENT"
+if [ "$LATEST" != "$CURRENT" ]; then
+  echo "🚫 Boilerplate versions do not match! Check test-boilerplate-typescript repo for new changes."
+  exit 1
+fi
+echo "✅ Boilerplate versions match!"

scripts/update-boilerplate-version.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+LATEST=$(
+  git ls-remote -h git@github.com:technology-studio/test-boilerplate-typescript.git |
+  grep refs/heads/master | awk '{ print $1 }'
+)
+echo $LATEST > .boilerplate-version
+echo "Updated boilerplate version to: $LATEST"

src/index.ts

@@ -24,7 +24,6 @@ export const reactConfig: Linter.Config = {
   plugins: {
     'jsx-a11y': eslintPluginJsxA11y,
     'react-hooks': eslintPluginReactHooks,
-    // @ts-expect-error -- TODO: eslint-plugin-react has broken types, remove when new version is published - https://github.com/jsx-eslint/eslint-plugin-react/pull/3840
     'react': eslintPluginReact,
   },
 }

tsconfig.base.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@txo/tsconfig",
+}

tsconfig.json

@@ -1,15 +1,14 @@
 {
-  "extends": "@txo/tsconfig",
+  "extends": "./tsconfig.base.json",
   "compilerOptions": {
-    "declaration": true,
     "noEmit": false,
-    "outDir": "lib",
-    "typeRoots": [
-      "node_modules/@types",
-      "src/types"
-    ]
+    "declaration": true,
+    "outDir": "./lib"
   },
   "include": [
     "src/**/*"
+  ],
+  "exclude": [
+    "node_modules"
   ]
 }