Initial commit

.eslintrc.json

@@ -0,0 +1,155 @@
+{
+  "env": {
+    "node": true,
+    "es2022": true
+  },
+  "extends": [
+    "eslint:all",
+    "plugin:@stylistic/all-extends",
+    "plugin:@typescript-eslint/strict-type-checked",
+    "plugin:array-func/all",
+    "plugin:eslint-comments/recommended",
+    "plugin:import/recommended",
+    "plugin:no-use-extend-native/recommended",
+    "plugin:promise/recommended",
+    "plugin:sonarjs/recommended-legacy",
+    "plugin:unicorn/all"
+  ],
+  "ignorePatterns": [
+    "coverage/*",
+    "out/*"
+  ],
+  "overrides": [
+    {
+      "files": ["./src/assets/**/*.js"],
+      "env": {
+        "browser": true,
+        "node": false
+      }
+    }
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "project": ["./tsconfig.json"],
+    "sourceType": "module"
+  },
+  "plugins": [
+    "jsdoc"
+  ],
+  "rules": {
+    "@stylistic/array-element-newline": ["error", "consistent"],
+    "@stylistic/arrow-parens": ["error", "as-needed"],
+    "@stylistic/dot-location": ["error", "property"],
+    "@stylistic/function-call-argument-newline": ["error", "consistent"],
+    "@stylistic/function-paren-newline": ["error", "consistent"],
+    "@stylistic/implicit-arrow-linebreak": "error",
+    "@stylistic/indent": ["error", 2],
+    "@stylistic/indent-binary-ops": "off",
+    "@stylistic/lines-around-comment": [
+      "error",
+      { "ignorePattern": "@type\\s.+|@ts-expect-error" }
+    ],
+    "@stylistic/max-len": [
+      "error",
+      { "ignoreComments": true }
+    ],
+    "@stylistic/multiline-ternary": ["error", "always-multiline"],
+    "@stylistic/no-confusing-arrow": "off",
+    "@stylistic/no-extra-parens": [
+      "error",
+      "all",
+      { "allowParensAfterCommentPattern": "@type" }
+    ],
+    "@stylistic/no-mixed-operators": "off",
+    "@stylistic/object-curly-spacing": ["error", "always"],
+    "@stylistic/object-property-newline": [
+      "error",
+      { "allowAllPropertiesOnSameLine": true }
+    ],
+    "@stylistic/padded-blocks": ["error", "never"],
+    "@stylistic/quote-props": ["error", "as-needed"],
+    "@stylistic/quotes": ["error", "single"],
+    "@stylistic/space-before-function-paren": [
+      "error",
+      {
+        "anonymous": "always",
+        "named": "never",
+        "asyncArrow": "always"
+      }
+    ],
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-base-to-string": "off",
+    "@typescript-eslint/no-extraneous-class": "off",
+    "@typescript-eslint/no-misused-promises": [
+      "error",
+      { "checksVoidReturn": false }
+    ],
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      { "varsIgnorePattern": "_" }
+    ],
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unsafe-call": "off",
+    "@typescript-eslint/no-unsafe-member-access": "off",
+    "array-func/prefer-array-from": "off",
+    "curly": ["error", "multi", "consistent"],
+    "eslint-comments/no-unused-disable": "error",
+    "func-style": [
+      "error",
+      "declaration",
+      { "allowArrowFunctions": true }
+    ],
+    "id-length": [
+      "error",
+      { "exceptions": [ "_" ] }
+    ],
+    "import/no-unresolved": "off",
+    "init-declarations": "off",
+    "jsdoc/check-tag-names": "error",
+    "jsdoc/check-types": "error",
+    "jsdoc/require-jsdoc": "error",
+    "jsdoc/require-param": "error",
+    "jsdoc/require-param-type": "error",
+    "jsdoc/require-property-type": "error",
+    "jsdoc/require-returns": "error",
+    "jsdoc/require-returns-type": "error",
+    "jsdoc/require-throws": "error",
+    "jsdoc/require-yields": "error",
+    "jsdoc/require-yields-check": "error",
+    "jsdoc/valid-types": "error",
+    "max-lines-per-function": "off",
+    "max-params": ["error", 5],
+    "max-statements": ["error", 100],
+    "no-console": ["error"],
+    "no-continue": "off",
+    "no-inline-comments": [
+      "error",
+      { "ignorePattern": "@type\\s.+|@ts-expect-error" }
+    ],
+    "no-loop-func": "off",
+    "no-magic-numbers": "off",
+    "no-plusplus": "off",
+    "no-ternary": "off",
+    "no-unused-vars": [
+      "error",
+      { "varsIgnorePattern": "_" }
+    ],
+    "one-var": [
+      "error",
+      {
+        "initialized": "never",
+        "uninitialized": "always"
+      }
+    ],
+    "sonarjs/cognitive-complexity": "off",
+    "unicorn/no-array-callback-reference": "off",
+    "unicorn/no-array-reduce": "off",
+    "unicorn/no-empty-file": "off",
+    "unicorn/no-for-loop": "off",
+    "unicorn/no-negated-condition": "off",
+    "unicorn/no-null": "off",
+    "unicorn/prefer-query-selector": "off",
+    "unicorn/switch-case-braces": "off"
+  }
+}

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.github/workflows/ci-js.yml

@@ -0,0 +1,45 @@
+name: Continuous Integration (JavaScript)
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '**.js'
+      - '**.ts'
+      - '**.json'
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ci-js-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  eslint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+      - name: Install Dependencies
+        run: bun install
+      - name: Run
+        run: bun run eslint
+  tsc:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+      - name: Install Dependencies
+        run: bun install
+      - name: Run
+        run: bun run tsc

.github/workflows/ci-test.yml

@@ -0,0 +1,30 @@
+name: Continuous Integration (Test)
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '**.js'
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ci-test-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+      - name: Install Dependencies
+        run: bun install
+      - name: Run
+        run: bun run test

.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

README.md

@@ -0,0 +1,27 @@
+# Build
+
+## Development
+
+Make sure you have npm (Node Package Manager) and Node.js installed on
+your system before running this command. Additionally, run `npm install` in
+the project's root directory to install all required dependencies.
+
+## Linting
+
+To maintain code quality and adhere to coding standards, you can use linting
+tools in your project's root directory. Follow the instructions below for each
+language.
+
+```bash
+npm run lint
+```
+
+### JavaScript Linting
+
+Run the following commands in your project's root directory to utilize ESLint
+and TypeScript:
+
+```bash
+npm run eslint
+npm run tsc
+```