Merge pull request #3 from ariesgun/sync-template/development

* feat: initial commit * feat: add TS support * feat: add conventional commits * feat: add dotenv * docs: add readme * feat: add pull request template * Create cloudflare-deploy * feat: create helloWorld index.html * feat: push action for development branch * feat: update readme * Update cloudflare-deploy.yml * fix: rename pull_request_template * Update conventional-commits.yml Use our version which supports GitHub UI updates. * chore: update dependencies and prettier * chore: update package json * Update conventional-commits.yml * Update cloudflare-deploy.yml Had to fix because `.nvmrc` is not compatible ``` error [email protected]: The engine "node" is incompatible with this module. Expected version ">=v20.3.0". Got "18.14.1" ``` * Update cloudflare-deploy.yml * feat: format on lint-staged * fix: commit-msg script and add lint-staged command * feat: prefer named functions * feat: add naming conventions rule * feat: easy ui support * feat: easy ui support * fix: prettier for css * chore: add .env file to .gitignore * fix: lint staged * fix: lint staged * chore: remove tabs ubiquity-os/ubiquity-os-kernel#2 (comment) * feat: reusable deploy script * feat: ban non null assertions resolves ubiquity/ts-template#7 * Update README.md * feat: spell check on commit * feat: copy typescript rules https://github.com/krzkaczor/TypeStrict.git thanks @krzkaczor * chore: remove no unnecessary condition for false positives * fix: forgot to include cspell * fix: cspell ci * fix(ci): cspell * chore: remove deprecated * feat(cspell): support colors * fix(ci): cspell * feat: production deploys related ubiquity/pay.ubq.fi#153 * chore: set up build for cd * chore(deps): upgrade all * chore: test on another brnach * chore: bump ci * chore: bump ci * chore: bump ci * chore: bump ci * chore: bump ci * chore: bump ci * feat: workflow dispatch * Merge branch 'test/cd' * chore: debug cd * chore: debug cd * chore: debug cd * chore: debug cd * feat: add knip CI configuration Resolves: ubiquity/ts-template#12 * feat: commit or pr * feat: workflow dispatch * chore: test env vars * Squashed commit of the following: commit 1dcef50 Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 06:52:34 2024 +0900 chore: test env vars commit 126e819 Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 06:51:03 2024 +0900 feat: workflow dispatch commit dbec9e3 Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 06:39:04 2024 +0900 feat: commit or pr commit d61f01e Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 04:18:18 2024 +0900 chore: debug cd commit 9a8fc77 Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 04:07:39 2024 +0900 chore: debug cd commit ea72c5e Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 04:06:43 2024 +0900 chore: debug cd commit de20331 Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 04:01:17 2024 +0900 chore: debug cd commit dc336a9 Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 03:46:41 2024 +0900 feat: workflow dispatch commit 0002fec Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 03:41:18 2024 +0900 chore: bump ci commit 56a8cf8 Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 03:34:16 2024 +0900 chore: bump ci commit ad2564c Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 03:33:38 2024 +0900 chore: bump ci commit 3ad759b Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 03:20:33 2024 +0900 chore: bump ci commit 8b25785 Author: アレクサンダー.eth <[email protected]> Date: Tue Feb 20 01:46:52 2024 +0900 chore: bump ci commit d117e10 Author: アレクサンダー.eth <[email protected]> Date: Mon Feb 19 23:33:58 2024 +0900 chore: bump ci commit d3b5d08 Author: アレクサンダー.eth <[email protected]> Date: Mon Feb 19 21:46:37 2024 +0900 chore: test on another brnach * fix: whitespace * fix: transport secrets * fix: app installation if * feat: new github env style * chore: update Knip yaml actions As suggested during pull request review. * chore: update supabase key name ref: ubiquity/pay.ubq.fi#164 (comment) * fix(ci): on prs * fix: change dist to static untested but in a rush and i think this is correct * Update esbuild-server.ts * fix: gitignore * fix: commit sha * feat: default Jest testing configuration * Update .github/workflows/jest-testing.yml * chore: moved jest config from js to ts * chore: removed unused check to trigger Jest Action * feat: cypress testing suite * feat: default Jest testing configuration (ubiquity#19) * feat: default Jest testing configuration * Update .github/workflows/jest-testing.yml * chore: moved jest config from js to ts * chore: removed unused check to trigger Jest Action --------- Co-authored-by: アレクサンダー.eth <[email protected]> * chore: updated yarn.lock * chore: removed checks for warn messages in the console * fix: disabled comments on every push, and added default value for coverage * chore: moved knip configuration * chore: workflow dispatch for knip * chore: workflow dispatch for knip * chore: changed action target to pull_request_target * chore: added test section to README.md * ci(cspell): fix * Create CODEOWNERS Congratulations on the promotion @FernandVEYRIER * chore: added missing dep * chore: added ignore rules to knip * chore: removed ts-node dep and changed jest config * chore: added ternary rules for eslint * chore: fixed trailing space in conf * ci: add init workflow * feat: release please Action * chore: changed release to target default branch * chore: changed release to target default branch * chore: added permissions to release please * chore: removed npm env variable * Update release-please.yml * Update CODEOWNERS * ci: pass cloudflare credentials * ci: add reusable cloudflare deploy * ci: use single action * ci: update deploy.yml * chore: add pascal case linter to enforce Erc20Permit and Erc721Permit naming conventions * chore: enable StrictPascalCase on all Identifiers * chore: undo unnecessary changes * chore: add eslint-filename plugin * revert camelCase deletions and change to strictCamelCase * fix: use regex and ignore e2e.ts * chore: eslint config type inference * chore: update knip configuration in the template to run on pull_request * fix: moved eslint from js to json and accept numbers in file names * fix: workflow release please * fix: workflow cypress * chore: test reporting lib * chore: test reporting lib * chore: test reporting lib * chore: test reporting lib * Update jest-testing.yml * chore: find PR number * chore: remove event * chore: test pr number * chore: test pr number * chore: test pr number * chore: test comment * chore: test comment * chore: revert default branch for release-please.yml * chore: revert default branch for release-please.yml --------- Co-authored-by: rndquu <[email protected]> Co-authored-by: アレクサンダー.eth <[email protected]> Co-authored-by: 0xCodercrane <[email protected]> Co-authored-by: アレクサンダー.eth <[email protected]> Co-authored-by: rndquu <[email protected]> Co-authored-by: Korrrba <[email protected]> Co-authored-by: Fernando <[email protected]> Co-authored-by: Fernand <[email protected]> Co-authored-by: jordan-ae <[email protected]> Co-authored-by: jordan-ae <[email protected]> Co-authored-by: Keyrxng <[email protected]> Co-authored-by: アレクサンダー.eth <[email protected]> Co-authored-by: Mentlegen <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
ariesgun · Oct 13, 2024 · 14f864e · 14f864e
2 parents e82c7e4 + 627f969
commit 14f864e
Show file tree

Hide file tree

Showing 32 changed files with 3,004 additions and 105 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -1,4 +1,11 @@
 {
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
-  "words": ["devpool", "octocat", "ratelimit", "supabase", "UBIQUIBOT"]
-}
+  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log"],
+  "useGitignore": true,
+  "language": "en",
+  "words": ["dataurl", "devpool", "outdir", "servedir", "octocat", "ratelimit", "supabase", "UBIQUIBOT", "greyscale", "devrel", "fract", "VZLJ", "localstorage"],
+  "dictionaries": ["typescript", "node", "software-terms"],
+  "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"],
+  "ignoreRegExpList": ["[0-9a-fA-F]{6}"]
+}
diff --git a/.eslintrc b/.eslintrc
@@ -4,27 +4,53 @@
   "parserOptions": {
     "project": ["./tsconfig.json"]
   },
-  "plugins": ["@typescript-eslint"],
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "plugins": ["@typescript-eslint", "sonarjs", "filename-rules"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:sonarjs/recommended"],
   "ignorePatterns": ["**/*.js"],
   "rules": {
-    "prefer-arrow-callback": ["warn", { "allowNamedFunctions": true }], // Disallow arrow functions as expressions
-    "func-style": ["warn", "declaration", { "allowArrowFunctions": false }], // Disallow the use of function expressions
+    "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"],
+    "use-isnan": "error",
+    "no-unneeded-ternary": "error",
+    "no-nested-ternary": "error",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "args": "after-used",
+        "ignoreRestSiblings": true,
+        "vars": "all",
+        "varsIgnorePattern": "^_",
+        "argsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/await-thenable": "error",
+    "@typescript-eslint/no-misused-new": "error",
+    "@typescript-eslint/restrict-plus-operands": "error",
+    "sonarjs/no-all-duplicated-branches": "error",
+    "sonarjs/no-collection-size-mischeck": "error",
+    "sonarjs/no-duplicated-branches": "error",
+    "sonarjs/no-element-overwrite": "error",
+    "sonarjs/no-identical-conditions": "error",
+    "sonarjs/no-identical-expressions": "error",
     "@typescript-eslint/naming-convention": [
       "error",
-      { "selector": "typeLike", "format": ["PascalCase"] },
-      { "selector": "variableLike", "format": ["camelCase"] },
-      { "selector": "memberLike", "modifiers": ["private"], "format": ["camelCase"], "leadingUnderscore": "require" },
-      { "selector": "variable", "types": ["boolean"], "format": ["PascalCase"], "prefix": ["is", "should", "has", "can", "did", "will"] },
-      { "selector": "variable", "format": ["camelCase", "UPPER_CASE"], "leadingUnderscore": "allow", "trailingUnderscore": "allow" },
-      { "selector": "typeParameter", "format": ["PascalCase"], "prefix": ["T"] },
-      { "selector": "interface", "format": ["PascalCase"], "custom": { "regex": "^I[A-Z]", "match": false } },
-      { "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", "format": ["strictCamelCase"], "leadingUnderscore": "allow", "trailingUnderscore": "allow" },
       { "selector": "variable", "modifiers": ["destructured"], "format": null },
-      { "selector": "variable", "format": ["camelCase"], "leadingUnderscore": "allow", "trailingUnderscore": "allow" },
-      { "selector": "variable", "types": ["boolean"], "format": ["PascalCase"], "prefix": ["is", "has", "should", "can", "did", "will"] }
+      { "selector": "variable", "types": ["boolean"], "format": ["StrictPascalCase"], "prefix": ["is", "should", "has", "can", "did", "will", "does"] },
+      { "selector": "variableLike", "format": ["strictCamelCase"] },
+      { "selector": ["function", "variable"], "format": ["strictCamelCase"] }
     ]
   }
 }
diff --git a/.github/empty-string-checker.ts b/.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)}`);
+});
diff --git a/.github/knip.ts b/.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;
diff --git a/.github/workflows/cspell.yml b/.github/workflows/cspell.yml
@@ -0,0 +1,24 @@
+name: Spell Check
+
+on:
+  push:
+
+jobs:
+  spellcheck:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - name: Install cspell
+        run: yarn add cspell
+
+      - name: Run cspell
+        run: yarn format:cspell
diff --git a/.github/workflows/cypress-testing.yml b/.github/workflows/cypress-testing.yml
@@ -1,7 +1,10 @@
 name: Run Cypress testing suite
 on:
   workflow_dispatch:
-  pull_request:
+  workflow_run:
+    workflows: ["Build"]
+    types:
+      - completed
 
 jobs:
   cypress-run:
@@ -18,12 +21,8 @@ jobs:
           build: yarn run build
           start: yarn start
         env:
-          NODE_ENV: "test"
           CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          # Values are set because the code requires them, but they are not actually used.
-          SUPABASE_URL: "https://wfzpewmlyiozupulbuur.supabase.co"
-          SUPABASE_ANON_KEY: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6IndmenBld21seWlvenVwdWxidXVyIiwicm9sZSI6ImFub24iLCJpYXQiOjE2OTU2NzQzMzksImV4cCI6MjAxMTI1MDMzOX0.SKIL3Q0NOBaMehH0ekFspwgcu3afp3Dl9EDzPqs1nKs"
       - uses: actions/upload-artifact@v4
         if: failure()
         with:

diff --git a/.github/workflows/jest-testing.yml b/.github/workflows/jest-testing.yml
@@ -0,0 +1,27 @@
+name: Run Jest testing suite
+on:
+  workflow_dispatch:
+  pull_request:
+
+env:
+  NODE_ENV: "test"
+
+jobs:
+  testing:
+    permissions: write-all
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+
+      - name: Jest With Coverage
+        run: yarn install --immutable --immutable-cache --check-cache && yarn test
+
+      - name: Add Jest Report to Summary
+        if: always()
+        run: echo "$(cat test-dashboard.md)" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/knip-reporter.yml b/.github/workflows/knip-reporter.yml
@@ -0,0 +1,38 @@
+name: Knip-reporter
+
+on:
+  workflow_run:
+    workflows: ["Knip"]
+    types:
+      - completed
+
+jobs:
+  knip-reporter:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion != 'success' }}
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: knip-results
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Read pr number
+        id: pr-number
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ./pr-number.txt
+          trim: true
+
+      - name: Report knip results to pull request
+        uses: gitcoindev/knip-reporter@main
+        with:
+          verbose: true
+          comment_id: ${{ github.workflow }}-reporter
+          command_script_name: knip-ci
+          annotations: true
+          ignore_results: false
+          json_input: true
+          json_input_file_name: knip-results.json
+          pull_request_number: ${{ steps.pr-number.outputs.content }}
+          token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/knip.yml b/.github/workflows/knip.yml
@@ -0,0 +1,38 @@
+name: Knip
+
+on:
+  pull_request:
+
+jobs:
+  run-knip:
+    runs-on: ubuntu-latest
+    steps:
+      - 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:
+          node-version: 20.10.0
+
+      - name: Install toolchain
+        run: yarn install
+
+      - name: Store PR number
+        run: echo ${{ github.event.number }} > pr-number.txt
+
+      - name: Run Knip
+        run: yarn knip || yarn knip --reporter json > knip-results.json
+
+      - name: Upload knip result
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: knip-results
+          path: |
+            knip-results.json
+            pr-number.txt