chore: update templates

Author: Zamiell

.eslintrc.cjs

@@ -1,22 +1,29 @@
 // This is the configuration file for ESLint, the TypeScript linter:
-// https://eslint.org/docs/user-guide/configuring
-module.exports = {
+// https://eslint.org/docs/latest/use/configure/
+
+/** @type {import("eslint").Linter.Config} */
+const config = {
   extends: [
     // The linter base is the shared IsaacScript config:
     // https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/configs/base.js
     "eslint-config-isaacscript/base",
   ],
 
+  // Don't bother linting the compiled output.
+  // @template-ignore-next-line
+  ignorePatterns: ["**/dist/**", "**/lib/**", "**/version.js"],
+
   parserOptions: {
     // ESLint needs to know about the project's TypeScript settings in order for TypeScript-specific
     // things to lint correctly. We do not point this at "./tsconfig.json" because certain files
     // (such at this file) should be linted but not included in the actual project output.
-    project: ["./tsconfig.eslint.json"],
+    project: "./tsconfig.eslint.json",
   },
 
-  ignorePatterns: ["**/dist/**", "**/lib/**", "**/version.js"],
-
   rules: {
+    // Insert changed or disabled rules here, if necessary.
+    // @template-customization-start
+
     /**
      * Documentation:
      * https://eslint.org/docs/latest/rules/func-style
@@ -115,5 +122,9 @@ module.exports = {
      * dependencies being up to date).
      */
     "unicorn/prefer-top-level-await": "off",
+
+    // @template-customization-end
   },
 };
+
+module.exports = config;

.prettierignore

@@ -1,16 +1,28 @@
-# Keldon files
-keldon
+# Compiled output
+dist
 
-# Special Golang files
-go.mod
-
-# Images
-*.svg
+# Package manager lock files
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
 
 # Minified files
 *.min.js
 *.min.css
 
+# @template-customization-start
+
+# Images
+*.svg
+
+# Special Golang files
+go.mod
+
 # Temporary files
 critical.css
 grunt_output
+
+# Keldon files
+keldon
+
+# @template-customization-end

.vscode/extensions.json

@@ -4,9 +4,12 @@
   "recommendations": [
     "esbenp.prettier-vscode", // The TypeScript formatter
     "dbaeumer.vscode-eslint", // The TypeScript linter
+    "streetsidesoftware.code-spell-checker", // A spell-checker extension based on CSpell
+
+    // @template-customization-start
     "orta.vscode-jest", // The TypeScript tester
     "golang.go", // Golang language server
     "ms-python.python", // Python language server
-    "streetsidesoftware.code-spell-checker", // A spell-checker extension based on CSpell
+    // @template-customization-end
   ],
 }

.vscode/settings.json

@@ -9,8 +9,10 @@
   "editor.tabSize": 2,
 
   "files.associations": {
-    "*.tmpl": "html", // Golang HTML templates are saved as "tmpl" files.
     ".env*": "shellscript", // e.g. ".env.example" is the same as ".env".
+    // @template-customization-start
+    "*.tmpl": "html", // Golang HTML templates are saved as "tmpl" files.
+    // @template-customization-end
   },
 
   // We want to always use "lf" to be consistent with all platforms.
@@ -21,17 +23,19 @@
 
   // Configure glob patterns for excluding files and folders in full text searches and quick open.
   "search.exclude": {
-    "**/*.min.js*": true,
     "**/*.mp3": true,
     "**/*.png": true,
     "**/*.svg": true,
     "**/*.wav": true,
     "**/.yarn/": true,
     "**/dist/": true,
-    "**/misc/keldon/": true,
     "**/node_modules/": true,
+    // @template-customization-start
+    "**/*.min.js*": true,
+    "**/misc/keldon/": true,
     "**/server_old/": true,
     "**/card-images/": true,
+    // @template-customization-end
   },
 
   // ------------------
@@ -49,6 +53,18 @@
   "javascript.suggest.completeFunctionCalls": true,
   "typescript.suggest.completeFunctionCalls": true,
 
+  // By default, VSCode will prefer non-relative paths for deeply nested files.
+  // @template-ignore-block-start
+  // "javascript.preferences.importModuleSpecifier": "relative",
+  // "typescript.preferences.importModuleSpecifier": "relative",
+  // @template-ignore-block-end
+
+  // @template-customization-start
+  // Using a value of "relative" prevents "@hanabi"-style imports.
+  "javascript.preferences.importModuleSpecifier": "project-relative",
+  "typescript.preferences.importModuleSpecifier": "project-relative",
+  // @template-customization-end
+
   // Show TypeScript errors for files that don't happen to be currently open, which makes TypeScript
   // work similar to other compiled languages like Golang or Rust.
   "typescript.tsserver.experimental.enableProjectDiagnostics": true,
@@ -66,6 +82,18 @@
     "editor.formatOnSave": true,
     "editor.tabSize": 2,
   },
+  "[javascriptreact]": {
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"],
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[typescriptreact]": {
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"],
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
   "[json]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true,
@@ -96,6 +124,12 @@
     "editor.formatOnSave": true,
     "editor.tabSize": 2,
   },
+  "[postcss]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  // @template-customization-start
   "[go]": {
     "editor.tabSize": 4,
     "editor.insertSpaces": false,
@@ -105,4 +139,5 @@
     "editor.formatOnSave": true,
     "editor.tabSize": 4,
   },
+  // @template-customization-end
 }

LICENSE

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -631,8 +631,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    {one line to give the program's name and a brief idea of what it does.}
-    Copyright (C) {year}  {name of author}
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -645,14 +645,14 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    {project}  Copyright (C) {year}  {fullname}
+    <program>  Copyright (C) <year>  <name of author>
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

lint.sh

@@ -31,4 +31,6 @@ wait
 
 # TODO: https://stackoverflow.com/questions/49513335/bash-wait-exit-on-error-code
 
+npx isaacscript check-ts --ignore "build.sh,ci.yml,cspell.json,lint.sh,publish.sh,run.sh,tsconfig.json"
+
 echo "Successfully linted $REPO_NAME in $SECONDS seconds."

package.json

@@ -24,21 +24,21 @@
     "@fastify/view": "^8.0.0",
     "@t3-oss/env-core": "^0.6.1",
     "@total-typescript/ts-reset": "^0.5.1",
-    "@tsconfig/node-lts": "^18.12.3",
-    "@types/jest": "^29.5.3",
-    "@types/jquery": "^3.5.16",
-    "@types/jsdom": "^21.1.1",
+    "@tsconfig/node-lts": "^18.12.4",
+    "@types/jest": "^29.5.4",
+    "@types/jquery": "^3.5.17",
+    "@types/jsdom": "^21.1.2",
     "@types/linkifyjs": "^2.1.4",
     "@types/lodash": "^4.14.197",
-    "@types/node": "^20.5.1",
+    "@types/node": "^20.5.3",
     "@types/tooltipster": "^0.0.32",
     "bufferutil": "^4.0.7",
     "canvas": "^2.11.2",
     "dotenv": "^16.3.1",
-    "drizzle-orm": "^0.28.2",
+    "drizzle-orm": "^0.28.3",
     "esbuild": "^0.19.2",
     "esbuild-plugin-pino": "^2.0.1",
-    "eta": "^3.1.0",
+    "eta": "^3.1.1",
     "fast-deep-equal": "^3.1.3",
     "fastify": "^4.21.0",
     "fastify-favicon": "^4.3.0",
@@ -49,10 +49,10 @@
     "http-status-codes": "^2.2.0",
     "immer": "^10.0.2",
     "interactjs": "^1.10.18",
-    "isaacscript": "^3.7.2",
+    "isaacscript": "^3.9.1",
     "isaacscript-lint": "^5.4.0",
     "isaacscript-tsconfig": "^4.0.0",
-    "jest": "^29.6.2",
+    "jest": "^29.6.3",
     "jquery": "^3.7.0",
     "jsdom": "^22.1.0",
     "jsonc-parser": "^3.2.0",
@@ -68,7 +68,7 @@
     "prettier-plugin-go-template": "^0.0.15",
     "prettier-plugin-organize-imports": "^3.2.3",
     "redux": "^4.2.1",
-    "stacktracify": "^1.0.3",
+    "stacktracify": "^1.0.4",
     "tooltipster": "^4.2.8",
     "ts-jest": "^29.1.1",
     "tsconfig": "^7.0.0",
@@ -77,7 +77,7 @@
     "typescript": "^5.1.6",
     "ws": "^8.13.0",
     "xmlserializer": "^0.6.1",
-    "zod": "^3.22.1"
+    "zod": "^3.22.2"
   },
   "packageManager": "[email protected]"
 }

prettier.config.mjs

@@ -3,6 +3,7 @@
 
 /** @type {import("prettier").Config} */
 const config = {
+  // @template-ignore-next-line
   plugins: ["prettier-plugin-organize-imports", "prettier-plugin-go-template"],
 
   overrides: [

todo.txt

@@ -3,15 +3,16 @@
 +------+
 
 - search for "Number("
-- search for all 6 constants (to replace with MAX_SUITS_IN_A_VARIANT)
 - search for "for (let"
 - fix eta undefined passing through to template (use Discord advice)
-- remove type assertions from sudoku.ts (need feedback from Ram)
 - remove type assertions from lobby + views
 - PlayerIndex type (maybe, look to see if it is useful first)
 - redo install instructions without choco
 - refactor START_CARD_RANK from 7 --> 0 (might affect database?)
 
+waiting to hear back:
+- remove type assertions from sudoku.ts (need feedback from Ram)
+
 short term:
 - refactor soundTypeForLastAction (should probably delete the whole thing)
 - getPlayerNames comma is in wrong place for 3+ players

tsconfig.eslint.json

@@ -1,8 +1,6 @@
-// The configuration file for TypeScript.
+// A special TypeScript configuration file, used by ESLint only.
 {
-  // We extend the Node.js IsaacScript config:
-  // https://github.com/IsaacScript/isaacscript/blob/main/packages/isaacscript-tsconfig/tsconfig.node.json
-  "extends": "isaacscript-tsconfig/tsconfig.node.json",
+  "extends": "./tsconfig.json",
 
   // We want to lint every file in the repository, regardless of whether it is actually bundled into
   // the TypeScript output or not. Two entries for each file extension are needed because TypeScript