Initial commit

.cspell.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log"],
+  "useGitignore": true,
+  "language": "en",
+  "words": ["dataurl", "devpool", "outdir", "servedir"],
+  "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}"]
+}

.env.example

@@ -0,0 +1 @@
+MY_SECRET="MY_SECRET"

.eslintrc

@@ -0,0 +1,53 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": ["./tsconfig.json"]
+  },
+  "plugins": ["@typescript-eslint", "sonarjs"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:sonarjs/recommended"],
+  "ignorePatterns": ["**/*.js"],
+  "rules": {
+    "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",
+    "@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": "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"] }
+    ]
+  }
+}

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @FernandVEYRIER

.github/knip.ts

@@ -0,0 +1,11 @@
+import type { KnipConfig } from "knip";
+
+const config: KnipConfig = {
+  entry: ["build/index.ts"],
+  project: ["src/**/*.ts"],
+  ignore: ["src/types/config.ts"],
+  ignoreExportsUsedInFile: true,
+  ignoreDependencies: [],
+};
+
+export default config;

.github/pull_request_template.md

@@ -0,0 +1,6 @@
+Resolves #
+
+<!--
+- You must link the issue number e.g. "Resolves #1234"
+- Please do not replace the keyword "Resolves" https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
+-->

.github/workflows/build.yml

@@ -0,0 +1,42 @@
+name: Build & Deploy
+
+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
+        # with:
+        # submodules: "recursive" # Ensures submodules are checked out
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.10.0
+
+      - name: Build
+        run: |
+          yarn
+          yarn build
+        # env: # Set environment variables for the build
+          # SUPABASE_URL: "https://wfzpewmlyiozupulbuur.supabase.co"
+          # SUPABASE_ANON_KEY: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6IndmenBld21seWlvenVwdWxidXVyIiwicm9sZSI6ImFub24iLCJpYXQiOjE2OTU2NzQzMzksImV4cCI6MjAxMTI1MDMzOX0.SKIL3Q0NOBaMehH0ekFspwgcu3afp3Dl9EDzPqs1nKs"
+
+      - name: Deploy to Cloudflare
+        uses: ubiquity/cloudflare-deploy-action@main
+        with:
+          repository: ${{ github.repository }}
+          production_branch: ${{ github.event.repository.default_branch }}
+          output_directory: "static"
+          current_branch: ${{ github.ref_name }}
+          pull_request_number: ${{ github.event.pull_request.number }}
+          commit_sha: ${{ github.event.pull_request.head.sha }}

.github/workflows/conventional-commits.yml

@@ -0,0 +1,12 @@
+name: Conventional Commits
+
+on:
+  push:
+
+jobs:
+  conventional-commits:
+    name: Conventional Commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ubiquity/action-conventional-commits@master

.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

.github/workflows/cypress-testing.yml

@@ -0,0 +1,35 @@
+name: Run Cypress testing suite
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [ opened, synchronize ]
+
+jobs:
+  cypress-run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.10.0
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Cypress run
+        uses: cypress-io/github-action@v6
+        with:
+          build: yarn run build
+          start: yarn start
+        env:
+          CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: cypress-screenshots
+          path: cypress/screenshots
+          if-no-files-found: ignore
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: cypress-videos
+          path: cypress/videos
+          if-no-files-found: ignore

.github/workflows/jest-testing.yml

@@ -0,0 +1,33 @@
+name: Run Jest testing suite
+on:
+  workflow_dispatch:
+  pull_request_target:
+    types: [ opened, synchronize ]
+
+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: Build & Run test suite
+        run: |
+          yarn
+          yarn test | tee ./coverage.txt && exit ${PIPESTATUS[0]}
+      - name: Jest Coverage Comment
+        # Ensures this step is run even on previous step failure (e.g. test failed)
+        if: always()
+        uses: MishaKav/jest-coverage-comment@main
+        with:
+          coverage-summary-path: coverage/coverage-summary.json
+          junitxml-path: junit.xml
+          junitxml-title: JUnit
+          coverage-path: ./coverage.txt

.github/workflows/knip.yml

@@ -0,0 +1,31 @@
+name: Knip
+
+on:
+  pull_request_target:
+  workflow_dispatch:
+
+permissions: write-all
+
+jobs:
+  run-knip:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.10.0
+
+      - name: Install toolchain
+        run: yarn install
+
+      - name: Report knip results to pull request
+        uses: Codex-/knip-reporter@v2
+        with:
+          verbose: true
+          comment_id: ${{ github.workflow }}-reporter
+          command_script_name: knip-ci
+          annotations: true
+          ignore_results: false

.gitignore

@@ -0,0 +1,13 @@
+# macOS
+.DS_Store
+# node
+node_modules
+# yarn2
+.yarn
+.pnp.cjs
+.pnp.loader.mjs
+.env
+static/dist
+coverage
+junit.xml
+cypress/screenshots

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged

.nvmrc

@@ -0,0 +1 @@
+v20.10.0

.prettierrc

@@ -0,0 +1,10 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": false,
+  "printWidth": 160,
+  "htmlWhitespaceSensitivity": "strict",
+  "plugins": [],
+  "useTabs": false
+}

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

README.md

@@ -0,0 +1,27 @@
+# `@ubiquity/ts-template`
+
+This template repository includes support for the following:
+
+- TypeScript
+- Environment Variables
+- Conventional Commits
+- Automatic deployment to Cloudflare Pages
+
+## Testing
+
+### Cypress
+To test with Cypress Studio UI, run
+```shell
+yarn cy:open
+```
+
+Otherwise to simply run the tests through the console, run
+```shell
+yarn cy:run
+```
+
+### Jest
+To start Jest tests, run
+```shell
+yarn test
+```

build/esbuild-build.ts

@@ -0,0 +1,33 @@
+import esbuild from "esbuild";
+const typescriptEntries = ["static/main.ts"];
+// const cssEntries = ["static/style.css"];
+const entries = [
+  ...typescriptEntries,
+  //  ...cssEntries
+];
+
+export const esBuildContext: esbuild.BuildOptions = {
+  sourcemap: true,
+  entryPoints: entries,
+  bundle: true,
+  minify: false,
+  loader: {
+    ".png": "dataurl",
+    ".woff": "dataurl",
+    ".woff2": "dataurl",
+    ".eot": "dataurl",
+    ".ttf": "dataurl",
+    ".svg": "dataurl",
+  },
+  outdir: "static/dist",
+};
+
+esbuild
+  .build(esBuildContext)
+  .then(() => {
+    console.log("\tesbuild complete");
+  })
+  .catch((err) => {
+    console.error(err);
+    process.exit(1);
+  });

build/esbuild-server.ts

@@ -0,0 +1,18 @@
+import esbuild from "esbuild";
+import { esBuildContext } from "./esbuild-build";
+
+(async () => {
+  await server();
+})().catch((error) => {
+  console.error("Unhandled error:", error);
+  process.exit(1);
+});
+
+export async function server() {
+  const _context = await esbuild.context(esBuildContext);
+  const { port } = await _context.serve({
+    servedir: "static",
+    port: 8080,
+  });
+  console.log(`http://localhost:${port}`);
+}

build/index.ts

@@ -0,0 +1,4 @@
+import * as dotenv from "dotenv";
+// load environment variables (if you have them)
+dotenv.config();
+console.log("Welcome to ts-template");