chore/merge sync template

.eslintrc

@@ -2,19 +2,10 @@
   "root": true,
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "project": [
-      "./tsconfig.json"
-    ]
+    "project": ["./tsconfig.json"]
   },
-  "plugins": [
-    "@typescript-eslint",
-    "sonarjs"
-  ],
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:sonarjs/recommended"
-  ],
+  "plugins": ["@typescript-eslint", "sonarjs", "filename-rules"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:sonarjs/recommended"],
   "ignorePatterns": [
     "**/*.js",
     "**/*.d.ts",
@@ -24,35 +15,22 @@
     "jest.config.ts",
     "knip.ts",
     "build",
-    "./lib",
-    "./dist"
+    "./dist",
+    "lib/**/*"
   ],
   "rules": {
-    "prefer-arrow-callback": [
-      "warn",
-      {
-        "allowNamedFunctions": true
-      }
-    ],
-    "func-style": [
-      "warn",
-      "declaration",
-      {
-        "allowArrowFunctions": false
-      }
-    ],
+    "filename-rules/match": [2, "/^(e2e\\.ts$|.*\\/e2e\\.ts$|[a-z0-9]+(?:[-._a-z0-9]+)*\\.ts|\\.[a-z0-9]+)$/"],
+    "prefer-arrow-callback": ["warn", { "allowNamedFunctions": true }],
+    "func-style": ["warn", "declaration", { "allowArrowFunctions": false }],
     "@typescript-eslint/no-floating-promises": "error",
     "@typescript-eslint/no-non-null-assertion": "error",
     "constructor-super": "error",
     "no-invalid-this": "off",
-    "@typescript-eslint/no-invalid-this": [
-      "error"
-    ],
-    "no-restricted-syntax": [
-      "error",
-      "ForInStatement"
-    ],
+    "@typescript-eslint/no-invalid-this": "error",
+    "no-restricted-syntax": ["error", "ForInStatement"],
     "use-isnan": "error",
+    "no-unneeded-ternary": "error",
+    "no-nested-ternary": "error",
     "@typescript-eslint/no-unused-vars": [
       "error",
       {
@@ -74,98 +52,15 @@
     "sonarjs/no-identical-expressions": "error",
     "@typescript-eslint/naming-convention": [
       "error",
-      {
-        "selector": "interface",
-        "format": [
-          "PascalCase"
-        ],
-        "custom": {
-          "regex": "^I[A-Z]",
-          "match": false
-        }
-      },
-      {
-        "selector": "memberLike",
-        "modifiers": [
-          "private"
-        ],
-        "format": [
-          "camelCase"
-        ],
-        "leadingUnderscore": "require"
-      },
-      {
-        "selector": "typeLike",
-        "format": [
-          "PascalCase"
-        ]
-      },
-      {
-        "selector": "typeParameter",
-        "format": [
-          "PascalCase"
-        ],
-        "prefix": [
-          "T"
-        ]
-      },
-      {
-        "selector": "variable",
-        "format": [
-          "camelCase",
-          "UPPER_CASE"
-        ],
-        "leadingUnderscore": "allow",
-        "trailingUnderscore": "allow"
-      },
-      {
-        "selector": "variable",
-        "format": [
-          "camelCase"
-        ],
-        "leadingUnderscore": "allow",
-        "trailingUnderscore": "allow"
-      },
-      {
-        "selector": "variable",
-        "modifiers": [
-          "destructured"
-        ],
-        "format": null
-      },
-      {
-        "selector": "variable",
-        "types": [
-          "boolean"
-        ],
-        "format": [
-          "PascalCase"
-        ],
-        "prefix": [
-          "is",
-          "should",
-          "has",
-          "can",
-          "did",
-          "will",
-          "does"
-        ]
-      },
-      {
-        "selector": "variableLike",
-        "format": [
-          "camelCase"
-        ]
-      },
-      {
-        "selector": [
-          "function",
-          "variable"
-        ],
-        "format": [
-          "camelCase"
-        ]
-      }
+      { "selector": "interface", "format": ["StrictPascalCase"], "custom": { "regex": "^I[A-Z]", "match": false } },
+      { "selector": "memberLike", "modifiers": ["private"], "format": ["strictCamelCase"], "leadingUnderscore": "require" },
+      { "selector": "typeLike", "format": ["StrictPascalCase"] },
+      { "selector": "typeParameter", "format": ["StrictPascalCase"], "prefix": ["T"] },
+      { "selector": "variable", "format": ["strictCamelCase", "UPPER_CASE"], "leadingUnderscore": "allow", "trailingUnderscore": "allow" },
+      { "selector": "variable", "modifiers": ["destructured"], "format": null },
+      { "selector": "variable", "types": ["boolean"], "format": ["StrictPascalCase"], "prefix": ["is", "should", "has", "can", "did", "will", "does"] },
+      { "selector": "variableLike", "format": ["strictCamelCase"] },
+      { "selector": ["function", "variable"], "format": ["strictCamelCase"] }
     ]
   }
-}
+}

.github/CODEOWNERS

@@ -0,0 +1 @@
+

.github/empty-string-checker.ts

@@ -0,0 +1,129 @@
+import * as core from "@actions/core";
+import { Octokit } from "@octokit/rest";
+import simpleGit from "simple-git";
+
+const token = process.env.GITHUB_TOKEN;
+const [owner, repo] = process.env.GITHUB_REPOSITORY?.split("/") || [];
+const pullNumber = process.env.GITHUB_PR_NUMBER || process.env.PULL_REQUEST_NUMBER || "0";
+const baseRef = process.env.GITHUB_BASE_REF;
+
+if (!token || !owner || !repo || pullNumber === "0" || !baseRef) {
+  core.setFailed("Missing required environment variables.");
+  process.exit(1);
+}
+
+const octokit = new Octokit({ auth: token });
+const git = simpleGit();
+
+async function main() {
+  try {
+    const { data: pullRequest } = await octokit.pulls.get({
+      owner,
+      repo,
+      pull_number: parseInt(pullNumber, 10),
+    });
+
+    const baseSha = pullRequest.base.sha;
+    const headSha = pullRequest.head.sha;
+
+    await git.fetch(["origin", baseSha, headSha]);
+
+    const diff = await git.diff([`${baseSha}...${headSha}`]);
+
+    core.info("Checking for empty strings...");
+    const violations = parseDiffForEmptyStrings(diff);
+
+    if (violations.length > 0) {
+      violations.forEach(({ file, line, content }) => {
+        core.warning(
+          "Detected an empty string.\n\nIf this is during variable initialization, consider using a different approach.\nFor more information, visit: https://www.github.com/ubiquity/ts-template/issues/31",
+          {
+            file,
+            startLine: line,
+          }
+        );
+      });
+
+      // core.setFailed(`${violations.length} empty string${violations.length > 1 ? "s" : ""} detected in the code.`);
+
+      await octokit.rest.checks.create({
+        owner,
+        repo,
+        name: "Empty String Check",
+        head_sha: headSha,
+        status: "completed",
+        conclusion: violations.length > 0 ? "failure" : "success",
+        output: {
+          title: "Empty String Check Results",
+          summary: `Found ${violations.length} violation${violations.length !== 1 ? "s" : ""}`,
+          annotations: violations.map((v) => ({
+            path: v.file,
+            start_line: v.line,
+            end_line: v.line,
+            annotation_level: "warning",
+            message: "Empty string found",
+            raw_details: v.content,
+          })),
+        },
+      });
+    } else {
+      core.info("No empty strings found.");
+    }
+  } catch (error) {
+    core.setFailed(`An error occurred: ${error instanceof Error ? error.message : String(error)}`);
+  }
+}
+
+function parseDiffForEmptyStrings(diff: string) {
+  const violations: Array<{ file: string; line: number; content: string }> = [];
+  const diffLines = diff.split("\n");
+
+  let currentFile: string;
+  let headLine = 0;
+  let inHunk = false;
+
+  diffLines.forEach((line) => {
+    const hunkHeaderMatch = /^@@ -\d+(?:,\d+)? \+(\d+)(?:,\d+)? @@/.exec(line);
+    if (hunkHeaderMatch) {
+      headLine = parseInt(hunkHeaderMatch[1], 10);
+      inHunk = true;
+      return;
+    }
+
+    if (line.startsWith("--- a/") || line.startsWith("+++ b/")) {
+      currentFile = line.slice(6);
+      inHunk = false;
+      return;
+    }
+
+    // Only process TypeScript files
+    if (!currentFile?.endsWith(".ts")) {
+      return;
+    }
+
+    if (inHunk && line.startsWith("+")) {
+      // Check for empty strings in TypeScript syntax
+      if (/^\+.*""/.test(line)) {
+        // Ignore empty strings in comments
+        if (!line.trim().startsWith("//") && !line.trim().startsWith("*")) {
+          // Ignore empty strings in template literals
+          if (!/`[^`]*\$\{[^}]*\}[^`]*`/.test(line)) {
+            violations.push({
+              file: currentFile,
+              line: headLine,
+              content: line.substring(1).trim(),
+            });
+          }
+        }
+      }
+      headLine++;
+    } else if (!line.startsWith("-")) {
+      headLine++;
+    }
+  });
+
+  return violations;
+}
+main().catch((error) => {
+  core.setFailed(`Error running empty string check: ${error instanceof Error ? error.message : String(error)}`);
+});

.github/knip.ts

@@ -0,0 +1,13 @@
+import type { KnipConfig } from "knip";
+
+const config: KnipConfig = {
+  entry: ["build/index.ts", ".github/empty-string-checker.ts"],
+  project: ["src/**/*.ts"],
+  ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"],
+  ignoreExportsUsedInFile: true,
+  // eslint can also be safely ignored as per the docs: https://knip.dev/guides/handling-issues#eslint--jest
+  ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@types/jest", "@mswjs/data"],
+  eslint: true,
+};
+
+export default config;

.github/workflows/build.yml

@@ -0,0 +1,33 @@
+name: Build
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.10.0
+
+      - name: Build
+        run: |
+          yarn
+          yarn build
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: static
+          path: static

.github/workflows/conventional-commits.yml

@@ -8,5 +8,5 @@ jobs:
     name: Conventional Commits
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ubiquity/action-conventional-commits@master

.github/workflows/jest-testing.yml

@@ -18,6 +18,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: "20.10.0"
+
       - uses: actions/checkout@master
         with:
           fetch-depth: 0
@@ -28,7 +29,7 @@ jobs:
           version: nightly
 
       - name: Install dependencies
-        run: yarn install
+        run: yarn install --immutable --immutable-cache --check-cache
 
       - name: Build
         run: yarn build

.github/workflows/knip.yml

@@ -10,6 +10,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      # needed to use yarn v4
+      - name: Enable corepack
+        run: corepack enable
+
       - name: Setup Node
         uses: actions/setup-node@v4
         with: