diff --git a/icons.config.ts b/icons.config.js similarity index 93% rename from icons.config.ts rename to icons.config.js index c451cb61..02e6425d 100644 --- a/icons.config.ts +++ b/icons.config.js @@ -1,11 +1,5 @@ -export interface IconsConfig { - codePoints: Record - inputPath: string - outputPath: string - icons: string[] -} - -const config: IconsConfig = { +/** @type {import('./src/tools/icons-config').IconsConfig} */ +const config = { inputPath: "node_modules/@fontsource-variable/material-symbols-rounded/files/material-symbols-rounded-latin-full-normal.woff2", outputPath: "src/lib/assets/icons.min.woff2", @@ -27,6 +21,7 @@ const config: IconsConfig = { "cable", "person", "sync", + "school", "restart_alt", "usb", "usb_off", @@ -95,6 +90,7 @@ const config: IconsConfig = { "upload_2", "stat_minus_2", "stat_2", + "description", ], codePoints: { speed: "e9e4", diff --git a/package-lock.json b/package-lock.json index 4d7daf2f..92bc3e52 100644 --- a/package-lock.json +++ b/package-lock.json @@ -53,7 +53,6 @@ "svelte-check": "^3.5.1", "svelte-preprocess": "^5.0.4", "tippy.js": "^6.3.7", - "ts-node": "^10.9.1", "typesafe-i18n": "^5.26.2", "typescript": "^5.2.2", "vite": "^4.4.9", @@ -1895,28 +1894,6 @@ "node": ">=0.1.90" } }, - "node_modules/@cspotcode/source-map-support": { - "version": "0.8.1", - "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", - "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", - "dev": true, - "dependencies": { - "@jridgewell/trace-mapping": "0.3.9" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/@cspotcode/source-map-support/node_modules/@jridgewell/trace-mapping": { - "version": "0.3.9", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", - "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", - "dev": true, - "dependencies": { - "@jridgewell/resolve-uri": "^3.0.3", - "@jridgewell/sourcemap-codec": "^1.4.10" - } - }, "node_modules/@csstools/css-parser-algorithms": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-2.3.1.tgz", @@ -3229,30 +3206,6 @@ "node": ">= 10" } }, - "node_modules/@tsconfig/node10": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz", - "integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==", - "dev": true - }, - "node_modules/@tsconfig/node12": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", - "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==", - "dev": true - }, - "node_modules/@tsconfig/node14": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", - "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==", - "dev": true - }, - "node_modules/@tsconfig/node16": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz", - "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==", - "dev": true - }, "node_modules/@types/chai": { "version": "4.3.5", "resolved": "https://registry.npmjs.org/@types/chai/-/chai-4.3.5.tgz", @@ -3640,12 +3593,6 @@ } ] }, - "node_modules/arg": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", - "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", - "dev": true - }, "node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", @@ -4526,12 +4473,6 @@ "url": "https://github.com/sponsors/d-fischer" } }, - "node_modules/create-require": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", - "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", - "dev": true - }, "node_modules/crelt": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/crelt/-/crelt-1.0.6.tgz", @@ -5100,15 +5041,6 @@ "integrity": "sha512-ED3jP8saaweFTjeGX8HQPjeC1YYyZs98jGNZx6IiBvxW7JG5v492kamAQB3m2wop07CvU/RQmzcKr6bgcC5D/Q==", "dev": true }, - "node_modules/diff": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", - "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", - "dev": true, - "engines": { - "node": ">=0.3.1" - } - }, "node_modules/diff-sequences": { "version": "29.6.3", "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.6.3.tgz", @@ -7636,12 +7568,6 @@ "node": ">=12" } }, - "node_modules/make-error": { - "version": "1.3.6", - "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", - "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", - "dev": true - }, "node_modules/map-obj": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-4.3.0.tgz", @@ -10538,49 +10464,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/ts-node": { - "version": "10.9.1", - "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz", - "integrity": "sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==", - "dev": true, - "dependencies": { - "@cspotcode/source-map-support": "^0.8.0", - "@tsconfig/node10": "^1.0.7", - "@tsconfig/node12": "^1.0.7", - "@tsconfig/node14": "^1.0.0", - "@tsconfig/node16": "^1.0.2", - "acorn": "^8.4.1", - "acorn-walk": "^8.1.1", - "arg": "^4.1.0", - "create-require": "^1.1.0", - "diff": "^4.0.1", - "make-error": "^1.1.1", - "v8-compile-cache-lib": "^3.0.1", - "yn": "3.1.1" - }, - "bin": { - "ts-node": "dist/bin.js", - "ts-node-cwd": "dist/bin-cwd.js", - "ts-node-esm": "dist/bin-esm.js", - "ts-node-script": "dist/bin-script.js", - "ts-node-transpile-only": "dist/bin-transpile.js", - "ts-script": "dist/bin-script-deprecated.js" - }, - "peerDependencies": { - "@swc/core": ">=1.2.50", - "@swc/wasm": ">=1.2.50", - "@types/node": "*", - "typescript": ">=2.7" - }, - "peerDependenciesMeta": { - "@swc/core": { - "optional": true - }, - "@swc/wasm": { - "optional": true - } - } - }, "node_modules/tslib": { "version": "2.6.0", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.0.tgz", @@ -10923,12 +10806,6 @@ "uuid": "dist/bin/uuid" } }, - "node_modules/v8-compile-cache-lib": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", - "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", - "dev": true - }, "node_modules/validate-npm-package-license": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", @@ -11850,15 +11727,6 @@ "fd-slicer": "~1.1.0" } }, - "node_modules/yn": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", - "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/yocto-queue": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", diff --git a/package.json b/package.json index 6fbacd46..45a7d7fe 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "type": "git", "url": "https://github.com/CharaChorder/DeviceManager.git" }, - "homepage": "https://github.com/CharaChorder/DeviceManager", + "homepage": "https://docs.charachorder.com", "bugs": { "url": "https://github.com/CharaChorder/DeviceManager/issues" }, @@ -23,8 +23,8 @@ "postinstall": "patch-package", "check": "svelte-kit sync && svelte-check --tsconfig ./jsconfig.json", "check:watch": "svelte-kit sync && svelte-check --tsconfig ./jsconfig.json --watch", - "minify-icons": "ts-node-esm src/tools/minify-icon-font.ts", - "version": "ts-node-esm src/tools/version.ts && git add src-tauri/Cargo.toml && git add src-tauri/tauri.conf.json", + "minify-icons": "node src/tools/minify-icon-font.js", + "version": "node src/tools/version.js && git add src-tauri/Cargo.toml && git add src-tauri/tauri.conf.json", "lint": "prettier --plugin-search-dir . --check .", "format": "prettier --plugin-search-dir . --write .", "typesafe-i18n": "typesafe-i18n" @@ -73,7 +73,6 @@ "svelte-check": "^3.5.1", "svelte-preprocess": "^5.0.4", "tippy.js": "^6.3.7", - "ts-node": "^10.9.1", "typesafe-i18n": "^5.26.2", "typescript": "^5.2.2", "vite": "^4.4.9", diff --git a/src/env.d.ts b/src/env.d.ts index 74e23365..39806d4e 100644 --- a/src/env.d.ts +++ b/src/env.d.ts @@ -10,6 +10,8 @@ interface ImportMetaEnv { readonly VITE_HOMEPAGE_URL: string readonly VITE_BUGS_URL: string + readonly VITE_DOCS_URL: string + readonly VIET_LEARN_URL: string } interface ImportMeta { diff --git a/src/routes/Footer.svelte b/src/routes/Footer.svelte index 2993c967..63f95e62 100644 --- a/src/routes/Footer.svelte +++ b/src/routes/Footer.svelte @@ -46,6 +46,16 @@ >bug_report File an issue +
  • + description Read the docs +
    • +
  • + school Training +
    • {#if !$serialPort} diff --git a/src/tools/icons-config.d.ts b/src/tools/icons-config.d.ts new file mode 100644 index 00000000..ccd29e13 --- /dev/null +++ b/src/tools/icons-config.d.ts @@ -0,0 +1,6 @@ +export interface IconsConfig { + codePoints: Record + inputPath: string + outputPath: string + icons: string[] +} diff --git a/src/tools/minify-icon-font.ts b/src/tools/minify-icon-font.js similarity index 91% rename from src/tools/minify-icon-font.ts rename to src/tools/minify-icon-font.js index 998c3fb4..2550204d 100644 --- a/src/tools/minify-icon-font.ts +++ b/src/tools/minify-icon-font.js @@ -16,11 +16,15 @@ import {openSync} from "fontkit" import {exec} from "child_process" import config from "../../icons.config.js" -import {statSync, existsSync} from "fs" +import {statSync} from "fs" import {readFile} from "fs/promises" import {glob} from "glob" -async function run(command: string[] | string): Promise { +/** + * @param {string[] | string} command + * @returns {Promise} + */ +async function run(command) { const fullCommand = Array.isArray(command) ? command.join(" ") : command console.log(`>> ${fullCommand}`) @@ -51,7 +55,8 @@ const font = openSync(config.inputPath) const glyphs = ["5f-7a", "30-39"] for (const icon of icons) { - const iconGlyphs: Array<{id: string}> = font.layout(icon).glyphs + /** @type {Array<{id: string}>} */ + const iconGlyphs = font.layout(icon).glyphs if (iconGlyphs.length === 0) { console.error(`${icon} not found in font. Typo?`) process.exit(-1) @@ -99,8 +104,9 @@ console.log( /** * Bytes to respective units + * @param {number} value */ -function toByteUnit(value: number) { +function toByteUnit(value) { if (value < 1024) { return `${value}B` } else if (value < 1024 * 1024) { diff --git a/src/tools/version.ts b/src/tools/version.js similarity index 100% rename from src/tools/version.ts rename to src/tools/version.js diff --git a/vite.config.ts b/vite.config.ts index 8704cdb8..34696ee8 100644 --- a/vite.config.ts +++ b/vite.config.ts @@ -9,12 +9,14 @@ import {fileURLToPath} from "url" const isTauri = "TAURI_FAMILY" in process.env console.info(isTauri ? "Building for Tauri" : "Building for PWA") -const {homepage, bugs} = JSON.parse( +const {homepage, bugs, repository} = JSON.parse( await readFile(fileURLToPath(new URL("package.json", import.meta.url)), "utf8"), ) -process.env.VITE_HOMEPAGE_URL = homepage +process.env.VITE_HOMEPAGE_URL = repository.url.replace(/\.git$/, "") +process.env.VITE_DOCS_URL = homepage process.env.VITE_BUGS_URL = bugs.url +process.env.VITE_LEARN_URL = "https://www.iq-eq.io/" export default defineConfig({ build: {