timestampSortedIndices[i], \\\"lookupArrayIndexByTsIndex\\\");\\n1039| const lookupEventByTsIndex = /* @__PURE__ */ __name((i) => traceEvents[lookupArrayIndexByTsIndex(i)], \\\"lookupEventByTsIndex\\\");\\n1040| const eEventIndices = [];\\n1041| const bxEventIndices = [];\\n1042| const otherEventIndices = [];\\n1043| for (const tsIndex of tsGroupIndices) {\\n1044| const arrayIndex = lookupArrayIndexByTsIndex(tsIndex);\\n1045| const event = lookupEventByTsIndex(tsIndex);\\n1046| if (event.ph === \\\"E\\\") eEventIndices.push(arrayIndex);\\n1047| else if (event.ph === \\\"X\\\" || event.ph === \\\"B\\\") bxEventIndices.push(arrayIndex);\\n1048| else otherEventIndices.push(arrayIndex);\\n1049| }\\n1050| const effectiveDuration = /* @__PURE__ */ new Map();\\n1051| for (const index of bxEventIndices) {\\n1052| const event = traceEvents[index];\\n1053| if (event.ph === \\\"X\\\") {\\n1054| effectiveDuration.set(index, event.dur);\\n1055| } else {\\n1056| let duration = Number.MAX_SAFE_INTEGER;\\n1057| let additionalNestedEventsWithSameName = 0;\\n1058| const startIndex = indexOfTsGroupIndicesStart + tsGroupIndices.length;\\n1059| for (let j = startIndex; j < timestampSortedIndices.length; j++) {\\n1060| const potentialMatchingEvent = lookupEventByTsIndex(j);\\n1061| const eventMatches = potentialMatchingEvent.name === event.name && potentialMatchingEvent.pid === event.pid && potentialMatchingEvent.tid === event.tid;\\n1062| if (!eventMatches) continue;\\n1063| if (potentialMatchingEvent.ph === \\\"E\\\" && additionalNestedEventsWithSameName === 0) {\\n1064| duration = potentialMatchingEvent.ts - event.ts;\\n1065| break;\\n1066| } else if (potentialMatchingEvent.ph === \\\"E\\\") {\\n1067| additionalNestedEventsWithSameName--;\\n1068| } else if (potentialMatchingEvent.ph === \\\"B\\\") {\\n1069| additionalNestedEventsWithSameName++;\\n1070| }\\n1071| }\\n1072| effectiveDuration.set(index, duration);\\n1073| }\\n1074| }\\n1075| bxEventIndices.sort((indexA, indexB) => (effectiveDuration.get(indexB) || 0) - (effectiveDuration.get(indexA) || 0) || indexA - indexB);\\n1076| otherEventIndices.sort((indexA, indexB) => indexA - indexB);\\n1077| return [...eEventIndices, ...bxEventIndices, ...otherEventIndices];\\n1078| }\\n1079| /**\\n1080| * Sorts and filters trace events by timestamp and respecting the nesting structure inherent to\\n1081| * parent/child event relationships.\\n1082| *\\n1083| * @param {LH.TraceEvent[]} traceEvents\\n1084| * @param {(e: LH.TraceEvent) => boolean} filter\\n1085| */\\n1086| static filteredTraceSort(traceEvents, filter) {\\n1087| const indices = [];\\n1088| for (let srcIndex = 0; srcIndex < traceEvents.length; srcIndex++) {\\n1089| if (filter(traceEvents[srcIndex])) {\\n1090| indices.push(srcIndex);\\n1091| }\\n1092| }\\n1093| indices.sort((indexA, indexB) => traceEvents[indexA].ts - traceEvents[indexB].ts);\\n1094| for (let i = 0; i < indices.length - 1; i++) {\\n1095| const ts = traceEvents[indices[i]].ts;\\n1096| const tsGroupIndices = [i];\\n1097| for (let j = i + 1; j < indices.length; j++) {\\n1098| if (traceEvents[indices[j]].ts !== ts) break;\\n1099| tsGroupIndices.push(j);\\n1100| }\\n```\\n\\n### FILE: src/tools/categories.ts (33 lines)\\n\\n```\\n 1| /**\\n 2| * @license\\n 3| * Copyright 2025 Google LLC\\n 4| * SPDX-License-Identifier: Apache-2.0\\n 5| */\\n 6| \\n 7| export enum ToolCategory {\\n 8| INPUT = 'input',\\n 9| NAVIGATION = 'navigation',\\n 10| EMULATION = 'emulation',\\n 11| PERFORMANCE = 'performance',\\n 12| NETWORK = 'network',\\n 13| DEBUGGING = 'debugging',\\n 14| EXTENSIONS = 'extensions',\\n 15| THIRD_PARTY = 'experimentalThirdParty',\\n 16| MEMORY = 'memory',\\n 17| WEBMCP = 'experimentalWebmcp',\\n 18| PWA = 'pwa',\\n 19| }\\n 20| \\n 21| export const labels = {\\n 22| [ToolCategory.INPUT]: 'Input automation',\\n 23| [ToolCategory.NAVIGATION]: 'Navigation automation',\\n 24| [ToolCategory.EMULATION]: 'Emulation',\\n 25| [ToolCategory.PERFORMANCE]: 'Performance',\\n 26| [ToolCategory.NETWORK]: 'Network',\\n 27| [ToolCategory.DEBUGGING]: 'Debugging',\\n 28| [ToolCategory.EXTENSIONS]: 'Extensions',\\n 29| [ToolCategory.THIRD_PARTY]: 'Third-party',\\n 30| [ToolCategory.MEMORY]: 'Memory',\\n 31| [ToolCategory.WEBMCP]: 'WebMCP',\\n 32| [ToolCategory.PWA]: 'Progressive Web Apps',\\n 33| };\\n```\\n<END_OF_CONTEXT>\\n\\n<query>\\nIdentify the most architecturally significant module in the provided context and write an in-depth wiki page analyzing it: its responsibilities, key abstractions, control flow, and how other parts of the system depend on it.\\n</query>\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"# Lighthouse DevTools MCP Bundle Analysis\\n\\n## Overview\\n\\nThe most architecturally significant module in the provided context is the `BaseGatherer` class defined in `src/third_party/lighthouse-devtools-mcp-bundle.js`. This class serves as the foundational abstraction for data gathering in Lighthouse, defining a standardized interface for collecting performance metrics, resource information, and other page artifacts. It is central to Lighthouse's modular architecture and is heavily relied upon by the broader Lighthouse system.\\n\\n## Detailed Analysis\\n\\n### Responsibilities\\n\\nThe `BaseGatherer` class defines the contract for all data gathering operations within Lighthouse. Its primary responsibilities include:\\n\\n1. **Defining the Gatherer Interface**: The class establishes a standardized API for gatherers to implement, ensuring consistency across different data collection mechanisms.\\n2. **Lifecycle Management**: It provides hooks for managing the instrumentation lifecycle of a page, including:\\n - `startInstrumentation()` - Initiates observation of a page for an arbitrary period.\\n - `startSensitiveInstrumentation()` - Begins sensitive observation with minimal Lighthouse-induced overhead.\\n - `stopSensitiveInstrumentation()` - Ends sensitive observation.\\n - `stopInstrumentation()` - Concludes observation after an arbitrary period.\\n3. **Artifact Collection**: The `getArtifact()` method defines how gathered data is transformed into a consumable artifact format.\\n\\n```typescript\\n// src/third_party/lighthouse-devtools-mcp-bundle.js:82-127\\nBaseGatherer = class {\\n static {\\n __name(this, \\\"BaseGatherer\\\");\\n }\\n /** @type {LH.Gatherer.GathererMeta} */\\n meta = { supportedModes: [] };\\n /**\\n * Method to start observing a page for an arbitrary period of time.\\n * @param {LH.Gatherer.Context} passContext\\n * @return {Promise<void>|void}\\n */\\n startInstrumentation(passContext) {\\n }\\n /**\\n * Method to start observing a page when the measurements are very sensitive and\\n * should observe as little Lighthouse-induced work as possible.\\n * @param {LH.Gatherer.Context} passContext\\n * @return {Promise<void>|void}\\n */\\n startSensitiveInstrumentation(passContext) {\\n }\\n /**\\n * Method to stop observing a page when the measurements are very sensitive and\\n * should observe as little Lighthouse-induced work as possible.\\n *\\n * @param {LH.Gatherer.Context} passContext\\n * @return {Promise<void>|void}\\n */\\n stopSensitiveInstrumentation(passContext) {\\n }\\n /**\\n * Method to end observing a page after an arbitrary period of time.\\n * @param {LH.Gatherer.Context} passContext\\n * @return {Promise<void>|void}\\n */\\n stopInstrumentation(passContext) {\\n }\\n /**\\n * Method to gather results about a page.\\n * @param {LH.Gatherer.Context} passContext\\n * @return {LH.Gatherer.PhaseResult}\\n */\\n getArtifact(passContext) {\\n }\\n};\\n```\\n\\n### Key Abstractions\\n\\nThe `BaseGatherer` introduces several key abstractions that are fundamental to Lighthouse's architecture:\\n\\n1. **GathererMeta**: A metadata object that describes the gatherer's capabilities, particularly its supported modes (`supportedModes`).\\n2. **Context**: The `passContext` parameter provides a consistent interface for gatherers to access page state, configuration, and other contextual information.\\n3. **PhaseResult**: The return type for `getArtifact()` that defines how gathered data should be structured and formatted for consumption by other parts of Lighthouse.\\n\\n### Control Flow\\n\\nThe control flow for a gatherer's lifecycle is managed through a sequence of method calls that are invoked by Lighthouse's core execution engine:\\n\\n1. **Initialization**: The gatherer's metadata is read and validated.\\n2. **Instrumentation Start**: The appropriate `start*Instrumentation` method is called to begin observation.\\n3. **Data Collection**: The gatherer collects data during the observation period.\\n4. **Artifact Generation**: The `getArtifact()` method is called to transform collected data into the final artifact format.\\n5. **Instrumentation End**: The appropriate `stop*Instrumentation` method is called to conclude observation.\\n\\n```mermaid\\nsequenceDiagram\\n participant Lighthouse\\n participant Gatherer\\n Lighthouse->>Gatherer: startInstrumentation()\\n Gatherer-->>Lighthouse: void|Promise\\n Lighthouse->>Gatherer: getArtifact()\\n Gatherer-->>Lighthouse: PhaseResult\\n Lighthouse->>Gatherer: stopInstrumentation()\\n Gatherer-->>Lighthouse: void|Promise\\n```\\n\\n### Dependencies and System Integration\\n\\nThe `BaseGatherer` is deeply integrated into the Lighthouse system and is depended upon by several other components:\\n\\n1. **Core Engine**: The main Lighthouse execution engine relies on `BaseGatherer` to ensure all gatherers conform to a consistent interface.\\n2. **Trace Processor**: As seen in `src/third_party/lighthouse-devtools-mcp-bundle.js:953-1100`, the trace processor (`TraceProcessor`) uses gatherer interfaces to process tracing data and extract meaningful performance metrics.\\n3. **Tool Categories**: The tool categories defined in `src/tools/categories.ts` (lines 7-19) are used to categorize different types of gatherers, indicating their role in different functional areas like performance, network, debugging, etc.\\n\\nThe `BaseGatherer` is also used by other modules that extend its functionality, such as the `TraceProcessor` which defines specific error types that may be encountered during trace processing:\\n\\n```typescript\\n// src/third_party/lighthouse-devtools-mcp-bundle.js:981-1007\\nstatic createNoNavstartError() {\\n return new Error(\\\"No navigationStart event found\\\");\\n}\\nstatic createNoResourceSendRequestError() {\\n return new Error(\\\"No ResourceSendRequest event found\\\");\\n}\\nstatic createNoTracingStartedError() {\\n return new Error(\\\"No tracingStartedInBrowser event found\\\");\\n}\\nstatic createNoFirstContentfulPaintError() {\\n return new Error(\\\"No FirstContentfulPaint event found\\\");\\n}\\nstatic createNoLighthouseMarkerError() {\\n return new Error(\\\"No Lighthouse timespan marker event found\\\");\\n}\\n```\\n\\nThis demonstrates that the `BaseGatherer`'s influence extends beyond its direct implementation to affect how errors are handled and reported throughout the system.\\n\\n## Conclusion\\n\\nThe `BaseGatherer` is a cornerstone of Lighthouse's architecture, providing a standardized interface that enables modularity and extensibility in data gathering. Its design ensures that all gatherers, regardless of their specific purpose, follow a consistent pattern for instrumentation and artifact generation. This abstraction allows Lighthouse to support diverse types of data collection while maintaining a coherent and predictable execution flow. The module's integration with other core components like the trace processor and the tool categorization system further underscores its central role in the overall system architecture.\"\n }\n]","isConversational":true},"source":{"kind":"string","value":"ChromeDevTools/chrome-devtools-mcp"},"category":{"kind":"string","value":"module_deep_dive"},"quality_score":{"kind":"number","value":100,"string":"100"},"citation_stats":{"kind":"string","value":"{\n \"total_citations\": 3,\n \"validity_rate\": 1,\n \"invalid\": []\n}"},"license":{"kind":"string","value":"Apache-2.0"},"language":{"kind":"string","value":"typescript"}}},{"rowIdx":94,"cells":{"messages":{"kind":"list like","value":[{"role":"system","content":["You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\n4. Explain the WHY behind design decisions, not only the WHAT.\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\n7. Example of the correct citation style, inline and attached to a path:\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon."]},{"role":"user","content":"<START_OF_CONTEXT>\n# Repository: ChromeDevTools/chrome-devtools-mcp (language: typescript)\n\n# Selected files (windows)\n- src/third_party/lighthouse-devtools-mcp-bundle.js (lines 1-1100 of 58496)\n- src/tools/categories.ts (33 lines)\n\n\n### FILE: src/third_party/lighthouse-devtools-mcp-bundle.js (lines 1-1100 of 58496)\n\n```\n 1| /**\n 2| * Lighthouse v13.4.1 (Jul 23 2026)\n 3| *\n 4| * Automated auditing, performance metrics, and best practices for the web.\n 5| *\n 6| * @homepage https://github.com/GoogleChrome/lighthouse#readme\n 7| * @author Copyright 2026 Google LLC\n 8| * @license Apache-2.0\n 9| *\n 10| * Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0\n 11| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n 12| */\n 13| var __create = Object.create;\n 14| var __defProp = Object.defineProperty;\n 15| var __getOwnPropDesc = Object.getOwnPropertyDescriptor;\n 16| var __getOwnPropNames = Object.getOwnPropertyNames;\n 17| var __getProtoOf = Object.getPrototypeOf;\n 18| var __hasOwnProp = Object.prototype.hasOwnProperty;\n 19| var __name = (target, value) => __defProp(target, \"name\", { value, configurable: true });\n 20| var __esm = (fn, res) => function __init() {\n 21| return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;\n 22| };\n 23| var __commonJS = (cb, mod2) => function __require() {\n 24| return mod2 || (0, cb[__getOwnPropNames(cb)[0]])((mod2 = { exports: {} }).exports, mod2), mod2.exports;\n 25| };\n 26| var __export = (target, all) => {\n 27| for (var name in all)\n 28| __defProp(target, name, { get: all[name], enumerable: true });\n 29| };\n 30| var __copyProps = (to, from, except, desc) => {\n 31| if (from && typeof from === \"object\" || typeof from === \"function\") {\n 32| for (let key of __getOwnPropNames(from))\n 33| if (!__hasOwnProp.call(to, key) && key !== except)\n 34| __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });\n 35| }\n 36| return to;\n 37| };\n 38| var __toESM = (mod2, isNodeMode, target) => (target = mod2 != null ? __create(__getProtoOf(mod2)) : {}, __copyProps(\n 39| // If the importer is in node compatibility mode or this is not an ESM\n 40| // file that has been converted to a CommonJS file using a Babel-\n 41| // compatible transform (i.e. \"__esModule\" has not been set), then set\n 42| // \"default\" to the CommonJS \"module.exports\" for node compatibility.\n 43| isNodeMode || !mod2 || !mod2.__esModule ? __defProp(target, \"default\", { value: mod2, enumerable: true }) : target,\n 44| mod2\n 45| ));\n 46| var __toCommonJS = (mod2) => __copyProps(__defProp({}, \"__esModule\", { value: true }), mod2);\n 47| \n 48| // build/process-global.js\n 49| import process2 from \"process\";\n 50| var init_process_global = __esm({\n 51| \"build/process-global.js\"() {\n 52| \"use strict\";\n 53| globalThis.process = process2;\n 54| }\n 55| });\n 56| \n 57| // types/lh.js\n 58| var init_lh = __esm({\n 59| \"types/lh.js\"() {\n 60| \"use strict\";\n 61| init_process_global();\n 62| /**\n 63| * @license\n 64| * Copyright 2023 Google LLC\n 65| * SPDX-License-Identifier: Apache-2.0\n 66| */\n 67| }\n 68| });\n 69| \n 70| // core/gather/base-gatherer.js\n 71| var BaseGatherer, base_gatherer_default;\n 72| var init_base_gatherer = __esm({\n 73| \"core/gather/base-gatherer.js\"() {\n 74| \"use strict\";\n 75| init_process_global();\n 76| init_lh();\n 77| /**\n 78| * @license\n 79| * Copyright 2021 Google LLC\n 80| * SPDX-License-Identifier: Apache-2.0\n 81| */\n 82| BaseGatherer = class {\n 83| static {\n 84| __name(this, \"BaseGatherer\");\n 85| }\n 86| /** @type {LH.Gatherer.GathererMeta} */\n 87| meta = { supportedModes: [] };\n 88| /**\n 89| * Method to start observing a page for an arbitrary period of time.\n 90| * @param {LH.Gatherer.Context} passContext\n 91| * @return {Promise<void>|void}\n 92| */\n 93| startInstrumentation(passContext) {\n 94| }\n 95| /**\n 96| * Method to start observing a page when the measurements are very sensitive and\n 97| * should observe as little Lighthouse-induced work as possible.\n 98| * @param {LH.Gatherer.Context} passContext\n 99| * @return {Promise<void>|void}\n 100| */\n 101| startSensitiveInstrumentation(passContext) {\n 102| }\n 103| /**\n 104| * Method to stop observing a page when the measurements are very sensitive and\n 105| * should observe as little Lighthouse-induced work as possible.\n 106| *\n 107| * @param {LH.Gatherer.Context} passContext\n 108| * @return {Promise<void>|void}\n 109| */\n 110| stopSensitiveInstrumentation(passContext) {\n 111| }\n 112| /**\n 113| * Method to end observing a page after an arbitrary period of time.\n 114| * @param {LH.Gatherer.Context} passContext\n 115| * @return {Promise<void>|void}\n 116| */\n 117| stopInstrumentation(passContext) {\n 118| }\n 119| /**\n 120| * Method to gather results about a page.\n 121| * @param {LH.Gatherer.Context} passContext\n 122| * @return {LH.Gatherer.PhaseResult}\n 123| */\n 124| getArtifact(passContext) {\n 125| }\n 126| };\n 127| base_gatherer_default = BaseGatherer;\n 128| }\n 129| });\n 130| \n 131| // node_modules/debug/node_modules/ms/index.js\n 132| var require_ms = __commonJS({\n 133| \"node_modules/debug/node_modules/ms/index.js\"(exports2, module2) {\n 134| init_process_global();\n 135| var s = 1e3;\n 136| var m = s * 60;\n 137| var h = m * 60;\n 138| var d = h * 24;\n 139| var w = d * 7;\n 140| var y = d * 365.25;\n 141| module2.exports = function(val, options) {\n 142| options = options || {};\n 143| var type = typeof val;\n 144| if (type === \"string\" && val.length > 0) {\n 145| return parse(val);\n 146| } else if (type === \"number\" && isFinite(val)) {\n 147| return options.long ? fmtLong(val) : fmtShort(val);\n 148| }\n 149| throw new Error(\n 150| \"val is not a non-empty string or a valid number. val=\" + JSON.stringify(val)\n 151| );\n 152| };\n 153| function parse(str) {\n 154| str = String(str);\n 155| if (str.length > 100) {\n 156| return;\n 157| }\n 158| var match = /^(-?(?:\\d+)?\\.?\\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i.exec(\n 159| str\n 160| );\n 161| if (!match) {\n 162| return;\n 163| }\n 164| var n = parseFloat(match[1]);\n 165| var type = (match[2] || \"ms\").toLowerCase();\n 166| switch (type) {\n 167| case \"years\":\n 168| case \"year\":\n 169| case \"yrs\":\n 170| case \"yr\":\n 171| case \"y\":\n 172| return n * y;\n 173| case \"weeks\":\n 174| case \"week\":\n 175| case \"w\":\n 176| return n * w;\n 177| case \"days\":\n 178| case \"day\":\n 179| case \"d\":\n 180| return n * d;\n 181| case \"hours\":\n 182| case \"hour\":\n 183| case \"hrs\":\n 184| case \"hr\":\n 185| case \"h\":\n 186| return n * h;\n 187| case \"minutes\":\n 188| case \"minute\":\n 189| case \"mins\":\n 190| case \"min\":\n 191| case \"m\":\n 192| return n * m;\n 193| case \"seconds\":\n 194| case \"second\":\n 195| case \"secs\":\n 196| case \"sec\":\n 197| case \"s\":\n 198| return n * s;\n 199| case \"milliseconds\":\n 200| case \"millisecond\":\n 201| case \"msecs\":\n 202| case \"msec\":\n 203| case \"ms\":\n 204| return n;\n 205| default:\n 206| return void 0;\n 207| }\n 208| }\n 209| __name(parse, \"parse\");\n 210| function fmtShort(ms) {\n 211| var msAbs = Math.abs(ms);\n 212| if (msAbs >= d) {\n 213| return Math.round(ms / d) + \"d\";\n 214| }\n 215| if (msAbs >= h) {\n 216| return Math.round(ms / h) + \"h\";\n 217| }\n 218| if (msAbs >= m) {\n 219| return Math.round(ms / m) + \"m\";\n 220| }\n 221| if (msAbs >= s) {\n 222| return Math.round(ms / s) + \"s\";\n 223| }\n 224| return ms + \"ms\";\n 225| }\n 226| __name(fmtShort, \"fmtShort\");\n 227| function fmtLong(ms) {\n 228| var msAbs = Math.abs(ms);\n 229| if (msAbs >= d) {\n 230| return plural(ms, msAbs, d, \"day\");\n 231| }\n 232| if (msAbs >= h) {\n 233| return plural(ms, msAbs, h, \"hour\");\n 234| }\n 235| if (msAbs >= m) {\n 236| return plural(ms, msAbs, m, \"minute\");\n 237| }\n 238| if (msAbs >= s) {\n 239| return plural(ms, msAbs, s, \"second\");\n 240| }\n 241| return ms + \" ms\";\n 242| }\n 243| __name(fmtLong, \"fmtLong\");\n 244| function plural(ms, msAbs, n, name) {\n 245| var isPlural = msAbs >= n * 1.5;\n 246| return Math.round(ms / n) + \" \" + name + (isPlural ? \"s\" : \"\");\n 247| }\n 248| __name(plural, \"plural\");\n 249| }\n 250| });\n 251| \n 252| // node_modules/debug/src/common.js\n 253| var require_common = __commonJS({\n 254| \"node_modules/debug/src/common.js\"(exports2, module2) {\n 255| init_process_global();\n 256| function setup(env) {\n 257| createDebug.debug = createDebug;\n 258| createDebug.default = createDebug;\n 259| createDebug.coerce = coerce;\n 260| createDebug.disable = disable;\n 261| createDebug.enable = enable;\n 262| createDebug.enabled = enabled;\n 263| createDebug.humanize = require_ms();\n 264| createDebug.destroy = destroy;\n 265| Object.keys(env).forEach((key) => {\n 266| createDebug[key] = env[key];\n 267| });\n 268| createDebug.names = [];\n 269| createDebug.skips = [];\n 270| createDebug.formatters = {};\n 271| function selectColor(namespace) {\n 272| let hash = 0;\n 273| for (let i = 0; i < namespace.length; i++) {\n 274| hash = (hash << 5) - hash + namespace.charCodeAt(i);\n 275| hash |= 0;\n 276| }\n 277| return createDebug.colors[Math.abs(hash) % createDebug.colors.length];\n 278| }\n 279| __name(selectColor, \"selectColor\");\n 280| createDebug.selectColor = selectColor;\n 281| function createDebug(namespace) {\n 282| let prevTime;\n 283| let enableOverride = null;\n 284| let namespacesCache;\n 285| let enabledCache;\n 286| function debug2(...args) {\n 287| if (!debug2.enabled) {\n 288| return;\n 289| }\n 290| const self2 = debug2;\n 291| const curr = Number(/* @__PURE__ */ new Date());\n 292| const ms = curr - (prevTime || curr);\n 293| self2.diff = ms;\n 294| self2.prev = prevTime;\n 295| self2.curr = curr;\n 296| prevTime = curr;\n 297| args[0] = createDebug.coerce(args[0]);\n 298| if (typeof args[0] !== \"string\") {\n 299| args.unshift(\"%O\");\n 300| }\n 301| let index = 0;\n 302| args[0] = args[0].replace(/%([a-zA-Z%])/g, (match, format) => {\n 303| if (match === \"%%\") {\n 304| return \"%\";\n 305| }\n 306| index++;\n 307| const formatter = createDebug.formatters[format];\n 308| if (typeof formatter === \"function\") {\n 309| const val = args[index];\n 310| match = formatter.call(self2, val);\n 311| args.splice(index, 1);\n 312| index--;\n 313| }\n 314| return match;\n 315| });\n 316| createDebug.formatArgs.call(self2, args);\n 317| const logFn = self2.log || createDebug.log;\n 318| logFn.apply(self2, args);\n 319| }\n 320| __name(debug2, \"debug\");\n 321| debug2.namespace = namespace;\n 322| debug2.useColors = createDebug.useColors();\n 323| debug2.color = createDebug.selectColor(namespace);\n 324| debug2.extend = extend;\n 325| debug2.destroy = createDebug.destroy;\n 326| Object.defineProperty(debug2, \"enabled\", {\n 327| enumerable: true,\n 328| configurable: false,\n 329| get: /* @__PURE__ */ __name(() => {\n 330| if (enableOverride !== null) {\n 331| return enableOverride;\n 332| }\n 333| if (namespacesCache !== createDebug.namespaces) {\n 334| namespacesCache = createDebug.namespaces;\n 335| enabledCache = createDebug.enabled(namespace);\n 336| }\n 337| return enabledCache;\n 338| }, \"get\"),\n 339| set: /* @__PURE__ */ __name((v) => {\n 340| enableOverride = v;\n 341| }, \"set\")\n 342| });\n 343| if (typeof createDebug.init === \"function\") {\n 344| createDebug.init(debug2);\n 345| }\n 346| return debug2;\n 347| }\n 348| __name(createDebug, \"createDebug\");\n 349| function extend(namespace, delimiter) {\n 350| const newDebug = createDebug(this.namespace + (typeof delimiter === \"undefined\" ? \":\" : delimiter) + namespace);\n 351| newDebug.log = this.log;\n 352| return newDebug;\n 353| }\n 354| __name(extend, \"extend\");\n 355| function enable(namespaces) {\n 356| createDebug.save(namespaces);\n 357| createDebug.namespaces = namespaces;\n 358| createDebug.names = [];\n 359| createDebug.skips = [];\n 360| let i;\n 361| const split = (typeof namespaces === \"string\" ? namespaces : \"\").split(/[\\s,]+/);\n 362| const len = split.length;\n 363| for (i = 0; i < len; i++) {\n 364| if (!split[i]) {\n 365| continue;\n 366| }\n 367| namespaces = split[i].replace(/\\*/g, \".*?\");\n 368| if (namespaces[0] === \"-\") {\n 369| createDebug.skips.push(new RegExp(\"^\" + namespaces.slice(1) + \"$\"));\n 370| } else {\n 371| createDebug.names.push(new RegExp(\"^\" + namespaces + \"$\"));\n 372| }\n 373| }\n 374| }\n 375| __name(enable, \"enable\");\n 376| function disable() {\n 377| const namespaces = [\n 378| ...createDebug.names.map(toNamespace),\n 379| ...createDebug.skips.map(toNamespace).map((namespace) => \"-\" + namespace)\n 380| ].join(\",\");\n 381| createDebug.enable(\"\");\n 382| return namespaces;\n 383| }\n 384| __name(disable, \"disable\");\n 385| function enabled(name) {\n 386| if (name[name.length - 1] === \"*\") {\n 387| return true;\n 388| }\n 389| let i;\n 390| let len;\n 391| for (i = 0, len = createDebug.skips.length; i < len; i++) {\n 392| if (createDebug.skips[i].test(name)) {\n 393| return false;\n 394| }\n 395| }\n 396| for (i = 0, len = createDebug.names.length; i < len; i++) {\n 397| if (createDebug.names[i].test(name)) {\n 398| return true;\n 399| }\n 400| }\n 401| return false;\n 402| }\n 403| __name(enabled, \"enabled\");\n 404| function toNamespace(regexp) {\n 405| return regexp.toString().substring(2, regexp.toString().length - 2).replace(/\\.\\*\\?$/, \"*\");\n 406| }\n 407| __name(toNamespace, \"toNamespace\");\n 408| function coerce(val) {\n 409| if (val instanceof Error) {\n 410| return val.stack || val.message;\n 411| }\n 412| return val;\n 413| }\n 414| __name(coerce, \"coerce\");\n 415| function destroy() {\n 416| console.warn(\"Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.\");\n 417| }\n 418| __name(destroy, \"destroy\");\n 419| createDebug.enable(createDebug.load());\n 420| return createDebug;\n 421| }\n 422| __name(setup, \"setup\");\n 423| module2.exports = setup;\n 424| }\n 425| });\n 426| \n 427| // node_modules/debug/src/browser.js\n 428| var require_browser = __commonJS({\n 429| \"node_modules/debug/src/browser.js\"(exports2, module2) {\n 430| init_process_global();\n 431| exports2.formatArgs = formatArgs;\n 432| exports2.save = save;\n 433| exports2.load = load;\n 434| exports2.useColors = useColors;\n 435| exports2.storage = localstorage();\n 436| exports2.destroy = /* @__PURE__ */ (() => {\n 437| let warned = false;\n 438| return () => {\n 439| if (!warned) {\n 440| warned = true;\n 441| console.warn(\"Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.\");\n 442| }\n 443| };\n 444| })();\n 445| exports2.colors = [\n 446| \"#0000CC\",\n 447| \"#0000FF\",\n 448| \"#0033CC\",\n 449| \"#0033FF\",\n 450| \"#0066CC\",\n 451| \"#0066FF\",\n 452| \"#0099CC\",\n 453| \"#0099FF\",\n 454| \"#00CC00\",\n 455| \"#00CC33\",\n 456| \"#00CC66\",\n 457| \"#00CC99\",\n 458| \"#00CCCC\",\n 459| \"#00CCFF\",\n 460| \"#3300CC\",\n 461| \"#3300FF\",\n 462| \"#3333CC\",\n 463| \"#3333FF\",\n 464| \"#3366CC\",\n 465| \"#3366FF\",\n 466| \"#3399CC\",\n 467| \"#3399FF\",\n 468| \"#33CC00\",\n 469| \"#33CC33\",\n 470| \"#33CC66\",\n 471| \"#33CC99\",\n 472| \"#33CCCC\",\n 473| \"#33CCFF\",\n 474| \"#6600CC\",\n 475| \"#6600FF\",\n 476| \"#6633CC\",\n 477| \"#6633FF\",\n 478| \"#66CC00\",\n 479| \"#66CC33\",\n 480| \"#9900CC\",\n 481| \"#9900FF\",\n 482| \"#9933CC\",\n 483| \"#9933FF\",\n 484| \"#99CC00\",\n 485| \"#99CC33\",\n 486| \"#CC0000\",\n 487| \"#CC0033\",\n 488| \"#CC0066\",\n 489| \"#CC0099\",\n 490| \"#CC00CC\",\n 491| \"#CC00FF\",\n 492| \"#CC3300\",\n 493| \"#CC3333\",\n 494| \"#CC3366\",\n 495| \"#CC3399\",\n 496| \"#CC33CC\",\n 497| \"#CC33FF\",\n 498| \"#CC6600\",\n 499| \"#CC6633\",\n 500| \"#CC9900\",\n 501| \"#CC9933\",\n 502| \"#CCCC00\",\n 503| \"#CCCC33\",\n 504| \"#FF0000\",\n 505| \"#FF0033\",\n 506| \"#FF0066\",\n 507| \"#FF0099\",\n 508| \"#FF00CC\",\n 509| \"#FF00FF\",\n 510| \"#FF3300\",\n 511| \"#FF3333\",\n 512| \"#FF3366\",\n 513| \"#FF3399\",\n 514| \"#FF33CC\",\n 515| \"#FF33FF\",\n 516| \"#FF6600\",\n 517| \"#FF6633\",\n 518| \"#FF9900\",\n 519| \"#FF9933\",\n 520| \"#FFCC00\",\n 521| \"#FFCC33\"\n 522| ];\n 523| function useColors() {\n 524| if (typeof window !== \"undefined\" && window.process && (window.process.type === \"renderer\" || window.process.__nwjs)) {\n 525| return true;\n 526| }\n 527| if (typeof navigator !== \"undefined\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\\/(\\d+)/)) {\n 528| return false;\n 529| }\n 530| return typeof document !== \"undefined\" && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance || // Is firebug? http://stackoverflow.com/a/398120/376773\n 531| typeof window !== \"undefined\" && window.console && (window.console.firebug || window.console.exception && window.console.table) || // Is firefox >= v31?\n 532| // https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages\n 533| typeof navigator !== \"undefined\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\\/(\\d+)/) && parseInt(RegExp.$1, 10) >= 31 || // Double check webkit in userAgent just in case we are in a worker\n 534| typeof navigator !== \"undefined\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\\/(\\d+)/);\n 535| }\n 536| __name(useColors, \"useColors\");\n 537| function formatArgs(args) {\n 538| args[0] = (this.useColors ? \"%c\" : \"\") + this.namespace + (this.useColors ? \" %c\" : \" \") + args[0] + (this.useColors ? \"%c \" : \" \") + \"+\" + module2.exports.humanize(this.diff);\n 539| if (!this.useColors) {\n 540| return;\n 541| }\n 542| const c = \"color: \" + this.color;\n 543| args.splice(1, 0, c, \"color: inherit\");\n 544| let index = 0;\n 545| let lastC = 0;\n 546| args[0].replace(/%[a-zA-Z%]/g, (match) => {\n 547| if (match === \"%%\") {\n 548| return;\n 549| }\n 550| index++;\n 551| if (match === \"%c\") {\n 552| lastC = index;\n 553| }\n 554| });\n 555| args.splice(lastC, 0, c);\n 556| }\n 557| __name(formatArgs, \"formatArgs\");\n 558| exports2.log = console.debug || console.log || (() => {\n 559| });\n 560| function save(namespaces) {\n 561| try {\n 562| if (namespaces) {\n 563| exports2.storage.setItem(\"debug\", namespaces);\n 564| } else {\n 565| exports2.storage.removeItem(\"debug\");\n 566| }\n 567| } catch (error) {\n 568| }\n 569| }\n 570| __name(save, \"save\");\n 571| function load() {\n 572| let r;\n 573| try {\n 574| r = exports2.storage.getItem(\"debug\");\n 575| } catch (error) {\n 576| }\n 577| if (!r && typeof process !== \"undefined\" && \"env\" in process) {\n 578| r = process.env.DEBUG;\n 579| }\n 580| return r;\n 581| }\n 582| __name(load, \"load\");\n 583| function localstorage() {\n 584| try {\n 585| return localStorage;\n 586| } catch (error) {\n 587| }\n 588| }\n 589| __name(localstorage, \"localstorage\");\n 590| module2.exports = require_common()(exports2);\n 591| var { formatters } = module2.exports;\n 592| formatters.j = function(v) {\n 593| try {\n 594| return JSON.stringify(v);\n 595| } catch (error) {\n 596| return \"[UnexpectedJSONParseError]: \" + error.message;\n 597| }\n 598| };\n 599| }\n 600| });\n 601| \n 602| // node_modules/marky/lib/marky.cjs.js\n 603| var require_marky_cjs = __commonJS({\n 604| \"node_modules/marky/lib/marky.cjs.js\"(exports2) {\n 605| \"use strict\";\n 606| init_process_global();\n 607| Object.defineProperty(exports2, \"__esModule\", { value: true });\n 608| var perf = typeof performance !== \"undefined\" && performance;\n 609| var nowForNode;\n 610| {\n 611| hrtime = process.hrtime;\n 612| getNanoSeconds = /* @__PURE__ */ __name(function() {\n 613| var hr = hrtime();\n 614| return hr[0] * 1e9 + hr[1];\n 615| }, \"getNanoSeconds\");\n 616| loadTime = getNanoSeconds();\n 617| nowForNode = /* @__PURE__ */ __name(function() {\n 618| return (getNanoSeconds() - loadTime) / 1e6;\n 619| }, \"nowForNode\");\n 620| }\n 621| var hrtime;\n 622| var getNanoSeconds;\n 623| var loadTime;\n 624| var now = nowForNode;\n 625| function throwIfEmpty(name) {\n 626| if (!name) {\n 627| throw new Error(\"name must be non-empty\");\n 628| }\n 629| }\n 630| __name(throwIfEmpty, \"throwIfEmpty\");\n 631| function insertSorted(arr, item) {\n 632| var low = 0;\n 633| var high = arr.length;\n 634| var mid;\n 635| while (low < high) {\n 636| mid = low + high >>> 1;\n 637| if (arr[mid].startTime < item.startTime) {\n 638| low = mid + 1;\n 639| } else {\n 640| high = mid;\n 641| }\n 642| }\n 643| arr.splice(low, 0, item);\n 644| }\n 645| __name(insertSorted, \"insertSorted\");\n 646| exports2.mark = void 0;\n 647| exports2.stop = void 0;\n 648| exports2.getEntries = void 0;\n 649| exports2.clear = void 0;\n 650| if (perf && perf.mark && perf.getEntriesByName && perf.getEntriesByType && perf.clearMeasures) {\n 651| exports2.mark = function(name) {\n 652| throwIfEmpty(name);\n 653| perf.mark(\"start \" + name);\n 654| };\n 655| exports2.stop = function(name) {\n 656| throwIfEmpty(name);\n 657| perf.mark(\"end \" + name);\n 658| perf.measure(name, \"start \" + name, \"end \" + name);\n 659| var entries2 = perf.getEntriesByName(name);\n 660| return entries2[entries2.length - 1];\n 661| };\n 662| exports2.getEntries = function() {\n 663| return perf.getEntriesByType(\"measure\");\n 664| };\n 665| exports2.clear = function() {\n 666| perf.clearMarks();\n 667| perf.clearMeasures();\n 668| };\n 669| } else {\n 670| marks = {};\n 671| entries = [];\n 672| exports2.mark = function(name) {\n 673| throwIfEmpty(name);\n 674| var startTime = now();\n 675| marks[\"$\" + name] = startTime;\n 676| };\n 677| exports2.stop = function(name) {\n 678| throwIfEmpty(name);\n 679| var endTime = now();\n 680| var startTime = marks[\"$\" + name];\n 681| if (!startTime) {\n 682| throw new Error(\"no known mark: \" + name);\n 683| }\n 684| var entry = {\n 685| startTime,\n 686| name,\n 687| duration: endTime - startTime,\n 688| entryType: \"measure\"\n 689| };\n 690| insertSorted(entries, entry);\n 691| return entry;\n 692| };\n 693| exports2.getEntries = function() {\n 694| return entries;\n 695| };\n 696| exports2.clear = function() {\n 697| marks = {};\n 698| entries = [];\n 699| };\n 700| }\n 701| var marks;\n 702| var entries;\n 703| }\n 704| });\n 705| \n 706| // lighthouse-logger/index.js\n 707| import process3 from \"process\";\n 708| import { EventEmitter } from \"events\";\n 709| var import_debug, marky, isWindows, isBrowser, colors, Emitter, loggersByTitle, loggingBufferColumns, level_, Log, lighthouse_logger_default;\n 710| var init_lighthouse_logger = __esm({\n 711| \"lighthouse-logger/index.js\"() {\n 712| \"use strict\";\n 713| init_process_global();\n 714| import_debug = __toESM(require_browser(), 1);\n 715| marky = __toESM(require_marky_cjs(), 1);\n 716| /**\n 717| * @license\n 718| * Copyright 2016 Google LLC\n 719| * SPDX-License-Identifier: Apache-2.0\n 720| */\n 721| isWindows = process3.platform === \"win32\";\n 722| isBrowser = process3.browser;\n 723| colors = {\n 724| red: isBrowser ? \"crimson\" : 1,\n 725| yellow: isBrowser ? \"gold\" : 3,\n 726| cyan: isBrowser ? \"darkturquoise\" : 6,\n 727| green: isBrowser ? \"forestgreen\" : 2,\n 728| blue: isBrowser ? \"steelblue\" : 4,\n 729| magenta: isBrowser ? \"palevioletred\" : 5\n 730| };\n 731| import_debug.default.colors = [colors.cyan, colors.green, colors.blue, colors.magenta];\n 732| Emitter = class extends EventEmitter {\n 733| static {\n 734| __name(this, \"Emitter\");\n 735| }\n 736| // yarn build-types fails without this!\n 737| // https://github.com/microsoft/TypeScript/issues/41672#issuecomment-2303803072\n 738| constructor(options) {\n 739| super(options);\n 740| }\n 741| /**\n 742| * Fires off all status updates. Listen with\n 743| * `require('lib/log').events.addListener('status', callback)`\n 744| * @param {string} title\n 745| * @param {!Array<*>} argsArray\n 746| */\n 747| issueStatus(title, argsArray) {\n 748| if (title === \"status\" || title === \"statusEnd\") {\n 749| this.emit(title, [title, ...argsArray]);\n 750| }\n 751| }\n 752| /**\n 753| * Fires off all warnings. Listen with\n 754| * `require('lib/log').events.addListener('warning', callback)`\n 755| * @param {string} title\n 756| * @param {!Array<*>} argsArray\n 757| */\n 758| issueWarning(title, argsArray) {\n 759| this.emit(\"warning\", [title, ...argsArray]);\n 760| }\n 761| };\n 762| loggersByTitle = {};\n 763| loggingBufferColumns = 25;\n 764| Log = class _Log {\n 765| static {\n 766| __name(this, \"Log\");\n 767| }\n 768| static _logToStdErr(title, argsArray) {\n 769| const log = _Log.loggerfn(title);\n 770| log(...argsArray);\n 771| }\n 772| /**\n 773| * @param {string} title\n 774| */\n 775| static loggerfn(title) {\n 776| title = `LH:${title}`;\n 777| let log = loggersByTitle[title];\n 778| if (!log) {\n 779| log = (0, import_debug.default)(title);\n 780| loggersByTitle[title] = log;\n 781| if (title.endsWith(\"error\")) {\n 782| log.color = colors.red;\n 783| } else if (title.endsWith(\"warn\")) {\n 784| log.color = colors.yellow;\n 785| }\n 786| }\n 787| return log;\n 788| }\n 789| /**\n 790| * @param {string} level\n 791| */\n 792| static setLevel(level) {\n 793| level_ = level;\n 794| switch (level) {\n 795| case \"silent\":\n 796| import_debug.default.enable(\"-LH:*\");\n 797| break;\n 798| case \"verbose\":\n 799| import_debug.default.enable(\"LH:*\");\n 800| break;\n 801| case \"warn\":\n 802| import_debug.default.enable(\"-LH:*, LH:*:warn, LH:*:error\");\n 803| break;\n 804| case \"error\":\n 805| import_debug.default.enable(\"-LH:*, LH:*:error\");\n 806| break;\n 807| default:\n 808| import_debug.default.enable(\"LH:*, -LH:*:verbose\");\n 809| }\n 810| }\n 811| /**\n 812| * A simple formatting utility for event logging.\n 813| * @param {string} prefix\n 814| * @param {!Object} data A JSON-serializable object of event data to log.\n 815| * @param {string=} level Optional logging level. Defaults to 'log'.\n 816| */\n 817| static formatProtocol(prefix, data31, level) {\n 818| const columns = !process3 || process3.browser ? Infinity : process3.stdout.columns;\n 819| const method = data31.method || \"?????\";\n 820| const maxLength = columns - method.length - prefix.length - loggingBufferColumns;\n 821| const snippet = data31.params && method !== \"IO.read\" ? JSON.stringify(data31.params).substr(0, maxLength) : \"\";\n 822| _Log._logToStdErr(`${prefix}:${level || \"\"}`, [method, snippet]);\n 823| }\n 824| /**\n 825| * @return {boolean}\n 826| */\n 827| static isVerbose() {\n 828| return level_ === \"verbose\";\n 829| }\n 830| /**\n 831| * @param {{msg: string, id: string, args?: any[]}} status\n 832| * @param {string} level\n 833| */\n 834| static time({ msg, id, args = [] }, level = \"log\") {\n 835| marky.mark(id);\n 836| _Log[level](\"status\", msg, ...args);\n 837| }\n 838| /**\n 839| * @param {{msg: string, id: string, args?: any[]}} status\n 840| * @param {string} level\n 841| */\n 842| static timeEnd({ msg, id, args = [] }, level = \"verbose\") {\n 843| _Log[level](\"statusEnd\", msg, ...args);\n 844| marky.stop(id);\n 845| }\n 846| /**\n 847| * @param {string} title\n 848| * @param {...any} args\n 849| */\n 850| static log(title, ...args) {\n 851| _Log.events.issueStatus(title, args);\n 852| return _Log._logToStdErr(title, args);\n 853| }\n 854| /**\n 855| * @param {string} title\n 856| * @param {...any} args\n 857| */\n 858| static warn(title, ...args) {\n 859| _Log.events.issueWarning(title, args);\n 860| return _Log._logToStdErr(`${title}:warn`, args);\n 861| }\n 862| /**\n 863| * @param {string} title\n 864| * @param {...any} args\n 865| */\n 866| static error(title, ...args) {\n 867| return _Log._logToStdErr(`${title}:error`, args);\n 868| }\n 869| /**\n 870| * @param {string} title\n 871| * @param {...any} args\n 872| */\n 873| static verbose(title, ...args) {\n 874| _Log.events.issueStatus(title, args);\n 875| return _Log._logToStdErr(`${title}:verbose`, args);\n 876| }\n 877| /**\n 878| * Add surrounding escape sequences to turn a string green when logged.\n 879| * @param {string} str\n 880| * @return {string}\n 881| */\n 882| static greenify(str) {\n 883| return `${_Log.green}${str}${_Log.reset}`;\n 884| }\n 885| /**\n 886| * Add surrounding escape sequences to turn a string red when logged.\n 887| * @param {string} str\n 888| * @return {string}\n 889| */\n 890| static redify(str) {\n 891| return `${_Log.red}${str}${_Log.reset}`;\n 892| }\n 893| static get green() {\n 894| return \"\\x1B[32m\";\n 895| }\n 896| static get red() {\n 897| return \"\\x1B[31m\";\n 898| }\n 899| static get yellow() {\n 900| return \"\\x1B[33m\";\n 901| }\n 902| static get purple() {\n 903| return \"\\x1B[95m\";\n 904| }\n 905| static get reset() {\n 906| return \"\\x1B[0m\";\n 907| }\n 908| static get bold() {\n 909| return \"\\x1B[1m\";\n 910| }\n 911| static get dim() {\n 912| return \"\\x1B[2m\";\n 913| }\n 914| static get tick() {\n 915| return isWindows ? \"√\" : \"✓\";\n 916| }\n 917| static get cross() {\n 918| return isWindows ? \"×\" : \"✘\";\n 919| }\n 920| static get whiteSmallSquare() {\n 921| return isWindows ? \"·\" : \"▫\";\n 922| }\n 923| static get heavyHorizontal() {\n 924| return isWindows ? \"─\" : \"━\";\n 925| }\n 926| static get heavyVertical() {\n 927| return isWindows ? \"│ \" : \"┃ \";\n 928| }\n 929| static get heavyUpAndRight() {\n 930| return isWindows ? \"└\" : \"┗\";\n 931| }\n 932| static get heavyVerticalAndRight() {\n 933| return isWindows ? \"├\" : \"┣\";\n 934| }\n 935| static get heavyDownAndHorizontal() {\n 936| return isWindows ? \"┬\" : \"┳\";\n 937| }\n 938| static get doubleLightHorizontal() {\n 939| return \"──\";\n 940| }\n 941| };\n 942| Log.events = new Emitter();\n 943| Log.takeTimeEntries = () => {\n 944| const entries = marky.getEntries();\n 945| marky.clear();\n 946| return entries;\n 947| };\n 948| Log.getTimeEntries = () => marky.getEntries();\n 949| lighthouse_logger_default = Log;\n 950| }\n 951| });\n 952| \n 953| // core/lib/tracehouse/trace-processor.js\n 954| var ACCEPTABLE_NAVIGATION_URL_REGEX, BASE_RESPONSE_LATENCY, SCHEDULABLE_TASK_TITLE_LH, SCHEDULABLE_TASK_TITLE_ALT1, SCHEDULABLE_TASK_TITLE_ALT2, SCHEDULABLE_TASK_TITLE_ALT3, TraceProcessor;\n 955| var init_trace_processor = __esm({\n 956| \"core/lib/tracehouse/trace-processor.js\"() {\n 957| \"use strict\";\n 958| init_process_global();\n 959| init_lighthouse_logger();\n 960| /**\n 961| * @license\n 962| * Copyright 2017 Google LLC\n 963| * SPDX-License-Identifier: Apache-2.0\n 964| */\n 965| ACCEPTABLE_NAVIGATION_URL_REGEX = /^(chrome|https?):/;\n 966| BASE_RESPONSE_LATENCY = 16;\n 967| SCHEDULABLE_TASK_TITLE_LH = \"RunTask\";\n 968| SCHEDULABLE_TASK_TITLE_ALT1 = \"ThreadControllerImpl::RunTask\";\n 969| SCHEDULABLE_TASK_TITLE_ALT2 = \"ThreadControllerImpl::DoWork\";\n 970| SCHEDULABLE_TASK_TITLE_ALT3 = \"TaskQueueManager::ProcessTaskFromWorkQueue\";\n 971| TraceProcessor = class _TraceProcessor {\n 972| static {\n 973| __name(this, \"TraceProcessor\");\n 974| }\n 975| static get TIMESPAN_MARKER_ID() {\n 976| return \"__lighthouseTimespanStart__\";\n 977| }\n 978| /**\n 979| * @return {Error}\n 980| */\n 981| static createNoNavstartError() {\n 982| return new Error(\"No navigationStart event found\");\n 983| }\n 984| /**\n 985| * @return {Error}\n 986| */\n 987| static createNoResourceSendRequestError() {\n 988| return new Error(\"No ResourceSendRequest event found\");\n 989| }\n 990| /**\n 991| * @return {Error}\n 992| */\n 993| static createNoTracingStartedError() {\n 994| return new Error(\"No tracingStartedInBrowser event found\");\n 995| }\n 996| /**\n 997| * @return {Error}\n 998| */\n 999| static createNoFirstContentfulPaintError() {\n1000| return new Error(\"No FirstContentfulPaint event found\");\n1001| }\n1002| /**\n1003| * @return {Error}\n1004| */\n1005| static createNoLighthouseMarkerError() {\n1006| return new Error(\"No Lighthouse timespan marker event found\");\n1007| }\n1008| /**\n1009| * Returns true if the event is a navigation start event of a document whose URL seems valid.\n1010| *\n1011| * @param {LH.TraceEvent} event\n1012| * @return {boolean}\n1013| */\n1014| static _isNavigationStartOfInterest(event) {\n1015| if (event.name !== \"navigationStart\") return false;\n1016| if (event.args.data?.documentLoaderURL === void 0) return true;\n1017| if (!event.args.data?.documentLoaderURL) return false;\n1018| return ACCEPTABLE_NAVIGATION_URL_REGEX.test(event.args.data.documentLoaderURL);\n1019| }\n1020| /**\n1021| * This method sorts a group of trace events that have the same timestamp. We want to...\n1022| *\n1023| * 1. Put E events first, we finish off our existing events before we start new ones.\n1024| * 2. Order B/X events by their duration, we want parents to start before child events.\n1025| * 3. If we don't have any of this to go on, just use the position in the original array (stable sort).\n1026| *\n1027| * Note that the typical group size with the same timestamp will be quite small (<10 or so events),\n1028| * and the number of groups typically ~1% of total trace, so the same ultra-performance-sensitive consideration\n1029| * given to functions that run on entire traces does not necessarily apply here.\n1030| *\n1031| * @param {number[]} tsGroupIndices\n1032| * @param {number[]} timestampSortedIndices\n1033| * @param {number} indexOfTsGroupIndicesStart\n1034| * @param {LH.TraceEvent[]} traceEvents\n1035| * @return {number[]}\n1036| */\n1037| static _sortTimestampEventGroup(tsGroupIndices, timestampSortedIndices, indexOfTsGroupIndicesStart, traceEvents) {\n1038| const lookupArrayIndexByTsIndex = /* @__PURE__ */ __name((i) => timestampSortedIndices[i], \"lookupArrayIndexByTsIndex\");\n1039| const lookupEventByTsIndex = /* @__PURE__ */ __name((i) => traceEvents[lookupArrayIndexByTsIndex(i)], \"lookupEventByTsIndex\");\n1040| const eEventIndices = [];\n1041| const bxEventIndices = [];\n1042| const otherEventIndices = [];\n1043| for (const tsIndex of tsGroupIndices) {\n1044| const arrayIndex = lookupArrayIndexByTsIndex(tsIndex);\n1045| const event = lookupEventByTsIndex(tsIndex);\n1046| if (event.ph === \"E\") eEventIndices.push(arrayIndex);\n1047| else if (event.ph === \"X\" || event.ph === \"B\") bxEventIndices.push(arrayIndex);\n1048| else otherEventIndices.push(arrayIndex);\n1049| }\n1050| const effectiveDuration = /* @__PURE__ */ new Map();\n1051| for (const index of bxEventIndices) {\n1052| const event = traceEvents[index];\n1053| if (event.ph === \"X\") {\n1054| effectiveDuration.set(index, event.dur);\n1055| } else {\n1056| let duration = Number.MAX_SAFE_INTEGER;\n1057| let additionalNestedEventsWithSameName = 0;\n1058| const startIndex = indexOfTsGroupIndicesStart + tsGroupIndices.length;\n1059| for (let j = startIndex; j < timestampSortedIndices.length; j++) {\n1060| const potentialMatchingEvent = lookupEventByTsIndex(j);\n1061| const eventMatches = potentialMatchingEvent.name === event.name && potentialMatchingEvent.pid === event.pid && potentialMatchingEvent.tid === event.tid;\n1062| if (!eventMatches) continue;\n1063| if (potentialMatchingEvent.ph === \"E\" && additionalNestedEventsWithSameName === 0) {\n1064| duration = potentialMatchingEvent.ts - event.ts;\n1065| break;\n1066| } else if (potentialMatchingEvent.ph === \"E\") {\n1067| additionalNestedEventsWithSameName--;\n1068| } else if (potentialMatchingEvent.ph === \"B\") {\n1069| additionalNestedEventsWithSameName++;\n1070| }\n1071| }\n1072| effectiveDuration.set(index, duration);\n1073| }\n1074| }\n1075| bxEventIndices.sort((indexA, indexB) => (effectiveDuration.get(indexB) || 0) - (effectiveDuration.get(indexA) || 0) || indexA - indexB);\n1076| otherEventIndices.sort((indexA, indexB) => indexA - indexB);\n1077| return [...eEventIndices, ...bxEventIndices, ...otherEventIndices];\n1078| }\n1079| /**\n1080| * Sorts and filters trace events by timestamp and respecting the nesting structure inherent to\n1081| * parent/child event relationships.\n1082| *\n1083| * @param {LH.TraceEvent[]} traceEvents\n1084| * @param {(e: LH.TraceEvent) => boolean} filter\n1085| */\n1086| static filteredTraceSort(traceEvents, filter) {\n1087| const indices = [];\n1088| for (let srcIndex = 0; srcIndex < traceEvents.length; srcIndex++) {\n1089| if (filter(traceEvents[srcIndex])) {\n1090| indices.push(srcIndex);\n1091| }\n1092| }\n1093| indices.sort((indexA, indexB) => traceEvents[indexA].ts - traceEvents[indexB].ts);\n1094| for (let i = 0; i < indices.length - 1; i++) {\n1095| const ts = traceEvents[indices[i]].ts;\n1096| const tsGroupIndices = [i];\n1097| for (let j = i + 1; j < indices.length; j++) {\n1098| if (traceEvents[indices[j]].ts !== ts) break;\n1099| tsGroupIndices.push(j);\n1100| }\n```\n\n### FILE: src/tools/categories.ts (33 lines)\n\n```\n 1| /**\n 2| * @license\n 3| * Copyright 2025 Google LLC\n 4| * SPDX-License-Identifier: Apache-2.0\n 5| */\n 6| \n 7| export enum ToolCategory {\n 8| INPUT = 'input',\n 9| NAVIGATION = 'navigation',\n 10| EMULATION = 'emulation',\n 11| PERFORMANCE = 'performance',\n 12| NETWORK = 'network',\n 13| DEBUGGING = 'debugging',\n 14| EXTENSIONS = 'extensions',\n 15| THIRD_PARTY = 'experimentalThirdParty',\n 16| MEMORY = 'memory',\n 17| WEBMCP = 'experimentalWebmcp',\n 18| PWA = 'pwa',\n 19| }\n 20| \n 21| export const labels = {\n 22| [ToolCategory.INPUT]: 'Input automation',\n 23| [ToolCategory.NAVIGATION]: 'Navigation automation',\n 24| [ToolCategory.EMULATION]: 'Emulation',\n 25| [ToolCategory.PERFORMANCE]: 'Performance',\n 26| [ToolCategory.NETWORK]: 'Network',\n 27| [ToolCategory.DEBUGGING]: 'Debugging',\n 28| [ToolCategory.EXTENSIONS]: 'Extensions',\n 29| [ToolCategory.THIRD_PARTY]: 'Third-party',\n 30| [ToolCategory.MEMORY]: 'Memory',\n 31| [ToolCategory.WEBMCP]: 'WebMCP',\n 32| [ToolCategory.PWA]: 'Progressive Web Apps',\n 33| };\n```\n<END_OF_CONTEXT>\n\n<query>\nGenerate a wiki page tracing the primary data or control flow through this system from entry to exit. Include a Mermaid sequenceDiagram showing the interactions between components.\n</query>"},{"role":"assistant","content":"# Lighthouse DevTools MCP System Architecture\n\n## Overview\n\nThis document traces the primary data and control flow through the Lighthouse DevTools MCP (Multi-Client Protocol) system. The system is built around the Lighthouse auditing framework, extended with DevTools-specific integrations for Chrome DevTools Protocol interaction. The core components include trace processing, gatherer infrastructure, logging, and category definitions for tool organization.\n\nThe system's entry point is through the `lighthouse-devtools-mcp-bundle.js` which contains the main Lighthouse engine, while `categories.ts` provides categorization for tools within the DevTools interface.\n\n## Detailed Analysis\n\nThe primary execution flow begins with the `BaseGatherer` class (`src/third_party/lighthouse-devtools-mcp-bundle.js:71-129`) which defines the interface for collecting data from a web page. This base class is extended by specific gatherers that implement methods for instrumenting and collecting artifacts during page interactions.\n\n```typescript\n// BaseGatherer class defines the interface for all gatherers\nclass BaseGatherer {\n meta = { supportedModes: [] };\n startInstrumentation(passContext) {}\n startSensitiveInstrumentation(passContext) {}\n stopSensitiveInstrumentation(passContext) {}\n stopInstrumentation(passContext) {}\n getArtifact(passContext) {}\n}\n```\n\nThe trace processing component (`src/third_party/lighthouse-devtools-mcp-bundle.js:953-1100`) handles the processing of Chrome trace events. It sorts and filters trace events using `filteredTraceSort` (`src/third_party/lighthouse-devtools-mcp-bundle.js:1086-1100`) which ensures proper chronological ordering while respecting event nesting relationships. The trace processor also provides error creation methods for missing critical events like navigationStart or FirstContentfulPaint.\n\n```typescript\n// Trace processing uses filteredTraceSort to organize events\nstatic filteredTraceSort(traceEvents, filter) {\n const indices = [];\n for (let srcIndex = 0; srcIndex < traceEvents.length; srcIndex++) {\n if (filter(traceEvents[srcIndex])) {\n indices.push(srcIndex);\n }\n }\n indices.sort((indexA, indexB) => traceEvents[indexA].ts - traceEvents[indexB].ts);\n // ... further processing\n}\n```\n\nThe logging system (`src/third_party/lighthouse-devtools-mcp-bundle.js:706-951`) provides structured logging capabilities using the debug library and marky performance measurement tools. This system supports different log levels and can format protocol messages for debugging.\n\n```typescript\n// Logger provides structured logging with different levels\nstatic log(title, ...args) {\n _Log.events.issueStatus(title, args);\n return _Log._logToStdErr(title, args);\n}\nstatic warn(title, ...args) {\n _Log.events.issueWarning(title, args);\n return _Log._logToStdErr(`${title}:warn`, args);\n}\nstatic error(title, ...args) {\n return _Log._logToStdErr(`${title}:error`, args);\n}\n```\n\nThe categories defined in `src/tools/categories.ts` (`lines 7-19`) organize tools into functional groups for the DevTools UI. These categories map to specific tool functionalities like input automation, performance analysis, and debugging.\n\n## Mermaid Sequence Diagram\n\n```mermaid\nsequenceDiagram\n participant User\n participant DevTools\n participant LighthouseEngine\n participant TraceProcessor\n participant BaseGatherer\n participant Logger\n\n User->>DevTools: Initiate audit\n DevTools->>LighthouseEngine: Start trace collection\n LighthouseEngine->>TraceProcessor: Process trace events\n TraceProcessor->>TraceProcessor: Sort and filter events\n TraceProcessor->>LighthouseEngine: Return processed events\n LighthouseEngine->>BaseGatherer: Execute gatherer lifecycle\n BaseGatherer->>BaseGatherer: Start instrumentation\n BaseGatherer->>BaseGatherer: Collect artifacts\n BaseGatherer->>BaseGatherer: Stop instrumentation\n BaseGatherer->>LighthouseEngine: Return gathered data\n LighthouseEngine->>Logger: Log status and warnings\n Logger->>DevTools: Output logs\n DevTools->>User: Present audit results\n```\n\n## Conclusion\n\nThe Lighthouse DevTools MCP system follows a structured flow where trace events are first processed and sorted, then gathered through specialized gatherers that implement the `BaseGatherer` interface. The logging system provides visibility into the process, while the categorization system in `categories.ts` helps organize the various tools within the DevTools interface. The design emphasizes modularity through the `BaseGatherer` pattern, allowing new data collection methods to be added without modifying core logic."}],"string":"[\n {\n \"role\": \"system\",\n \"content\": [\n \"You are an expert software architect writing wiki documentation for codebases.\\nRequirements:\\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\\n4. Explain the WHY behind design decisions, not only the WHAT.\\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\\n7. Example of the correct citation style, inline and attached to a path:\\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon.\"\n ]\n },\n {\n \"role\": \"user\",\n \"content\": \"<START_OF_CONTEXT>\\n# Repository: ChromeDevTools/chrome-devtools-mcp (language: typescript)\\n\\n# Selected files (windows)\\n- src/third_party/lighthouse-devtools-mcp-bundle.js (lines 1-1100 of 58496)\\n- src/tools/categories.ts (33 lines)\\n\\n\\n### FILE: src/third_party/lighthouse-devtools-mcp-bundle.js (lines 1-1100 of 58496)\\n\\n```\\n 1| /**\\n 2| * Lighthouse v13.4.1 (Jul 23 2026)\\n 3| *\\n 4| * Automated auditing, performance metrics, and best practices for the web.\\n 5| *\\n 6| * @homepage https://github.com/GoogleChrome/lighthouse#readme\\n 7| * @author Copyright 2026 Google LLC\\n 8| * @license Apache-2.0\\n 9| *\\n 10| * Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0\\n 11| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\\n 12| */\\n 13| var __create = Object.create;\\n 14| var __defProp = Object.defineProperty;\\n 15| var __getOwnPropDesc = Object.getOwnPropertyDescriptor;\\n 16| var __getOwnPropNames = Object.getOwnPropertyNames;\\n 17| var __getProtoOf = Object.getPrototypeOf;\\n 18| var __hasOwnProp = Object.prototype.hasOwnProperty;\\n 19| var __name = (target, value) => __defProp(target, \\\"name\\\", { value, configurable: true });\\n 20| var __esm = (fn, res) => function __init() {\\n 21| return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;\\n 22| };\\n 23| var __commonJS = (cb, mod2) => function __require() {\\n 24| return mod2 || (0, cb[__getOwnPropNames(cb)[0]])((mod2 = { exports: {} }).exports, mod2), mod2.exports;\\n 25| };\\n 26| var __export = (target, all) => {\\n 27| for (var name in all)\\n 28| __defProp(target, name, { get: all[name], enumerable: true });\\n 29| };\\n 30| var __copyProps = (to, from, except, desc) => {\\n 31| if (from && typeof from === \\\"object\\\" || typeof from === \\\"function\\\") {\\n 32| for (let key of __getOwnPropNames(from))\\n 33| if (!__hasOwnProp.call(to, key) && key !== except)\\n 34| __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });\\n 35| }\\n 36| return to;\\n 37| };\\n 38| var __toESM = (mod2, isNodeMode, target) => (target = mod2 != null ? __create(__getProtoOf(mod2)) : {}, __copyProps(\\n 39| // If the importer is in node compatibility mode or this is not an ESM\\n 40| // file that has been converted to a CommonJS file using a Babel-\\n 41| // compatible transform (i.e. \\\"__esModule\\\" has not been set), then set\\n 42| // \\\"default\\\" to the CommonJS \\\"module.exports\\\" for node compatibility.\\n 43| isNodeMode || !mod2 || !mod2.__esModule ? __defProp(target, \\\"default\\\", { value: mod2, enumerable: true }) : target,\\n 44| mod2\\n 45| ));\\n 46| var __toCommonJS = (mod2) => __copyProps(__defProp({}, \\\"__esModule\\\", { value: true }), mod2);\\n 47| \\n 48| // build/process-global.js\\n 49| import process2 from \\\"process\\\";\\n 50| var init_process_global = __esm({\\n 51| \\\"build/process-global.js\\\"() {\\n 52| \\\"use strict\\\";\\n 53| globalThis.process = process2;\\n 54| }\\n 55| });\\n 56| \\n 57| // types/lh.js\\n 58| var init_lh = __esm({\\n 59| \\\"types/lh.js\\\"() {\\n 60| \\\"use strict\\\";\\n 61| init_process_global();\\n 62| /**\\n 63| * @license\\n 64| * Copyright 2023 Google LLC\\n 65| * SPDX-License-Identifier: Apache-2.0\\n 66| */\\n 67| }\\n 68| });\\n 69| \\n 70| // core/gather/base-gatherer.js\\n 71| var BaseGatherer, base_gatherer_default;\\n 72| var init_base_gatherer = __esm({\\n 73| \\\"core/gather/base-gatherer.js\\\"() {\\n 74| \\\"use strict\\\";\\n 75| init_process_global();\\n 76| init_lh();\\n 77| /**\\n 78| * @license\\n 79| * Copyright 2021 Google LLC\\n 80| * SPDX-License-Identifier: Apache-2.0\\n 81| */\\n 82| BaseGatherer = class {\\n 83| static {\\n 84| __name(this, \\\"BaseGatherer\\\");\\n 85| }\\n 86| /** @type {LH.Gatherer.GathererMeta} */\\n 87| meta = { supportedModes: [] };\\n 88| /**\\n 89| * Method to start observing a page for an arbitrary period of time.\\n 90| * @param {LH.Gatherer.Context} passContext\\n 91| * @return {Promise<void>|void}\\n 92| */\\n 93| startInstrumentation(passContext) {\\n 94| }\\n 95| /**\\n 96| * Method to start observing a page when the measurements are very sensitive and\\n 97| * should observe as little Lighthouse-induced work as possible.\\n 98| * @param {LH.Gatherer.Context} passContext\\n 99| * @return {Promise<void>|void}\\n 100| */\\n 101| startSensitiveInstrumentation(passContext) {\\n 102| }\\n 103| /**\\n 104| * Method to stop observing a page when the measurements are very sensitive and\\n 105| * should observe as little Lighthouse-induced work as possible.\\n 106| *\\n 107| * @param {LH.Gatherer.Context} passContext\\n 108| * @return {Promise<void>|void}\\n 109| */\\n 110| stopSensitiveInstrumentation(passContext) {\\n 111| }\\n 112| /**\\n 113| * Method to end observing a page after an arbitrary period of time.\\n 114| * @param {LH.Gatherer.Context} passContext\\n 115| * @return {Promise<void>|void}\\n 116| */\\n 117| stopInstrumentation(passContext) {\\n 118| }\\n 119| /**\\n 120| * Method to gather results about a page.\\n 121| * @param {LH.Gatherer.Context} passContext\\n 122| * @return {LH.Gatherer.PhaseResult}\\n 123| */\\n 124| getArtifact(passContext) {\\n 125| }\\n 126| };\\n 127| base_gatherer_default = BaseGatherer;\\n 128| }\\n 129| });\\n 130| \\n 131| // node_modules/debug/node_modules/ms/index.js\\n 132| var require_ms = __commonJS({\\n 133| \\\"node_modules/debug/node_modules/ms/index.js\\\"(exports2, module2) {\\n 134| init_process_global();\\n 135| var s = 1e3;\\n 136| var m = s * 60;\\n 137| var h = m * 60;\\n 138| var d = h * 24;\\n 139| var w = d * 7;\\n 140| var y = d * 365.25;\\n 141| module2.exports = function(val, options) {\\n 142| options = options || {};\\n 143| var type = typeof val;\\n 144| if (type === \\\"string\\\" && val.length > 0) {\\n 145| return parse(val);\\n 146| } else if (type === \\\"number\\\" && isFinite(val)) {\\n 147| return options.long ? fmtLong(val) : fmtShort(val);\\n 148| }\\n 149| throw new Error(\\n 150| \\\"val is not a non-empty string or a valid number. val=\\\" + JSON.stringify(val)\\n 151| );\\n 152| };\\n 153| function parse(str) {\\n 154| str = String(str);\\n 155| if (str.length > 100) {\\n 156| return;\\n 157| }\\n 158| var match = /^(-?(?:\\\\d+)?\\\\.?\\\\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i.exec(\\n 159| str\\n 160| );\\n 161| if (!match) {\\n 162| return;\\n 163| }\\n 164| var n = parseFloat(match[1]);\\n 165| var type = (match[2] || \\\"ms\\\").toLowerCase();\\n 166| switch (type) {\\n 167| case \\\"years\\\":\\n 168| case \\\"year\\\":\\n 169| case \\\"yrs\\\":\\n 170| case \\\"yr\\\":\\n 171| case \\\"y\\\":\\n 172| return n * y;\\n 173| case \\\"weeks\\\":\\n 174| case \\\"week\\\":\\n 175| case \\\"w\\\":\\n 176| return n * w;\\n 177| case \\\"days\\\":\\n 178| case \\\"day\\\":\\n 179| case \\\"d\\\":\\n 180| return n * d;\\n 181| case \\\"hours\\\":\\n 182| case \\\"hour\\\":\\n 183| case \\\"hrs\\\":\\n 184| case \\\"hr\\\":\\n 185| case \\\"h\\\":\\n 186| return n * h;\\n 187| case \\\"minutes\\\":\\n 188| case \\\"minute\\\":\\n 189| case \\\"mins\\\":\\n 190| case \\\"min\\\":\\n 191| case \\\"m\\\":\\n 192| return n * m;\\n 193| case \\\"seconds\\\":\\n 194| case \\\"second\\\":\\n 195| case \\\"secs\\\":\\n 196| case \\\"sec\\\":\\n 197| case \\\"s\\\":\\n 198| return n * s;\\n 199| case \\\"milliseconds\\\":\\n 200| case \\\"millisecond\\\":\\n 201| case \\\"msecs\\\":\\n 202| case \\\"msec\\\":\\n 203| case \\\"ms\\\":\\n 204| return n;\\n 205| default:\\n 206| return void 0;\\n 207| }\\n 208| }\\n 209| __name(parse, \\\"parse\\\");\\n 210| function fmtShort(ms) {\\n 211| var msAbs = Math.abs(ms);\\n 212| if (msAbs >= d) {\\n 213| return Math.round(ms / d) + \\\"d\\\";\\n 214| }\\n 215| if (msAbs >= h) {\\n 216| return Math.round(ms / h) + \\\"h\\\";\\n 217| }\\n 218| if (msAbs >= m) {\\n 219| return Math.round(ms / m) + \\\"m\\\";\\n 220| }\\n 221| if (msAbs >= s) {\\n 222| return Math.round(ms / s) + \\\"s\\\";\\n 223| }\\n 224| return ms + \\\"ms\\\";\\n 225| }\\n 226| __name(fmtShort, \\\"fmtShort\\\");\\n 227| function fmtLong(ms) {\\n 228| var msAbs = Math.abs(ms);\\n 229| if (msAbs >= d) {\\n 230| return plural(ms, msAbs, d, \\\"day\\\");\\n 231| }\\n 232| if (msAbs >= h) {\\n 233| return plural(ms, msAbs, h, \\\"hour\\\");\\n 234| }\\n 235| if (msAbs >= m) {\\n 236| return plural(ms, msAbs, m, \\\"minute\\\");\\n 237| }\\n 238| if (msAbs >= s) {\\n 239| return plural(ms, msAbs, s, \\\"second\\\");\\n 240| }\\n 241| return ms + \\\" ms\\\";\\n 242| }\\n 243| __name(fmtLong, \\\"fmtLong\\\");\\n 244| function plural(ms, msAbs, n, name) {\\n 245| var isPlural = msAbs >= n * 1.5;\\n 246| return Math.round(ms / n) + \\\" \\\" + name + (isPlural ? \\\"s\\\" : \\\"\\\");\\n 247| }\\n 248| __name(plural, \\\"plural\\\");\\n 249| }\\n 250| });\\n 251| \\n 252| // node_modules/debug/src/common.js\\n 253| var require_common = __commonJS({\\n 254| \\\"node_modules/debug/src/common.js\\\"(exports2, module2) {\\n 255| init_process_global();\\n 256| function setup(env) {\\n 257| createDebug.debug = createDebug;\\n 258| createDebug.default = createDebug;\\n 259| createDebug.coerce = coerce;\\n 260| createDebug.disable = disable;\\n 261| createDebug.enable = enable;\\n 262| createDebug.enabled = enabled;\\n 263| createDebug.humanize = require_ms();\\n 264| createDebug.destroy = destroy;\\n 265| Object.keys(env).forEach((key) => {\\n 266| createDebug[key] = env[key];\\n 267| });\\n 268| createDebug.names = [];\\n 269| createDebug.skips = [];\\n 270| createDebug.formatters = {};\\n 271| function selectColor(namespace) {\\n 272| let hash = 0;\\n 273| for (let i = 0; i < namespace.length; i++) {\\n 274| hash = (hash << 5) - hash + namespace.charCodeAt(i);\\n 275| hash |= 0;\\n 276| }\\n 277| return createDebug.colors[Math.abs(hash) % createDebug.colors.length];\\n 278| }\\n 279| __name(selectColor, \\\"selectColor\\\");\\n 280| createDebug.selectColor = selectColor;\\n 281| function createDebug(namespace) {\\n 282| let prevTime;\\n 283| let enableOverride = null;\\n 284| let namespacesCache;\\n 285| let enabledCache;\\n 286| function debug2(...args) {\\n 287| if (!debug2.enabled) {\\n 288| return;\\n 289| }\\n 290| const self2 = debug2;\\n 291| const curr = Number(/* @__PURE__ */ new Date());\\n 292| const ms = curr - (prevTime || curr);\\n 293| self2.diff = ms;\\n 294| self2.prev = prevTime;\\n 295| self2.curr = curr;\\n 296| prevTime = curr;\\n 297| args[0] = createDebug.coerce(args[0]);\\n 298| if (typeof args[0] !== \\\"string\\\") {\\n 299| args.unshift(\\\"%O\\\");\\n 300| }\\n 301| let index = 0;\\n 302| args[0] = args[0].replace(/%([a-zA-Z%])/g, (match, format) => {\\n 303| if (match === \\\"%%\\\") {\\n 304| return \\\"%\\\";\\n 305| }\\n 306| index++;\\n 307| const formatter = createDebug.formatters[format];\\n 308| if (typeof formatter === \\\"function\\\") {\\n 309| const val = args[index];\\n 310| match = formatter.call(self2, val);\\n 311| args.splice(index, 1);\\n 312| index--;\\n 313| }\\n 314| return match;\\n 315| });\\n 316| createDebug.formatArgs.call(self2, args);\\n 317| const logFn = self2.log || createDebug.log;\\n 318| logFn.apply(self2, args);\\n 319| }\\n 320| __name(debug2, \\\"debug\\\");\\n 321| debug2.namespace = namespace;\\n 322| debug2.useColors = createDebug.useColors();\\n 323| debug2.color = createDebug.selectColor(namespace);\\n 324| debug2.extend = extend;\\n 325| debug2.destroy = createDebug.destroy;\\n 326| Object.defineProperty(debug2, \\\"enabled\\\", {\\n 327| enumerable: true,\\n 328| configurable: false,\\n 329| get: /* @__PURE__ */ __name(() => {\\n 330| if (enableOverride !== null) {\\n 331| return enableOverride;\\n 332| }\\n 333| if (namespacesCache !== createDebug.namespaces) {\\n 334| namespacesCache = createDebug.namespaces;\\n 335| enabledCache = createDebug.enabled(namespace);\\n 336| }\\n 337| return enabledCache;\\n 338| }, \\\"get\\\"),\\n 339| set: /* @__PURE__ */ __name((v) => {\\n 340| enableOverride = v;\\n 341| }, \\\"set\\\")\\n 342| });\\n 343| if (typeof createDebug.init === \\\"function\\\") {\\n 344| createDebug.init(debug2);\\n 345| }\\n 346| return debug2;\\n 347| }\\n 348| __name(createDebug, \\\"createDebug\\\");\\n 349| function extend(namespace, delimiter) {\\n 350| const newDebug = createDebug(this.namespace + (typeof delimiter === \\\"undefined\\\" ? \\\":\\\" : delimiter) + namespace);\\n 351| newDebug.log = this.log;\\n 352| return newDebug;\\n 353| }\\n 354| __name(extend, \\\"extend\\\");\\n 355| function enable(namespaces) {\\n 356| createDebug.save(namespaces);\\n 357| createDebug.namespaces = namespaces;\\n 358| createDebug.names = [];\\n 359| createDebug.skips = [];\\n 360| let i;\\n 361| const split = (typeof namespaces === \\\"string\\\" ? namespaces : \\\"\\\").split(/[\\\\s,]+/);\\n 362| const len = split.length;\\n 363| for (i = 0; i < len; i++) {\\n 364| if (!split[i]) {\\n 365| continue;\\n 366| }\\n 367| namespaces = split[i].replace(/\\\\*/g, \\\".*?\\\");\\n 368| if (namespaces[0] === \\\"-\\\") {\\n 369| createDebug.skips.push(new RegExp(\\\"^\\\" + namespaces.slice(1) + \\\"$\\\"));\\n 370| } else {\\n 371| createDebug.names.push(new RegExp(\\\"^\\\" + namespaces + \\\"$\\\"));\\n 372| }\\n 373| }\\n 374| }\\n 375| __name(enable, \\\"enable\\\");\\n 376| function disable() {\\n 377| const namespaces = [\\n 378| ...createDebug.names.map(toNamespace),\\n 379| ...createDebug.skips.map(toNamespace).map((namespace) => \\\"-\\\" + namespace)\\n 380| ].join(\\\",\\\");\\n 381| createDebug.enable(\\\"\\\");\\n 382| return namespaces;\\n 383| }\\n 384| __name(disable, \\\"disable\\\");\\n 385| function enabled(name) {\\n 386| if (name[name.length - 1] === \\\"*\\\") {\\n 387| return true;\\n 388| }\\n 389| let i;\\n 390| let len;\\n 391| for (i = 0, len = createDebug.skips.length; i < len; i++) {\\n 392| if (createDebug.skips[i].test(name)) {\\n 393| return false;\\n 394| }\\n 395| }\\n 396| for (i = 0, len = createDebug.names.length; i < len; i++) {\\n 397| if (createDebug.names[i].test(name)) {\\n 398| return true;\\n 399| }\\n 400| }\\n 401| return false;\\n 402| }\\n 403| __name(enabled, \\\"enabled\\\");\\n 404| function toNamespace(regexp) {\\n 405| return regexp.toString().substring(2, regexp.toString().length - 2).replace(/\\\\.\\\\*\\\\?$/, \\\"*\\\");\\n 406| }\\n 407| __name(toNamespace, \\\"toNamespace\\\");\\n 408| function coerce(val) {\\n 409| if (val instanceof Error) {\\n 410| return val.stack || val.message;\\n 411| }\\n 412| return val;\\n 413| }\\n 414| __name(coerce, \\\"coerce\\\");\\n 415| function destroy() {\\n 416| console.warn(\\\"Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.\\\");\\n 417| }\\n 418| __name(destroy, \\\"destroy\\\");\\n 419| createDebug.enable(createDebug.load());\\n 420| return createDebug;\\n 421| }\\n 422| __name(setup, \\\"setup\\\");\\n 423| module2.exports = setup;\\n 424| }\\n 425| });\\n 426| \\n 427| // node_modules/debug/src/browser.js\\n 428| var require_browser = __commonJS({\\n 429| \\\"node_modules/debug/src/browser.js\\\"(exports2, module2) {\\n 430| init_process_global();\\n 431| exports2.formatArgs = formatArgs;\\n 432| exports2.save = save;\\n 433| exports2.load = load;\\n 434| exports2.useColors = useColors;\\n 435| exports2.storage = localstorage();\\n 436| exports2.destroy = /* @__PURE__ */ (() => {\\n 437| let warned = false;\\n 438| return () => {\\n 439| if (!warned) {\\n 440| warned = true;\\n 441| console.warn(\\\"Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.\\\");\\n 442| }\\n 443| };\\n 444| })();\\n 445| exports2.colors = [\\n 446| \\\"#0000CC\\\",\\n 447| \\\"#0000FF\\\",\\n 448| \\\"#0033CC\\\",\\n 449| \\\"#0033FF\\\",\\n 450| \\\"#0066CC\\\",\\n 451| \\\"#0066FF\\\",\\n 452| \\\"#0099CC\\\",\\n 453| \\\"#0099FF\\\",\\n 454| \\\"#00CC00\\\",\\n 455| \\\"#00CC33\\\",\\n 456| \\\"#00CC66\\\",\\n 457| \\\"#00CC99\\\",\\n 458| \\\"#00CCCC\\\",\\n 459| \\\"#00CCFF\\\",\\n 460| \\\"#3300CC\\\",\\n 461| \\\"#3300FF\\\",\\n 462| \\\"#3333CC\\\",\\n 463| \\\"#3333FF\\\",\\n 464| \\\"#3366CC\\\",\\n 465| \\\"#3366FF\\\",\\n 466| \\\"#3399CC\\\",\\n 467| \\\"#3399FF\\\",\\n 468| \\\"#33CC00\\\",\\n 469| \\\"#33CC33\\\",\\n 470| \\\"#33CC66\\\",\\n 471| \\\"#33CC99\\\",\\n 472| \\\"#33CCCC\\\",\\n 473| \\\"#33CCFF\\\",\\n 474| \\\"#6600CC\\\",\\n 475| \\\"#6600FF\\\",\\n 476| \\\"#6633CC\\\",\\n 477| \\\"#6633FF\\\",\\n 478| \\\"#66CC00\\\",\\n 479| \\\"#66CC33\\\",\\n 480| \\\"#9900CC\\\",\\n 481| \\\"#9900FF\\\",\\n 482| \\\"#9933CC\\\",\\n 483| \\\"#9933FF\\\",\\n 484| \\\"#99CC00\\\",\\n 485| \\\"#99CC33\\\",\\n 486| \\\"#CC0000\\\",\\n 487| \\\"#CC0033\\\",\\n 488| \\\"#CC0066\\\",\\n 489| \\\"#CC0099\\\",\\n 490| \\\"#CC00CC\\\",\\n 491| \\\"#CC00FF\\\",\\n 492| \\\"#CC3300\\\",\\n 493| \\\"#CC3333\\\",\\n 494| \\\"#CC3366\\\",\\n 495| \\\"#CC3399\\\",\\n 496| \\\"#CC33CC\\\",\\n 497| \\\"#CC33FF\\\",\\n 498| \\\"#CC6600\\\",\\n 499| \\\"#CC6633\\\",\\n 500| \\\"#CC9900\\\",\\n 501| \\\"#CC9933\\\",\\n 502| \\\"#CCCC00\\\",\\n 503| \\\"#CCCC33\\\",\\n 504| \\\"#FF0000\\\",\\n 505| \\\"#FF0033\\\",\\n 506| \\\"#FF0066\\\",\\n 507| \\\"#FF0099\\\",\\n 508| \\\"#FF00CC\\\",\\n 509| \\\"#FF00FF\\\",\\n 510| \\\"#FF3300\\\",\\n 511| \\\"#FF3333\\\",\\n 512| \\\"#FF3366\\\",\\n 513| \\\"#FF3399\\\",\\n 514| \\\"#FF33CC\\\",\\n 515| \\\"#FF33FF\\\",\\n 516| \\\"#FF6600\\\",\\n 517| \\\"#FF6633\\\",\\n 518| \\\"#FF9900\\\",\\n 519| \\\"#FF9933\\\",\\n 520| \\\"#FFCC00\\\",\\n 521| \\\"#FFCC33\\\"\\n 522| ];\\n 523| function useColors() {\\n 524| if (typeof window !== \\\"undefined\\\" && window.process && (window.process.type === \\\"renderer\\\" || window.process.__nwjs)) {\\n 525| return true;\\n 526| }\\n 527| if (typeof navigator !== \\\"undefined\\\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\\\\/(\\\\d+)/)) {\\n 528| return false;\\n 529| }\\n 530| return typeof document !== \\\"undefined\\\" && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance || // Is firebug? http://stackoverflow.com/a/398120/376773\\n 531| typeof window !== \\\"undefined\\\" && window.console && (window.console.firebug || window.console.exception && window.console.table) || // Is firefox >= v31?\\n 532| // https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages\\n 533| typeof navigator !== \\\"undefined\\\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\\\\/(\\\\d+)/) && parseInt(RegExp.$1, 10) >= 31 || // Double check webkit in userAgent just in case we are in a worker\\n 534| typeof navigator !== \\\"undefined\\\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\\\\/(\\\\d+)/);\\n 535| }\\n 536| __name(useColors, \\\"useColors\\\");\\n 537| function formatArgs(args) {\\n 538| args[0] = (this.useColors ? \\\"%c\\\" : \\\"\\\") + this.namespace + (this.useColors ? \\\" %c\\\" : \\\" \\\") + args[0] + (this.useColors ? \\\"%c \\\" : \\\" \\\") + \\\"+\\\" + module2.exports.humanize(this.diff);\\n 539| if (!this.useColors) {\\n 540| return;\\n 541| }\\n 542| const c = \\\"color: \\\" + this.color;\\n 543| args.splice(1, 0, c, \\\"color: inherit\\\");\\n 544| let index = 0;\\n 545| let lastC = 0;\\n 546| args[0].replace(/%[a-zA-Z%]/g, (match) => {\\n 547| if (match === \\\"%%\\\") {\\n 548| return;\\n 549| }\\n 550| index++;\\n 551| if (match === \\\"%c\\\") {\\n 552| lastC = index;\\n 553| }\\n 554| });\\n 555| args.splice(lastC, 0, c);\\n 556| }\\n 557| __name(formatArgs, \\\"formatArgs\\\");\\n 558| exports2.log = console.debug || console.log || (() => {\\n 559| });\\n 560| function save(namespaces) {\\n 561| try {\\n 562| if (namespaces) {\\n 563| exports2.storage.setItem(\\\"debug\\\", namespaces);\\n 564| } else {\\n 565| exports2.storage.removeItem(\\\"debug\\\");\\n 566| }\\n 567| } catch (error) {\\n 568| }\\n 569| }\\n 570| __name(save, \\\"save\\\");\\n 571| function load() {\\n 572| let r;\\n 573| try {\\n 574| r = exports2.storage.getItem(\\\"debug\\\");\\n 575| } catch (error) {\\n 576| }\\n 577| if (!r && typeof process !== \\\"undefined\\\" && \\\"env\\\" in process) {\\n 578| r = process.env.DEBUG;\\n 579| }\\n 580| return r;\\n 581| }\\n 582| __name(load, \\\"load\\\");\\n 583| function localstorage() {\\n 584| try {\\n 585| return localStorage;\\n 586| } catch (error) {\\n 587| }\\n 588| }\\n 589| __name(localstorage, \\\"localstorage\\\");\\n 590| module2.exports = require_common()(exports2);\\n 591| var { formatters } = module2.exports;\\n 592| formatters.j = function(v) {\\n 593| try {\\n 594| return JSON.stringify(v);\\n 595| } catch (error) {\\n 596| return \\\"[UnexpectedJSONParseError]: \\\" + error.message;\\n 597| }\\n 598| };\\n 599| }\\n 600| });\\n 601| \\n 602| // node_modules/marky/lib/marky.cjs.js\\n 603| var require_marky_cjs = __commonJS({\\n 604| \\\"node_modules/marky/lib/marky.cjs.js\\\"(exports2) {\\n 605| \\\"use strict\\\";\\n 606| init_process_global();\\n 607| Object.defineProperty(exports2, \\\"__esModule\\\", { value: true });\\n 608| var perf = typeof performance !== \\\"undefined\\\" && performance;\\n 609| var nowForNode;\\n 610| {\\n 611| hrtime = process.hrtime;\\n 612| getNanoSeconds = /* @__PURE__ */ __name(function() {\\n 613| var hr = hrtime();\\n 614| return hr[0] * 1e9 + hr[1];\\n 615| }, \\\"getNanoSeconds\\\");\\n 616| loadTime = getNanoSeconds();\\n 617| nowForNode = /* @__PURE__ */ __name(function() {\\n 618| return (getNanoSeconds() - loadTime) / 1e6;\\n 619| }, \\\"nowForNode\\\");\\n 620| }\\n 621| var hrtime;\\n 622| var getNanoSeconds;\\n 623| var loadTime;\\n 624| var now = nowForNode;\\n 625| function throwIfEmpty(name) {\\n 626| if (!name) {\\n 627| throw new Error(\\\"name must be non-empty\\\");\\n 628| }\\n 629| }\\n 630| __name(throwIfEmpty, \\\"throwIfEmpty\\\");\\n 631| function insertSorted(arr, item) {\\n 632| var low = 0;\\n 633| var high = arr.length;\\n 634| var mid;\\n 635| while (low < high) {\\n 636| mid = low + high >>> 1;\\n 637| if (arr[mid].startTime < item.startTime) {\\n 638| low = mid + 1;\\n 639| } else {\\n 640| high = mid;\\n 641| }\\n 642| }\\n 643| arr.splice(low, 0, item);\\n 644| }\\n 645| __name(insertSorted, \\\"insertSorted\\\");\\n 646| exports2.mark = void 0;\\n 647| exports2.stop = void 0;\\n 648| exports2.getEntries = void 0;\\n 649| exports2.clear = void 0;\\n 650| if (perf && perf.mark && perf.getEntriesByName && perf.getEntriesByType && perf.clearMeasures) {\\n 651| exports2.mark = function(name) {\\n 652| throwIfEmpty(name);\\n 653| perf.mark(\\\"start \\\" + name);\\n 654| };\\n 655| exports2.stop = function(name) {\\n 656| throwIfEmpty(name);\\n 657| perf.mark(\\\"end \\\" + name);\\n 658| perf.measure(name, \\\"start \\\" + name, \\\"end \\\" + name);\\n 659| var entries2 = perf.getEntriesByName(name);\\n 660| return entries2[entries2.length - 1];\\n 661| };\\n 662| exports2.getEntries = function() {\\n 663| return perf.getEntriesByType(\\\"measure\\\");\\n 664| };\\n 665| exports2.clear = function() {\\n 666| perf.clearMarks();\\n 667| perf.clearMeasures();\\n 668| };\\n 669| } else {\\n 670| marks = {};\\n 671| entries = [];\\n 672| exports2.mark = function(name) {\\n 673| throwIfEmpty(name);\\n 674| var startTime = now();\\n 675| marks[\\\"$\\\" + name] = startTime;\\n 676| };\\n 677| exports2.stop = function(name) {\\n 678| throwIfEmpty(name);\\n 679| var endTime = now();\\n 680| var startTime = marks[\\\"$\\\" + name];\\n 681| if (!startTime) {\\n 682| throw new Error(\\\"no known mark: \\\" + name);\\n 683| }\\n 684| var entry = {\\n 685| startTime,\\n 686| name,\\n 687| duration: endTime - startTime,\\n 688| entryType: \\\"measure\\\"\\n 689| };\\n 690| insertSorted(entries, entry);\\n 691| return entry;\\n 692| };\\n 693| exports2.getEntries = function() {\\n 694| return entries;\\n 695| };\\n 696| exports2.clear = function() {\\n 697| marks = {};\\n 698| entries = [];\\n 699| };\\n 700| }\\n 701| var marks;\\n 702| var entries;\\n 703| }\\n 704| });\\n 705| \\n 706| // lighthouse-logger/index.js\\n 707| import process3 from \\\"process\\\";\\n 708| import { EventEmitter } from \\\"events\\\";\\n 709| var import_debug, marky, isWindows, isBrowser, colors, Emitter, loggersByTitle, loggingBufferColumns, level_, Log, lighthouse_logger_default;\\n 710| var init_lighthouse_logger = __esm({\\n 711| \\\"lighthouse-logger/index.js\\\"() {\\n 712| \\\"use strict\\\";\\n 713| init_process_global();\\n 714| import_debug = __toESM(require_browser(), 1);\\n 715| marky = __toESM(require_marky_cjs(), 1);\\n 716| /**\\n 717| * @license\\n 718| * Copyright 2016 Google LLC\\n 719| * SPDX-License-Identifier: Apache-2.0\\n 720| */\\n 721| isWindows = process3.platform === \\\"win32\\\";\\n 722| isBrowser = process3.browser;\\n 723| colors = {\\n 724| red: isBrowser ? \\\"crimson\\\" : 1,\\n 725| yellow: isBrowser ? \\\"gold\\\" : 3,\\n 726| cyan: isBrowser ? \\\"darkturquoise\\\" : 6,\\n 727| green: isBrowser ? \\\"forestgreen\\\" : 2,\\n 728| blue: isBrowser ? \\\"steelblue\\\" : 4,\\n 729| magenta: isBrowser ? \\\"palevioletred\\\" : 5\\n 730| };\\n 731| import_debug.default.colors = [colors.cyan, colors.green, colors.blue, colors.magenta];\\n 732| Emitter = class extends EventEmitter {\\n 733| static {\\n 734| __name(this, \\\"Emitter\\\");\\n 735| }\\n 736| // yarn build-types fails without this!\\n 737| // https://github.com/microsoft/TypeScript/issues/41672#issuecomment-2303803072\\n 738| constructor(options) {\\n 739| super(options);\\n 740| }\\n 741| /**\\n 742| * Fires off all status updates. Listen with\\n 743| * `require('lib/log').events.addListener('status', callback)`\\n 744| * @param {string} title\\n 745| * @param {!Array<*>} argsArray\\n 746| */\\n 747| issueStatus(title, argsArray) {\\n 748| if (title === \\\"status\\\" || title === \\\"statusEnd\\\") {\\n 749| this.emit(title, [title, ...argsArray]);\\n 750| }\\n 751| }\\n 752| /**\\n 753| * Fires off all warnings. Listen with\\n 754| * `require('lib/log').events.addListener('warning', callback)`\\n 755| * @param {string} title\\n 756| * @param {!Array<*>} argsArray\\n 757| */\\n 758| issueWarning(title, argsArray) {\\n 759| this.emit(\\\"warning\\\", [title, ...argsArray]);\\n 760| }\\n 761| };\\n 762| loggersByTitle = {};\\n 763| loggingBufferColumns = 25;\\n 764| Log = class _Log {\\n 765| static {\\n 766| __name(this, \\\"Log\\\");\\n 767| }\\n 768| static _logToStdErr(title, argsArray) {\\n 769| const log = _Log.loggerfn(title);\\n 770| log(...argsArray);\\n 771| }\\n 772| /**\\n 773| * @param {string} title\\n 774| */\\n 775| static loggerfn(title) {\\n 776| title = `LH:${title}`;\\n 777| let log = loggersByTitle[title];\\n 778| if (!log) {\\n 779| log = (0, import_debug.default)(title);\\n 780| loggersByTitle[title] = log;\\n 781| if (title.endsWith(\\\"error\\\")) {\\n 782| log.color = colors.red;\\n 783| } else if (title.endsWith(\\\"warn\\\")) {\\n 784| log.color = colors.yellow;\\n 785| }\\n 786| }\\n 787| return log;\\n 788| }\\n 789| /**\\n 790| * @param {string} level\\n 791| */\\n 792| static setLevel(level) {\\n 793| level_ = level;\\n 794| switch (level) {\\n 795| case \\\"silent\\\":\\n 796| import_debug.default.enable(\\\"-LH:*\\\");\\n 797| break;\\n 798| case \\\"verbose\\\":\\n 799| import_debug.default.enable(\\\"LH:*\\\");\\n 800| break;\\n 801| case \\\"warn\\\":\\n 802| import_debug.default.enable(\\\"-LH:*, LH:*:warn, LH:*:error\\\");\\n 803| break;\\n 804| case \\\"error\\\":\\n 805| import_debug.default.enable(\\\"-LH:*, LH:*:error\\\");\\n 806| break;\\n 807| default:\\n 808| import_debug.default.enable(\\\"LH:*, -LH:*:verbose\\\");\\n 809| }\\n 810| }\\n 811| /**\\n 812| * A simple formatting utility for event logging.\\n 813| * @param {string} prefix\\n 814| * @param {!Object} data A JSON-serializable object of event data to log.\\n 815| * @param {string=} level Optional logging level. Defaults to 'log'.\\n 816| */\\n 817| static formatProtocol(prefix, data31, level) {\\n 818| const columns = !process3 || process3.browser ? Infinity : process3.stdout.columns;\\n 819| const method = data31.method || \\\"?????\\\";\\n 820| const maxLength = columns - method.length - prefix.length - loggingBufferColumns;\\n 821| const snippet = data31.params && method !== \\\"IO.read\\\" ? JSON.stringify(data31.params).substr(0, maxLength) : \\\"\\\";\\n 822| _Log._logToStdErr(`${prefix}:${level || \\\"\\\"}`, [method, snippet]);\\n 823| }\\n 824| /**\\n 825| * @return {boolean}\\n 826| */\\n 827| static isVerbose() {\\n 828| return level_ === \\\"verbose\\\";\\n 829| }\\n 830| /**\\n 831| * @param {{msg: string, id: string, args?: any[]}} status\\n 832| * @param {string} level\\n 833| */\\n 834| static time({ msg, id, args = [] }, level = \\\"log\\\") {\\n 835| marky.mark(id);\\n 836| _Log[level](\\\"status\\\", msg, ...args);\\n 837| }\\n 838| /**\\n 839| * @param {{msg: string, id: string, args?: any[]}} status\\n 840| * @param {string} level\\n 841| */\\n 842| static timeEnd({ msg, id, args = [] }, level = \\\"verbose\\\") {\\n 843| _Log[level](\\\"statusEnd\\\", msg, ...args);\\n 844| marky.stop(id);\\n 845| }\\n 846| /**\\n 847| * @param {string} title\\n 848| * @param {...any} args\\n 849| */\\n 850| static log(title, ...args) {\\n 851| _Log.events.issueStatus(title, args);\\n 852| return _Log._logToStdErr(title, args);\\n 853| }\\n 854| /**\\n 855| * @param {string} title\\n 856| * @param {...any} args\\n 857| */\\n 858| static warn(title, ...args) {\\n 859| _Log.events.issueWarning(title, args);\\n 860| return _Log._logToStdErr(`${title}:warn`, args);\\n 861| }\\n 862| /**\\n 863| * @param {string} title\\n 864| * @param {...any} args\\n 865| */\\n 866| static error(title, ...args) {\\n 867| return _Log._logToStdErr(`${title}:error`, args);\\n 868| }\\n 869| /**\\n 870| * @param {string} title\\n 871| * @param {...any} args\\n 872| */\\n 873| static verbose(title, ...args) {\\n 874| _Log.events.issueStatus(title, args);\\n 875| return _Log._logToStdErr(`${title}:verbose`, args);\\n 876| }\\n 877| /**\\n 878| * Add surrounding escape sequences to turn a string green when logged.\\n 879| * @param {string} str\\n 880| * @return {string}\\n 881| */\\n 882| static greenify(str) {\\n 883| return `${_Log.green}${str}${_Log.reset}`;\\n 884| }\\n 885| /**\\n 886| * Add surrounding escape sequences to turn a string red when logged.\\n 887| * @param {string} str\\n 888| * @return {string}\\n 889| */\\n 890| static redify(str) {\\n 891| return `${_Log.red}${str}${_Log.reset}`;\\n 892| }\\n 893| static get green() {\\n 894| return \\\"\\\\x1B[32m\\\";\\n 895| }\\n 896| static get red() {\\n 897| return \\\"\\\\x1B[31m\\\";\\n 898| }\\n 899| static get yellow() {\\n 900| return \\\"\\\\x1B[33m\\\";\\n 901| }\\n 902| static get purple() {\\n 903| return \\\"\\\\x1B[95m\\\";\\n 904| }\\n 905| static get reset() {\\n 906| return \\\"\\\\x1B[0m\\\";\\n 907| }\\n 908| static get bold() {\\n 909| return \\\"\\\\x1B[1m\\\";\\n 910| }\\n 911| static get dim() {\\n 912| return \\\"\\\\x1B[2m\\\";\\n 913| }\\n 914| static get tick() {\\n 915| return isWindows ? \\\"√\\\" : \\\"✓\\\";\\n 916| }\\n 917| static get cross() {\\n 918| return isWindows ? \\\"×\\\" : \\\"✘\\\";\\n 919| }\\n 920| static get whiteSmallSquare() {\\n 921| return isWindows ? \\\"·\\\" : \\\"▫\\\";\\n 922| }\\n 923| static get heavyHorizontal() {\\n 924| return isWindows ? \\\"─\\\" : \\\"━\\\";\\n 925| }\\n 926| static get heavyVertical() {\\n 927| return isWindows ? \\\"│ \\\" : \\\"┃ \\\";\\n 928| }\\n 929| static get heavyUpAndRight() {\\n 930| return isWindows ? \\\"└\\\" : \\\"┗\\\";\\n 931| }\\n 932| static get heavyVerticalAndRight() {\\n 933| return isWindows ? \\\"├\\\" : \\\"┣\\\";\\n 934| }\\n 935| static get heavyDownAndHorizontal() {\\n 936| return isWindows ? \\\"┬\\\" : \\\"┳\\\";\\n 937| }\\n 938| static get doubleLightHorizontal() {\\n 939| return \\\"──\\\";\\n 940| }\\n 941| };\\n 942| Log.events = new Emitter();\\n 943| Log.takeTimeEntries = () => {\\n 944| const entries = marky.getEntries();\\n 945| marky.clear();\\n 946| return entries;\\n 947| };\\n 948| Log.getTimeEntries = () => marky.getEntries();\\n 949| lighthouse_logger_default = Log;\\n 950| }\\n 951| });\\n 952| \\n 953| // core/lib/tracehouse/trace-processor.js\\n 954| var ACCEPTABLE_NAVIGATION_URL_REGEX, BASE_RESPONSE_LATENCY, SCHEDULABLE_TASK_TITLE_LH, SCHEDULABLE_TASK_TITLE_ALT1, SCHEDULABLE_TASK_TITLE_ALT2, SCHEDULABLE_TASK_TITLE_ALT3, TraceProcessor;\\n 955| var init_trace_processor = __esm({\\n 956| \\\"core/lib/tracehouse/trace-processor.js\\\"() {\\n 957| \\\"use strict\\\";\\n 958| init_process_global();\\n 959| init_lighthouse_logger();\\n 960| /**\\n 961| * @license\\n 962| * Copyright 2017 Google LLC\\n 963| * SPDX-License-Identifier: Apache-2.0\\n 964| */\\n 965| ACCEPTABLE_NAVIGATION_URL_REGEX = /^(chrome|https?):/;\\n 966| BASE_RESPONSE_LATENCY = 16;\\n 967| SCHEDULABLE_TASK_TITLE_LH = \\\"RunTask\\\";\\n 968| SCHEDULABLE_TASK_TITLE_ALT1 = \\\"ThreadControllerImpl::RunTask\\\";\\n 969| SCHEDULABLE_TASK_TITLE_ALT2 = \\\"ThreadControllerImpl::DoWork\\\";\\n 970| SCHEDULABLE_TASK_TITLE_ALT3 = \\\"TaskQueueManager::ProcessTaskFromWorkQueue\\\";\\n 971| TraceProcessor = class _TraceProcessor {\\n 972| static {\\n 973| __name(this, \\\"TraceProcessor\\\");\\n 974| }\\n 975| static get TIMESPAN_MARKER_ID() {\\n 976| return \\\"__lighthouseTimespanStart__\\\";\\n 977| }\\n 978| /**\\n 979| * @return {Error}\\n 980| */\\n 981| static createNoNavstartError() {\\n 982| return new Error(\\\"No navigationStart event found\\\");\\n 983| }\\n 984| /**\\n 985| * @return {Error}\\n 986| */\\n 987| static createNoResourceSendRequestError() {\\n 988| return new Error(\\\"No ResourceSendRequest event found\\\");\\n 989| }\\n 990| /**\\n 991| * @return {Error}\\n 992| */\\n 993| static createNoTracingStartedError() {\\n 994| return new Error(\\\"No tracingStartedInBrowser event found\\\");\\n 995| }\\n 996| /**\\n 997| * @return {Error}\\n 998| */\\n 999| static createNoFirstContentfulPaintError() {\\n1000| return new Error(\\\"No FirstContentfulPaint event found\\\");\\n1001| }\\n1002| /**\\n1003| * @return {Error}\\n1004| */\\n1005| static createNoLighthouseMarkerError() {\\n1006| return new Error(\\\"No Lighthouse timespan marker event found\\\");\\n1007| }\\n1008| /**\\n1009| * Returns true if the event is a navigation start event of a document whose URL seems valid.\\n1010| *\\n1011| * @param {LH.TraceEvent} event\\n1012| * @return {boolean}\\n1013| */\\n1014| static _isNavigationStartOfInterest(event) {\\n1015| if (event.name !== \\\"navigationStart\\\") return false;\\n1016| if (event.args.data?.documentLoaderURL === void 0) return true;\\n1017| if (!event.args.data?.documentLoaderURL) return false;\\n1018| return ACCEPTABLE_NAVIGATION_URL_REGEX.test(event.args.data.documentLoaderURL);\\n1019| }\\n1020| /**\\n1021| * This method sorts a group of trace events that have the same timestamp. We want to...\\n1022| *\\n1023| * 1. Put E events first, we finish off our existing events before we start new ones.\\n1024| * 2. Order B/X events by their duration, we want parents to start before child events.\\n1025| * 3. If we don't have any of this to go on, just use the position in the original array (stable sort).\\n1026| *\\n1027| * Note that the typical group size with the same timestamp will be quite small (<10 or so events),\\n1028| * and the number of groups typically ~1% of total trace, so the same ultra-performance-sensitive consideration\\n1029| * given to functions that run on entire traces does not necessarily apply here.\\n1030| *\\n1031| * @param {number[]} tsGroupIndices\\n1032| * @param {number[]} timestampSortedIndices\\n1033| * @param {number} indexOfTsGroupIndicesStart\\n1034| * @param {LH.TraceEvent[]} traceEvents\\n1035| * @return {number[]}\\n1036| */\\n1037| static _sortTimestampEventGroup(tsGroupIndices, timestampSortedIndices, indexOfTsGroupIndicesStart, traceEvents) {\\n1038| const lookupArrayIndexByTsIndex = /* @__PURE__ */ __name((i) => timestampSortedIndices[i], \\\"lookupArrayIndexByTsIndex\\\");\\n1039| const lookupEventByTsIndex = /* @__PURE__ */ __name((i) => traceEvents[lookupArrayIndexByTsIndex(i)], \\\"lookupEventByTsIndex\\\");\\n1040| const eEventIndices = [];\\n1041| const bxEventIndices = [];\\n1042| const otherEventIndices = [];\\n1043| for (const tsIndex of tsGroupIndices) {\\n1044| const arrayIndex = lookupArrayIndexByTsIndex(tsIndex);\\n1045| const event = lookupEventByTsIndex(tsIndex);\\n1046| if (event.ph === \\\"E\\\") eEventIndices.push(arrayIndex);\\n1047| else if (event.ph === \\\"X\\\" || event.ph === \\\"B\\\") bxEventIndices.push(arrayIndex);\\n1048| else otherEventIndices.push(arrayIndex);\\n1049| }\\n1050| const effectiveDuration = /* @__PURE__ */ new Map();\\n1051| for (const index of bxEventIndices) {\\n1052| const event = traceEvents[index];\\n1053| if (event.ph === \\\"X\\\") {\\n1054| effectiveDuration.set(index, event.dur);\\n1055| } else {\\n1056| let duration = Number.MAX_SAFE_INTEGER;\\n1057| let additionalNestedEventsWithSameName = 0;\\n1058| const startIndex = indexOfTsGroupIndicesStart + tsGroupIndices.length;\\n1059| for (let j = startIndex; j < timestampSortedIndices.length; j++) {\\n1060| const potentialMatchingEvent = lookupEventByTsIndex(j);\\n1061| const eventMatches = potentialMatchingEvent.name === event.name && potentialMatchingEvent.pid === event.pid && potentialMatchingEvent.tid === event.tid;\\n1062| if (!eventMatches) continue;\\n1063| if (potentialMatchingEvent.ph === \\\"E\\\" && additionalNestedEventsWithSameName === 0) {\\n1064| duration = potentialMatchingEvent.ts - event.ts;\\n1065| break;\\n1066| } else if (potentialMatchingEvent.ph === \\\"E\\\") {\\n1067| additionalNestedEventsWithSameName--;\\n1068| } else if (potentialMatchingEvent.ph === \\\"B\\\") {\\n1069| additionalNestedEventsWithSameName++;\\n1070| }\\n1071| }\\n1072| effectiveDuration.set(index, duration);\\n1073| }\\n1074| }\\n1075| bxEventIndices.sort((indexA, indexB) => (effectiveDuration.get(indexB) || 0) - (effectiveDuration.get(indexA) || 0) || indexA - indexB);\\n1076| otherEventIndices.sort((indexA, indexB) => indexA - indexB);\\n1077| return [...eEventIndices, ...bxEventIndices, ...otherEventIndices];\\n1078| }\\n1079| /**\\n1080| * Sorts and filters trace events by timestamp and respecting the nesting structure inherent to\\n1081| * parent/child event relationships.\\n1082| *\\n1083| * @param {LH.TraceEvent[]} traceEvents\\n1084| * @param {(e: LH.TraceEvent) => boolean} filter\\n1085| */\\n1086| static filteredTraceSort(traceEvents, filter) {\\n1087| const indices = [];\\n1088| for (let srcIndex = 0; srcIndex < traceEvents.length; srcIndex++) {\\n1089| if (filter(traceEvents[srcIndex])) {\\n1090| indices.push(srcIndex);\\n1091| }\\n1092| }\\n1093| indices.sort((indexA, indexB) => traceEvents[indexA].ts - traceEvents[indexB].ts);\\n1094| for (let i = 0; i < indices.length - 1; i++) {\\n1095| const ts = traceEvents[indices[i]].ts;\\n1096| const tsGroupIndices = [i];\\n1097| for (let j = i + 1; j < indices.length; j++) {\\n1098| if (traceEvents[indices[j]].ts !== ts) break;\\n1099| tsGroupIndices.push(j);\\n1100| }\\n```\\n\\n### FILE: src/tools/categories.ts (33 lines)\\n\\n```\\n 1| /**\\n 2| * @license\\n 3| * Copyright 2025 Google LLC\\n 4| * SPDX-License-Identifier: Apache-2.0\\n 5| */\\n 6| \\n 7| export enum ToolCategory {\\n 8| INPUT = 'input',\\n 9| NAVIGATION = 'navigation',\\n 10| EMULATION = 'emulation',\\n 11| PERFORMANCE = 'performance',\\n 12| NETWORK = 'network',\\n 13| DEBUGGING = 'debugging',\\n 14| EXTENSIONS = 'extensions',\\n 15| THIRD_PARTY = 'experimentalThirdParty',\\n 16| MEMORY = 'memory',\\n 17| WEBMCP = 'experimentalWebmcp',\\n 18| PWA = 'pwa',\\n 19| }\\n 20| \\n 21| export const labels = {\\n 22| [ToolCategory.INPUT]: 'Input automation',\\n 23| [ToolCategory.NAVIGATION]: 'Navigation automation',\\n 24| [ToolCategory.EMULATION]: 'Emulation',\\n 25| [ToolCategory.PERFORMANCE]: 'Performance',\\n 26| [ToolCategory.NETWORK]: 'Network',\\n 27| [ToolCategory.DEBUGGING]: 'Debugging',\\n 28| [ToolCategory.EXTENSIONS]: 'Extensions',\\n 29| [ToolCategory.THIRD_PARTY]: 'Third-party',\\n 30| [ToolCategory.MEMORY]: 'Memory',\\n 31| [ToolCategory.WEBMCP]: 'WebMCP',\\n 32| [ToolCategory.PWA]: 'Progressive Web Apps',\\n 33| };\\n```\\n<END_OF_CONTEXT>\\n\\n<query>\\nGenerate a wiki page tracing the primary data or control flow through this system from entry to exit. Include a Mermaid sequenceDiagram showing the interactions between components.\\n</query>\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"# Lighthouse DevTools MCP System Architecture\\n\\n## Overview\\n\\nThis document traces the primary data and control flow through the Lighthouse DevTools MCP (Multi-Client Protocol) system. The system is built around the Lighthouse auditing framework, extended with DevTools-specific integrations for Chrome DevTools Protocol interaction. The core components include trace processing, gatherer infrastructure, logging, and category definitions for tool organization.\\n\\nThe system's entry point is through the `lighthouse-devtools-mcp-bundle.js` which contains the main Lighthouse engine, while `categories.ts` provides categorization for tools within the DevTools interface.\\n\\n## Detailed Analysis\\n\\nThe primary execution flow begins with the `BaseGatherer` class (`src/third_party/lighthouse-devtools-mcp-bundle.js:71-129`) which defines the interface for collecting data from a web page. This base class is extended by specific gatherers that implement methods for instrumenting and collecting artifacts during page interactions.\\n\\n```typescript\\n// BaseGatherer class defines the interface for all gatherers\\nclass BaseGatherer {\\n meta = { supportedModes: [] };\\n startInstrumentation(passContext) {}\\n startSensitiveInstrumentation(passContext) {}\\n stopSensitiveInstrumentation(passContext) {}\\n stopInstrumentation(passContext) {}\\n getArtifact(passContext) {}\\n}\\n```\\n\\nThe trace processing component (`src/third_party/lighthouse-devtools-mcp-bundle.js:953-1100`) handles the processing of Chrome trace events. It sorts and filters trace events using `filteredTraceSort` (`src/third_party/lighthouse-devtools-mcp-bundle.js:1086-1100`) which ensures proper chronological ordering while respecting event nesting relationships. The trace processor also provides error creation methods for missing critical events like navigationStart or FirstContentfulPaint.\\n\\n```typescript\\n// Trace processing uses filteredTraceSort to organize events\\nstatic filteredTraceSort(traceEvents, filter) {\\n const indices = [];\\n for (let srcIndex = 0; srcIndex < traceEvents.length; srcIndex++) {\\n if (filter(traceEvents[srcIndex])) {\\n indices.push(srcIndex);\\n }\\n }\\n indices.sort((indexA, indexB) => traceEvents[indexA].ts - traceEvents[indexB].ts);\\n // ... further processing\\n}\\n```\\n\\nThe logging system (`src/third_party/lighthouse-devtools-mcp-bundle.js:706-951`) provides structured logging capabilities using the debug library and marky performance measurement tools. This system supports different log levels and can format protocol messages for debugging.\\n\\n```typescript\\n// Logger provides structured logging with different levels\\nstatic log(title, ...args) {\\n _Log.events.issueStatus(title, args);\\n return _Log._logToStdErr(title, args);\\n}\\nstatic warn(title, ...args) {\\n _Log.events.issueWarning(title, args);\\n return _Log._logToStdErr(`${title}:warn`, args);\\n}\\nstatic error(title, ...args) {\\n return _Log._logToStdErr(`${title}:error`, args);\\n}\\n```\\n\\nThe categories defined in `src/tools/categories.ts` (`lines 7-19`) organize tools into functional groups for the DevTools UI. These categories map to specific tool functionalities like input automation, performance analysis, and debugging.\\n\\n## Mermaid Sequence Diagram\\n\\n```mermaid\\nsequenceDiagram\\n participant User\\n participant DevTools\\n participant LighthouseEngine\\n participant TraceProcessor\\n participant BaseGatherer\\n participant Logger\\n\\n User->>DevTools: Initiate audit\\n DevTools->>LighthouseEngine: Start trace collection\\n LighthouseEngine->>TraceProcessor: Process trace events\\n TraceProcessor->>TraceProcessor: Sort and filter events\\n TraceProcessor->>LighthouseEngine: Return processed events\\n LighthouseEngine->>BaseGatherer: Execute gatherer lifecycle\\n BaseGatherer->>BaseGatherer: Start instrumentation\\n BaseGatherer->>BaseGatherer: Collect artifacts\\n BaseGatherer->>BaseGatherer: Stop instrumentation\\n BaseGatherer->>LighthouseEngine: Return gathered data\\n LighthouseEngine->>Logger: Log status and warnings\\n Logger->>DevTools: Output logs\\n DevTools->>User: Present audit results\\n```\\n\\n## Conclusion\\n\\nThe Lighthouse DevTools MCP system follows a structured flow where trace events are first processed and sorted, then gathered through specialized gatherers that implement the `BaseGatherer` interface. The logging system provides visibility into the process, while the categorization system in `categories.ts` helps organize the various tools within the DevTools interface. The design emphasizes modularity through the `BaseGatherer` pattern, allowing new data collection methods to be added without modifying core logic.\"\n }\n]","isConversational":true},"source":{"kind":"string","value":"ChromeDevTools/chrome-devtools-mcp"},"category":{"kind":"string","value":"data_flow"},"quality_score":{"kind":"number","value":100,"string":"100"},"citation_stats":{"kind":"string","value":"{\n \"total_citations\": 4,\n \"validity_rate\": 1,\n \"invalid\": []\n}"},"license":{"kind":"string","value":"Apache-2.0"},"language":{"kind":"string","value":"typescript"}}},{"rowIdx":95,"cells":{"messages":{"kind":"list like","value":[{"role":"system","content":["You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\n4. Explain the WHY behind design decisions, not only the WHAT.\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\n7. Example of the correct citation style, inline and attached to a path:\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon."]},{"role":"user","content":"<START_OF_CONTEXT>\n# Repository: ChromeDevTools/chrome-devtools-mcp (language: typescript)\n\n# Selected files (windows)\n- src/third_party/lighthouse-devtools-mcp-bundle.js (lines 1-1100 of 58496)\n- src/tools/categories.ts (33 lines)\n\n\n### FILE: src/third_party/lighthouse-devtools-mcp-bundle.js (lines 1-1100 of 58496)\n\n```\n 1| /**\n 2| * Lighthouse v13.4.1 (Jul 23 2026)\n 3| *\n 4| * Automated auditing, performance metrics, and best practices for the web.\n 5| *\n 6| * @homepage https://github.com/GoogleChrome/lighthouse#readme\n 7| * @author Copyright 2026 Google LLC\n 8| * @license Apache-2.0\n 9| *\n 10| * Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0\n 11| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n 12| */\n 13| var __create = Object.create;\n 14| var __defProp = Object.defineProperty;\n 15| var __getOwnPropDesc = Object.getOwnPropertyDescriptor;\n 16| var __getOwnPropNames = Object.getOwnPropertyNames;\n 17| var __getProtoOf = Object.getPrototypeOf;\n 18| var __hasOwnProp = Object.prototype.hasOwnProperty;\n 19| var __name = (target, value) => __defProp(target, \"name\", { value, configurable: true });\n 20| var __esm = (fn, res) => function __init() {\n 21| return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;\n 22| };\n 23| var __commonJS = (cb, mod2) => function __require() {\n 24| return mod2 || (0, cb[__getOwnPropNames(cb)[0]])((mod2 = { exports: {} }).exports, mod2), mod2.exports;\n 25| };\n 26| var __export = (target, all) => {\n 27| for (var name in all)\n 28| __defProp(target, name, { get: all[name], enumerable: true });\n 29| };\n 30| var __copyProps = (to, from, except, desc) => {\n 31| if (from && typeof from === \"object\" || typeof from === \"function\") {\n 32| for (let key of __getOwnPropNames(from))\n 33| if (!__hasOwnProp.call(to, key) && key !== except)\n 34| __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });\n 35| }\n 36| return to;\n 37| };\n 38| var __toESM = (mod2, isNodeMode, target) => (target = mod2 != null ? __create(__getProtoOf(mod2)) : {}, __copyProps(\n 39| // If the importer is in node compatibility mode or this is not an ESM\n 40| // file that has been converted to a CommonJS file using a Babel-\n 41| // compatible transform (i.e. \"__esModule\" has not been set), then set\n 42| // \"default\" to the CommonJS \"module.exports\" for node compatibility.\n 43| isNodeMode || !mod2 || !mod2.__esModule ? __defProp(target, \"default\", { value: mod2, enumerable: true }) : target,\n 44| mod2\n 45| ));\n 46| var __toCommonJS = (mod2) => __copyProps(__defProp({}, \"__esModule\", { value: true }), mod2);\n 47| \n 48| // build/process-global.js\n 49| import process2 from \"process\";\n 50| var init_process_global = __esm({\n 51| \"build/process-global.js\"() {\n 52| \"use strict\";\n 53| globalThis.process = process2;\n 54| }\n 55| });\n 56| \n 57| // types/lh.js\n 58| var init_lh = __esm({\n 59| \"types/lh.js\"() {\n 60| \"use strict\";\n 61| init_process_global();\n 62| /**\n 63| * @license\n 64| * Copyright 2023 Google LLC\n 65| * SPDX-License-Identifier: Apache-2.0\n 66| */\n 67| }\n 68| });\n 69| \n 70| // core/gather/base-gatherer.js\n 71| var BaseGatherer, base_gatherer_default;\n 72| var init_base_gatherer = __esm({\n 73| \"core/gather/base-gatherer.js\"() {\n 74| \"use strict\";\n 75| init_process_global();\n 76| init_lh();\n 77| /**\n 78| * @license\n 79| * Copyright 2021 Google LLC\n 80| * SPDX-License-Identifier: Apache-2.0\n 81| */\n 82| BaseGatherer = class {\n 83| static {\n 84| __name(this, \"BaseGatherer\");\n 85| }\n 86| /** @type {LH.Gatherer.GathererMeta} */\n 87| meta = { supportedModes: [] };\n 88| /**\n 89| * Method to start observing a page for an arbitrary period of time.\n 90| * @param {LH.Gatherer.Context} passContext\n 91| * @return {Promise<void>|void}\n 92| */\n 93| startInstrumentation(passContext) {\n 94| }\n 95| /**\n 96| * Method to start observing a page when the measurements are very sensitive and\n 97| * should observe as little Lighthouse-induced work as possible.\n 98| * @param {LH.Gatherer.Context} passContext\n 99| * @return {Promise<void>|void}\n 100| */\n 101| startSensitiveInstrumentation(passContext) {\n 102| }\n 103| /**\n 104| * Method to stop observing a page when the measurements are very sensitive and\n 105| * should observe as little Lighthouse-induced work as possible.\n 106| *\n 107| * @param {LH.Gatherer.Context} passContext\n 108| * @return {Promise<void>|void}\n 109| */\n 110| stopSensitiveInstrumentation(passContext) {\n 111| }\n 112| /**\n 113| * Method to end observing a page after an arbitrary period of time.\n 114| * @param {LH.Gatherer.Context} passContext\n 115| * @return {Promise<void>|void}\n 116| */\n 117| stopInstrumentation(passContext) {\n 118| }\n 119| /**\n 120| * Method to gather results about a page.\n 121| * @param {LH.Gatherer.Context} passContext\n 122| * @return {LH.Gatherer.PhaseResult}\n 123| */\n 124| getArtifact(passContext) {\n 125| }\n 126| };\n 127| base_gatherer_default = BaseGatherer;\n 128| }\n 129| });\n 130| \n 131| // node_modules/debug/node_modules/ms/index.js\n 132| var require_ms = __commonJS({\n 133| \"node_modules/debug/node_modules/ms/index.js\"(exports2, module2) {\n 134| init_process_global();\n 135| var s = 1e3;\n 136| var m = s * 60;\n 137| var h = m * 60;\n 138| var d = h * 24;\n 139| var w = d * 7;\n 140| var y = d * 365.25;\n 141| module2.exports = function(val, options) {\n 142| options = options || {};\n 143| var type = typeof val;\n 144| if (type === \"string\" && val.length > 0) {\n 145| return parse(val);\n 146| } else if (type === \"number\" && isFinite(val)) {\n 147| return options.long ? fmtLong(val) : fmtShort(val);\n 148| }\n 149| throw new Error(\n 150| \"val is not a non-empty string or a valid number. val=\" + JSON.stringify(val)\n 151| );\n 152| };\n 153| function parse(str) {\n 154| str = String(str);\n 155| if (str.length > 100) {\n 156| return;\n 157| }\n 158| var match = /^(-?(?:\\d+)?\\.?\\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i.exec(\n 159| str\n 160| );\n 161| if (!match) {\n 162| return;\n 163| }\n 164| var n = parseFloat(match[1]);\n 165| var type = (match[2] || \"ms\").toLowerCase();\n 166| switch (type) {\n 167| case \"years\":\n 168| case \"year\":\n 169| case \"yrs\":\n 170| case \"yr\":\n 171| case \"y\":\n 172| return n * y;\n 173| case \"weeks\":\n 174| case \"week\":\n 175| case \"w\":\n 176| return n * w;\n 177| case \"days\":\n 178| case \"day\":\n 179| case \"d\":\n 180| return n * d;\n 181| case \"hours\":\n 182| case \"hour\":\n 183| case \"hrs\":\n 184| case \"hr\":\n 185| case \"h\":\n 186| return n * h;\n 187| case \"minutes\":\n 188| case \"minute\":\n 189| case \"mins\":\n 190| case \"min\":\n 191| case \"m\":\n 192| return n * m;\n 193| case \"seconds\":\n 194| case \"second\":\n 195| case \"secs\":\n 196| case \"sec\":\n 197| case \"s\":\n 198| return n * s;\n 199| case \"milliseconds\":\n 200| case \"millisecond\":\n 201| case \"msecs\":\n 202| case \"msec\":\n 203| case \"ms\":\n 204| return n;\n 205| default:\n 206| return void 0;\n 207| }\n 208| }\n 209| __name(parse, \"parse\");\n 210| function fmtShort(ms) {\n 211| var msAbs = Math.abs(ms);\n 212| if (msAbs >= d) {\n 213| return Math.round(ms / d) + \"d\";\n 214| }\n 215| if (msAbs >= h) {\n 216| return Math.round(ms / h) + \"h\";\n 217| }\n 218| if (msAbs >= m) {\n 219| return Math.round(ms / m) + \"m\";\n 220| }\n 221| if (msAbs >= s) {\n 222| return Math.round(ms / s) + \"s\";\n 223| }\n 224| return ms + \"ms\";\n 225| }\n 226| __name(fmtShort, \"fmtShort\");\n 227| function fmtLong(ms) {\n 228| var msAbs = Math.abs(ms);\n 229| if (msAbs >= d) {\n 230| return plural(ms, msAbs, d, \"day\");\n 231| }\n 232| if (msAbs >= h) {\n 233| return plural(ms, msAbs, h, \"hour\");\n 234| }\n 235| if (msAbs >= m) {\n 236| return plural(ms, msAbs, m, \"minute\");\n 237| }\n 238| if (msAbs >= s) {\n 239| return plural(ms, msAbs, s, \"second\");\n 240| }\n 241| return ms + \" ms\";\n 242| }\n 243| __name(fmtLong, \"fmtLong\");\n 244| function plural(ms, msAbs, n, name) {\n 245| var isPlural = msAbs >= n * 1.5;\n 246| return Math.round(ms / n) + \" \" + name + (isPlural ? \"s\" : \"\");\n 247| }\n 248| __name(plural, \"plural\");\n 249| }\n 250| });\n 251| \n 252| // node_modules/debug/src/common.js\n 253| var require_common = __commonJS({\n 254| \"node_modules/debug/src/common.js\"(exports2, module2) {\n 255| init_process_global();\n 256| function setup(env) {\n 257| createDebug.debug = createDebug;\n 258| createDebug.default = createDebug;\n 259| createDebug.coerce = coerce;\n 260| createDebug.disable = disable;\n 261| createDebug.enable = enable;\n 262| createDebug.enabled = enabled;\n 263| createDebug.humanize = require_ms();\n 264| createDebug.destroy = destroy;\n 265| Object.keys(env).forEach((key) => {\n 266| createDebug[key] = env[key];\n 267| });\n 268| createDebug.names = [];\n 269| createDebug.skips = [];\n 270| createDebug.formatters = {};\n 271| function selectColor(namespace) {\n 272| let hash = 0;\n 273| for (let i = 0; i < namespace.length; i++) {\n 274| hash = (hash << 5) - hash + namespace.charCodeAt(i);\n 275| hash |= 0;\n 276| }\n 277| return createDebug.colors[Math.abs(hash) % createDebug.colors.length];\n 278| }\n 279| __name(selectColor, \"selectColor\");\n 280| createDebug.selectColor = selectColor;\n 281| function createDebug(namespace) {\n 282| let prevTime;\n 283| let enableOverride = null;\n 284| let namespacesCache;\n 285| let enabledCache;\n 286| function debug2(...args) {\n 287| if (!debug2.enabled) {\n 288| return;\n 289| }\n 290| const self2 = debug2;\n 291| const curr = Number(/* @__PURE__ */ new Date());\n 292| const ms = curr - (prevTime || curr);\n 293| self2.diff = ms;\n 294| self2.prev = prevTime;\n 295| self2.curr = curr;\n 296| prevTime = curr;\n 297| args[0] = createDebug.coerce(args[0]);\n 298| if (typeof args[0] !== \"string\") {\n 299| args.unshift(\"%O\");\n 300| }\n 301| let index = 0;\n 302| args[0] = args[0].replace(/%([a-zA-Z%])/g, (match, format) => {\n 303| if (match === \"%%\") {\n 304| return \"%\";\n 305| }\n 306| index++;\n 307| const formatter = createDebug.formatters[format];\n 308| if (typeof formatter === \"function\") {\n 309| const val = args[index];\n 310| match = formatter.call(self2, val);\n 311| args.splice(index, 1);\n 312| index--;\n 313| }\n 314| return match;\n 315| });\n 316| createDebug.formatArgs.call(self2, args);\n 317| const logFn = self2.log || createDebug.log;\n 318| logFn.apply(self2, args);\n 319| }\n 320| __name(debug2, \"debug\");\n 321| debug2.namespace = namespace;\n 322| debug2.useColors = createDebug.useColors();\n 323| debug2.color = createDebug.selectColor(namespace);\n 324| debug2.extend = extend;\n 325| debug2.destroy = createDebug.destroy;\n 326| Object.defineProperty(debug2, \"enabled\", {\n 327| enumerable: true,\n 328| configurable: false,\n 329| get: /* @__PURE__ */ __name(() => {\n 330| if (enableOverride !== null) {\n 331| return enableOverride;\n 332| }\n 333| if (namespacesCache !== createDebug.namespaces) {\n 334| namespacesCache = createDebug.namespaces;\n 335| enabledCache = createDebug.enabled(namespace);\n 336| }\n 337| return enabledCache;\n 338| }, \"get\"),\n 339| set: /* @__PURE__ */ __name((v) => {\n 340| enableOverride = v;\n 341| }, \"set\")\n 342| });\n 343| if (typeof createDebug.init === \"function\") {\n 344| createDebug.init(debug2);\n 345| }\n 346| return debug2;\n 347| }\n 348| __name(createDebug, \"createDebug\");\n 349| function extend(namespace, delimiter) {\n 350| const newDebug = createDebug(this.namespace + (typeof delimiter === \"undefined\" ? \":\" : delimiter) + namespace);\n 351| newDebug.log = this.log;\n 352| return newDebug;\n 353| }\n 354| __name(extend, \"extend\");\n 355| function enable(namespaces) {\n 356| createDebug.save(namespaces);\n 357| createDebug.namespaces = namespaces;\n 358| createDebug.names = [];\n 359| createDebug.skips = [];\n 360| let i;\n 361| const split = (typeof namespaces === \"string\" ? namespaces : \"\").split(/[\\s,]+/);\n 362| const len = split.length;\n 363| for (i = 0; i < len; i++) {\n 364| if (!split[i]) {\n 365| continue;\n 366| }\n 367| namespaces = split[i].replace(/\\*/g, \".*?\");\n 368| if (namespaces[0] === \"-\") {\n 369| createDebug.skips.push(new RegExp(\"^\" + namespaces.slice(1) + \"$\"));\n 370| } else {\n 371| createDebug.names.push(new RegExp(\"^\" + namespaces + \"$\"));\n 372| }\n 373| }\n 374| }\n 375| __name(enable, \"enable\");\n 376| function disable() {\n 377| const namespaces = [\n 378| ...createDebug.names.map(toNamespace),\n 379| ...createDebug.skips.map(toNamespace).map((namespace) => \"-\" + namespace)\n 380| ].join(\",\");\n 381| createDebug.enable(\"\");\n 382| return namespaces;\n 383| }\n 384| __name(disable, \"disable\");\n 385| function enabled(name) {\n 386| if (name[name.length - 1] === \"*\") {\n 387| return true;\n 388| }\n 389| let i;\n 390| let len;\n 391| for (i = 0, len = createDebug.skips.length; i < len; i++) {\n 392| if (createDebug.skips[i].test(name)) {\n 393| return false;\n 394| }\n 395| }\n 396| for (i = 0, len = createDebug.names.length; i < len; i++) {\n 397| if (createDebug.names[i].test(name)) {\n 398| return true;\n 399| }\n 400| }\n 401| return false;\n 402| }\n 403| __name(enabled, \"enabled\");\n 404| function toNamespace(regexp) {\n 405| return regexp.toString().substring(2, regexp.toString().length - 2).replace(/\\.\\*\\?$/, \"*\");\n 406| }\n 407| __name(toNamespace, \"toNamespace\");\n 408| function coerce(val) {\n 409| if (val instanceof Error) {\n 410| return val.stack || val.message;\n 411| }\n 412| return val;\n 413| }\n 414| __name(coerce, \"coerce\");\n 415| function destroy() {\n 416| console.warn(\"Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.\");\n 417| }\n 418| __name(destroy, \"destroy\");\n 419| createDebug.enable(createDebug.load());\n 420| return createDebug;\n 421| }\n 422| __name(setup, \"setup\");\n 423| module2.exports = setup;\n 424| }\n 425| });\n 426| \n 427| // node_modules/debug/src/browser.js\n 428| var require_browser = __commonJS({\n 429| \"node_modules/debug/src/browser.js\"(exports2, module2) {\n 430| init_process_global();\n 431| exports2.formatArgs = formatArgs;\n 432| exports2.save = save;\n 433| exports2.load = load;\n 434| exports2.useColors = useColors;\n 435| exports2.storage = localstorage();\n 436| exports2.destroy = /* @__PURE__ */ (() => {\n 437| let warned = false;\n 438| return () => {\n 439| if (!warned) {\n 440| warned = true;\n 441| console.warn(\"Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.\");\n 442| }\n 443| };\n 444| })();\n 445| exports2.colors = [\n 446| \"#0000CC\",\n 447| \"#0000FF\",\n 448| \"#0033CC\",\n 449| \"#0033FF\",\n 450| \"#0066CC\",\n 451| \"#0066FF\",\n 452| \"#0099CC\",\n 453| \"#0099FF\",\n 454| \"#00CC00\",\n 455| \"#00CC33\",\n 456| \"#00CC66\",\n 457| \"#00CC99\",\n 458| \"#00CCCC\",\n 459| \"#00CCFF\",\n 460| \"#3300CC\",\n 461| \"#3300FF\",\n 462| \"#3333CC\",\n 463| \"#3333FF\",\n 464| \"#3366CC\",\n 465| \"#3366FF\",\n 466| \"#3399CC\",\n 467| \"#3399FF\",\n 468| \"#33CC00\",\n 469| \"#33CC33\",\n 470| \"#33CC66\",\n 471| \"#33CC99\",\n 472| \"#33CCCC\",\n 473| \"#33CCFF\",\n 474| \"#6600CC\",\n 475| \"#6600FF\",\n 476| \"#6633CC\",\n 477| \"#6633FF\",\n 478| \"#66CC00\",\n 479| \"#66CC33\",\n 480| \"#9900CC\",\n 481| \"#9900FF\",\n 482| \"#9933CC\",\n 483| \"#9933FF\",\n 484| \"#99CC00\",\n 485| \"#99CC33\",\n 486| \"#CC0000\",\n 487| \"#CC0033\",\n 488| \"#CC0066\",\n 489| \"#CC0099\",\n 490| \"#CC00CC\",\n 491| \"#CC00FF\",\n 492| \"#CC3300\",\n 493| \"#CC3333\",\n 494| \"#CC3366\",\n 495| \"#CC3399\",\n 496| \"#CC33CC\",\n 497| \"#CC33FF\",\n 498| \"#CC6600\",\n 499| \"#CC6633\",\n 500| \"#CC9900\",\n 501| \"#CC9933\",\n 502| \"#CCCC00\",\n 503| \"#CCCC33\",\n 504| \"#FF0000\",\n 505| \"#FF0033\",\n 506| \"#FF0066\",\n 507| \"#FF0099\",\n 508| \"#FF00CC\",\n 509| \"#FF00FF\",\n 510| \"#FF3300\",\n 511| \"#FF3333\",\n 512| \"#FF3366\",\n 513| \"#FF3399\",\n 514| \"#FF33CC\",\n 515| \"#FF33FF\",\n 516| \"#FF6600\",\n 517| \"#FF6633\",\n 518| \"#FF9900\",\n 519| \"#FF9933\",\n 520| \"#FFCC00\",\n 521| \"#FFCC33\"\n 522| ];\n 523| function useColors() {\n 524| if (typeof window !== \"undefined\" && window.process && (window.process.type === \"renderer\" || window.process.__nwjs)) {\n 525| return true;\n 526| }\n 527| if (typeof navigator !== \"undefined\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\\/(\\d+)/)) {\n 528| return false;\n 529| }\n 530| return typeof document !== \"undefined\" && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance || // Is firebug? http://stackoverflow.com/a/398120/376773\n 531| typeof window !== \"undefined\" && window.console && (window.console.firebug || window.console.exception && window.console.table) || // Is firefox >= v31?\n 532| // https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages\n 533| typeof navigator !== \"undefined\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\\/(\\d+)/) && parseInt(RegExp.$1, 10) >= 31 || // Double check webkit in userAgent just in case we are in a worker\n 534| typeof navigator !== \"undefined\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\\/(\\d+)/);\n 535| }\n 536| __name(useColors, \"useColors\");\n 537| function formatArgs(args) {\n 538| args[0] = (this.useColors ? \"%c\" : \"\") + this.namespace + (this.useColors ? \" %c\" : \" \") + args[0] + (this.useColors ? \"%c \" : \" \") + \"+\" + module2.exports.humanize(this.diff);\n 539| if (!this.useColors) {\n 540| return;\n 541| }\n 542| const c = \"color: \" + this.color;\n 543| args.splice(1, 0, c, \"color: inherit\");\n 544| let index = 0;\n 545| let lastC = 0;\n 546| args[0].replace(/%[a-zA-Z%]/g, (match) => {\n 547| if (match === \"%%\") {\n 548| return;\n 549| }\n 550| index++;\n 551| if (match === \"%c\") {\n 552| lastC = index;\n 553| }\n 554| });\n 555| args.splice(lastC, 0, c);\n 556| }\n 557| __name(formatArgs, \"formatArgs\");\n 558| exports2.log = console.debug || console.log || (() => {\n 559| });\n 560| function save(namespaces) {\n 561| try {\n 562| if (namespaces) {\n 563| exports2.storage.setItem(\"debug\", namespaces);\n 564| } else {\n 565| exports2.storage.removeItem(\"debug\");\n 566| }\n 567| } catch (error) {\n 568| }\n 569| }\n 570| __name(save, \"save\");\n 571| function load() {\n 572| let r;\n 573| try {\n 574| r = exports2.storage.getItem(\"debug\");\n 575| } catch (error) {\n 576| }\n 577| if (!r && typeof process !== \"undefined\" && \"env\" in process) {\n 578| r = process.env.DEBUG;\n 579| }\n 580| return r;\n 581| }\n 582| __name(load, \"load\");\n 583| function localstorage() {\n 584| try {\n 585| return localStorage;\n 586| } catch (error) {\n 587| }\n 588| }\n 589| __name(localstorage, \"localstorage\");\n 590| module2.exports = require_common()(exports2);\n 591| var { formatters } = module2.exports;\n 592| formatters.j = function(v) {\n 593| try {\n 594| return JSON.stringify(v);\n 595| } catch (error) {\n 596| return \"[UnexpectedJSONParseError]: \" + error.message;\n 597| }\n 598| };\n 599| }\n 600| });\n 601| \n 602| // node_modules/marky/lib/marky.cjs.js\n 603| var require_marky_cjs = __commonJS({\n 604| \"node_modules/marky/lib/marky.cjs.js\"(exports2) {\n 605| \"use strict\";\n 606| init_process_global();\n 607| Object.defineProperty(exports2, \"__esModule\", { value: true });\n 608| var perf = typeof performance !== \"undefined\" && performance;\n 609| var nowForNode;\n 610| {\n 611| hrtime = process.hrtime;\n 612| getNanoSeconds = /* @__PURE__ */ __name(function() {\n 613| var hr = hrtime();\n 614| return hr[0] * 1e9 + hr[1];\n 615| }, \"getNanoSeconds\");\n 616| loadTime = getNanoSeconds();\n 617| nowForNode = /* @__PURE__ */ __name(function() {\n 618| return (getNanoSeconds() - loadTime) / 1e6;\n 619| }, \"nowForNode\");\n 620| }\n 621| var hrtime;\n 622| var getNanoSeconds;\n 623| var loadTime;\n 624| var now = nowForNode;\n 625| function throwIfEmpty(name) {\n 626| if (!name) {\n 627| throw new Error(\"name must be non-empty\");\n 628| }\n 629| }\n 630| __name(throwIfEmpty, \"throwIfEmpty\");\n 631| function insertSorted(arr, item) {\n 632| var low = 0;\n 633| var high = arr.length;\n 634| var mid;\n 635| while (low < high) {\n 636| mid = low + high >>> 1;\n 637| if (arr[mid].startTime < item.startTime) {\n 638| low = mid + 1;\n 639| } else {\n 640| high = mid;\n 641| }\n 642| }\n 643| arr.splice(low, 0, item);\n 644| }\n 645| __name(insertSorted, \"insertSorted\");\n 646| exports2.mark = void 0;\n 647| exports2.stop = void 0;\n 648| exports2.getEntries = void 0;\n 649| exports2.clear = void 0;\n 650| if (perf && perf.mark && perf.getEntriesByName && perf.getEntriesByType && perf.clearMeasures) {\n 651| exports2.mark = function(name) {\n 652| throwIfEmpty(name);\n 653| perf.mark(\"start \" + name);\n 654| };\n 655| exports2.stop = function(name) {\n 656| throwIfEmpty(name);\n 657| perf.mark(\"end \" + name);\n 658| perf.measure(name, \"start \" + name, \"end \" + name);\n 659| var entries2 = perf.getEntriesByName(name);\n 660| return entries2[entries2.length - 1];\n 661| };\n 662| exports2.getEntries = function() {\n 663| return perf.getEntriesByType(\"measure\");\n 664| };\n 665| exports2.clear = function() {\n 666| perf.clearMarks();\n 667| perf.clearMeasures();\n 668| };\n 669| } else {\n 670| marks = {};\n 671| entries = [];\n 672| exports2.mark = function(name) {\n 673| throwIfEmpty(name);\n 674| var startTime = now();\n 675| marks[\"$\" + name] = startTime;\n 676| };\n 677| exports2.stop = function(name) {\n 678| throwIfEmpty(name);\n 679| var endTime = now();\n 680| var startTime = marks[\"$\" + name];\n 681| if (!startTime) {\n 682| throw new Error(\"no known mark: \" + name);\n 683| }\n 684| var entry = {\n 685| startTime,\n 686| name,\n 687| duration: endTime - startTime,\n 688| entryType: \"measure\"\n 689| };\n 690| insertSorted(entries, entry);\n 691| return entry;\n 692| };\n 693| exports2.getEntries = function() {\n 694| return entries;\n 695| };\n 696| exports2.clear = function() {\n 697| marks = {};\n 698| entries = [];\n 699| };\n 700| }\n 701| var marks;\n 702| var entries;\n 703| }\n 704| });\n 705| \n 706| // lighthouse-logger/index.js\n 707| import process3 from \"process\";\n 708| import { EventEmitter } from \"events\";\n 709| var import_debug, marky, isWindows, isBrowser, colors, Emitter, loggersByTitle, loggingBufferColumns, level_, Log, lighthouse_logger_default;\n 710| var init_lighthouse_logger = __esm({\n 711| \"lighthouse-logger/index.js\"() {\n 712| \"use strict\";\n 713| init_process_global();\n 714| import_debug = __toESM(require_browser(), 1);\n 715| marky = __toESM(require_marky_cjs(), 1);\n 716| /**\n 717| * @license\n 718| * Copyright 2016 Google LLC\n 719| * SPDX-License-Identifier: Apache-2.0\n 720| */\n 721| isWindows = process3.platform === \"win32\";\n 722| isBrowser = process3.browser;\n 723| colors = {\n 724| red: isBrowser ? \"crimson\" : 1,\n 725| yellow: isBrowser ? \"gold\" : 3,\n 726| cyan: isBrowser ? \"darkturquoise\" : 6,\n 727| green: isBrowser ? \"forestgreen\" : 2,\n 728| blue: isBrowser ? \"steelblue\" : 4,\n 729| magenta: isBrowser ? \"palevioletred\" : 5\n 730| };\n 731| import_debug.default.colors = [colors.cyan, colors.green, colors.blue, colors.magenta];\n 732| Emitter = class extends EventEmitter {\n 733| static {\n 734| __name(this, \"Emitter\");\n 735| }\n 736| // yarn build-types fails without this!\n 737| // https://github.com/microsoft/TypeScript/issues/41672#issuecomment-2303803072\n 738| constructor(options) {\n 739| super(options);\n 740| }\n 741| /**\n 742| * Fires off all status updates. Listen with\n 743| * `require('lib/log').events.addListener('status', callback)`\n 744| * @param {string} title\n 745| * @param {!Array<*>} argsArray\n 746| */\n 747| issueStatus(title, argsArray) {\n 748| if (title === \"status\" || title === \"statusEnd\") {\n 749| this.emit(title, [title, ...argsArray]);\n 750| }\n 751| }\n 752| /**\n 753| * Fires off all warnings. Listen with\n 754| * `require('lib/log').events.addListener('warning', callback)`\n 755| * @param {string} title\n 756| * @param {!Array<*>} argsArray\n 757| */\n 758| issueWarning(title, argsArray) {\n 759| this.emit(\"warning\", [title, ...argsArray]);\n 760| }\n 761| };\n 762| loggersByTitle = {};\n 763| loggingBufferColumns = 25;\n 764| Log = class _Log {\n 765| static {\n 766| __name(this, \"Log\");\n 767| }\n 768| static _logToStdErr(title, argsArray) {\n 769| const log = _Log.loggerfn(title);\n 770| log(...argsArray);\n 771| }\n 772| /**\n 773| * @param {string} title\n 774| */\n 775| static loggerfn(title) {\n 776| title = `LH:${title}`;\n 777| let log = loggersByTitle[title];\n 778| if (!log) {\n 779| log = (0, import_debug.default)(title);\n 780| loggersByTitle[title] = log;\n 781| if (title.endsWith(\"error\")) {\n 782| log.color = colors.red;\n 783| } else if (title.endsWith(\"warn\")) {\n 784| log.color = colors.yellow;\n 785| }\n 786| }\n 787| return log;\n 788| }\n 789| /**\n 790| * @param {string} level\n 791| */\n 792| static setLevel(level) {\n 793| level_ = level;\n 794| switch (level) {\n 795| case \"silent\":\n 796| import_debug.default.enable(\"-LH:*\");\n 797| break;\n 798| case \"verbose\":\n 799| import_debug.default.enable(\"LH:*\");\n 800| break;\n 801| case \"warn\":\n 802| import_debug.default.enable(\"-LH:*, LH:*:warn, LH:*:error\");\n 803| break;\n 804| case \"error\":\n 805| import_debug.default.enable(\"-LH:*, LH:*:error\");\n 806| break;\n 807| default:\n 808| import_debug.default.enable(\"LH:*, -LH:*:verbose\");\n 809| }\n 810| }\n 811| /**\n 812| * A simple formatting utility for event logging.\n 813| * @param {string} prefix\n 814| * @param {!Object} data A JSON-serializable object of event data to log.\n 815| * @param {string=} level Optional logging level. Defaults to 'log'.\n 816| */\n 817| static formatProtocol(prefix, data31, level) {\n 818| const columns = !process3 || process3.browser ? Infinity : process3.stdout.columns;\n 819| const method = data31.method || \"?????\";\n 820| const maxLength = columns - method.length - prefix.length - loggingBufferColumns;\n 821| const snippet = data31.params && method !== \"IO.read\" ? JSON.stringify(data31.params).substr(0, maxLength) : \"\";\n 822| _Log._logToStdErr(`${prefix}:${level || \"\"}`, [method, snippet]);\n 823| }\n 824| /**\n 825| * @return {boolean}\n 826| */\n 827| static isVerbose() {\n 828| return level_ === \"verbose\";\n 829| }\n 830| /**\n 831| * @param {{msg: string, id: string, args?: any[]}} status\n 832| * @param {string} level\n 833| */\n 834| static time({ msg, id, args = [] }, level = \"log\") {\n 835| marky.mark(id);\n 836| _Log[level](\"status\", msg, ...args);\n 837| }\n 838| /**\n 839| * @param {{msg: string, id: string, args?: any[]}} status\n 840| * @param {string} level\n 841| */\n 842| static timeEnd({ msg, id, args = [] }, level = \"verbose\") {\n 843| _Log[level](\"statusEnd\", msg, ...args);\n 844| marky.stop(id);\n 845| }\n 846| /**\n 847| * @param {string} title\n 848| * @param {...any} args\n 849| */\n 850| static log(title, ...args) {\n 851| _Log.events.issueStatus(title, args);\n 852| return _Log._logToStdErr(title, args);\n 853| }\n 854| /**\n 855| * @param {string} title\n 856| * @param {...any} args\n 857| */\n 858| static warn(title, ...args) {\n 859| _Log.events.issueWarning(title, args);\n 860| return _Log._logToStdErr(`${title}:warn`, args);\n 861| }\n 862| /**\n 863| * @param {string} title\n 864| * @param {...any} args\n 865| */\n 866| static error(title, ...args) {\n 867| return _Log._logToStdErr(`${title}:error`, args);\n 868| }\n 869| /**\n 870| * @param {string} title\n 871| * @param {...any} args\n 872| */\n 873| static verbose(title, ...args) {\n 874| _Log.events.issueStatus(title, args);\n 875| return _Log._logToStdErr(`${title}:verbose`, args);\n 876| }\n 877| /**\n 878| * Add surrounding escape sequences to turn a string green when logged.\n 879| * @param {string} str\n 880| * @return {string}\n 881| */\n 882| static greenify(str) {\n 883| return `${_Log.green}${str}${_Log.reset}`;\n 884| }\n 885| /**\n 886| * Add surrounding escape sequences to turn a string red when logged.\n 887| * @param {string} str\n 888| * @return {string}\n 889| */\n 890| static redify(str) {\n 891| return `${_Log.red}${str}${_Log.reset}`;\n 892| }\n 893| static get green() {\n 894| return \"\\x1B[32m\";\n 895| }\n 896| static get red() {\n 897| return \"\\x1B[31m\";\n 898| }\n 899| static get yellow() {\n 900| return \"\\x1B[33m\";\n 901| }\n 902| static get purple() {\n 903| return \"\\x1B[95m\";\n 904| }\n 905| static get reset() {\n 906| return \"\\x1B[0m\";\n 907| }\n 908| static get bold() {\n 909| return \"\\x1B[1m\";\n 910| }\n 911| static get dim() {\n 912| return \"\\x1B[2m\";\n 913| }\n 914| static get tick() {\n 915| return isWindows ? \"√\" : \"✓\";\n 916| }\n 917| static get cross() {\n 918| return isWindows ? \"×\" : \"✘\";\n 919| }\n 920| static get whiteSmallSquare() {\n 921| return isWindows ? \"·\" : \"▫\";\n 922| }\n 923| static get heavyHorizontal() {\n 924| return isWindows ? \"─\" : \"━\";\n 925| }\n 926| static get heavyVertical() {\n 927| return isWindows ? \"│ \" : \"┃ \";\n 928| }\n 929| static get heavyUpAndRight() {\n 930| return isWindows ? \"└\" : \"┗\";\n 931| }\n 932| static get heavyVerticalAndRight() {\n 933| return isWindows ? \"├\" : \"┣\";\n 934| }\n 935| static get heavyDownAndHorizontal() {\n 936| return isWindows ? \"┬\" : \"┳\";\n 937| }\n 938| static get doubleLightHorizontal() {\n 939| return \"──\";\n 940| }\n 941| };\n 942| Log.events = new Emitter();\n 943| Log.takeTimeEntries = () => {\n 944| const entries = marky.getEntries();\n 945| marky.clear();\n 946| return entries;\n 947| };\n 948| Log.getTimeEntries = () => marky.getEntries();\n 949| lighthouse_logger_default = Log;\n 950| }\n 951| });\n 952| \n 953| // core/lib/tracehouse/trace-processor.js\n 954| var ACCEPTABLE_NAVIGATION_URL_REGEX, BASE_RESPONSE_LATENCY, SCHEDULABLE_TASK_TITLE_LH, SCHEDULABLE_TASK_TITLE_ALT1, SCHEDULABLE_TASK_TITLE_ALT2, SCHEDULABLE_TASK_TITLE_ALT3, TraceProcessor;\n 955| var init_trace_processor = __esm({\n 956| \"core/lib/tracehouse/trace-processor.js\"() {\n 957| \"use strict\";\n 958| init_process_global();\n 959| init_lighthouse_logger();\n 960| /**\n 961| * @license\n 962| * Copyright 2017 Google LLC\n 963| * SPDX-License-Identifier: Apache-2.0\n 964| */\n 965| ACCEPTABLE_NAVIGATION_URL_REGEX = /^(chrome|https?):/;\n 966| BASE_RESPONSE_LATENCY = 16;\n 967| SCHEDULABLE_TASK_TITLE_LH = \"RunTask\";\n 968| SCHEDULABLE_TASK_TITLE_ALT1 = \"ThreadControllerImpl::RunTask\";\n 969| SCHEDULABLE_TASK_TITLE_ALT2 = \"ThreadControllerImpl::DoWork\";\n 970| SCHEDULABLE_TASK_TITLE_ALT3 = \"TaskQueueManager::ProcessTaskFromWorkQueue\";\n 971| TraceProcessor = class _TraceProcessor {\n 972| static {\n 973| __name(this, \"TraceProcessor\");\n 974| }\n 975| static get TIMESPAN_MARKER_ID() {\n 976| return \"__lighthouseTimespanStart__\";\n 977| }\n 978| /**\n 979| * @return {Error}\n 980| */\n 981| static createNoNavstartError() {\n 982| return new Error(\"No navigationStart event found\");\n 983| }\n 984| /**\n 985| * @return {Error}\n 986| */\n 987| static createNoResourceSendRequestError() {\n 988| return new Error(\"No ResourceSendRequest event found\");\n 989| }\n 990| /**\n 991| * @return {Error}\n 992| */\n 993| static createNoTracingStartedError() {\n 994| return new Error(\"No tracingStartedInBrowser event found\");\n 995| }\n 996| /**\n 997| * @return {Error}\n 998| */\n 999| static createNoFirstContentfulPaintError() {\n1000| return new Error(\"No FirstContentfulPaint event found\");\n1001| }\n1002| /**\n1003| * @return {Error}\n1004| */\n1005| static createNoLighthouseMarkerError() {\n1006| return new Error(\"No Lighthouse timespan marker event found\");\n1007| }\n1008| /**\n1009| * Returns true if the event is a navigation start event of a document whose URL seems valid.\n1010| *\n1011| * @param {LH.TraceEvent} event\n1012| * @return {boolean}\n1013| */\n1014| static _isNavigationStartOfInterest(event) {\n1015| if (event.name !== \"navigationStart\") return false;\n1016| if (event.args.data?.documentLoaderURL === void 0) return true;\n1017| if (!event.args.data?.documentLoaderURL) return false;\n1018| return ACCEPTABLE_NAVIGATION_URL_REGEX.test(event.args.data.documentLoaderURL);\n1019| }\n1020| /**\n1021| * This method sorts a group of trace events that have the same timestamp. We want to...\n1022| *\n1023| * 1. Put E events first, we finish off our existing events before we start new ones.\n1024| * 2. Order B/X events by their duration, we want parents to start before child events.\n1025| * 3. If we don't have any of this to go on, just use the position in the original array (stable sort).\n1026| *\n1027| * Note that the typical group size with the same timestamp will be quite small (<10 or so events),\n1028| * and the number of groups typically ~1% of total trace, so the same ultra-performance-sensitive consideration\n1029| * given to functions that run on entire traces does not necessarily apply here.\n1030| *\n1031| * @param {number[]} tsGroupIndices\n1032| * @param {number[]} timestampSortedIndices\n1033| * @param {number} indexOfTsGroupIndicesStart\n1034| * @param {LH.TraceEvent[]} traceEvents\n1035| * @return {number[]}\n1036| */\n1037| static _sortTimestampEventGroup(tsGroupIndices, timestampSortedIndices, indexOfTsGroupIndicesStart, traceEvents) {\n1038| const lookupArrayIndexByTsIndex = /* @__PURE__ */ __name((i) => timestampSortedIndices[i], \"lookupArrayIndexByTsIndex\");\n1039| const lookupEventByTsIndex = /* @__PURE__ */ __name((i) => traceEvents[lookupArrayIndexByTsIndex(i)], \"lookupEventByTsIndex\");\n1040| const eEventIndices = [];\n1041| const bxEventIndices = [];\n1042| const otherEventIndices = [];\n1043| for (const tsIndex of tsGroupIndices) {\n1044| const arrayIndex = lookupArrayIndexByTsIndex(tsIndex);\n1045| const event = lookupEventByTsIndex(tsIndex);\n1046| if (event.ph === \"E\") eEventIndices.push(arrayIndex);\n1047| else if (event.ph === \"X\" || event.ph === \"B\") bxEventIndices.push(arrayIndex);\n1048| else otherEventIndices.push(arrayIndex);\n1049| }\n1050| const effectiveDuration = /* @__PURE__ */ new Map();\n1051| for (const index of bxEventIndices) {\n1052| const event = traceEvents[index];\n1053| if (event.ph === \"X\") {\n1054| effectiveDuration.set(index, event.dur);\n1055| } else {\n1056| let duration = Number.MAX_SAFE_INTEGER;\n1057| let additionalNestedEventsWithSameName = 0;\n1058| const startIndex = indexOfTsGroupIndicesStart + tsGroupIndices.length;\n1059| for (let j = startIndex; j < timestampSortedIndices.length; j++) {\n1060| const potentialMatchingEvent = lookupEventByTsIndex(j);\n1061| const eventMatches = potentialMatchingEvent.name === event.name && potentialMatchingEvent.pid === event.pid && potentialMatchingEvent.tid === event.tid;\n1062| if (!eventMatches) continue;\n1063| if (potentialMatchingEvent.ph === \"E\" && additionalNestedEventsWithSameName === 0) {\n1064| duration = potentialMatchingEvent.ts - event.ts;\n1065| break;\n1066| } else if (potentialMatchingEvent.ph === \"E\") {\n1067| additionalNestedEventsWithSameName--;\n1068| } else if (potentialMatchingEvent.ph === \"B\") {\n1069| additionalNestedEventsWithSameName++;\n1070| }\n1071| }\n1072| effectiveDuration.set(index, duration);\n1073| }\n1074| }\n1075| bxEventIndices.sort((indexA, indexB) => (effectiveDuration.get(indexB) || 0) - (effectiveDuration.get(indexA) || 0) || indexA - indexB);\n1076| otherEventIndices.sort((indexA, indexB) => indexA - indexB);\n1077| return [...eEventIndices, ...bxEventIndices, ...otherEventIndices];\n1078| }\n1079| /**\n1080| * Sorts and filters trace events by timestamp and respecting the nesting structure inherent to\n1081| * parent/child event relationships.\n1082| *\n1083| * @param {LH.TraceEvent[]} traceEvents\n1084| * @param {(e: LH.TraceEvent) => boolean} filter\n1085| */\n1086| static filteredTraceSort(traceEvents, filter) {\n1087| const indices = [];\n1088| for (let srcIndex = 0; srcIndex < traceEvents.length; srcIndex++) {\n1089| if (filter(traceEvents[srcIndex])) {\n1090| indices.push(srcIndex);\n1091| }\n1092| }\n1093| indices.sort((indexA, indexB) => traceEvents[indexA].ts - traceEvents[indexB].ts);\n1094| for (let i = 0; i < indices.length - 1; i++) {\n1095| const ts = traceEvents[indices[i]].ts;\n1096| const tsGroupIndices = [i];\n1097| for (let j = i + 1; j < indices.length; j++) {\n1098| if (traceEvents[indices[j]].ts !== ts) break;\n1099| tsGroupIndices.push(j);\n1100| }\n```\n\n### FILE: src/tools/categories.ts (33 lines)\n\n```\n 1| /**\n 2| * @license\n 3| * Copyright 2025 Google LLC\n 4| * SPDX-License-Identifier: Apache-2.0\n 5| */\n 6| \n 7| export enum ToolCategory {\n 8| INPUT = 'input',\n 9| NAVIGATION = 'navigation',\n 10| EMULATION = 'emulation',\n 11| PERFORMANCE = 'performance',\n 12| NETWORK = 'network',\n 13| DEBUGGING = 'debugging',\n 14| EXTENSIONS = 'extensions',\n 15| THIRD_PARTY = 'experimentalThirdParty',\n 16| MEMORY = 'memory',\n 17| WEBMCP = 'experimentalWebmcp',\n 18| PWA = 'pwa',\n 19| }\n 20| \n 21| export const labels = {\n 22| [ToolCategory.INPUT]: 'Input automation',\n 23| [ToolCategory.NAVIGATION]: 'Navigation automation',\n 24| [ToolCategory.EMULATION]: 'Emulation',\n 25| [ToolCategory.PERFORMANCE]: 'Performance',\n 26| [ToolCategory.NETWORK]: 'Network',\n 27| [ToolCategory.DEBUGGING]: 'Debugging',\n 28| [ToolCategory.EXTENSIONS]: 'Extensions',\n 29| [ToolCategory.THIRD_PARTY]: 'Third-party',\n 30| [ToolCategory.MEMORY]: 'Memory',\n 31| [ToolCategory.WEBMCP]: 'WebMCP',\n 32| [ToolCategory.PWA]: 'Progressive Web Apps',\n 33| };\n```\n<END_OF_CONTEXT>\n\n<query>\nGenerate a wiki page explaining WHY this codebase is designed the way it is: the constraints it balances, the patterns it uses and what problems they solve, and the trade-offs visible in the code.\n</query>"},{"role":"assistant","content":"# Chrome DevTools MCP Codebase Design Analysis\n\n## Overview\n\nThis codebase implements the Chrome DevTools Multi-Client Protocol (MCP) integration, specifically focusing on Lighthouse auditing capabilities within the Chrome DevTools environment. The repository contains a bundled Lighthouse version (`lighthouse-devtools-mcp-bundle.js`) and tool categorization definitions (`categories.ts`). The design balances several constraints including browser compatibility, performance requirements, modular architecture, and tool categorization for developer experience.\n\n## Detailed Analysis\n\n### Core Architecture and Constraints\n\nThe codebase demonstrates a modular architecture that integrates Lighthouse auditing capabilities into Chrome DevTools. The `lighthouse-devtools-mcp-bundle.js` file is a substantial bundle that includes Lighthouse core components, which suggests a design choice to bundle dependencies rather than rely on external module resolution. This approach reduces runtime complexity and ensures consistent behavior across different environments.\n\nThe design pattern of using `__esm` and `__commonJS` wrappers (`src/third_party/lighthouse-devtools-mcp-bundle.js:20-25`) indicates a transpilation strategy that maintains compatibility with both ES modules and CommonJS environments. This is particularly important for Chrome DevTools integration where runtime environments can vary significantly.\n\n```mermaid\nflowchart TD\n A[Chrome DevTools] --> B[Lighthouse Bundle]\n B --> C[Lighthouse Core]\n B --> D[DevTools Integration]\n C --> E[Performance Audits]\n C --> F[Accessibility Checks]\n C --> G[Best Practices]\n D --> H[Tool Categories]\n```\n\n### Tool Categorization Strategy\n\nThe `categories.ts` file (`src/tools/categories.ts:7-33`) defines an enum `ToolCategory` that organizes tools into logical groups. This design addresses the problem of tool discoverability and organization within the DevTools UI. The categories reflect the functional domains that developers commonly interact with:\n\n- **INPUT/NAVIGATION**: Automation capabilities\n- **EMULATION**: Device and environment simulation\n- **PERFORMANCE**: Performance metrics and analysis\n- **NETWORK**: Network behavior inspection\n- **DEBUGGING**: Debugging utilities\n- **EXTENSIONS**: Extension management\n- **THIRD_PARTY/WEBMCP**: Experimental and external integrations\n- **MEMORY**: Memory profiling\n- **PWA**: Progressive Web App capabilities\n\nThis categorization pattern solves the problem of organizing a large number of tools into digestible groups, improving usability and maintainability.\n\n### Performance and Compatibility Considerations\n\nThe codebase carefully balances performance and compatibility through several mechanisms:\n\n1. **Conditional Logic for Browser vs Node.js**: The `lighthouse-logger/index.js` file (`src/third_party/lighthouse-devtools-mcp-bundle.js:707-723`) includes explicit checks for browser environments:\n ```typescript\n isWindows = process3.platform === \"win32\";\n isBrowser = process3.browser;\n ```\n This allows the same codebase to function in both Node.js environments (for tooling) and browser environments (for DevTools integration).\n\n2. **Performance Measurement Utilities**: The `marky` library integration (`src/third_party/lighthouse-devtools-mcp-bundle.js:602-704`) provides a unified interface for performance measurement that gracefully degrades from `performance.mark` API to custom implementations when browser APIs are unavailable.\n\n3. **Debugging and Logging Framework**: The integration with the `debug` library (`src/third_party/lighthouse-devtools-mcp-bundle.js:252-425`) provides a flexible logging system that can be configured at runtime, solving the problem of varying logging requirements across different environments and debugging needs.\n\n### Design Patterns and Problem-Solving\n\nThe codebase employs several design patterns that address specific architectural challenges:\n\n#### 1. Base Gatherer Pattern\nThe `BaseGatherer` class (`src/third_party/lighthouse-devtools-mcp-bundle.js:70-129`) establishes a clear interface for data collection. This pattern solves the problem of standardizing how different types of audits gather information from the page:\n\n```typescript\nclass BaseGatherer {\n startInstrumentation(passContext) {}\n getArtifact(passContext) {}\n}\n```\n\nThis abstraction allows for different gathering strategies (instrumentation vs sensitive instrumentation) while maintaining a consistent API.\n\n#### 2. Trace Processing Architecture\nThe `TraceProcessor` class (`src/third_party/lighthouse-devtools-mcp-bundle.js:953-1100`) demonstrates a sophisticated approach to handling trace data. It addresses the complex problem of sorting and filtering trace events that may have identical timestamps:\n\n```typescript\nstatic _sortTimestampEventGroup(tsGroupIndices, timestampSortedIndices, indexOfTsGroupIndicesStart, traceEvents)\n```\n\nThis method prioritizes event types and duration relationships to maintain proper execution order, which is crucial for accurate performance analysis.\n\n#### 3. Error Handling and Validation\nThe `TraceProcessor` also demonstrates good error handling practices with specific error creation methods:\n\n```typescript\nstatic createNoNavstartError() { return new Error(\"No navigationStart event found\"); }\n```\n\nThis pattern solves the problem of providing meaningful error messages for common trace processing failures.\n\n## Conclusion\n\nThe Chrome DevTools MCP codebase demonstrates a sophisticated balance between modularity, performance, and usability. Key design decisions include:\n\n1. **Bundling Strategy**: Using bundled dependencies to ensure consistent behavior and reduce runtime complexity\n2. **Environment Adaptation**: Supporting both Node.js and browser environments through conditional logic\n3. **Modular Architecture**: Clear separation of concerns with base classes and specialized processors\n4. **Tool Organization**: Logical categorization of tools to improve discoverability\n5. **Performance Optimization**: Graceful degradation and efficient algorithms for complex operations\n\nThese design choices reflect the constraints of integrating complex auditing tools into a browser environment while maintaining developer productivity and tool effectiveness. The codebase prioritizes robustness, maintainability, and performance across different execution contexts, making it suitable for the demanding requirements of browser-based development tools."}],"string":"[\n {\n \"role\": \"system\",\n \"content\": [\n \"You are an expert software architect writing wiki documentation for codebases.\\nRequirements:\\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\\n4. Explain the WHY behind design decisions, not only the WHAT.\\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\\n7. Example of the correct citation style, inline and attached to a path:\\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon.\"\n ]\n },\n {\n \"role\": \"user\",\n \"content\": \"<START_OF_CONTEXT>\\n# Repository: ChromeDevTools/chrome-devtools-mcp (language: typescript)\\n\\n# Selected files (windows)\\n- src/third_party/lighthouse-devtools-mcp-bundle.js (lines 1-1100 of 58496)\\n- src/tools/categories.ts (33 lines)\\n\\n\\n### FILE: src/third_party/lighthouse-devtools-mcp-bundle.js (lines 1-1100 of 58496)\\n\\n```\\n 1| /**\\n 2| * Lighthouse v13.4.1 (Jul 23 2026)\\n 3| *\\n 4| * Automated auditing, performance metrics, and best practices for the web.\\n 5| *\\n 6| * @homepage https://github.com/GoogleChrome/lighthouse#readme\\n 7| * @author Copyright 2026 Google LLC\\n 8| * @license Apache-2.0\\n 9| *\\n 10| * Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0\\n 11| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\\n 12| */\\n 13| var __create = Object.create;\\n 14| var __defProp = Object.defineProperty;\\n 15| var __getOwnPropDesc = Object.getOwnPropertyDescriptor;\\n 16| var __getOwnPropNames = Object.getOwnPropertyNames;\\n 17| var __getProtoOf = Object.getPrototypeOf;\\n 18| var __hasOwnProp = Object.prototype.hasOwnProperty;\\n 19| var __name = (target, value) => __defProp(target, \\\"name\\\", { value, configurable: true });\\n 20| var __esm = (fn, res) => function __init() {\\n 21| return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;\\n 22| };\\n 23| var __commonJS = (cb, mod2) => function __require() {\\n 24| return mod2 || (0, cb[__getOwnPropNames(cb)[0]])((mod2 = { exports: {} }).exports, mod2), mod2.exports;\\n 25| };\\n 26| var __export = (target, all) => {\\n 27| for (var name in all)\\n 28| __defProp(target, name, { get: all[name], enumerable: true });\\n 29| };\\n 30| var __copyProps = (to, from, except, desc) => {\\n 31| if (from && typeof from === \\\"object\\\" || typeof from === \\\"function\\\") {\\n 32| for (let key of __getOwnPropNames(from))\\n 33| if (!__hasOwnProp.call(to, key) && key !== except)\\n 34| __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });\\n 35| }\\n 36| return to;\\n 37| };\\n 38| var __toESM = (mod2, isNodeMode, target) => (target = mod2 != null ? __create(__getProtoOf(mod2)) : {}, __copyProps(\\n 39| // If the importer is in node compatibility mode or this is not an ESM\\n 40| // file that has been converted to a CommonJS file using a Babel-\\n 41| // compatible transform (i.e. \\\"__esModule\\\" has not been set), then set\\n 42| // \\\"default\\\" to the CommonJS \\\"module.exports\\\" for node compatibility.\\n 43| isNodeMode || !mod2 || !mod2.__esModule ? __defProp(target, \\\"default\\\", { value: mod2, enumerable: true }) : target,\\n 44| mod2\\n 45| ));\\n 46| var __toCommonJS = (mod2) => __copyProps(__defProp({}, \\\"__esModule\\\", { value: true }), mod2);\\n 47| \\n 48| // build/process-global.js\\n 49| import process2 from \\\"process\\\";\\n 50| var init_process_global = __esm({\\n 51| \\\"build/process-global.js\\\"() {\\n 52| \\\"use strict\\\";\\n 53| globalThis.process = process2;\\n 54| }\\n 55| });\\n 56| \\n 57| // types/lh.js\\n 58| var init_lh = __esm({\\n 59| \\\"types/lh.js\\\"() {\\n 60| \\\"use strict\\\";\\n 61| init_process_global();\\n 62| /**\\n 63| * @license\\n 64| * Copyright 2023 Google LLC\\n 65| * SPDX-License-Identifier: Apache-2.0\\n 66| */\\n 67| }\\n 68| });\\n 69| \\n 70| // core/gather/base-gatherer.js\\n 71| var BaseGatherer, base_gatherer_default;\\n 72| var init_base_gatherer = __esm({\\n 73| \\\"core/gather/base-gatherer.js\\\"() {\\n 74| \\\"use strict\\\";\\n 75| init_process_global();\\n 76| init_lh();\\n 77| /**\\n 78| * @license\\n 79| * Copyright 2021 Google LLC\\n 80| * SPDX-License-Identifier: Apache-2.0\\n 81| */\\n 82| BaseGatherer = class {\\n 83| static {\\n 84| __name(this, \\\"BaseGatherer\\\");\\n 85| }\\n 86| /** @type {LH.Gatherer.GathererMeta} */\\n 87| meta = { supportedModes: [] };\\n 88| /**\\n 89| * Method to start observing a page for an arbitrary period of time.\\n 90| * @param {LH.Gatherer.Context} passContext\\n 91| * @return {Promise<void>|void}\\n 92| */\\n 93| startInstrumentation(passContext) {\\n 94| }\\n 95| /**\\n 96| * Method to start observing a page when the measurements are very sensitive and\\n 97| * should observe as little Lighthouse-induced work as possible.\\n 98| * @param {LH.Gatherer.Context} passContext\\n 99| * @return {Promise<void>|void}\\n 100| */\\n 101| startSensitiveInstrumentation(passContext) {\\n 102| }\\n 103| /**\\n 104| * Method to stop observing a page when the measurements are very sensitive and\\n 105| * should observe as little Lighthouse-induced work as possible.\\n 106| *\\n 107| * @param {LH.Gatherer.Context} passContext\\n 108| * @return {Promise<void>|void}\\n 109| */\\n 110| stopSensitiveInstrumentation(passContext) {\\n 111| }\\n 112| /**\\n 113| * Method to end observing a page after an arbitrary period of time.\\n 114| * @param {LH.Gatherer.Context} passContext\\n 115| * @return {Promise<void>|void}\\n 116| */\\n 117| stopInstrumentation(passContext) {\\n 118| }\\n 119| /**\\n 120| * Method to gather results about a page.\\n 121| * @param {LH.Gatherer.Context} passContext\\n 122| * @return {LH.Gatherer.PhaseResult}\\n 123| */\\n 124| getArtifact(passContext) {\\n 125| }\\n 126| };\\n 127| base_gatherer_default = BaseGatherer;\\n 128| }\\n 129| });\\n 130| \\n 131| // node_modules/debug/node_modules/ms/index.js\\n 132| var require_ms = __commonJS({\\n 133| \\\"node_modules/debug/node_modules/ms/index.js\\\"(exports2, module2) {\\n 134| init_process_global();\\n 135| var s = 1e3;\\n 136| var m = s * 60;\\n 137| var h = m * 60;\\n 138| var d = h * 24;\\n 139| var w = d * 7;\\n 140| var y = d * 365.25;\\n 141| module2.exports = function(val, options) {\\n 142| options = options || {};\\n 143| var type = typeof val;\\n 144| if (type === \\\"string\\\" && val.length > 0) {\\n 145| return parse(val);\\n 146| } else if (type === \\\"number\\\" && isFinite(val)) {\\n 147| return options.long ? fmtLong(val) : fmtShort(val);\\n 148| }\\n 149| throw new Error(\\n 150| \\\"val is not a non-empty string or a valid number. val=\\\" + JSON.stringify(val)\\n 151| );\\n 152| };\\n 153| function parse(str) {\\n 154| str = String(str);\\n 155| if (str.length > 100) {\\n 156| return;\\n 157| }\\n 158| var match = /^(-?(?:\\\\d+)?\\\\.?\\\\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i.exec(\\n 159| str\\n 160| );\\n 161| if (!match) {\\n 162| return;\\n 163| }\\n 164| var n = parseFloat(match[1]);\\n 165| var type = (match[2] || \\\"ms\\\").toLowerCase();\\n 166| switch (type) {\\n 167| case \\\"years\\\":\\n 168| case \\\"year\\\":\\n 169| case \\\"yrs\\\":\\n 170| case \\\"yr\\\":\\n 171| case \\\"y\\\":\\n 172| return n * y;\\n 173| case \\\"weeks\\\":\\n 174| case \\\"week\\\":\\n 175| case \\\"w\\\":\\n 176| return n * w;\\n 177| case \\\"days\\\":\\n 178| case \\\"day\\\":\\n 179| case \\\"d\\\":\\n 180| return n * d;\\n 181| case \\\"hours\\\":\\n 182| case \\\"hour\\\":\\n 183| case \\\"hrs\\\":\\n 184| case \\\"hr\\\":\\n 185| case \\\"h\\\":\\n 186| return n * h;\\n 187| case \\\"minutes\\\":\\n 188| case \\\"minute\\\":\\n 189| case \\\"mins\\\":\\n 190| case \\\"min\\\":\\n 191| case \\\"m\\\":\\n 192| return n * m;\\n 193| case \\\"seconds\\\":\\n 194| case \\\"second\\\":\\n 195| case \\\"secs\\\":\\n 196| case \\\"sec\\\":\\n 197| case \\\"s\\\":\\n 198| return n * s;\\n 199| case \\\"milliseconds\\\":\\n 200| case \\\"millisecond\\\":\\n 201| case \\\"msecs\\\":\\n 202| case \\\"msec\\\":\\n 203| case \\\"ms\\\":\\n 204| return n;\\n 205| default:\\n 206| return void 0;\\n 207| }\\n 208| }\\n 209| __name(parse, \\\"parse\\\");\\n 210| function fmtShort(ms) {\\n 211| var msAbs = Math.abs(ms);\\n 212| if (msAbs >= d) {\\n 213| return Math.round(ms / d) + \\\"d\\\";\\n 214| }\\n 215| if (msAbs >= h) {\\n 216| return Math.round(ms / h) + \\\"h\\\";\\n 217| }\\n 218| if (msAbs >= m) {\\n 219| return Math.round(ms / m) + \\\"m\\\";\\n 220| }\\n 221| if (msAbs >= s) {\\n 222| return Math.round(ms / s) + \\\"s\\\";\\n 223| }\\n 224| return ms + \\\"ms\\\";\\n 225| }\\n 226| __name(fmtShort, \\\"fmtShort\\\");\\n 227| function fmtLong(ms) {\\n 228| var msAbs = Math.abs(ms);\\n 229| if (msAbs >= d) {\\n 230| return plural(ms, msAbs, d, \\\"day\\\");\\n 231| }\\n 232| if (msAbs >= h) {\\n 233| return plural(ms, msAbs, h, \\\"hour\\\");\\n 234| }\\n 235| if (msAbs >= m) {\\n 236| return plural(ms, msAbs, m, \\\"minute\\\");\\n 237| }\\n 238| if (msAbs >= s) {\\n 239| return plural(ms, msAbs, s, \\\"second\\\");\\n 240| }\\n 241| return ms + \\\" ms\\\";\\n 242| }\\n 243| __name(fmtLong, \\\"fmtLong\\\");\\n 244| function plural(ms, msAbs, n, name) {\\n 245| var isPlural = msAbs >= n * 1.5;\\n 246| return Math.round(ms / n) + \\\" \\\" + name + (isPlural ? \\\"s\\\" : \\\"\\\");\\n 247| }\\n 248| __name(plural, \\\"plural\\\");\\n 249| }\\n 250| });\\n 251| \\n 252| // node_modules/debug/src/common.js\\n 253| var require_common = __commonJS({\\n 254| \\\"node_modules/debug/src/common.js\\\"(exports2, module2) {\\n 255| init_process_global();\\n 256| function setup(env) {\\n 257| createDebug.debug = createDebug;\\n 258| createDebug.default = createDebug;\\n 259| createDebug.coerce = coerce;\\n 260| createDebug.disable = disable;\\n 261| createDebug.enable = enable;\\n 262| createDebug.enabled = enabled;\\n 263| createDebug.humanize = require_ms();\\n 264| createDebug.destroy = destroy;\\n 265| Object.keys(env).forEach((key) => {\\n 266| createDebug[key] = env[key];\\n 267| });\\n 268| createDebug.names = [];\\n 269| createDebug.skips = [];\\n 270| createDebug.formatters = {};\\n 271| function selectColor(namespace) {\\n 272| let hash = 0;\\n 273| for (let i = 0; i < namespace.length; i++) {\\n 274| hash = (hash << 5) - hash + namespace.charCodeAt(i);\\n 275| hash |= 0;\\n 276| }\\n 277| return createDebug.colors[Math.abs(hash) % createDebug.colors.length];\\n 278| }\\n 279| __name(selectColor, \\\"selectColor\\\");\\n 280| createDebug.selectColor = selectColor;\\n 281| function createDebug(namespace) {\\n 282| let prevTime;\\n 283| let enableOverride = null;\\n 284| let namespacesCache;\\n 285| let enabledCache;\\n 286| function debug2(...args) {\\n 287| if (!debug2.enabled) {\\n 288| return;\\n 289| }\\n 290| const self2 = debug2;\\n 291| const curr = Number(/* @__PURE__ */ new Date());\\n 292| const ms = curr - (prevTime || curr);\\n 293| self2.diff = ms;\\n 294| self2.prev = prevTime;\\n 295| self2.curr = curr;\\n 296| prevTime = curr;\\n 297| args[0] = createDebug.coerce(args[0]);\\n 298| if (typeof args[0] !== \\\"string\\\") {\\n 299| args.unshift(\\\"%O\\\");\\n 300| }\\n 301| let index = 0;\\n 302| args[0] = args[0].replace(/%([a-zA-Z%])/g, (match, format) => {\\n 303| if (match === \\\"%%\\\") {\\n 304| return \\\"%\\\";\\n 305| }\\n 306| index++;\\n 307| const formatter = createDebug.formatters[format];\\n 308| if (typeof formatter === \\\"function\\\") {\\n 309| const val = args[index];\\n 310| match = formatter.call(self2, val);\\n 311| args.splice(index, 1);\\n 312| index--;\\n 313| }\\n 314| return match;\\n 315| });\\n 316| createDebug.formatArgs.call(self2, args);\\n 317| const logFn = self2.log || createDebug.log;\\n 318| logFn.apply(self2, args);\\n 319| }\\n 320| __name(debug2, \\\"debug\\\");\\n 321| debug2.namespace = namespace;\\n 322| debug2.useColors = createDebug.useColors();\\n 323| debug2.color = createDebug.selectColor(namespace);\\n 324| debug2.extend = extend;\\n 325| debug2.destroy = createDebug.destroy;\\n 326| Object.defineProperty(debug2, \\\"enabled\\\", {\\n 327| enumerable: true,\\n 328| configurable: false,\\n 329| get: /* @__PURE__ */ __name(() => {\\n 330| if (enableOverride !== null) {\\n 331| return enableOverride;\\n 332| }\\n 333| if (namespacesCache !== createDebug.namespaces) {\\n 334| namespacesCache = createDebug.namespaces;\\n 335| enabledCache = createDebug.enabled(namespace);\\n 336| }\\n 337| return enabledCache;\\n 338| }, \\\"get\\\"),\\n 339| set: /* @__PURE__ */ __name((v) => {\\n 340| enableOverride = v;\\n 341| }, \\\"set\\\")\\n 342| });\\n 343| if (typeof createDebug.init === \\\"function\\\") {\\n 344| createDebug.init(debug2);\\n 345| }\\n 346| return debug2;\\n 347| }\\n 348| __name(createDebug, \\\"createDebug\\\");\\n 349| function extend(namespace, delimiter) {\\n 350| const newDebug = createDebug(this.namespace + (typeof delimiter === \\\"undefined\\\" ? \\\":\\\" : delimiter) + namespace);\\n 351| newDebug.log = this.log;\\n 352| return newDebug;\\n 353| }\\n 354| __name(extend, \\\"extend\\\");\\n 355| function enable(namespaces) {\\n 356| createDebug.save(namespaces);\\n 357| createDebug.namespaces = namespaces;\\n 358| createDebug.names = [];\\n 359| createDebug.skips = [];\\n 360| let i;\\n 361| const split = (typeof namespaces === \\\"string\\\" ? namespaces : \\\"\\\").split(/[\\\\s,]+/);\\n 362| const len = split.length;\\n 363| for (i = 0; i < len; i++) {\\n 364| if (!split[i]) {\\n 365| continue;\\n 366| }\\n 367| namespaces = split[i].replace(/\\\\*/g, \\\".*?\\\");\\n 368| if (namespaces[0] === \\\"-\\\") {\\n 369| createDebug.skips.push(new RegExp(\\\"^\\\" + namespaces.slice(1) + \\\"$\\\"));\\n 370| } else {\\n 371| createDebug.names.push(new RegExp(\\\"^\\\" + namespaces + \\\"$\\\"));\\n 372| }\\n 373| }\\n 374| }\\n 375| __name(enable, \\\"enable\\\");\\n 376| function disable() {\\n 377| const namespaces = [\\n 378| ...createDebug.names.map(toNamespace),\\n 379| ...createDebug.skips.map(toNamespace).map((namespace) => \\\"-\\\" + namespace)\\n 380| ].join(\\\",\\\");\\n 381| createDebug.enable(\\\"\\\");\\n 382| return namespaces;\\n 383| }\\n 384| __name(disable, \\\"disable\\\");\\n 385| function enabled(name) {\\n 386| if (name[name.length - 1] === \\\"*\\\") {\\n 387| return true;\\n 388| }\\n 389| let i;\\n 390| let len;\\n 391| for (i = 0, len = createDebug.skips.length; i < len; i++) {\\n 392| if (createDebug.skips[i].test(name)) {\\n 393| return false;\\n 394| }\\n 395| }\\n 396| for (i = 0, len = createDebug.names.length; i < len; i++) {\\n 397| if (createDebug.names[i].test(name)) {\\n 398| return true;\\n 399| }\\n 400| }\\n 401| return false;\\n 402| }\\n 403| __name(enabled, \\\"enabled\\\");\\n 404| function toNamespace(regexp) {\\n 405| return regexp.toString().substring(2, regexp.toString().length - 2).replace(/\\\\.\\\\*\\\\?$/, \\\"*\\\");\\n 406| }\\n 407| __name(toNamespace, \\\"toNamespace\\\");\\n 408| function coerce(val) {\\n 409| if (val instanceof Error) {\\n 410| return val.stack || val.message;\\n 411| }\\n 412| return val;\\n 413| }\\n 414| __name(coerce, \\\"coerce\\\");\\n 415| function destroy() {\\n 416| console.warn(\\\"Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.\\\");\\n 417| }\\n 418| __name(destroy, \\\"destroy\\\");\\n 419| createDebug.enable(createDebug.load());\\n 420| return createDebug;\\n 421| }\\n 422| __name(setup, \\\"setup\\\");\\n 423| module2.exports = setup;\\n 424| }\\n 425| });\\n 426| \\n 427| // node_modules/debug/src/browser.js\\n 428| var require_browser = __commonJS({\\n 429| \\\"node_modules/debug/src/browser.js\\\"(exports2, module2) {\\n 430| init_process_global();\\n 431| exports2.formatArgs = formatArgs;\\n 432| exports2.save = save;\\n 433| exports2.load = load;\\n 434| exports2.useColors = useColors;\\n 435| exports2.storage = localstorage();\\n 436| exports2.destroy = /* @__PURE__ */ (() => {\\n 437| let warned = false;\\n 438| return () => {\\n 439| if (!warned) {\\n 440| warned = true;\\n 441| console.warn(\\\"Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.\\\");\\n 442| }\\n 443| };\\n 444| })();\\n 445| exports2.colors = [\\n 446| \\\"#0000CC\\\",\\n 447| \\\"#0000FF\\\",\\n 448| \\\"#0033CC\\\",\\n 449| \\\"#0033FF\\\",\\n 450| \\\"#0066CC\\\",\\n 451| \\\"#0066FF\\\",\\n 452| \\\"#0099CC\\\",\\n 453| \\\"#0099FF\\\",\\n 454| \\\"#00CC00\\\",\\n 455| \\\"#00CC33\\\",\\n 456| \\\"#00CC66\\\",\\n 457| \\\"#00CC99\\\",\\n 458| \\\"#00CCCC\\\",\\n 459| \\\"#00CCFF\\\",\\n 460| \\\"#3300CC\\\",\\n 461| \\\"#3300FF\\\",\\n 462| \\\"#3333CC\\\",\\n 463| \\\"#3333FF\\\",\\n 464| \\\"#3366CC\\\",\\n 465| \\\"#3366FF\\\",\\n 466| \\\"#3399CC\\\",\\n 467| \\\"#3399FF\\\",\\n 468| \\\"#33CC00\\\",\\n 469| \\\"#33CC33\\\",\\n 470| \\\"#33CC66\\\",\\n 471| \\\"#33CC99\\\",\\n 472| \\\"#33CCCC\\\",\\n 473| \\\"#33CCFF\\\",\\n 474| \\\"#6600CC\\\",\\n 475| \\\"#6600FF\\\",\\n 476| \\\"#6633CC\\\",\\n 477| \\\"#6633FF\\\",\\n 478| \\\"#66CC00\\\",\\n 479| \\\"#66CC33\\\",\\n 480| \\\"#9900CC\\\",\\n 481| \\\"#9900FF\\\",\\n 482| \\\"#9933CC\\\",\\n 483| \\\"#9933FF\\\",\\n 484| \\\"#99CC00\\\",\\n 485| \\\"#99CC33\\\",\\n 486| \\\"#CC0000\\\",\\n 487| \\\"#CC0033\\\",\\n 488| \\\"#CC0066\\\",\\n 489| \\\"#CC0099\\\",\\n 490| \\\"#CC00CC\\\",\\n 491| \\\"#CC00FF\\\",\\n 492| \\\"#CC3300\\\",\\n 493| \\\"#CC3333\\\",\\n 494| \\\"#CC3366\\\",\\n 495| \\\"#CC3399\\\",\\n 496| \\\"#CC33CC\\\",\\n 497| \\\"#CC33FF\\\",\\n 498| \\\"#CC6600\\\",\\n 499| \\\"#CC6633\\\",\\n 500| \\\"#CC9900\\\",\\n 501| \\\"#CC9933\\\",\\n 502| \\\"#CCCC00\\\",\\n 503| \\\"#CCCC33\\\",\\n 504| \\\"#FF0000\\\",\\n 505| \\\"#FF0033\\\",\\n 506| \\\"#FF0066\\\",\\n 507| \\\"#FF0099\\\",\\n 508| \\\"#FF00CC\\\",\\n 509| \\\"#FF00FF\\\",\\n 510| \\\"#FF3300\\\",\\n 511| \\\"#FF3333\\\",\\n 512| \\\"#FF3366\\\",\\n 513| \\\"#FF3399\\\",\\n 514| \\\"#FF33CC\\\",\\n 515| \\\"#FF33FF\\\",\\n 516| \\\"#FF6600\\\",\\n 517| \\\"#FF6633\\\",\\n 518| \\\"#FF9900\\\",\\n 519| \\\"#FF9933\\\",\\n 520| \\\"#FFCC00\\\",\\n 521| \\\"#FFCC33\\\"\\n 522| ];\\n 523| function useColors() {\\n 524| if (typeof window !== \\\"undefined\\\" && window.process && (window.process.type === \\\"renderer\\\" || window.process.__nwjs)) {\\n 525| return true;\\n 526| }\\n 527| if (typeof navigator !== \\\"undefined\\\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\\\\/(\\\\d+)/)) {\\n 528| return false;\\n 529| }\\n 530| return typeof document !== \\\"undefined\\\" && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance || // Is firebug? http://stackoverflow.com/a/398120/376773\\n 531| typeof window !== \\\"undefined\\\" && window.console && (window.console.firebug || window.console.exception && window.console.table) || // Is firefox >= v31?\\n 532| // https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages\\n 533| typeof navigator !== \\\"undefined\\\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\\\\/(\\\\d+)/) && parseInt(RegExp.$1, 10) >= 31 || // Double check webkit in userAgent just in case we are in a worker\\n 534| typeof navigator !== \\\"undefined\\\" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\\\\/(\\\\d+)/);\\n 535| }\\n 536| __name(useColors, \\\"useColors\\\");\\n 537| function formatArgs(args) {\\n 538| args[0] = (this.useColors ? \\\"%c\\\" : \\\"\\\") + this.namespace + (this.useColors ? \\\" %c\\\" : \\\" \\\") + args[0] + (this.useColors ? \\\"%c \\\" : \\\" \\\") + \\\"+\\\" + module2.exports.humanize(this.diff);\\n 539| if (!this.useColors) {\\n 540| return;\\n 541| }\\n 542| const c = \\\"color: \\\" + this.color;\\n 543| args.splice(1, 0, c, \\\"color: inherit\\\");\\n 544| let index = 0;\\n 545| let lastC = 0;\\n 546| args[0].replace(/%[a-zA-Z%]/g, (match) => {\\n 547| if (match === \\\"%%\\\") {\\n 548| return;\\n 549| }\\n 550| index++;\\n 551| if (match === \\\"%c\\\") {\\n 552| lastC = index;\\n 553| }\\n 554| });\\n 555| args.splice(lastC, 0, c);\\n 556| }\\n 557| __name(formatArgs, \\\"formatArgs\\\");\\n 558| exports2.log = console.debug || console.log || (() => {\\n 559| });\\n 560| function save(namespaces) {\\n 561| try {\\n 562| if (namespaces) {\\n 563| exports2.storage.setItem(\\\"debug\\\", namespaces);\\n 564| } else {\\n 565| exports2.storage.removeItem(\\\"debug\\\");\\n 566| }\\n 567| } catch (error) {\\n 568| }\\n 569| }\\n 570| __name(save, \\\"save\\\");\\n 571| function load() {\\n 572| let r;\\n 573| try {\\n 574| r = exports2.storage.getItem(\\\"debug\\\");\\n 575| } catch (error) {\\n 576| }\\n 577| if (!r && typeof process !== \\\"undefined\\\" && \\\"env\\\" in process) {\\n 578| r = process.env.DEBUG;\\n 579| }\\n 580| return r;\\n 581| }\\n 582| __name(load, \\\"load\\\");\\n 583| function localstorage() {\\n 584| try {\\n 585| return localStorage;\\n 586| } catch (error) {\\n 587| }\\n 588| }\\n 589| __name(localstorage, \\\"localstorage\\\");\\n 590| module2.exports = require_common()(exports2);\\n 591| var { formatters } = module2.exports;\\n 592| formatters.j = function(v) {\\n 593| try {\\n 594| return JSON.stringify(v);\\n 595| } catch (error) {\\n 596| return \\\"[UnexpectedJSONParseError]: \\\" + error.message;\\n 597| }\\n 598| };\\n 599| }\\n 600| });\\n 601| \\n 602| // node_modules/marky/lib/marky.cjs.js\\n 603| var require_marky_cjs = __commonJS({\\n 604| \\\"node_modules/marky/lib/marky.cjs.js\\\"(exports2) {\\n 605| \\\"use strict\\\";\\n 606| init_process_global();\\n 607| Object.defineProperty(exports2, \\\"__esModule\\\", { value: true });\\n 608| var perf = typeof performance !== \\\"undefined\\\" && performance;\\n 609| var nowForNode;\\n 610| {\\n 611| hrtime = process.hrtime;\\n 612| getNanoSeconds = /* @__PURE__ */ __name(function() {\\n 613| var hr = hrtime();\\n 614| return hr[0] * 1e9 + hr[1];\\n 615| }, \\\"getNanoSeconds\\\");\\n 616| loadTime = getNanoSeconds();\\n 617| nowForNode = /* @__PURE__ */ __name(function() {\\n 618| return (getNanoSeconds() - loadTime) / 1e6;\\n 619| }, \\\"nowForNode\\\");\\n 620| }\\n 621| var hrtime;\\n 622| var getNanoSeconds;\\n 623| var loadTime;\\n 624| var now = nowForNode;\\n 625| function throwIfEmpty(name) {\\n 626| if (!name) {\\n 627| throw new Error(\\\"name must be non-empty\\\");\\n 628| }\\n 629| }\\n 630| __name(throwIfEmpty, \\\"throwIfEmpty\\\");\\n 631| function insertSorted(arr, item) {\\n 632| var low = 0;\\n 633| var high = arr.length;\\n 634| var mid;\\n 635| while (low < high) {\\n 636| mid = low + high >>> 1;\\n 637| if (arr[mid].startTime < item.startTime) {\\n 638| low = mid + 1;\\n 639| } else {\\n 640| high = mid;\\n 641| }\\n 642| }\\n 643| arr.splice(low, 0, item);\\n 644| }\\n 645| __name(insertSorted, \\\"insertSorted\\\");\\n 646| exports2.mark = void 0;\\n 647| exports2.stop = void 0;\\n 648| exports2.getEntries = void 0;\\n 649| exports2.clear = void 0;\\n 650| if (perf && perf.mark && perf.getEntriesByName && perf.getEntriesByType && perf.clearMeasures) {\\n 651| exports2.mark = function(name) {\\n 652| throwIfEmpty(name);\\n 653| perf.mark(\\\"start \\\" + name);\\n 654| };\\n 655| exports2.stop = function(name) {\\n 656| throwIfEmpty(name);\\n 657| perf.mark(\\\"end \\\" + name);\\n 658| perf.measure(name, \\\"start \\\" + name, \\\"end \\\" + name);\\n 659| var entries2 = perf.getEntriesByName(name);\\n 660| return entries2[entries2.length - 1];\\n 661| };\\n 662| exports2.getEntries = function() {\\n 663| return perf.getEntriesByType(\\\"measure\\\");\\n 664| };\\n 665| exports2.clear = function() {\\n 666| perf.clearMarks();\\n 667| perf.clearMeasures();\\n 668| };\\n 669| } else {\\n 670| marks = {};\\n 671| entries = [];\\n 672| exports2.mark = function(name) {\\n 673| throwIfEmpty(name);\\n 674| var startTime = now();\\n 675| marks[\\\"$\\\" + name] = startTime;\\n 676| };\\n 677| exports2.stop = function(name) {\\n 678| throwIfEmpty(name);\\n 679| var endTime = now();\\n 680| var startTime = marks[\\\"$\\\" + name];\\n 681| if (!startTime) {\\n 682| throw new Error(\\\"no known mark: \\\" + name);\\n 683| }\\n 684| var entry = {\\n 685| startTime,\\n 686| name,\\n 687| duration: endTime - startTime,\\n 688| entryType: \\\"measure\\\"\\n 689| };\\n 690| insertSorted(entries, entry);\\n 691| return entry;\\n 692| };\\n 693| exports2.getEntries = function() {\\n 694| return entries;\\n 695| };\\n 696| exports2.clear = function() {\\n 697| marks = {};\\n 698| entries = [];\\n 699| };\\n 700| }\\n 701| var marks;\\n 702| var entries;\\n 703| }\\n 704| });\\n 705| \\n 706| // lighthouse-logger/index.js\\n 707| import process3 from \\\"process\\\";\\n 708| import { EventEmitter } from \\\"events\\\";\\n 709| var import_debug, marky, isWindows, isBrowser, colors, Emitter, loggersByTitle, loggingBufferColumns, level_, Log, lighthouse_logger_default;\\n 710| var init_lighthouse_logger = __esm({\\n 711| \\\"lighthouse-logger/index.js\\\"() {\\n 712| \\\"use strict\\\";\\n 713| init_process_global();\\n 714| import_debug = __toESM(require_browser(), 1);\\n 715| marky = __toESM(require_marky_cjs(), 1);\\n 716| /**\\n 717| * @license\\n 718| * Copyright 2016 Google LLC\\n 719| * SPDX-License-Identifier: Apache-2.0\\n 720| */\\n 721| isWindows = process3.platform === \\\"win32\\\";\\n 722| isBrowser = process3.browser;\\n 723| colors = {\\n 724| red: isBrowser ? \\\"crimson\\\" : 1,\\n 725| yellow: isBrowser ? \\\"gold\\\" : 3,\\n 726| cyan: isBrowser ? \\\"darkturquoise\\\" : 6,\\n 727| green: isBrowser ? \\\"forestgreen\\\" : 2,\\n 728| blue: isBrowser ? \\\"steelblue\\\" : 4,\\n 729| magenta: isBrowser ? \\\"palevioletred\\\" : 5\\n 730| };\\n 731| import_debug.default.colors = [colors.cyan, colors.green, colors.blue, colors.magenta];\\n 732| Emitter = class extends EventEmitter {\\n 733| static {\\n 734| __name(this, \\\"Emitter\\\");\\n 735| }\\n 736| // yarn build-types fails without this!\\n 737| // https://github.com/microsoft/TypeScript/issues/41672#issuecomment-2303803072\\n 738| constructor(options) {\\n 739| super(options);\\n 740| }\\n 741| /**\\n 742| * Fires off all status updates. Listen with\\n 743| * `require('lib/log').events.addListener('status', callback)`\\n 744| * @param {string} title\\n 745| * @param {!Array<*>} argsArray\\n 746| */\\n 747| issueStatus(title, argsArray) {\\n 748| if (title === \\\"status\\\" || title === \\\"statusEnd\\\") {\\n 749| this.emit(title, [title, ...argsArray]);\\n 750| }\\n 751| }\\n 752| /**\\n 753| * Fires off all warnings. Listen with\\n 754| * `require('lib/log').events.addListener('warning', callback)`\\n 755| * @param {string} title\\n 756| * @param {!Array<*>} argsArray\\n 757| */\\n 758| issueWarning(title, argsArray) {\\n 759| this.emit(\\\"warning\\\", [title, ...argsArray]);\\n 760| }\\n 761| };\\n 762| loggersByTitle = {};\\n 763| loggingBufferColumns = 25;\\n 764| Log = class _Log {\\n 765| static {\\n 766| __name(this, \\\"Log\\\");\\n 767| }\\n 768| static _logToStdErr(title, argsArray) {\\n 769| const log = _Log.loggerfn(title);\\n 770| log(...argsArray);\\n 771| }\\n 772| /**\\n 773| * @param {string} title\\n 774| */\\n 775| static loggerfn(title) {\\n 776| title = `LH:${title}`;\\n 777| let log = loggersByTitle[title];\\n 778| if (!log) {\\n 779| log = (0, import_debug.default)(title);\\n 780| loggersByTitle[title] = log;\\n 781| if (title.endsWith(\\\"error\\\")) {\\n 782| log.color = colors.red;\\n 783| } else if (title.endsWith(\\\"warn\\\")) {\\n 784| log.color = colors.yellow;\\n 785| }\\n 786| }\\n 787| return log;\\n 788| }\\n 789| /**\\n 790| * @param {string} level\\n 791| */\\n 792| static setLevel(level) {\\n 793| level_ = level;\\n 794| switch (level) {\\n 795| case \\\"silent\\\":\\n 796| import_debug.default.enable(\\\"-LH:*\\\");\\n 797| break;\\n 798| case \\\"verbose\\\":\\n 799| import_debug.default.enable(\\\"LH:*\\\");\\n 800| break;\\n 801| case \\\"warn\\\":\\n 802| import_debug.default.enable(\\\"-LH:*, LH:*:warn, LH:*:error\\\");\\n 803| break;\\n 804| case \\\"error\\\":\\n 805| import_debug.default.enable(\\\"-LH:*, LH:*:error\\\");\\n 806| break;\\n 807| default:\\n 808| import_debug.default.enable(\\\"LH:*, -LH:*:verbose\\\");\\n 809| }\\n 810| }\\n 811| /**\\n 812| * A simple formatting utility for event logging.\\n 813| * @param {string} prefix\\n 814| * @param {!Object} data A JSON-serializable object of event data to log.\\n 815| * @param {string=} level Optional logging level. Defaults to 'log'.\\n 816| */\\n 817| static formatProtocol(prefix, data31, level) {\\n 818| const columns = !process3 || process3.browser ? Infinity : process3.stdout.columns;\\n 819| const method = data31.method || \\\"?????\\\";\\n 820| const maxLength = columns - method.length - prefix.length - loggingBufferColumns;\\n 821| const snippet = data31.params && method !== \\\"IO.read\\\" ? JSON.stringify(data31.params).substr(0, maxLength) : \\\"\\\";\\n 822| _Log._logToStdErr(`${prefix}:${level || \\\"\\\"}`, [method, snippet]);\\n 823| }\\n 824| /**\\n 825| * @return {boolean}\\n 826| */\\n 827| static isVerbose() {\\n 828| return level_ === \\\"verbose\\\";\\n 829| }\\n 830| /**\\n 831| * @param {{msg: string, id: string, args?: any[]}} status\\n 832| * @param {string} level\\n 833| */\\n 834| static time({ msg, id, args = [] }, level = \\\"log\\\") {\\n 835| marky.mark(id);\\n 836| _Log[level](\\\"status\\\", msg, ...args);\\n 837| }\\n 838| /**\\n 839| * @param {{msg: string, id: string, args?: any[]}} status\\n 840| * @param {string} level\\n 841| */\\n 842| static timeEnd({ msg, id, args = [] }, level = \\\"verbose\\\") {\\n 843| _Log[level](\\\"statusEnd\\\", msg, ...args);\\n 844| marky.stop(id);\\n 845| }\\n 846| /**\\n 847| * @param {string} title\\n 848| * @param {...any} args\\n 849| */\\n 850| static log(title, ...args) {\\n 851| _Log.events.issueStatus(title, args);\\n 852| return _Log._logToStdErr(title, args);\\n 853| }\\n 854| /**\\n 855| * @param {string} title\\n 856| * @param {...any} args\\n 857| */\\n 858| static warn(title, ...args) {\\n 859| _Log.events.issueWarning(title, args);\\n 860| return _Log._logToStdErr(`${title}:warn`, args);\\n 861| }\\n 862| /**\\n 863| * @param {string} title\\n 864| * @param {...any} args\\n 865| */\\n 866| static error(title, ...args) {\\n 867| return _Log._logToStdErr(`${title}:error`, args);\\n 868| }\\n 869| /**\\n 870| * @param {string} title\\n 871| * @param {...any} args\\n 872| */\\n 873| static verbose(title, ...args) {\\n 874| _Log.events.issueStatus(title, args);\\n 875| return _Log._logToStdErr(`${title}:verbose`, args);\\n 876| }\\n 877| /**\\n 878| * Add surrounding escape sequences to turn a string green when logged.\\n 879| * @param {string} str\\n 880| * @return {string}\\n 881| */\\n 882| static greenify(str) {\\n 883| return `${_Log.green}${str}${_Log.reset}`;\\n 884| }\\n 885| /**\\n 886| * Add surrounding escape sequences to turn a string red when logged.\\n 887| * @param {string} str\\n 888| * @return {string}\\n 889| */\\n 890| static redify(str) {\\n 891| return `${_Log.red}${str}${_Log.reset}`;\\n 892| }\\n 893| static get green() {\\n 894| return \\\"\\\\x1B[32m\\\";\\n 895| }\\n 896| static get red() {\\n 897| return \\\"\\\\x1B[31m\\\";\\n 898| }\\n 899| static get yellow() {\\n 900| return \\\"\\\\x1B[33m\\\";\\n 901| }\\n 902| static get purple() {\\n 903| return \\\"\\\\x1B[95m\\\";\\n 904| }\\n 905| static get reset() {\\n 906| return \\\"\\\\x1B[0m\\\";\\n 907| }\\n 908| static get bold() {\\n 909| return \\\"\\\\x1B[1m\\\";\\n 910| }\\n 911| static get dim() {\\n 912| return \\\"\\\\x1B[2m\\\";\\n 913| }\\n 914| static get tick() {\\n 915| return isWindows ? \\\"√\\\" : \\\"✓\\\";\\n 916| }\\n 917| static get cross() {\\n 918| return isWindows ? \\\"×\\\" : \\\"✘\\\";\\n 919| }\\n 920| static get whiteSmallSquare() {\\n 921| return isWindows ? \\\"·\\\" : \\\"▫\\\";\\n 922| }\\n 923| static get heavyHorizontal() {\\n 924| return isWindows ? \\\"─\\\" : \\\"━\\\";\\n 925| }\\n 926| static get heavyVertical() {\\n 927| return isWindows ? \\\"│ \\\" : \\\"┃ \\\";\\n 928| }\\n 929| static get heavyUpAndRight() {\\n 930| return isWindows ? \\\"└\\\" : \\\"┗\\\";\\n 931| }\\n 932| static get heavyVerticalAndRight() {\\n 933| return isWindows ? \\\"├\\\" : \\\"┣\\\";\\n 934| }\\n 935| static get heavyDownAndHorizontal() {\\n 936| return isWindows ? \\\"┬\\\" : \\\"┳\\\";\\n 937| }\\n 938| static get doubleLightHorizontal() {\\n 939| return \\\"──\\\";\\n 940| }\\n 941| };\\n 942| Log.events = new Emitter();\\n 943| Log.takeTimeEntries = () => {\\n 944| const entries = marky.getEntries();\\n 945| marky.clear();\\n 946| return entries;\\n 947| };\\n 948| Log.getTimeEntries = () => marky.getEntries();\\n 949| lighthouse_logger_default = Log;\\n 950| }\\n 951| });\\n 952| \\n 953| // core/lib/tracehouse/trace-processor.js\\n 954| var ACCEPTABLE_NAVIGATION_URL_REGEX, BASE_RESPONSE_LATENCY, SCHEDULABLE_TASK_TITLE_LH, SCHEDULABLE_TASK_TITLE_ALT1, SCHEDULABLE_TASK_TITLE_ALT2, SCHEDULABLE_TASK_TITLE_ALT3, TraceProcessor;\\n 955| var init_trace_processor = __esm({\\n 956| \\\"core/lib/tracehouse/trace-processor.js\\\"() {\\n 957| \\\"use strict\\\";\\n 958| init_process_global();\\n 959| init_lighthouse_logger();\\n 960| /**\\n 961| * @license\\n 962| * Copyright 2017 Google LLC\\n 963| * SPDX-License-Identifier: Apache-2.0\\n 964| */\\n 965| ACCEPTABLE_NAVIGATION_URL_REGEX = /^(chrome|https?):/;\\n 966| BASE_RESPONSE_LATENCY = 16;\\n 967| SCHEDULABLE_TASK_TITLE_LH = \\\"RunTask\\\";\\n 968| SCHEDULABLE_TASK_TITLE_ALT1 = \\\"ThreadControllerImpl::RunTask\\\";\\n 969| SCHEDULABLE_TASK_TITLE_ALT2 = \\\"ThreadControllerImpl::DoWork\\\";\\n 970| SCHEDULABLE_TASK_TITLE_ALT3 = \\\"TaskQueueManager::ProcessTaskFromWorkQueue\\\";\\n 971| TraceProcessor = class _TraceProcessor {\\n 972| static {\\n 973| __name(this, \\\"TraceProcessor\\\");\\n 974| }\\n 975| static get TIMESPAN_MARKER_ID() {\\n 976| return \\\"__lighthouseTimespanStart__\\\";\\n 977| }\\n 978| /**\\n 979| * @return {Error}\\n 980| */\\n 981| static createNoNavstartError() {\\n 982| return new Error(\\\"No navigationStart event found\\\");\\n 983| }\\n 984| /**\\n 985| * @return {Error}\\n 986| */\\n 987| static createNoResourceSendRequestError() {\\n 988| return new Error(\\\"No ResourceSendRequest event found\\\");\\n 989| }\\n 990| /**\\n 991| * @return {Error}\\n 992| */\\n 993| static createNoTracingStartedError() {\\n 994| return new Error(\\\"No tracingStartedInBrowser event found\\\");\\n 995| }\\n 996| /**\\n 997| * @return {Error}\\n 998| */\\n 999| static createNoFirstContentfulPaintError() {\\n1000| return new Error(\\\"No FirstContentfulPaint event found\\\");\\n1001| }\\n1002| /**\\n1003| * @return {Error}\\n1004| */\\n1005| static createNoLighthouseMarkerError() {\\n1006| return new Error(\\\"No Lighthouse timespan marker event found\\\");\\n1007| }\\n1008| /**\\n1009| * Returns true if the event is a navigation start event of a document whose URL seems valid.\\n1010| *\\n1011| * @param {LH.TraceEvent} event\\n1012| * @return {boolean}\\n1013| */\\n1014| static _isNavigationStartOfInterest(event) {\\n1015| if (event.name !== \\\"navigationStart\\\") return false;\\n1016| if (event.args.data?.documentLoaderURL === void 0) return true;\\n1017| if (!event.args.data?.documentLoaderURL) return false;\\n1018| return ACCEPTABLE_NAVIGATION_URL_REGEX.test(event.args.data.documentLoaderURL);\\n1019| }\\n1020| /**\\n1021| * This method sorts a group of trace events that have the same timestamp. We want to...\\n1022| *\\n1023| * 1. Put E events first, we finish off our existing events before we start new ones.\\n1024| * 2. Order B/X events by their duration, we want parents to start before child events.\\n1025| * 3. If we don't have any of this to go on, just use the position in the original array (stable sort).\\n1026| *\\n1027| * Note that the typical group size with the same timestamp will be quite small (<10 or so events),\\n1028| * and the number of groups typically ~1% of total trace, so the same ultra-performance-sensitive consideration\\n1029| * given to functions that run on entire traces does not necessarily apply here.\\n1030| *\\n1031| * @param {number[]} tsGroupIndices\\n1032| * @param {number[]} timestampSortedIndices\\n1033| * @param {number} indexOfTsGroupIndicesStart\\n1034| * @param {LH.TraceEvent[]} traceEvents\\n1035| * @return {number[]}\\n1036| */\\n1037| static _sortTimestampEventGroup(tsGroupIndices, timestampSortedIndices, indexOfTsGroupIndicesStart, traceEvents) {\\n1038| const lookupArrayIndexByTsIndex = /* @__PURE__ */ __name((i) => timestampSortedIndices[i], \\\"lookupArrayIndexByTsIndex\\\");\\n1039| const lookupEventByTsIndex = /* @__PURE__ */ __name((i) => traceEvents[lookupArrayIndexByTsIndex(i)], \\\"lookupEventByTsIndex\\\");\\n1040| const eEventIndices = [];\\n1041| const bxEventIndices = [];\\n1042| const otherEventIndices = [];\\n1043| for (const tsIndex of tsGroupIndices) {\\n1044| const arrayIndex = lookupArrayIndexByTsIndex(tsIndex);\\n1045| const event = lookupEventByTsIndex(tsIndex);\\n1046| if (event.ph === \\\"E\\\") eEventIndices.push(arrayIndex);\\n1047| else if (event.ph === \\\"X\\\" || event.ph === \\\"B\\\") bxEventIndices.push(arrayIndex);\\n1048| else otherEventIndices.push(arrayIndex);\\n1049| }\\n1050| const effectiveDuration = /* @__PURE__ */ new Map();\\n1051| for (const index of bxEventIndices) {\\n1052| const event = traceEvents[index];\\n1053| if (event.ph === \\\"X\\\") {\\n1054| effectiveDuration.set(index, event.dur);\\n1055| } else {\\n1056| let duration = Number.MAX_SAFE_INTEGER;\\n1057| let additionalNestedEventsWithSameName = 0;\\n1058| const startIndex = indexOfTsGroupIndicesStart + tsGroupIndices.length;\\n1059| for (let j = startIndex; j < timestampSortedIndices.length; j++) {\\n1060| const potentialMatchingEvent = lookupEventByTsIndex(j);\\n1061| const eventMatches = potentialMatchingEvent.name === event.name && potentialMatchingEvent.pid === event.pid && potentialMatchingEvent.tid === event.tid;\\n1062| if (!eventMatches) continue;\\n1063| if (potentialMatchingEvent.ph === \\\"E\\\" && additionalNestedEventsWithSameName === 0) {\\n1064| duration = potentialMatchingEvent.ts - event.ts;\\n1065| break;\\n1066| } else if (potentialMatchingEvent.ph === \\\"E\\\") {\\n1067| additionalNestedEventsWithSameName--;\\n1068| } else if (potentialMatchingEvent.ph === \\\"B\\\") {\\n1069| additionalNestedEventsWithSameName++;\\n1070| }\\n1071| }\\n1072| effectiveDuration.set(index, duration);\\n1073| }\\n1074| }\\n1075| bxEventIndices.sort((indexA, indexB) => (effectiveDuration.get(indexB) || 0) - (effectiveDuration.get(indexA) || 0) || indexA - indexB);\\n1076| otherEventIndices.sort((indexA, indexB) => indexA - indexB);\\n1077| return [...eEventIndices, ...bxEventIndices, ...otherEventIndices];\\n1078| }\\n1079| /**\\n1080| * Sorts and filters trace events by timestamp and respecting the nesting structure inherent to\\n1081| * parent/child event relationships.\\n1082| *\\n1083| * @param {LH.TraceEvent[]} traceEvents\\n1084| * @param {(e: LH.TraceEvent) => boolean} filter\\n1085| */\\n1086| static filteredTraceSort(traceEvents, filter) {\\n1087| const indices = [];\\n1088| for (let srcIndex = 0; srcIndex < traceEvents.length; srcIndex++) {\\n1089| if (filter(traceEvents[srcIndex])) {\\n1090| indices.push(srcIndex);\\n1091| }\\n1092| }\\n1093| indices.sort((indexA, indexB) => traceEvents[indexA].ts - traceEvents[indexB].ts);\\n1094| for (let i = 0; i < indices.length - 1; i++) {\\n1095| const ts = traceEvents[indices[i]].ts;\\n1096| const tsGroupIndices = [i];\\n1097| for (let j = i + 1; j < indices.length; j++) {\\n1098| if (traceEvents[indices[j]].ts !== ts) break;\\n1099| tsGroupIndices.push(j);\\n1100| }\\n```\\n\\n### FILE: src/tools/categories.ts (33 lines)\\n\\n```\\n 1| /**\\n 2| * @license\\n 3| * Copyright 2025 Google LLC\\n 4| * SPDX-License-Identifier: Apache-2.0\\n 5| */\\n 6| \\n 7| export enum ToolCategory {\\n 8| INPUT = 'input',\\n 9| NAVIGATION = 'navigation',\\n 10| EMULATION = 'emulation',\\n 11| PERFORMANCE = 'performance',\\n 12| NETWORK = 'network',\\n 13| DEBUGGING = 'debugging',\\n 14| EXTENSIONS = 'extensions',\\n 15| THIRD_PARTY = 'experimentalThirdParty',\\n 16| MEMORY = 'memory',\\n 17| WEBMCP = 'experimentalWebmcp',\\n 18| PWA = 'pwa',\\n 19| }\\n 20| \\n 21| export const labels = {\\n 22| [ToolCategory.INPUT]: 'Input automation',\\n 23| [ToolCategory.NAVIGATION]: 'Navigation automation',\\n 24| [ToolCategory.EMULATION]: 'Emulation',\\n 25| [ToolCategory.PERFORMANCE]: 'Performance',\\n 26| [ToolCategory.NETWORK]: 'Network',\\n 27| [ToolCategory.DEBUGGING]: 'Debugging',\\n 28| [ToolCategory.EXTENSIONS]: 'Extensions',\\n 29| [ToolCategory.THIRD_PARTY]: 'Third-party',\\n 30| [ToolCategory.MEMORY]: 'Memory',\\n 31| [ToolCategory.WEBMCP]: 'WebMCP',\\n 32| [ToolCategory.PWA]: 'Progressive Web Apps',\\n 33| };\\n```\\n<END_OF_CONTEXT>\\n\\n<query>\\nGenerate a wiki page explaining WHY this codebase is designed the way it is: the constraints it balances, the patterns it uses and what problems they solve, and the trade-offs visible in the code.\\n</query>\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"# Chrome DevTools MCP Codebase Design Analysis\\n\\n## Overview\\n\\nThis codebase implements the Chrome DevTools Multi-Client Protocol (MCP) integration, specifically focusing on Lighthouse auditing capabilities within the Chrome DevTools environment. The repository contains a bundled Lighthouse version (`lighthouse-devtools-mcp-bundle.js`) and tool categorization definitions (`categories.ts`). The design balances several constraints including browser compatibility, performance requirements, modular architecture, and tool categorization for developer experience.\\n\\n## Detailed Analysis\\n\\n### Core Architecture and Constraints\\n\\nThe codebase demonstrates a modular architecture that integrates Lighthouse auditing capabilities into Chrome DevTools. The `lighthouse-devtools-mcp-bundle.js` file is a substantial bundle that includes Lighthouse core components, which suggests a design choice to bundle dependencies rather than rely on external module resolution. This approach reduces runtime complexity and ensures consistent behavior across different environments.\\n\\nThe design pattern of using `__esm` and `__commonJS` wrappers (`src/third_party/lighthouse-devtools-mcp-bundle.js:20-25`) indicates a transpilation strategy that maintains compatibility with both ES modules and CommonJS environments. This is particularly important for Chrome DevTools integration where runtime environments can vary significantly.\\n\\n```mermaid\\nflowchart TD\\n A[Chrome DevTools] --> B[Lighthouse Bundle]\\n B --> C[Lighthouse Core]\\n B --> D[DevTools Integration]\\n C --> E[Performance Audits]\\n C --> F[Accessibility Checks]\\n C --> G[Best Practices]\\n D --> H[Tool Categories]\\n```\\n\\n### Tool Categorization Strategy\\n\\nThe `categories.ts` file (`src/tools/categories.ts:7-33`) defines an enum `ToolCategory` that organizes tools into logical groups. This design addresses the problem of tool discoverability and organization within the DevTools UI. The categories reflect the functional domains that developers commonly interact with:\\n\\n- **INPUT/NAVIGATION**: Automation capabilities\\n- **EMULATION**: Device and environment simulation\\n- **PERFORMANCE**: Performance metrics and analysis\\n- **NETWORK**: Network behavior inspection\\n- **DEBUGGING**: Debugging utilities\\n- **EXTENSIONS**: Extension management\\n- **THIRD_PARTY/WEBMCP**: Experimental and external integrations\\n- **MEMORY**: Memory profiling\\n- **PWA**: Progressive Web App capabilities\\n\\nThis categorization pattern solves the problem of organizing a large number of tools into digestible groups, improving usability and maintainability.\\n\\n### Performance and Compatibility Considerations\\n\\nThe codebase carefully balances performance and compatibility through several mechanisms:\\n\\n1. **Conditional Logic for Browser vs Node.js**: The `lighthouse-logger/index.js` file (`src/third_party/lighthouse-devtools-mcp-bundle.js:707-723`) includes explicit checks for browser environments:\\n ```typescript\\n isWindows = process3.platform === \\\"win32\\\";\\n isBrowser = process3.browser;\\n ```\\n This allows the same codebase to function in both Node.js environments (for tooling) and browser environments (for DevTools integration).\\n\\n2. **Performance Measurement Utilities**: The `marky` library integration (`src/third_party/lighthouse-devtools-mcp-bundle.js:602-704`) provides a unified interface for performance measurement that gracefully degrades from `performance.mark` API to custom implementations when browser APIs are unavailable.\\n\\n3. **Debugging and Logging Framework**: The integration with the `debug` library (`src/third_party/lighthouse-devtools-mcp-bundle.js:252-425`) provides a flexible logging system that can be configured at runtime, solving the problem of varying logging requirements across different environments and debugging needs.\\n\\n### Design Patterns and Problem-Solving\\n\\nThe codebase employs several design patterns that address specific architectural challenges:\\n\\n#### 1. Base Gatherer Pattern\\nThe `BaseGatherer` class (`src/third_party/lighthouse-devtools-mcp-bundle.js:70-129`) establishes a clear interface for data collection. This pattern solves the problem of standardizing how different types of audits gather information from the page:\\n\\n```typescript\\nclass BaseGatherer {\\n startInstrumentation(passContext) {}\\n getArtifact(passContext) {}\\n}\\n```\\n\\nThis abstraction allows for different gathering strategies (instrumentation vs sensitive instrumentation) while maintaining a consistent API.\\n\\n#### 2. Trace Processing Architecture\\nThe `TraceProcessor` class (`src/third_party/lighthouse-devtools-mcp-bundle.js:953-1100`) demonstrates a sophisticated approach to handling trace data. It addresses the complex problem of sorting and filtering trace events that may have identical timestamps:\\n\\n```typescript\\nstatic _sortTimestampEventGroup(tsGroupIndices, timestampSortedIndices, indexOfTsGroupIndicesStart, traceEvents)\\n```\\n\\nThis method prioritizes event types and duration relationships to maintain proper execution order, which is crucial for accurate performance analysis.\\n\\n#### 3. Error Handling and Validation\\nThe `TraceProcessor` also demonstrates good error handling practices with specific error creation methods:\\n\\n```typescript\\nstatic createNoNavstartError() { return new Error(\\\"No navigationStart event found\\\"); }\\n```\\n\\nThis pattern solves the problem of providing meaningful error messages for common trace processing failures.\\n\\n## Conclusion\\n\\nThe Chrome DevTools MCP codebase demonstrates a sophisticated balance between modularity, performance, and usability. Key design decisions include:\\n\\n1. **Bundling Strategy**: Using bundled dependencies to ensure consistent behavior and reduce runtime complexity\\n2. **Environment Adaptation**: Supporting both Node.js and browser environments through conditional logic\\n3. **Modular Architecture**: Clear separation of concerns with base classes and specialized processors\\n4. **Tool Organization**: Logical categorization of tools to improve discoverability\\n5. **Performance Optimization**: Graceful degradation and efficient algorithms for complex operations\\n\\nThese design choices reflect the constraints of integrating complex auditing tools into a browser environment while maintaining developer productivity and tool effectiveness. The codebase prioritizes robustness, maintainability, and performance across different execution contexts, making it suitable for the demanding requirements of browser-based development tools.\"\n }\n]","isConversational":true},"source":{"kind":"string","value":"ChromeDevTools/chrome-devtools-mcp"},"category":{"kind":"string","value":"design_rationale"},"quality_score":{"kind":"number","value":100,"string":"100"},"citation_stats":{"kind":"string","value":"{\n \"total_citations\": 7,\n \"validity_rate\": 1,\n \"invalid\": []\n}"},"license":{"kind":"string","value":"Apache-2.0"},"language":{"kind":"string","value":"typescript"}}},{"rowIdx":96,"cells":{"messages":{"kind":"list like","value":[{"role":"system","content":["You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\n4. Explain the WHY behind design decisions, not only the WHAT.\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\n7. Example of the correct citation style, inline and attached to a path:\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon."]},{"role":"user","content":"<START_OF_CONTEXT>\n# Repository: type-challenges/type-challenges (language: typescript)\n\n# Selected files (windows)\n- eslint.config.js (24 lines)\n- questions/00002-medium-return-type/test-cases.ts (20 lines)\n- questions/00003-medium-omit/test-cases.ts (32 lines)\n- questions/00004-easy-pick/test-cases.ts (23 lines)\n- questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\n- questions/00006-hard-simple-vue/test-cases.ts (37 lines)\n- questions/00008-medium-readonly-2/test-cases.ts (29 lines)\n- questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\n- questions/00599-medium-merge/test-cases.ts (18 lines)\n- scripts/actions/utils/formatToCode.ts (26 lines)\n- scripts/actions/utils/toInfoHeader.ts (15 lines)\n- scripts/build.ts (54 lines)\n- scripts/generate-play.ts (180 lines)\n- scripts/loader.ts (117 lines)\n- scripts/locales.ts (26 lines)\n- scripts/readme.ts (240 lines)\n- scripts/toUrl.ts (85 lines)\n- scripts/translate.ts (73 lines)\n- scripts/types.ts (38 lines)\n- utils/index.d.test.ts (35 lines)\n- utils/index.d.ts (29 lines)\n\n\n### FILE: eslint.config.js (24 lines)\n\n```\n 1| const antfu = require('@antfu/eslint-config').default\n 2| \n 3| module.exports = antfu(\n 4| {\n 5| markdown: false,\n 6| },\n 7| {\n 8| rules: {\n 9| 'import/first': 'off',\n 10| 'no-alert': 'off',\n 11| 'no-unused-expressions': 'off',\n 12| 'no-unused-vars': 'off',\n 13| 'no-use-before-define': 'off',\n 14| 'prefer-const': 'off',\n 15| 'ts/ban-ts-comment': 'off',\n 16| 'ts/ban-types': 'off',\n 17| 'ts/consistent-type-definitions': 'off',\n 18| 'ts/no-namespace': 'off',\n 19| 'ts/no-require-imports': 'off',\n 20| 'ts/no-unused-vars': 'off',\n 21| 'unused-imports/no-unused-vars': 'off',\n 22| },\n 23| },\n 24| )\n```\n\n### FILE: questions/00002-medium-return-type/test-cases.ts (20 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<string, MyReturnType<() => string>>>,\n 5| Expect<Equal<123, MyReturnType<() => 123>>>,\n 6| Expect<Equal<ComplexObject, MyReturnType<() => ComplexObject>>>,\n 7| Expect<Equal<Promise<boolean>, MyReturnType<() => Promise<boolean>>>>,\n 8| Expect<Equal<() => 'foo', MyReturnType<() => () => 'foo'>>>,\n 9| Expect<Equal<1 | 2, MyReturnType<typeof fn>>>,\n 10| Expect<Equal<1 | 2, MyReturnType<typeof fn1>>>,\n 11| ]\n 12| \n 13| type ComplexObject = {\n 14| a: [12, 'foo']\n 15| bar: 'hello'\n 16| prev(): number\n 17| }\n 18| \n 19| const fn = (v: boolean) => v ? 1 : 2\n 20| const fn1 = (v: boolean, w: any) => v ? 1 : 2\n```\n\n### FILE: questions/00003-medium-omit/test-cases.ts (32 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<Expected1, MyOmit<Todo, 'description'>>>,\n 5| Expect<Equal<Expected2, MyOmit<Todo, 'description' | 'completed'>>>,\n 6| Expect<Equal<Expected3, MyOmit<Todo1, 'description' | 'completed'>>>,\n 7| ]\n 8| \n 9| interface Todo {\n 10| title: string\n 11| description: string\n 12| completed: boolean\n 13| }\n 14| \n 15| interface Todo1 {\n 16| readonly title: string\n 17| description: string\n 18| completed: boolean\n 19| }\n 20| \n 21| interface Expected1 {\n 22| title: string\n 23| completed: boolean\n 24| }\n 25| \n 26| interface Expected2 {\n 27| title: string\n 28| }\n 29| \n 30| interface Expected3 {\n 31| readonly title: string\n 32| }\n```\n\n### FILE: questions/00004-easy-pick/test-cases.ts (23 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<Expected1, MyPick<Todo, 'title'>>>,\n 5| Expect<Equal<Expected2, MyPick<Todo, 'title' | 'completed'>>>,\n 6| // @ts-expect-error\n 7| MyPick<Todo, 'title' | 'completed' | 'invalid'>,\n 8| ]\n 9| \n 10| interface Todo {\n 11| title: string\n 12| description: string\n 13| completed: boolean\n 14| }\n 15| \n 16| interface Expected1 {\n 17| title: string\n 18| }\n 19| \n 20| interface Expected2 {\n 21| title: string\n 22| completed: boolean\n 23| }\n```\n\n### FILE: questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<'title', GetReadonlyKeys<Todo1>>>,\n 5| Expect<Equal<'title' | 'description', GetReadonlyKeys<Todo2>>>,\n 6| ]\n 7| \n 8| interface Todo1 {\n 9| readonly title: string\n 10| description: string\n 11| completed: boolean\n 12| }\n 13| \n 14| interface Todo2 {\n 15| readonly title: string\n 16| readonly description: string\n 17| completed?: boolean\n 18| }\n```\n\n### FILE: questions/00006-hard-simple-vue/test-cases.ts (37 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| SimpleVue({\n 4| data() {\n 5| // @ts-expect-error\n 6| this.firstname\n 7| // @ts-expect-error\n 8| this.getRandom()\n 9| // @ts-expect-error\n 10| this.data()\n 11| \n 12| return {\n 13| firstname: 'Type',\n 14| lastname: 'Challenges',\n 15| amount: 10,\n 16| }\n 17| },\n 18| computed: {\n 19| fullname() {\n 20| return `${this.firstname} ${this.lastname}`\n 21| },\n 22| },\n 23| methods: {\n 24| getRandom() {\n 25| return Math.random()\n 26| },\n 27| hi() {\n 28| alert(this.amount)\n 29| alert(this.fullname.toLowerCase())\n 30| alert(this.getRandom())\n 31| },\n 32| test() {\n 33| const fullname = this.fullname\n 34| const cases: [Expect<Equal<typeof fullname, string>>] = [] as any\n 35| },\n 36| },\n 37| })\n```\n\n### FILE: questions/00008-medium-readonly-2/test-cases.ts (29 lines)\n\n```\n 1| import type { Alike, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Alike<MyReadonly2<Todo1>, Readonly<Todo1>>>,\n 5| Expect<Alike<MyReadonly2<Todo1, 'title' | 'description'>, Expected>>,\n 6| Expect<Alike<MyReadonly2<Todo2, 'title' | 'description'>, Expected>>,\n 7| Expect<Alike<MyReadonly2<Todo2, 'description' >, Expected>>,\n 8| ]\n 9| \n 10| // @ts-expect-error\n 11| type error = MyReadonly2<Todo1, 'title' | 'invalid'>\n 12| \n 13| interface Todo1 {\n 14| title: string\n 15| description?: string\n 16| completed: boolean\n 17| }\n 18| \n 19| interface Todo2 {\n 20| readonly title: string\n 21| description?: string\n 22| completed: boolean\n 23| }\n 24| \n 25| interface Expected {\n 26| readonly title: string\n 27| readonly description?: string\n 28| completed: boolean\n 29| }\n```\n\n### FILE: questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<DeepReadonly<X1>, Expected1>>,\n 5| Expect<Equal<DeepReadonly<X2>, Expected2>>,\n 6| ]\n 7| \n 8| type X1 = {\n 9| a: () => 22\n 10| b: string\n 11| c: {\n 12| d: boolean\n 13| e: {\n 14| g: {\n 15| h: {\n 16| i: true\n 17| j: 'string'\n 18| }\n 19| k: 'hello'\n 20| }\n 21| l: [\n 22| 'hi',\n 23| {\n 24| m: ['hey']\n 25| },\n 26| ]\n 27| }\n 28| }\n 29| }\n 30| \n 31| type X2 = { a: string } | { b: number }\n 32| \n 33| type Expected1 = {\n 34| readonly a: () => 22\n 35| readonly b: string\n 36| readonly c: {\n 37| readonly d: boolean\n 38| readonly e: {\n 39| readonly g: {\n 40| readonly h: {\n 41| readonly i: true\n 42| readonly j: 'string'\n 43| }\n 44| readonly k: 'hello'\n 45| }\n 46| readonly l: readonly [\n 47| 'hi',\n 48| {\n 49| readonly m: readonly ['hey']\n 50| },\n 51| ]\n 52| }\n 53| }\n 54| }\n 55| \n 56| type Expected2 = { readonly a: string } | { readonly b: number }\n```\n\n### FILE: questions/00599-medium-merge/test-cases.ts (18 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type Foo = {\n 4| a: number\n 5| b: string\n 6| }\n 7| type Bar = {\n 8| b: number\n 9| c: boolean\n 10| }\n 11| \n 12| type cases = [\n 13| Expect<Equal<Merge<Foo, Bar>, {\n 14| a: number\n 15| b: number\n 16| c: boolean\n 17| }>>,\n 18| ]\n```\n\n### FILE: scripts/actions/utils/formatToCode.ts (26 lines)\n\n```\n 1| import type { Quiz } from '../../types'\n 2| import type { SupportedLocale } from '../../locales'\n 3| import { defaultLocale, t } from '../../locales'\n 4| import { toCommentBlock } from './toCommentBlock'\n 5| import { toInfoHeader } from './toInfoHeader'\n 6| import { toLinks } from './toLinks'\n 7| import { toDivider } from './toDivider'\n 8| import { toFooter } from './toFooter'\n 9| \n 10| export function formatToCode(quiz: Quiz, locale: SupportedLocale) {\n 11| return `${toCommentBlock(\n 12| toInfoHeader(quiz, locale)\n 13| + (quiz.readme[locale] || quiz.readme[defaultLocale])\n 14| + toLinks(quiz, locale),\n 15| )\n 16| + toDivider(t(locale, 'divider.code-start'))\n 17| }\\n${\n 18| (quiz.template || '').trim()\n 19| }\\n${\n 20| toDivider(t(locale, 'divider.test-cases'))\n 21| }${\n 22| (quiz.tests || '').trim()\n 23| }\\n${\n 24| toDivider(t(locale, 'divider.further-steps'))\n 25| }${toCommentBlock(toFooter(quiz, locale))}`\n 26| }\n```\n\n### FILE: scripts/actions/utils/toInfoHeader.ts (15 lines)\n\n```\n 1| import type { Quiz } from '../../types'\n 2| import type { SupportedLocale } from '../../locales'\n 3| import { t } from '../../locales'\n 4| import { resolveInfo } from '../../loader'\n 5| \n 6| export const toInfoHeader = function toInfoHeader(quiz: Quiz, locale: SupportedLocale) {\n 7| const info = resolveInfo(quiz, locale)\n 8| \n 9| const author = `${info.author?.name} (@${info?.author?.github})`\n 10| \n 11| return `${quiz.no} - ${info.title || ''}\\n`\n 12| + '-------\\n'\n 13| + `by ${author} #${t(locale, `difficulty.${quiz.difficulty}`)} ${info?.tags?.map(i => `#${i}`).join(' ') || ''}\\n\\n`\n 14| + `### ${t(locale, 'title.question')}\\n\\n`\n 15| }\n```\n\n### FILE: scripts/build.ts (54 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import { loadQuizzes, resolveInfo } from './loader'\n 4| import { REPO, toPlaygroundUrl, toQuestionsRawREADME, toQuizREADME, toRawREADME, toShareAnswerFull, toSolutionsFull } from './toUrl'\n 5| import { defaultLocale, supportedLocales } from './locales'\n 6| import { formatToCode } from './actions/utils/formatToCode'\n 7| \n 8| export async function build() {\n 9| const quizzes = await loadQuizzes()\n 10| const redirects: [string, string, number][] = []\n 11| \n 12| // redirect homepage to github repo\n 13| supportedLocales.filter(locale => locale !== defaultLocale).forEach((locale) => {\n 14| redirects.push([`/${locale}`, `${REPO}/blob/main/README.${locale}.md`, 302])\n 15| })\n 16| \n 17| supportedLocales.forEach((locale) => {\n 18| redirects.push([`/raw/${locale}`, toQuestionsRawREADME(locale), 302])\n 19| })\n 20| \n 21| for (const quiz of quizzes) {\n 22| for (const locale of supportedLocales) {\n 23| const info = resolveInfo(quiz, locale)\n 24| \n 25| const code = formatToCode(quiz, locale)\n 26| \n 27| const url = toPlaygroundUrl(code, info.tsconfig || {})\n 28| \n 29| if (locale === defaultLocale) {\n 30| redirects.push([`/${quiz.no}`, toQuizREADME(quiz, locale, true), 302])\n 31| redirects.push([`/${quiz.no}/raw`, toRawREADME(quiz, locale), 302])\n 32| redirects.push([`/${quiz.no}/play`, url, 302])\n 33| redirects.push([`/${quiz.no}/answer`, toShareAnswerFull(quiz), 302])\n 34| }\n 35| else {\n 36| redirects.push([`/${quiz.no}/${locale}`, toQuizREADME(quiz, locale, true), 302])\n 37| redirects.push([`/${quiz.no}/raw/${locale}`, toRawREADME(quiz, locale), 302])\n 38| redirects.push([`/${quiz.no}/play/${locale}`, url, 302])\n 39| redirects.push([`/${quiz.no}/answer/${locale}`, toShareAnswerFull(quiz, locale), 302])\n 40| }\n 41| }\n 42| \n 43| redirects.push([`/${quiz.no}/solutions`, toSolutionsFull(quiz.no), 302])\n 44| }\n 45| \n 46| const dist = path.resolve(__dirname, 'dist')\n 47| \n 48| await fs.remove(dist)\n 49| await fs.ensureDir(dist)\n 50| \n 51| await fs.writeFileSync(path.join(dist, '_redirects'), redirects.map(i => i.join('\\t')).join('\\n'), 'utf-8')\n 52| }\n 53| \n 54| build()\n```\n\n### FILE: scripts/generate-play.ts (180 lines)\n\n```\n 1| import path from 'node:path'\n 2| import process from 'node:process'\n 3| import crypto from 'node:crypto'\n 4| import fs from 'fs-extra'\n 5| import c from 'ansis'\n 6| import prompts from 'prompts'\n 7| import { formatToCode } from './actions/utils/formatToCode'\n 8| import { loadQuizzes, resolveInfo } from './loader'\n 9| import { supportedLocales } from './locales'\n 10| import { getQuestionFullName } from './actions/issue-pr'\n 11| import type { QuizMetaInfo } from './types'\n 12| \n 13| type Snapshot = Record<string, string>\n 14| \n 15| function calculateFileHash(filePathFull: string): Promise<string> {\n 16| return new Promise((resolve, reject) => {\n 17| const hash = crypto.createHash('sha1')\n 18| const fileStream = fs.createReadStream(filePathFull)\n 19| \n 20| fileStream.on('data', (data) => {\n 21| hash.update(data)\n 22| })\n 23| \n 24| fileStream.on('end', () => {\n 25| hash.update(filePathFull)\n 26| resolve(hash.digest('hex'))\n 27| })\n 28| \n 29| fileStream.on('error', (err) => {\n 30| reject(err)\n 31| })\n 32| })\n 33| }\n 34| \n 35| async function takeSnapshot(quizzesPath: string) {\n 36| let snapshot: Snapshot = {}\n 37| \n 38| const files = fs.readdirSync(quizzesPath)\n 39| \n 40| for (const file of files) {\n 41| // Might be a file, or a folder\n 42| const fPath = path.join(quizzesPath, file)\n 43| const fStats = fs.statSync(fPath)\n 44| \n 45| if (fStats.isDirectory()) {\n 46| snapshot = {\n 47| ...snapshot,\n 48| ...(await takeSnapshot(fPath)),\n 49| }\n 50| }\n 51| else {\n 52| snapshot[file] = await calculateFileHash(fPath)\n 53| }\n 54| }\n 55| \n 56| return snapshot\n 57| }\n 58| \n 59| function readPlaygroundCache(playgroundCachePath: string): Snapshot {\n 60| if (!fs.existsSync(playgroundCachePath))\n 61| return {}\n 62| \n 63| try {\n 64| const rawCacheContent = fs.readFileSync(playgroundCachePath)\n 65| return JSON.parse(rawCacheContent.toString())\n 66| }\n 67| catch (err) {\n 68| console.log(c.red('Playground cache corrupted. '\n 69| + 'Cannot generate playground without keeping your changes intact'))\n 70| console.log(c.cyan('Please ensure you have run this: \"pnpm generate\"'))\n 71| process.exit(1)\n 72| }\n 73| }\n 74| \n 75| function calculateOverridableFiles(cache: Snapshot, snapshot: Snapshot) {\n 76| const result: Snapshot = {}\n 77| \n 78| for (const quizName in snapshot) {\n 79| if (snapshot[quizName] === cache[quizName])\n 80| result[quizName] = snapshot[quizName]\n 81| }\n 82| \n 83| return result\n 84| }\n 85| \n 86| function isQuizWritable(quizFileName: string, overridableFiles: Snapshot, playgroundSnapshot: Snapshot): boolean {\n 87| return !!(\n 88| overridableFiles[quizFileName]\n 89| || (!overridableFiles[quizFileName] && !playgroundSnapshot[quizFileName])\n 90| )\n 91| }\n 92| \n 93| async function generatePlayground() {\n 94| const playgroundPath = path.join(__dirname, '../playground')\n 95| const playgroundCachePath = path.join(__dirname, '../.playgroundcache')\n 96| \n 97| let locale = supportedLocales.find(locale => locale === process.argv[2])!\n 98| \n 99| console.log(c.bold.cyan('Generating local playground...\\n'))\n 100| \n 101| let overridableFiles: Snapshot\n 102| let keepChanges = false\n 103| const currentPlaygroundCache = readPlaygroundCache(playgroundCachePath)\n 104| let playgroundSnapshot: Snapshot\n 105| \n 106| if (process.argv.length === 3 && (process.argv[2] === '--keep-changes' || process.argv[2] === '-K')) {\n 107| console.log(c.bold.cyan('We will keep your changes while generating.\\n'))\n 108| keepChanges = true\n 109| \n 110| playgroundSnapshot = await takeSnapshot(playgroundPath)\n 111| \n 112| overridableFiles = calculateOverridableFiles(currentPlaygroundCache, playgroundSnapshot)\n 113| }\n 114| else if (fs.existsSync(playgroundPath)) {\n 115| const result = await prompts([{\n 116| name: 'confirm',\n 117| type: 'confirm',\n 118| initial: false,\n 119| message: 'The playground directory already exists, it may contains the answers you did. Do you want to override it?',\n 120| }])\n 121| if (!result?.confirm)\n 122| return console.log(c.yellow('Skipped.'))\n 123| }\n 124| \n 125| if (!locale) {\n 126| const result = await prompts([{\n 127| name: 'locale',\n 128| type: 'select',\n 129| message: 'Select language:',\n 130| choices: supportedLocales.map(i => ({\n 131| title: i,\n 132| value: i,\n 133| })),\n 134| }])\n 135| if (!result)\n 136| return console.log(c.yellow('Skipped.'))\n 137| locale = result.locale\n 138| }\n 139| \n 140| if (!keepChanges) {\n 141| await fs.remove(playgroundPath)\n 142| await fs.ensureDir(playgroundPath)\n 143| }\n 144| \n 145| const quizzes = await loadQuizzes()\n 146| const incomingQuizzesCache: Snapshot = {}\n 147| \n 148| for (const quiz of quizzes) {\n 149| const { difficulty, title } = resolveInfo(quiz, locale) as QuizMetaInfo & { difficulty: string }\n 150| const code = formatToCode(quiz, locale)\n 151| \n 152| if (difficulty === undefined || title === undefined) {\n 153| console.log(c.yellow`${quiz.no} has no ${locale.toUpperCase()} version. Skipping`)\n 154| continue\n 155| }\n 156| \n 157| const quizzesPathByDifficulty = path.join(playgroundPath, difficulty)\n 158| \n 159| const quizFileName = `${getQuestionFullName(quiz.no, difficulty, title)}.ts`\n 160| const quizPathFull = path.join(quizzesPathByDifficulty, quizFileName)\n 161| \n 162| if (!keepChanges || (keepChanges && isQuizWritable(quizFileName, overridableFiles!, playgroundSnapshot!))) {\n 163| if (!fs.existsSync(quizzesPathByDifficulty))\n 164| fs.mkdirSync(quizzesPathByDifficulty)\n 165| await fs.writeFile(quizPathFull, code, 'utf-8')\n 166| incomingQuizzesCache[quizFileName] = await calculateFileHash(quizPathFull)\n 167| }\n 168| }\n 169| \n 170| fs.writeFile(playgroundCachePath, JSON.stringify({\n 171| ...currentPlaygroundCache,\n 172| ...incomingQuizzesCache,\n 173| }))\n 174| \n 175| console.log()\n 176| console.log(c.bold.green('Local playground generated at: ') + c.dim(playgroundPath))\n 177| console.log()\n 178| }\n 179| \n 180| generatePlayground()\n```\n\n### FILE: scripts/loader.ts (117 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import fg from 'fast-glob'\n 4| import YAML from 'js-yaml'\n 5| import type { Quiz, QuizMetaInfo } from './types'\n 6| import { defaultLocale, supportedLocales } from './locales'\n 7| \n 8| export async function loadFile(filepath: string) {\n 9| if (fs.existsSync(filepath))\n 10| return await fs.readFile(filepath, 'utf-8')\n 11| return undefined\n 12| }\n 13| \n 14| export async function loadLocaleVariations<T = string>(\n 15| filepath: string,\n 16| preprocessor: (s: string) => T = s => s as any as T,\n 17| ) {\n 18| const { ext, dir, name } = path.parse(filepath)\n 19| const data: Record<string, T> = {}\n 20| \n 21| for (const locale of supportedLocales) {\n 22| const file = preprocessor(await loadFile(path.join(dir, `${name}.${locale}${ext}`)) || '')\n 23| \n 24| if (file)\n 25| data[locale] = file\n 26| }\n 27| \n 28| if (!data[defaultLocale]) {\n 29| // default version\n 30| const file = preprocessor(await loadFile(filepath) || '')\n 31| if (file)\n 32| data[defaultLocale] = file\n 33| }\n 34| \n 35| return data\n 36| }\n 37| \n 38| export function readmeCleanUp(text: string) {\n 39| return text\n 40| .replace(/<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/, '')\n 41| .replace(/<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/, '')\n 42| .trim()\n 43| }\n 44| \n 45| export function loadInfo(s: string): Partial<QuizMetaInfo> | undefined {\n 46| const object = YAML.load(s) as any\n 47| if (!object)\n 48| return undefined\n 49| \n 50| const arrayKeys = ['tags', 'related']\n 51| \n 52| for (const key of arrayKeys) {\n 53| if (object[key]) {\n 54| object[key] = (object[key] || '')\n 55| .toString()\n 56| .split(',')\n 57| .map((i: string) => i.trim())\n 58| .filter(Boolean)\n 59| }\n 60| else {\n 61| object[key] = undefined\n 62| }\n 63| }\n 64| \n 65| return object\n 66| }\n 67| \n 68| export const QUIZ_ROOT = path.resolve(__dirname, '../questions')\n 69| \n 70| export async function loadQuizzes(): Promise<Quiz[]> {\n 71| const folders = await fg('{0..9}*-*', {\n 72| onlyDirectories: true,\n 73| cwd: QUIZ_ROOT,\n 74| })\n 75| \n 76| const quizzes = await Promise.all(\n 77| folders.map(async dir => loadQuiz(dir)),\n 78| )\n 79| \n 80| return quizzes\n 81| }\n 82| \n 83| export async function loadQuiz(dir: string): Promise<Quiz> {\n 84| return {\n 85| no: Number(dir.replace(/^(\\d+)-.*/, '$1')),\n 86| difficulty: dir.replace(/^\\d+-(.+?)-.*$/, '$1') as any,\n 87| path: dir,\n 88| info: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'info.yml'), loadInfo),\n 89| readme: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'README.md'), readmeCleanUp),\n 90| template: await loadFile(path.join(QUIZ_ROOT, dir, 'template.ts')) || '',\n 91| tests: await loadFile(path.join(QUIZ_ROOT, dir, 'test-cases.ts')),\n 92| }\n 93| }\n 94| \n 95| export async function loadQuizByNo(no: number | string) {\n 96| const folders = await fg(`${no}-*`, {\n 97| onlyDirectories: true,\n 98| cwd: QUIZ_ROOT,\n 99| })\n 100| \n 101| if (folders.length)\n 102| return await loadQuiz(folders[0])\n 103| \n 104| return undefined\n 105| }\n 106| \n 107| export function resolveInfo(quiz: Quiz, locale: string = defaultLocale) {\n 108| const info = { ...quiz.info[defaultLocale], ...quiz.info[locale] }\n 109| info.tags = quiz.info[locale]?.tags || quiz.info[defaultLocale]?.tags || []\n 110| info.related = quiz.info[locale]?.related || quiz.info[defaultLocale]?.related || []\n 111| \n 112| if (typeof info.tags === 'string')\n 113| // @ts-expect-error\n 114| info.tags = info.tags.split(',').map(i => i.trim()).filter(Boolean)\n 115| \n 116| return info as QuizMetaInfo\n 117| }\n```\n\n### FILE: scripts/locales.ts (26 lines)\n\n```\n 1| export const defaultLocale = 'en'\n 2| \n 3| export const supportedLocales = ['en', 'zh-CN', 'ja', 'ko', 'pt-BR'] as const\n 4| \n 5| export const messages = {\n 6| 'en': require('./locales/en.json'),\n 7| 'zh-CN': require('./locales/zh-CN.json'),\n 8| 'ja': require('./locales/ja.json'),\n 9| 'ko': require('./locales/ko.json'),\n 10| 'pt-BR': require('./locales/pt-BR.json'),\n 11| }\n 12| \n 13| export type SupportedLocale = keyof typeof messages\n 14| \n 15| export function t(locale: SupportedLocale, key: string): string {\n 16| const result = (messages[locale] && messages[locale][key]) || messages[defaultLocale][key]\n 17| if (!result)\n 18| throw new Error(`Missing message for key \"${key}\"`)\n 19| return result\n 20| }\n 21| \n 22| export function f(name: string, locale: string, ext: string) {\n 23| if (locale === defaultLocale)\n 24| return `${name}.${ext}`\n 25| return `${name}.${locale}.${ext}`\n 26| }\n```\n\n### FILE: scripts/readme.ts (240 lines)\n\n```\n 1| import path from 'node:path'\n 2| import process from 'node:process'\n 3| import fs from 'fs-extra'\n 4| import type { SupportedLocale } from './locales'\n 5| import { defaultLocale, f, supportedLocales, t } from './locales'\n 6| import { loadQuizzes, resolveInfo } from './loader'\n 7| import { toAnswerShort, toNearborREADME, toPlayShort, toQuizREADME, toSolutionsShort } from './toUrl'\n 8| import type { Quiz, QuizMetaInfo } from './types'\n 9| \n 10| const DifficultyColors: Record<string, string> = {\n 11| warm: 'teal',\n 12| easy: '7aad0c',\n 13| medium: 'd9901a',\n 14| hard: 'de3d37',\n 15| extreme: 'b11b8d',\n 16| }\n 17| \n 18| const DifficultyRank = [\n 19| 'warm',\n 20| 'easy',\n 21| 'medium',\n 22| 'hard',\n 23| 'extreme',\n 24| ]\n 25| \n 26| function escapeHtml(unsafe: string) {\n 27| return unsafe\n 28| .replace(/&/g, '&')\n 29| .replace(/</g, '<')\n 30| .replace(/>/g, '>')\n 31| .replace(/\"/g, '"')\n 32| .replace(/'/g, ''')\n 33| }\n 34| \n 35| function toBadgeURL(label: string, text: string, color: string, args = '') {\n 36| return `https://img.shields.io/badge/${encodeURIComponent(label.replace(/-/g, '--'))}-${encodeURIComponent(text.replace(/-/g, '--'))}-${color}${args}`\n 37| }\n 38| \n 39| function toBadge(label: string, text: string, color: string, args = '') {\n 40| return `<img src=\"${toBadgeURL(label, text, color, args)}\" alt=\"${text}\"/>`\n 41| }\n 42| \n 43| export function toBadgeLink(url: string, label: string, text: string, color: string, args = '') {\n 44| return `<a href=\"${url}\" target=\"_blank\">${toBadge(label, text, color, args)}</a> `\n 45| }\n 46| \n 47| export function toPlanTextLink(url: string, _label: string, text: string, _color: string, _args = '') {\n 48| return `<a href=\"${url}\" target=\"_blank\">${text}</a> `\n 49| }\n 50| \n 51| function toAuthorInfo(author: Partial<QuizMetaInfo['author']> = {}) {\n 52| return `by ${author.name}${author.github ? ` <a href=\"https://github.com/${author.github}\" target=\"_blank\">@${author.github}</a>` : ''}`\n 53| }\n 54| \n 55| function toDifficultyBadge(difficulty: string, locale: SupportedLocale) {\n 56| return toBadge('', t(locale, `difficulty.${difficulty}`), DifficultyColors[difficulty])\n 57| }\n 58| \n 59| function toDifficultyBadgeInverted(difficulty: string, locale: SupportedLocale, count: number) {\n 60| return toBadge(t(locale, `difficulty.${difficulty}`), count.toString(), DifficultyColors[difficulty])\n 61| }\n 62| \n 63| function toDifficultyPlainText(difficulty: string, locale: SupportedLocale, count: number) {\n 64| return `${t(locale, `difficulty.${difficulty}`)} (${count.toString()})`\n 65| }\n 66| \n 67| function toDetailsInnerText(text: string, locale: SupportedLocale) {\n 68| return `${t(locale, `details.${text}`)}`\n 69| }\n 70| \n 71| function quizToBadge(quiz: Quiz, locale: string, absolute = false, badge = true) {\n 72| const fn = badge ? toBadgeLink : toPlanTextLink\n 73| return fn(\n 74| toQuizREADME(quiz, locale, absolute),\n 75| '',\n 76| `${quiz.no}・${quiz.info[locale]?.title || quiz.info[defaultLocale]?.title}`,\n 77| DifficultyColors[quiz.difficulty],\n 78| )\n 79| }\n 80| \n 81| function quizNoToBadges(ids: (string | number)[], quizzes: Quiz[], locale: string, absolute = false) {\n 82| return ids\n 83| .map(i => quizzes.find(q => q.no === Number(i)))\n 84| .filter(Boolean)\n 85| .map(i => quizToBadge(i!, locale, absolute))\n 86| .join(' ')\n 87| }\n 88| \n 89| function getAllTags(quizzes: Quiz[], locale: string) {\n 90| const set = new Set<string>()\n 91| for (const quiz of quizzes) {\n 92| const info = resolveInfo(quiz, locale)\n 93| for (const tag of (info?.tags || []))\n 94| set.add(tag)\n 95| }\n 96| return Array.from(set).sort()\n 97| }\n 98| \n 99| function getQuizzesByTag(quizzes: Quiz[], locale: string, tag: string) {\n 100| return quizzes.filter((quiz) => {\n 101| const info = resolveInfo(quiz, locale)\n 102| return !!info.tags?.includes(tag)\n 103| })\n 104| }\n 105| \n 106| async function insertInfoReadme(filepath: string, quiz: Quiz, locale: SupportedLocale, quizzes: Quiz[]) {\n 107| if (!fs.existsSync(filepath))\n 108| return\n 109| let text = await fs.readFile(filepath, 'utf-8')\n 110| /* eslint-disable prefer-template */\n 111| \n 112| if (!text.match(/<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/))\n 113| text = `<!--info-header-start--><!--info-header-end-->\\n\\n${text}`\n 114| if (!text.match(/<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/))\n 115| text = `${text}\\n\\n<!--info-footer-start--><!--info-footer-end-->`\n 116| \n 117| const info = resolveInfo(quiz, locale)\n 118| \n 119| const availableLocales = supportedLocales.filter(l => l !== locale).filter(l => !!quiz.readme[l])\n 120| \n 121| text = text\n 122| .replace(\n 123| /<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/,\n 124| '<!--info-header-start-->'\n 125| + `<h1>${escapeHtml(info.title || '')} ${toDifficultyBadge(quiz.difficulty, locale)} ${(info.tags || []).map(i => toBadge('', `#${i}`, '999')).join(' ')}</h1>`\n 126| + `<blockquote><p>${toAuthorInfo(info.author)}</p></blockquote>`\n 127| + '<p>'\n 128| + toBadgeLink(toPlayShort(quiz.no, locale), '', t(locale, 'badge.take-the-challenge'), '3178c6', '?logo=typescript&logoColor=white')\n 129| + (availableLocales.length ? (' ' + availableLocales.map(l => toBadgeLink(toNearborREADME(quiz, l), '', t(l, 'display'), 'gray')).join(' ')) : '')\n 130| + '</p>'\n 131| + '<!--info-header-end-->',\n 132| )\n 133| .replace(\n 134| /<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/,\n 135| '<!--info-footer-start--><br>'\n 136| + toBadgeLink(`../../${f('README', locale, 'md')}`, '', t(locale, 'badge.back'), 'grey')\n 137| + toBadgeLink(toAnswerShort(quiz.no, locale), '', t(locale, 'badge.share-your-solutions'), 'teal')\n 138| + toBadgeLink(toSolutionsShort(quiz.no), '', t(locale, 'badge.checkout-solutions'), 'de5a77', '?logo=awesome-lists&logoColor=white')\n 139| + (Array.isArray(info.related) && info.related.length ? `<hr><h3>${t(locale, 'readme.related-challenges')}</h3>${quizNoToBadges(info.related, quizzes, locale, true)}` : '')\n 140| + '<!--info-footer-end-->',\n 141| )\n 142| \n 143| /* eslint-enable prefer-template */\n 144| \n 145| await fs.writeFile(filepath, text, 'utf-8')\n 146| }\n 147| \n 148| async function updateIndexREADME(quizzes: Quiz[]) {\n 149| // update index README\n 150| for (const locale of supportedLocales) {\n 151| const filepath = path.resolve(__dirname, '..', f('README', locale, 'md'))\n 152| \n 153| let challengesREADME = ''\n 154| let prev = ''\n 155| \n 156| // difficulty\n 157| const quizzesByDifficulty = [...quizzes].sort((a, b) => DifficultyRank.indexOf(a.difficulty) - DifficultyRank.indexOf(b.difficulty))\n 158| \n 159| for (const quiz of quizzesByDifficulty) {\n 160| if (prev !== quiz.difficulty)\n 161| challengesREADME += `${prev ? '<br><br>' : ''}${toDifficultyBadgeInverted(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}<br>`\n 162| \n 163| challengesREADME += quizToBadge(quiz, locale)\n 164| \n 165| prev = quiz.difficulty\n 166| }\n 167| \n 168| // by tags\n 169| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-tags', locale)}</summary><br><table><tbody>`\n 170| const tags = getAllTags(quizzes, locale)\n 171| for (const tag of tags) {\n 172| challengesREADME += `<tr><td>${toBadge('', `#${tag}`, '999')}</td><td>`\n 173| getQuizzesByTag(quizzesByDifficulty, locale, tag)\n 174| .forEach((quiz) => {\n 175| challengesREADME += quizToBadge(quiz, locale)\n 176| })\n 177| challengesREADME += '</td></tr>'\n 178| }\n 179| challengesREADME += '<tr><td><code> </code></td><td></td></tr>'\n 180| challengesREADME += '</tbody></table></details>'\n 181| \n 182| // by plain text\n 183| prev = ''\n 184| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-plain-text', locale)}</summary><br>`\n 185| for (const quiz of quizzesByDifficulty) {\n 186| if (prev !== quiz.difficulty)\n 187| challengesREADME += `${prev ? '</ul>' : ''}<h3>${toDifficultyPlainText(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}</h3><ul>`\n 188| challengesREADME += `<li>${quizToBadge(quiz, locale, false, false)}</li>`\n 189| prev = quiz.difficulty\n 190| }\n 191| challengesREADME += '</ul></details><br>'\n 192| \n 193| let readme = await fs.readFile(filepath, 'utf-8')\n 194| readme = readme.replace(\n 195| /<!--challenges-start-->[\\s\\S]*<!--challenges-end-->/m,\n 196| `<!--challenges-start-->\\n${challengesREADME}\\n<!--challenges-end-->`,\n 197| )\n 198| await fs.writeFile(filepath, readme, 'utf-8')\n 199| }\n 200| }\n 201| \n 202| async function updateQuestionsREADME(quizzes: Quiz[]) {\n 203| const questionsDir = path.resolve(__dirname, '../questions')\n 204| \n 205| // update each questions' readme\n 206| for (const quiz of quizzes) {\n 207| for (const locale of supportedLocales) {\n 208| await insertInfoReadme(\n 209| path.join(\n 210| questionsDir,\n 211| quiz.path,\n 212| f('README', locale, 'md'),\n 213| ),\n 214| quiz,\n 215| locale,\n 216| quizzes,\n 217| )\n 218| }\n 219| }\n 220| }\n 221| \n 222| export async function updateREADMEs(type?: 'quiz' | 'index') {\n 223| const quizzes = await loadQuizzes()\n 224| quizzes.sort((a, b) => a.no - b.no)\n 225| \n 226| if (type === 'quiz') {\n 227| await updateQuestionsREADME(quizzes)\n 228| }\n 229| else if (type === 'index') {\n 230| await updateIndexREADME(quizzes)\n 231| }\n 232| else {\n 233| await Promise.all([\n 234| updateIndexREADME(quizzes),\n 235| updateQuestionsREADME(quizzes),\n 236| ])\n 237| }\n 238| }\n 239| \n 240| updateREADMEs(process.argv.slice(2)[0] as any)\n```\n\n### FILE: scripts/toUrl.ts (85 lines)\n\n```\n 1| import lzs from 'lz-string'\n 2| import type { Quiz } from './types'\n 3| import { defaultLocale } from './locales'\n 4| import { resolveInfo } from './loader'\n 5| \n 6| export const REPO = 'https://github.com/type-challenges/type-challenges'\n 7| export const DOMAIN = 'https://tsch.js.org'\n 8| export const TYPESCRIPT_PLAYGROUND = 'https://www.typescriptlang.org/play'\n 9| \n 10| // https://github.com/microsoft/TypeScript-Website/tree/v2/packages/playground\n 11| export function toPlaygroundUrl(\n 12| code: string,\n 13| config: Object = {},\n 14| site = TYPESCRIPT_PLAYGROUND,\n 15| ) {\n 16| return `${site}?${Object.entries(config).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}#code/${lzs.compressToEncodedURIComponent(code)}`\n 17| }\n 18| \n 19| export function toSolutionsFull(no: number) {\n 20| return `${REPO}/issues?q=label%3A${no}+label%3Aanswer+sort%3Areactions-%2B1-desc`\n 21| }\n 22| \n 23| export function toQuizREADME(quiz: Quiz, locale?: string, absolute = false) {\n 24| const prefix = absolute ? `${REPO}/blob/main` : '.'\n 25| return locale && locale !== defaultLocale && quiz.readme[locale]\n 26| ? `${prefix}/questions/${quiz.path}/README.${locale}.md`\n 27| : `${prefix}/questions/${quiz.path}/README.md`\n 28| }\n 29| \n 30| export function toRawREADME(quiz: Quiz, locale?: string) {\n 31| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\n 32| // const provider = 'https://raw.githubusercontent.com/type-challenges/type-challenges/main'\n 33| return locale && locale !== defaultLocale && quiz.readme[locale]\n 34| ? `${provider}/questions/${quiz.path}/README.${locale}.md`\n 35| : `${provider}/questions/${quiz.path}/README.md`\n 36| }\n 37| \n 38| export function toQuestionsRawREADME(locale?: string) {\n 39| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\n 40| return locale && locale !== defaultLocale ? `${provider}/README.${locale}.md` : `${provider}/README.md`\n 41| }\n 42| \n 43| export function toNearborREADME(quiz: Quiz, locale?: string) {\n 44| return locale && locale !== defaultLocale && quiz.readme[locale]\n 45| ? `./README.${locale}.md`\n 46| : './README.md'\n 47| }\n 48| \n 49| export function toShareAnswerFull(quiz: Quiz, locale: string = defaultLocale) {\n 50| const info = resolveInfo(quiz, locale)\n 51| if (locale === defaultLocale)\n 52| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=0-answer.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\n 53| else\n 54| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=1-answer.${locale}.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\n 55| }\n 56| \n 57| // Short\n 58| \n 59| export function toReadmeShort(no: number, locale?: string) {\n 60| return locale !== defaultLocale\n 61| ? `${DOMAIN}/${no}/${locale}`\n 62| : `${DOMAIN}/${no}`\n 63| }\n 64| \n 65| export function toSolutionsShort(no: number) {\n 66| return `${DOMAIN}/${no}/solutions`\n 67| }\n 68| \n 69| export function toPlayShort(no: number, locale?: string) {\n 70| return locale !== defaultLocale\n 71| ? `${DOMAIN}/${no}/play/${locale}`\n 72| : `${DOMAIN}/${no}/play`\n 73| }\n 74| \n 75| export function toAnswerShort(no: number, locale?: string) {\n 76| return locale !== defaultLocale\n 77| ? `${DOMAIN}/${no}/answer/${locale}`\n 78| : `${DOMAIN}/${no}/answer`\n 79| }\n 80| \n 81| export function toHomepageShort(locale?: string) {\n 82| return locale !== defaultLocale\n 83| ? `${DOMAIN}/${locale}`\n 84| : `${DOMAIN}`\n 85| }\n```\n\n### FILE: scripts/translate.ts (73 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import { translate } from '@vitalets/google-translate-api'\n 4| import { QUIZ_ROOT, loadQuizByNo, loadQuizzes } from './loader'\n 5| import { resolveFilePath } from './utils/resolve'\n 6| import type { Quiz } from './types'\n 7| import type { SupportedLocale } from './locales'\n 8| import { t } from './locales'\n 9| \n 10| export async function translateQuizByNo(no: number, from: SupportedLocale, to: SupportedLocale) {\n 11| const quiz = await loadQuizByNo(no)\n 12| if (!quiz)\n 13| throw new Error(`Quiz #${no} not founded`)\n 14| return await translateQuiz(quiz, from, to)\n 15| }\n 16| \n 17| export async function translateQuiz(quiz: Quiz, from: SupportedLocale, to: SupportedLocale) {\n 18| let translatedReadme = await translateMarkdown(quiz.readme[from], from, to)\n 19| \n 20| if (!translatedReadme)\n 21| throw new Error(`Quiz #${quiz.no} empty translation`)\n 22| \n 23| translatedReadme = `> ${t(to, 'readme.google-translated')}\\n\\n${translatedReadme.trim()}`\n 24| \n 25| const readmePath = resolveFilePath(path.join(QUIZ_ROOT, quiz.path), 'README', 'md', to)\n 26| await fs.writeFile(readmePath, translatedReadme, 'utf-8')\n 27| \n 28| console.log(`Translated [${quiz.no}] ${from} → ${to} | saved to ${readmePath}`)\n 29| }\n 30| \n 31| export async function translateMarkdown(code: string, from: SupportedLocale, to: SupportedLocale) {\n 32| // to replace the code blocks intro a placeholder then feed it into translator\n 33| // then replace back for the results\n 34| const codeBlocks: string[] = []\n 35| \n 36| const source = code\n 37| .replace(/```[\\s\\S\\n]+?```/g, (v) => {\n 38| const placeholder = `__${codeBlocks.length}__`\n 39| codeBlocks.push(v)\n 40| return placeholder\n 41| })\n 42| .replace(/`[\\s\\S\\n]+?`/g, (v) => {\n 43| const placeholder = `__${codeBlocks.length}__`\n 44| codeBlocks.push(v)\n 45| return placeholder\n 46| })\n 47| \n 48| const { text } = await translate(source, {\n 49| from,\n 50| to,\n 51| })\n 52| \n 53| if (!text)\n 54| return\n 55| \n 56| const result = text.replace(/__\\s*?(\\d+?)\\s*?__/g, (_, i) => codeBlocks[+i])\n 57| \n 58| return result\n 59| }\n 60| \n 61| export async function translateAllQuizzes(from: SupportedLocale, to: SupportedLocale) {\n 62| const quizzes = await loadQuizzes()\n 63| \n 64| for (const quiz of quizzes) {\n 65| if (quiz.readme[to] || !quiz.readme[from]) {\n 66| console.log(`Skipped #${quiz.no}`)\n 67| continue\n 68| }\n 69| \n 70| console.log(`Translating #${quiz.no} to ${to}`)\n 71| await translateQuiz(quiz, from, to)\n 72| }\n 73| }\n```\n\n### FILE: scripts/types.ts (38 lines)\n\n```\n 1| import type { DeepPartial } from 'utility-types'\n 2| import type { context, getOctokit } from '@actions/github'\n 3| import type Core from '@actions/core'\n 4| import type IO from '@actions/io'\n 5| \n 6| export type Github = ReturnType<typeof getOctokit>\n 7| export type Context = typeof context\n 8| export type Action = (github: Github, context: Context, core: typeof Core, io: typeof IO) => Promise<void>\n 9| \n 10| export interface QuizMetaInfo {\n 11| title: string\n 12| author: {\n 13| name: string\n 14| email: string\n 15| github: string\n 16| }\n 17| tsconfig?: Record<string, any>\n 18| original_issues: number[]\n 19| recommended_solutions: number[]\n 20| tags: string[]\n 21| related?: string[]\n 22| }\n 23| \n 24| export type Difficulty = 'warm' | 'easy' | 'medium' | 'hard' | 'extreme' | 'pending'\n 25| \n 26| export interface Quiz {\n 27| no: number\n 28| difficulty: Difficulty\n 29| path: string\n 30| readme: Record<string, string>\n 31| template: string\n 32| info: Record<string, DeepPartial<QuizMetaInfo> | undefined>\n 33| tests?: string\n 34| solutions?: {\n 35| code?: string\n 36| readme?: Record<string, string>\n 37| }\n 38| }\n```\n\n### FILE: utils/index.d.test.ts (35 lines)\n\n```\n 1| import type { Alike, Equal, Expect, ExpectFalse, IsAny, NotEqual } from './index'\n 2| \n 3| type cases = [\n 4| /* Expect */\n 5| Expect<true>,\n 6| // @ts-expect-error\n 7| Expect<false>,\n 8| \n 9| /* ExpectFalse */\n 10| ExpectFalse<false>,\n 11| // @ts-expect-error\n 12| ExpectFalse<true>,\n 13| \n 14| /* Equal */\n 15| Expect<Equal<true, true>>,\n 16| ExpectFalse<Equal<false, true>>,\n 17| Expect<Equal<'123', '123'>>,\n 18| ExpectFalse<Equal<'123', string>>,\n 19| Expect<Equal<{ a: number }, { a: number }>>,\n 20| ExpectFalse<Equal<{ a: number }, { b: number }>>,\n 21| ExpectFalse<Equal<any, '123'>>,\n 22| ExpectFalse<Equal<any, unknown>>,\n 23| \n 24| /* Not Equal */\n 25| Expect<NotEqual<false, true>>,\n 26| ExpectFalse<NotEqual<true, true>>,\n 27| \n 28| /* IsAny */\n 29| Expect<IsAny<any>>,\n 30| ExpectFalse<IsAny<1>>,\n 31| \n 32| /* Alike */\n 33| Expect<Alike<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\n 34| ExpectFalse<Equal<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\n 35| ]\n```\n\n### FILE: utils/index.d.ts (29 lines)\n\n```\n 1| export type Expect<T extends true> = T\n 2| export type ExpectTrue<T extends true> = T\n 3| export type ExpectFalse<T extends false> = T\n 4| export type IsTrue<T extends true> = T\n 5| export type IsFalse<T extends false> = T\n 6| \n 7| export type Equal<X, Y> =\n 8| (<T>() => T extends X ? 1 : 2) extends\n 9| (<T>() => T extends Y ? 1 : 2) ? true : false\n 10| export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true\n 11| \n 12| // https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\n 13| export type IsAny<T> = 0 extends (1 & T) ? true : false\n 14| export type NotAny<T> = true extends IsAny<T> ? false : true\n 15| \n 16| export type Debug<T> = { [K in keyof T]: T[K] }\n 17| export type MergeInsertions<T> =\n 18| T extends object\n 19| ? { [K in keyof T]: MergeInsertions<T[K]> }\n 20| : T\n 21| \n 22| export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>\n 23| \n 24| export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE ? true : false\n 25| export type ExpectValidArgs<FUNC extends (...args: any[]) => any, ARGS extends any[]> = ARGS extends Parameters<FUNC>\n 26| ? true\n 27| : false\n 28| \n 29| export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never\n```\n<END_OF_CONTEXT>\n\n<query>\nGenerate a wiki page describing the overall architecture of this codebase: the main components, how they interact, entry points, and the public interface. Include a Mermaid flowchart of the component structure.\n</query>"},{"role":"assistant","content":"# Type Challenges Codebase Architecture\n\n## Overview\n\nThe Type Challenges codebase is a TypeScript-based platform for generating and managing coding challenges focused on TypeScript type manipulation. It's designed to provide a framework for creating, organizing, and sharing type-level programming challenges with automated testing and translation capabilities.\n\nThe system is composed of several core components that work together to manage challenges, generate code templates, handle localization, and provide web interfaces for users.\n\n## Detailed Analysis\n\n### Core Components\n\nThe codebase is structured around several key components:\n\n1. **Quiz Management System** (`scripts/loader.ts`) - Handles loading and organizing challenge data from the filesystem\n2. **Build System** (`scripts/build.ts`) - Generates static content and redirects for deployment\n3. **Code Generation** (`scripts/generate-play.ts`) - Creates local playground files for user practice\n4. **Documentation Generation** (`scripts/readme.ts`) - Updates README files with challenge metadata\n5. **URL Generation** (`scripts/toUrl.ts`) - Creates URLs for various interfaces and services\n6. **Localization System** (`scripts/locales.ts`) - Manages multi-language support\n7. **Challenge Templates** (`questions/00002-medium-return-type/test-cases.ts`) - Example challenge files with test cases\n\n### Component Interactions\n\nThe architecture follows a data-driven approach where data flows through several processing stages:\n\n1. **Data Loading**: The `loader.ts` module reads challenge data from the filesystem structure (`questions/{number}-{difficulty}-{name}/`) [scripts/loader.ts:68-93]\n2. **Data Processing**: Scripts process this data through various transformations:\n - `build.ts` creates redirect rules and playground URLs [scripts/build.ts:8-54]\n - `generate-play.ts` creates local development files [scripts/generate-play.ts:93-180]\n - `readme.ts` updates documentation with metadata [scripts/readme.ts:148-240]\n3. **Output Generation**: Final outputs include:\n - Playground files for local development\n - README files with embedded metadata\n - Static redirect configurations\n\n### Entry Points\n\nThe main entry points are:\n\n- **Build Process** (`scripts/build.ts`): Called during deployment to generate all static assets [scripts/build.ts:8-54]\n- **Playground Generator** (`scripts/generate-play.ts`): Generates local playground files for user practice [scripts/generate-play.ts:93-180]\n- **README Generator** (`scripts/readme.ts`): Updates documentation files with challenge metadata [scripts/readme.ts:148-240]\n- **Translation System** (`scripts/translate.ts`): Handles language translation of challenges [scripts/translate.ts:10-73]\n\n### Public Interface\n\nThe public interface is primarily accessed through:\n\n1. **URL Routes**:\n - `/questions/{no}` - Challenge page\n - `/questions/{no}/play` - Playground link\n - `/questions/{no}/answer` - Answer submission\n - `/questions/{no}/solutions` - Solutions page\n\n2. **CLI Commands**:\n - `pnpm generate` - Generates playground files\n - `pnpm build` - Builds static assets\n - `pnpm readme` - Updates README files\n\n3. **File Structure**:\n - `questions/{number}-{difficulty}-{name}/` - Challenge directory structure\n - `questions/{number}-{difficulty}-{name}/README.md` - Challenge description\n - `questions/{number}-{difficulty}-{name}/test-cases.ts` - Test cases\n - `questions/{number}-{difficulty}-{name}/template.ts` - Template code\n\n## Mermaid Component Diagram\n\n```mermaid\nflowchart TD\n A[File System] --> B[Loader Module]\n B --> C[Build System]\n B --> D[Playground Generator]\n B --> E[README Generator]\n B --> F[Translation System]\n \n C --> G[Static Redirects]\n C --> H[Playground URLs]\n \n D --> I[Local Playground Files]\n D --> J[Cache Management]\n \n E --> K[Documentation Updates]\n E --> L[Metadata Embedding]\n \n F --> M[Translated READMEs]\n \n G --> N[Deployment]\n H --> O[Web Interface]\n I --> P[Developer Tools]\n K --> Q[Documentation]\n M --> R[Localization]\n \n subgraph \"Core Components\"\n B\n C\n D\n E\n F\n end\n \n subgraph \"Outputs\"\n G\n H\n I\n K\n M\n end\n \n subgraph \"External Services\"\n N\n O\n P\n Q\n R\n end\n```\n\n## Design Rationale\n\nThe architecture emphasizes modularity and separation of concerns. Each component has a single responsibility:\n\n1. **Data Abstraction**: The loader abstracts filesystem access, making it easy to change storage mechanisms [scripts/loader.ts:68-93]\n2. **Immutability**: Data processing is largely immutable, with transformations creating new structures\n3. **Extensibility**: The component-based approach allows easy addition of new processing steps\n4. **Localization**: Built-in support for multiple languages through the locale system [scripts/locales.ts:1-26]\n5. **Developer Experience**: Local playground generation enables immediate experimentation\n\nThe system's design reflects a balance between providing rich functionality for challenge creators and maintaining simplicity for end users, with a strong emphasis on automation and consistency across all generated content."}],"string":"[\n {\n \"role\": \"system\",\n \"content\": [\n \"You are an expert software architect writing wiki documentation for codebases.\\nRequirements:\\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\\n4. Explain the WHY behind design decisions, not only the WHAT.\\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\\n7. Example of the correct citation style, inline and attached to a path:\\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon.\"\n ]\n },\n {\n \"role\": \"user\",\n \"content\": \"<START_OF_CONTEXT>\\n# Repository: type-challenges/type-challenges (language: typescript)\\n\\n# Selected files (windows)\\n- eslint.config.js (24 lines)\\n- questions/00002-medium-return-type/test-cases.ts (20 lines)\\n- questions/00003-medium-omit/test-cases.ts (32 lines)\\n- questions/00004-easy-pick/test-cases.ts (23 lines)\\n- questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\\n- questions/00006-hard-simple-vue/test-cases.ts (37 lines)\\n- questions/00008-medium-readonly-2/test-cases.ts (29 lines)\\n- questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\\n- questions/00599-medium-merge/test-cases.ts (18 lines)\\n- scripts/actions/utils/formatToCode.ts (26 lines)\\n- scripts/actions/utils/toInfoHeader.ts (15 lines)\\n- scripts/build.ts (54 lines)\\n- scripts/generate-play.ts (180 lines)\\n- scripts/loader.ts (117 lines)\\n- scripts/locales.ts (26 lines)\\n- scripts/readme.ts (240 lines)\\n- scripts/toUrl.ts (85 lines)\\n- scripts/translate.ts (73 lines)\\n- scripts/types.ts (38 lines)\\n- utils/index.d.test.ts (35 lines)\\n- utils/index.d.ts (29 lines)\\n\\n\\n### FILE: eslint.config.js (24 lines)\\n\\n```\\n 1| const antfu = require('@antfu/eslint-config').default\\n 2| \\n 3| module.exports = antfu(\\n 4| {\\n 5| markdown: false,\\n 6| },\\n 7| {\\n 8| rules: {\\n 9| 'import/first': 'off',\\n 10| 'no-alert': 'off',\\n 11| 'no-unused-expressions': 'off',\\n 12| 'no-unused-vars': 'off',\\n 13| 'no-use-before-define': 'off',\\n 14| 'prefer-const': 'off',\\n 15| 'ts/ban-ts-comment': 'off',\\n 16| 'ts/ban-types': 'off',\\n 17| 'ts/consistent-type-definitions': 'off',\\n 18| 'ts/no-namespace': 'off',\\n 19| 'ts/no-require-imports': 'off',\\n 20| 'ts/no-unused-vars': 'off',\\n 21| 'unused-imports/no-unused-vars': 'off',\\n 22| },\\n 23| },\\n 24| )\\n```\\n\\n### FILE: questions/00002-medium-return-type/test-cases.ts (20 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<string, MyReturnType<() => string>>>,\\n 5| Expect<Equal<123, MyReturnType<() => 123>>>,\\n 6| Expect<Equal<ComplexObject, MyReturnType<() => ComplexObject>>>,\\n 7| Expect<Equal<Promise<boolean>, MyReturnType<() => Promise<boolean>>>>,\\n 8| Expect<Equal<() => 'foo', MyReturnType<() => () => 'foo'>>>,\\n 9| Expect<Equal<1 | 2, MyReturnType<typeof fn>>>,\\n 10| Expect<Equal<1 | 2, MyReturnType<typeof fn1>>>,\\n 11| ]\\n 12| \\n 13| type ComplexObject = {\\n 14| a: [12, 'foo']\\n 15| bar: 'hello'\\n 16| prev(): number\\n 17| }\\n 18| \\n 19| const fn = (v: boolean) => v ? 1 : 2\\n 20| const fn1 = (v: boolean, w: any) => v ? 1 : 2\\n```\\n\\n### FILE: questions/00003-medium-omit/test-cases.ts (32 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<Expected1, MyOmit<Todo, 'description'>>>,\\n 5| Expect<Equal<Expected2, MyOmit<Todo, 'description' | 'completed'>>>,\\n 6| Expect<Equal<Expected3, MyOmit<Todo1, 'description' | 'completed'>>>,\\n 7| ]\\n 8| \\n 9| interface Todo {\\n 10| title: string\\n 11| description: string\\n 12| completed: boolean\\n 13| }\\n 14| \\n 15| interface Todo1 {\\n 16| readonly title: string\\n 17| description: string\\n 18| completed: boolean\\n 19| }\\n 20| \\n 21| interface Expected1 {\\n 22| title: string\\n 23| completed: boolean\\n 24| }\\n 25| \\n 26| interface Expected2 {\\n 27| title: string\\n 28| }\\n 29| \\n 30| interface Expected3 {\\n 31| readonly title: string\\n 32| }\\n```\\n\\n### FILE: questions/00004-easy-pick/test-cases.ts (23 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<Expected1, MyPick<Todo, 'title'>>>,\\n 5| Expect<Equal<Expected2, MyPick<Todo, 'title' | 'completed'>>>,\\n 6| // @ts-expect-error\\n 7| MyPick<Todo, 'title' | 'completed' | 'invalid'>,\\n 8| ]\\n 9| \\n 10| interface Todo {\\n 11| title: string\\n 12| description: string\\n 13| completed: boolean\\n 14| }\\n 15| \\n 16| interface Expected1 {\\n 17| title: string\\n 18| }\\n 19| \\n 20| interface Expected2 {\\n 21| title: string\\n 22| completed: boolean\\n 23| }\\n```\\n\\n### FILE: questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<'title', GetReadonlyKeys<Todo1>>>,\\n 5| Expect<Equal<'title' | 'description', GetReadonlyKeys<Todo2>>>,\\n 6| ]\\n 7| \\n 8| interface Todo1 {\\n 9| readonly title: string\\n 10| description: string\\n 11| completed: boolean\\n 12| }\\n 13| \\n 14| interface Todo2 {\\n 15| readonly title: string\\n 16| readonly description: string\\n 17| completed?: boolean\\n 18| }\\n```\\n\\n### FILE: questions/00006-hard-simple-vue/test-cases.ts (37 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| SimpleVue({\\n 4| data() {\\n 5| // @ts-expect-error\\n 6| this.firstname\\n 7| // @ts-expect-error\\n 8| this.getRandom()\\n 9| // @ts-expect-error\\n 10| this.data()\\n 11| \\n 12| return {\\n 13| firstname: 'Type',\\n 14| lastname: 'Challenges',\\n 15| amount: 10,\\n 16| }\\n 17| },\\n 18| computed: {\\n 19| fullname() {\\n 20| return `${this.firstname} ${this.lastname}`\\n 21| },\\n 22| },\\n 23| methods: {\\n 24| getRandom() {\\n 25| return Math.random()\\n 26| },\\n 27| hi() {\\n 28| alert(this.amount)\\n 29| alert(this.fullname.toLowerCase())\\n 30| alert(this.getRandom())\\n 31| },\\n 32| test() {\\n 33| const fullname = this.fullname\\n 34| const cases: [Expect<Equal<typeof fullname, string>>] = [] as any\\n 35| },\\n 36| },\\n 37| })\\n```\\n\\n### FILE: questions/00008-medium-readonly-2/test-cases.ts (29 lines)\\n\\n```\\n 1| import type { Alike, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Alike<MyReadonly2<Todo1>, Readonly<Todo1>>>,\\n 5| Expect<Alike<MyReadonly2<Todo1, 'title' | 'description'>, Expected>>,\\n 6| Expect<Alike<MyReadonly2<Todo2, 'title' | 'description'>, Expected>>,\\n 7| Expect<Alike<MyReadonly2<Todo2, 'description' >, Expected>>,\\n 8| ]\\n 9| \\n 10| // @ts-expect-error\\n 11| type error = MyReadonly2<Todo1, 'title' | 'invalid'>\\n 12| \\n 13| interface Todo1 {\\n 14| title: string\\n 15| description?: string\\n 16| completed: boolean\\n 17| }\\n 18| \\n 19| interface Todo2 {\\n 20| readonly title: string\\n 21| description?: string\\n 22| completed: boolean\\n 23| }\\n 24| \\n 25| interface Expected {\\n 26| readonly title: string\\n 27| readonly description?: string\\n 28| completed: boolean\\n 29| }\\n```\\n\\n### FILE: questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<DeepReadonly<X1>, Expected1>>,\\n 5| Expect<Equal<DeepReadonly<X2>, Expected2>>,\\n 6| ]\\n 7| \\n 8| type X1 = {\\n 9| a: () => 22\\n 10| b: string\\n 11| c: {\\n 12| d: boolean\\n 13| e: {\\n 14| g: {\\n 15| h: {\\n 16| i: true\\n 17| j: 'string'\\n 18| }\\n 19| k: 'hello'\\n 20| }\\n 21| l: [\\n 22| 'hi',\\n 23| {\\n 24| m: ['hey']\\n 25| },\\n 26| ]\\n 27| }\\n 28| }\\n 29| }\\n 30| \\n 31| type X2 = { a: string } | { b: number }\\n 32| \\n 33| type Expected1 = {\\n 34| readonly a: () => 22\\n 35| readonly b: string\\n 36| readonly c: {\\n 37| readonly d: boolean\\n 38| readonly e: {\\n 39| readonly g: {\\n 40| readonly h: {\\n 41| readonly i: true\\n 42| readonly j: 'string'\\n 43| }\\n 44| readonly k: 'hello'\\n 45| }\\n 46| readonly l: readonly [\\n 47| 'hi',\\n 48| {\\n 49| readonly m: readonly ['hey']\\n 50| },\\n 51| ]\\n 52| }\\n 53| }\\n 54| }\\n 55| \\n 56| type Expected2 = { readonly a: string } | { readonly b: number }\\n```\\n\\n### FILE: questions/00599-medium-merge/test-cases.ts (18 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type Foo = {\\n 4| a: number\\n 5| b: string\\n 6| }\\n 7| type Bar = {\\n 8| b: number\\n 9| c: boolean\\n 10| }\\n 11| \\n 12| type cases = [\\n 13| Expect<Equal<Merge<Foo, Bar>, {\\n 14| a: number\\n 15| b: number\\n 16| c: boolean\\n 17| }>>,\\n 18| ]\\n```\\n\\n### FILE: scripts/actions/utils/formatToCode.ts (26 lines)\\n\\n```\\n 1| import type { Quiz } from '../../types'\\n 2| import type { SupportedLocale } from '../../locales'\\n 3| import { defaultLocale, t } from '../../locales'\\n 4| import { toCommentBlock } from './toCommentBlock'\\n 5| import { toInfoHeader } from './toInfoHeader'\\n 6| import { toLinks } from './toLinks'\\n 7| import { toDivider } from './toDivider'\\n 8| import { toFooter } from './toFooter'\\n 9| \\n 10| export function formatToCode(quiz: Quiz, locale: SupportedLocale) {\\n 11| return `${toCommentBlock(\\n 12| toInfoHeader(quiz, locale)\\n 13| + (quiz.readme[locale] || quiz.readme[defaultLocale])\\n 14| + toLinks(quiz, locale),\\n 15| )\\n 16| + toDivider(t(locale, 'divider.code-start'))\\n 17| }\\\\n${\\n 18| (quiz.template || '').trim()\\n 19| }\\\\n${\\n 20| toDivider(t(locale, 'divider.test-cases'))\\n 21| }${\\n 22| (quiz.tests || '').trim()\\n 23| }\\\\n${\\n 24| toDivider(t(locale, 'divider.further-steps'))\\n 25| }${toCommentBlock(toFooter(quiz, locale))}`\\n 26| }\\n```\\n\\n### FILE: scripts/actions/utils/toInfoHeader.ts (15 lines)\\n\\n```\\n 1| import type { Quiz } from '../../types'\\n 2| import type { SupportedLocale } from '../../locales'\\n 3| import { t } from '../../locales'\\n 4| import { resolveInfo } from '../../loader'\\n 5| \\n 6| export const toInfoHeader = function toInfoHeader(quiz: Quiz, locale: SupportedLocale) {\\n 7| const info = resolveInfo(quiz, locale)\\n 8| \\n 9| const author = `${info.author?.name} (@${info?.author?.github})`\\n 10| \\n 11| return `${quiz.no} - ${info.title || ''}\\\\n`\\n 12| + '-------\\\\n'\\n 13| + `by ${author} #${t(locale, `difficulty.${quiz.difficulty}`)} ${info?.tags?.map(i => `#${i}`).join(' ') || ''}\\\\n\\\\n`\\n 14| + `### ${t(locale, 'title.question')}\\\\n\\\\n`\\n 15| }\\n```\\n\\n### FILE: scripts/build.ts (54 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import { loadQuizzes, resolveInfo } from './loader'\\n 4| import { REPO, toPlaygroundUrl, toQuestionsRawREADME, toQuizREADME, toRawREADME, toShareAnswerFull, toSolutionsFull } from './toUrl'\\n 5| import { defaultLocale, supportedLocales } from './locales'\\n 6| import { formatToCode } from './actions/utils/formatToCode'\\n 7| \\n 8| export async function build() {\\n 9| const quizzes = await loadQuizzes()\\n 10| const redirects: [string, string, number][] = []\\n 11| \\n 12| // redirect homepage to github repo\\n 13| supportedLocales.filter(locale => locale !== defaultLocale).forEach((locale) => {\\n 14| redirects.push([`/${locale}`, `${REPO}/blob/main/README.${locale}.md`, 302])\\n 15| })\\n 16| \\n 17| supportedLocales.forEach((locale) => {\\n 18| redirects.push([`/raw/${locale}`, toQuestionsRawREADME(locale), 302])\\n 19| })\\n 20| \\n 21| for (const quiz of quizzes) {\\n 22| for (const locale of supportedLocales) {\\n 23| const info = resolveInfo(quiz, locale)\\n 24| \\n 25| const code = formatToCode(quiz, locale)\\n 26| \\n 27| const url = toPlaygroundUrl(code, info.tsconfig || {})\\n 28| \\n 29| if (locale === defaultLocale) {\\n 30| redirects.push([`/${quiz.no}`, toQuizREADME(quiz, locale, true), 302])\\n 31| redirects.push([`/${quiz.no}/raw`, toRawREADME(quiz, locale), 302])\\n 32| redirects.push([`/${quiz.no}/play`, url, 302])\\n 33| redirects.push([`/${quiz.no}/answer`, toShareAnswerFull(quiz), 302])\\n 34| }\\n 35| else {\\n 36| redirects.push([`/${quiz.no}/${locale}`, toQuizREADME(quiz, locale, true), 302])\\n 37| redirects.push([`/${quiz.no}/raw/${locale}`, toRawREADME(quiz, locale), 302])\\n 38| redirects.push([`/${quiz.no}/play/${locale}`, url, 302])\\n 39| redirects.push([`/${quiz.no}/answer/${locale}`, toShareAnswerFull(quiz, locale), 302])\\n 40| }\\n 41| }\\n 42| \\n 43| redirects.push([`/${quiz.no}/solutions`, toSolutionsFull(quiz.no), 302])\\n 44| }\\n 45| \\n 46| const dist = path.resolve(__dirname, 'dist')\\n 47| \\n 48| await fs.remove(dist)\\n 49| await fs.ensureDir(dist)\\n 50| \\n 51| await fs.writeFileSync(path.join(dist, '_redirects'), redirects.map(i => i.join('\\\\t')).join('\\\\n'), 'utf-8')\\n 52| }\\n 53| \\n 54| build()\\n```\\n\\n### FILE: scripts/generate-play.ts (180 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import process from 'node:process'\\n 3| import crypto from 'node:crypto'\\n 4| import fs from 'fs-extra'\\n 5| import c from 'ansis'\\n 6| import prompts from 'prompts'\\n 7| import { formatToCode } from './actions/utils/formatToCode'\\n 8| import { loadQuizzes, resolveInfo } from './loader'\\n 9| import { supportedLocales } from './locales'\\n 10| import { getQuestionFullName } from './actions/issue-pr'\\n 11| import type { QuizMetaInfo } from './types'\\n 12| \\n 13| type Snapshot = Record<string, string>\\n 14| \\n 15| function calculateFileHash(filePathFull: string): Promise<string> {\\n 16| return new Promise((resolve, reject) => {\\n 17| const hash = crypto.createHash('sha1')\\n 18| const fileStream = fs.createReadStream(filePathFull)\\n 19| \\n 20| fileStream.on('data', (data) => {\\n 21| hash.update(data)\\n 22| })\\n 23| \\n 24| fileStream.on('end', () => {\\n 25| hash.update(filePathFull)\\n 26| resolve(hash.digest('hex'))\\n 27| })\\n 28| \\n 29| fileStream.on('error', (err) => {\\n 30| reject(err)\\n 31| })\\n 32| })\\n 33| }\\n 34| \\n 35| async function takeSnapshot(quizzesPath: string) {\\n 36| let snapshot: Snapshot = {}\\n 37| \\n 38| const files = fs.readdirSync(quizzesPath)\\n 39| \\n 40| for (const file of files) {\\n 41| // Might be a file, or a folder\\n 42| const fPath = path.join(quizzesPath, file)\\n 43| const fStats = fs.statSync(fPath)\\n 44| \\n 45| if (fStats.isDirectory()) {\\n 46| snapshot = {\\n 47| ...snapshot,\\n 48| ...(await takeSnapshot(fPath)),\\n 49| }\\n 50| }\\n 51| else {\\n 52| snapshot[file] = await calculateFileHash(fPath)\\n 53| }\\n 54| }\\n 55| \\n 56| return snapshot\\n 57| }\\n 58| \\n 59| function readPlaygroundCache(playgroundCachePath: string): Snapshot {\\n 60| if (!fs.existsSync(playgroundCachePath))\\n 61| return {}\\n 62| \\n 63| try {\\n 64| const rawCacheContent = fs.readFileSync(playgroundCachePath)\\n 65| return JSON.parse(rawCacheContent.toString())\\n 66| }\\n 67| catch (err) {\\n 68| console.log(c.red('Playground cache corrupted. '\\n 69| + 'Cannot generate playground without keeping your changes intact'))\\n 70| console.log(c.cyan('Please ensure you have run this: \\\"pnpm generate\\\"'))\\n 71| process.exit(1)\\n 72| }\\n 73| }\\n 74| \\n 75| function calculateOverridableFiles(cache: Snapshot, snapshot: Snapshot) {\\n 76| const result: Snapshot = {}\\n 77| \\n 78| for (const quizName in snapshot) {\\n 79| if (snapshot[quizName] === cache[quizName])\\n 80| result[quizName] = snapshot[quizName]\\n 81| }\\n 82| \\n 83| return result\\n 84| }\\n 85| \\n 86| function isQuizWritable(quizFileName: string, overridableFiles: Snapshot, playgroundSnapshot: Snapshot): boolean {\\n 87| return !!(\\n 88| overridableFiles[quizFileName]\\n 89| || (!overridableFiles[quizFileName] && !playgroundSnapshot[quizFileName])\\n 90| )\\n 91| }\\n 92| \\n 93| async function generatePlayground() {\\n 94| const playgroundPath = path.join(__dirname, '../playground')\\n 95| const playgroundCachePath = path.join(__dirname, '../.playgroundcache')\\n 96| \\n 97| let locale = supportedLocales.find(locale => locale === process.argv[2])!\\n 98| \\n 99| console.log(c.bold.cyan('Generating local playground...\\\\n'))\\n 100| \\n 101| let overridableFiles: Snapshot\\n 102| let keepChanges = false\\n 103| const currentPlaygroundCache = readPlaygroundCache(playgroundCachePath)\\n 104| let playgroundSnapshot: Snapshot\\n 105| \\n 106| if (process.argv.length === 3 && (process.argv[2] === '--keep-changes' || process.argv[2] === '-K')) {\\n 107| console.log(c.bold.cyan('We will keep your changes while generating.\\\\n'))\\n 108| keepChanges = true\\n 109| \\n 110| playgroundSnapshot = await takeSnapshot(playgroundPath)\\n 111| \\n 112| overridableFiles = calculateOverridableFiles(currentPlaygroundCache, playgroundSnapshot)\\n 113| }\\n 114| else if (fs.existsSync(playgroundPath)) {\\n 115| const result = await prompts([{\\n 116| name: 'confirm',\\n 117| type: 'confirm',\\n 118| initial: false,\\n 119| message: 'The playground directory already exists, it may contains the answers you did. Do you want to override it?',\\n 120| }])\\n 121| if (!result?.confirm)\\n 122| return console.log(c.yellow('Skipped.'))\\n 123| }\\n 124| \\n 125| if (!locale) {\\n 126| const result = await prompts([{\\n 127| name: 'locale',\\n 128| type: 'select',\\n 129| message: 'Select language:',\\n 130| choices: supportedLocales.map(i => ({\\n 131| title: i,\\n 132| value: i,\\n 133| })),\\n 134| }])\\n 135| if (!result)\\n 136| return console.log(c.yellow('Skipped.'))\\n 137| locale = result.locale\\n 138| }\\n 139| \\n 140| if (!keepChanges) {\\n 141| await fs.remove(playgroundPath)\\n 142| await fs.ensureDir(playgroundPath)\\n 143| }\\n 144| \\n 145| const quizzes = await loadQuizzes()\\n 146| const incomingQuizzesCache: Snapshot = {}\\n 147| \\n 148| for (const quiz of quizzes) {\\n 149| const { difficulty, title } = resolveInfo(quiz, locale) as QuizMetaInfo & { difficulty: string }\\n 150| const code = formatToCode(quiz, locale)\\n 151| \\n 152| if (difficulty === undefined || title === undefined) {\\n 153| console.log(c.yellow`${quiz.no} has no ${locale.toUpperCase()} version. Skipping`)\\n 154| continue\\n 155| }\\n 156| \\n 157| const quizzesPathByDifficulty = path.join(playgroundPath, difficulty)\\n 158| \\n 159| const quizFileName = `${getQuestionFullName(quiz.no, difficulty, title)}.ts`\\n 160| const quizPathFull = path.join(quizzesPathByDifficulty, quizFileName)\\n 161| \\n 162| if (!keepChanges || (keepChanges && isQuizWritable(quizFileName, overridableFiles!, playgroundSnapshot!))) {\\n 163| if (!fs.existsSync(quizzesPathByDifficulty))\\n 164| fs.mkdirSync(quizzesPathByDifficulty)\\n 165| await fs.writeFile(quizPathFull, code, 'utf-8')\\n 166| incomingQuizzesCache[quizFileName] = await calculateFileHash(quizPathFull)\\n 167| }\\n 168| }\\n 169| \\n 170| fs.writeFile(playgroundCachePath, JSON.stringify({\\n 171| ...currentPlaygroundCache,\\n 172| ...incomingQuizzesCache,\\n 173| }))\\n 174| \\n 175| console.log()\\n 176| console.log(c.bold.green('Local playground generated at: ') + c.dim(playgroundPath))\\n 177| console.log()\\n 178| }\\n 179| \\n 180| generatePlayground()\\n```\\n\\n### FILE: scripts/loader.ts (117 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import fg from 'fast-glob'\\n 4| import YAML from 'js-yaml'\\n 5| import type { Quiz, QuizMetaInfo } from './types'\\n 6| import { defaultLocale, supportedLocales } from './locales'\\n 7| \\n 8| export async function loadFile(filepath: string) {\\n 9| if (fs.existsSync(filepath))\\n 10| return await fs.readFile(filepath, 'utf-8')\\n 11| return undefined\\n 12| }\\n 13| \\n 14| export async function loadLocaleVariations<T = string>(\\n 15| filepath: string,\\n 16| preprocessor: (s: string) => T = s => s as any as T,\\n 17| ) {\\n 18| const { ext, dir, name } = path.parse(filepath)\\n 19| const data: Record<string, T> = {}\\n 20| \\n 21| for (const locale of supportedLocales) {\\n 22| const file = preprocessor(await loadFile(path.join(dir, `${name}.${locale}${ext}`)) || '')\\n 23| \\n 24| if (file)\\n 25| data[locale] = file\\n 26| }\\n 27| \\n 28| if (!data[defaultLocale]) {\\n 29| // default version\\n 30| const file = preprocessor(await loadFile(filepath) || '')\\n 31| if (file)\\n 32| data[defaultLocale] = file\\n 33| }\\n 34| \\n 35| return data\\n 36| }\\n 37| \\n 38| export function readmeCleanUp(text: string) {\\n 39| return text\\n 40| .replace(/<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/, '')\\n 41| .replace(/<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/, '')\\n 42| .trim()\\n 43| }\\n 44| \\n 45| export function loadInfo(s: string): Partial<QuizMetaInfo> | undefined {\\n 46| const object = YAML.load(s) as any\\n 47| if (!object)\\n 48| return undefined\\n 49| \\n 50| const arrayKeys = ['tags', 'related']\\n 51| \\n 52| for (const key of arrayKeys) {\\n 53| if (object[key]) {\\n 54| object[key] = (object[key] || '')\\n 55| .toString()\\n 56| .split(',')\\n 57| .map((i: string) => i.trim())\\n 58| .filter(Boolean)\\n 59| }\\n 60| else {\\n 61| object[key] = undefined\\n 62| }\\n 63| }\\n 64| \\n 65| return object\\n 66| }\\n 67| \\n 68| export const QUIZ_ROOT = path.resolve(__dirname, '../questions')\\n 69| \\n 70| export async function loadQuizzes(): Promise<Quiz[]> {\\n 71| const folders = await fg('{0..9}*-*', {\\n 72| onlyDirectories: true,\\n 73| cwd: QUIZ_ROOT,\\n 74| })\\n 75| \\n 76| const quizzes = await Promise.all(\\n 77| folders.map(async dir => loadQuiz(dir)),\\n 78| )\\n 79| \\n 80| return quizzes\\n 81| }\\n 82| \\n 83| export async function loadQuiz(dir: string): Promise<Quiz> {\\n 84| return {\\n 85| no: Number(dir.replace(/^(\\\\d+)-.*/, '$1')),\\n 86| difficulty: dir.replace(/^\\\\d+-(.+?)-.*$/, '$1') as any,\\n 87| path: dir,\\n 88| info: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'info.yml'), loadInfo),\\n 89| readme: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'README.md'), readmeCleanUp),\\n 90| template: await loadFile(path.join(QUIZ_ROOT, dir, 'template.ts')) || '',\\n 91| tests: await loadFile(path.join(QUIZ_ROOT, dir, 'test-cases.ts')),\\n 92| }\\n 93| }\\n 94| \\n 95| export async function loadQuizByNo(no: number | string) {\\n 96| const folders = await fg(`${no}-*`, {\\n 97| onlyDirectories: true,\\n 98| cwd: QUIZ_ROOT,\\n 99| })\\n 100| \\n 101| if (folders.length)\\n 102| return await loadQuiz(folders[0])\\n 103| \\n 104| return undefined\\n 105| }\\n 106| \\n 107| export function resolveInfo(quiz: Quiz, locale: string = defaultLocale) {\\n 108| const info = { ...quiz.info[defaultLocale], ...quiz.info[locale] }\\n 109| info.tags = quiz.info[locale]?.tags || quiz.info[defaultLocale]?.tags || []\\n 110| info.related = quiz.info[locale]?.related || quiz.info[defaultLocale]?.related || []\\n 111| \\n 112| if (typeof info.tags === 'string')\\n 113| // @ts-expect-error\\n 114| info.tags = info.tags.split(',').map(i => i.trim()).filter(Boolean)\\n 115| \\n 116| return info as QuizMetaInfo\\n 117| }\\n```\\n\\n### FILE: scripts/locales.ts (26 lines)\\n\\n```\\n 1| export const defaultLocale = 'en'\\n 2| \\n 3| export const supportedLocales = ['en', 'zh-CN', 'ja', 'ko', 'pt-BR'] as const\\n 4| \\n 5| export const messages = {\\n 6| 'en': require('./locales/en.json'),\\n 7| 'zh-CN': require('./locales/zh-CN.json'),\\n 8| 'ja': require('./locales/ja.json'),\\n 9| 'ko': require('./locales/ko.json'),\\n 10| 'pt-BR': require('./locales/pt-BR.json'),\\n 11| }\\n 12| \\n 13| export type SupportedLocale = keyof typeof messages\\n 14| \\n 15| export function t(locale: SupportedLocale, key: string): string {\\n 16| const result = (messages[locale] && messages[locale][key]) || messages[defaultLocale][key]\\n 17| if (!result)\\n 18| throw new Error(`Missing message for key \\\"${key}\\\"`)\\n 19| return result\\n 20| }\\n 21| \\n 22| export function f(name: string, locale: string, ext: string) {\\n 23| if (locale === defaultLocale)\\n 24| return `${name}.${ext}`\\n 25| return `${name}.${locale}.${ext}`\\n 26| }\\n```\\n\\n### FILE: scripts/readme.ts (240 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import process from 'node:process'\\n 3| import fs from 'fs-extra'\\n 4| import type { SupportedLocale } from './locales'\\n 5| import { defaultLocale, f, supportedLocales, t } from './locales'\\n 6| import { loadQuizzes, resolveInfo } from './loader'\\n 7| import { toAnswerShort, toNearborREADME, toPlayShort, toQuizREADME, toSolutionsShort } from './toUrl'\\n 8| import type { Quiz, QuizMetaInfo } from './types'\\n 9| \\n 10| const DifficultyColors: Record<string, string> = {\\n 11| warm: 'teal',\\n 12| easy: '7aad0c',\\n 13| medium: 'd9901a',\\n 14| hard: 'de3d37',\\n 15| extreme: 'b11b8d',\\n 16| }\\n 17| \\n 18| const DifficultyRank = [\\n 19| 'warm',\\n 20| 'easy',\\n 21| 'medium',\\n 22| 'hard',\\n 23| 'extreme',\\n 24| ]\\n 25| \\n 26| function escapeHtml(unsafe: string) {\\n 27| return unsafe\\n 28| .replace(/&/g, '&')\\n 29| .replace(/</g, '<')\\n 30| .replace(/>/g, '>')\\n 31| .replace(/\\\"/g, '"')\\n 32| .replace(/'/g, ''')\\n 33| }\\n 34| \\n 35| function toBadgeURL(label: string, text: string, color: string, args = '') {\\n 36| return `https://img.shields.io/badge/${encodeURIComponent(label.replace(/-/g, '--'))}-${encodeURIComponent(text.replace(/-/g, '--'))}-${color}${args}`\\n 37| }\\n 38| \\n 39| function toBadge(label: string, text: string, color: string, args = '') {\\n 40| return `<img src=\\\"${toBadgeURL(label, text, color, args)}\\\" alt=\\\"${text}\\\"/>`\\n 41| }\\n 42| \\n 43| export function toBadgeLink(url: string, label: string, text: string, color: string, args = '') {\\n 44| return `<a href=\\\"${url}\\\" target=\\\"_blank\\\">${toBadge(label, text, color, args)}</a> `\\n 45| }\\n 46| \\n 47| export function toPlanTextLink(url: string, _label: string, text: string, _color: string, _args = '') {\\n 48| return `<a href=\\\"${url}\\\" target=\\\"_blank\\\">${text}</a> `\\n 49| }\\n 50| \\n 51| function toAuthorInfo(author: Partial<QuizMetaInfo['author']> = {}) {\\n 52| return `by ${author.name}${author.github ? ` <a href=\\\"https://github.com/${author.github}\\\" target=\\\"_blank\\\">@${author.github}</a>` : ''}`\\n 53| }\\n 54| \\n 55| function toDifficultyBadge(difficulty: string, locale: SupportedLocale) {\\n 56| return toBadge('', t(locale, `difficulty.${difficulty}`), DifficultyColors[difficulty])\\n 57| }\\n 58| \\n 59| function toDifficultyBadgeInverted(difficulty: string, locale: SupportedLocale, count: number) {\\n 60| return toBadge(t(locale, `difficulty.${difficulty}`), count.toString(), DifficultyColors[difficulty])\\n 61| }\\n 62| \\n 63| function toDifficultyPlainText(difficulty: string, locale: SupportedLocale, count: number) {\\n 64| return `${t(locale, `difficulty.${difficulty}`)} (${count.toString()})`\\n 65| }\\n 66| \\n 67| function toDetailsInnerText(text: string, locale: SupportedLocale) {\\n 68| return `${t(locale, `details.${text}`)}`\\n 69| }\\n 70| \\n 71| function quizToBadge(quiz: Quiz, locale: string, absolute = false, badge = true) {\\n 72| const fn = badge ? toBadgeLink : toPlanTextLink\\n 73| return fn(\\n 74| toQuizREADME(quiz, locale, absolute),\\n 75| '',\\n 76| `${quiz.no}・${quiz.info[locale]?.title || quiz.info[defaultLocale]?.title}`,\\n 77| DifficultyColors[quiz.difficulty],\\n 78| )\\n 79| }\\n 80| \\n 81| function quizNoToBadges(ids: (string | number)[], quizzes: Quiz[], locale: string, absolute = false) {\\n 82| return ids\\n 83| .map(i => quizzes.find(q => q.no === Number(i)))\\n 84| .filter(Boolean)\\n 85| .map(i => quizToBadge(i!, locale, absolute))\\n 86| .join(' ')\\n 87| }\\n 88| \\n 89| function getAllTags(quizzes: Quiz[], locale: string) {\\n 90| const set = new Set<string>()\\n 91| for (const quiz of quizzes) {\\n 92| const info = resolveInfo(quiz, locale)\\n 93| for (const tag of (info?.tags || []))\\n 94| set.add(tag)\\n 95| }\\n 96| return Array.from(set).sort()\\n 97| }\\n 98| \\n 99| function getQuizzesByTag(quizzes: Quiz[], locale: string, tag: string) {\\n 100| return quizzes.filter((quiz) => {\\n 101| const info = resolveInfo(quiz, locale)\\n 102| return !!info.tags?.includes(tag)\\n 103| })\\n 104| }\\n 105| \\n 106| async function insertInfoReadme(filepath: string, quiz: Quiz, locale: SupportedLocale, quizzes: Quiz[]) {\\n 107| if (!fs.existsSync(filepath))\\n 108| return\\n 109| let text = await fs.readFile(filepath, 'utf-8')\\n 110| /* eslint-disable prefer-template */\\n 111| \\n 112| if (!text.match(/<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/))\\n 113| text = `<!--info-header-start--><!--info-header-end-->\\\\n\\\\n${text}`\\n 114| if (!text.match(/<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/))\\n 115| text = `${text}\\\\n\\\\n<!--info-footer-start--><!--info-footer-end-->`\\n 116| \\n 117| const info = resolveInfo(quiz, locale)\\n 118| \\n 119| const availableLocales = supportedLocales.filter(l => l !== locale).filter(l => !!quiz.readme[l])\\n 120| \\n 121| text = text\\n 122| .replace(\\n 123| /<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/,\\n 124| '<!--info-header-start-->'\\n 125| + `<h1>${escapeHtml(info.title || '')} ${toDifficultyBadge(quiz.difficulty, locale)} ${(info.tags || []).map(i => toBadge('', `#${i}`, '999')).join(' ')}</h1>`\\n 126| + `<blockquote><p>${toAuthorInfo(info.author)}</p></blockquote>`\\n 127| + '<p>'\\n 128| + toBadgeLink(toPlayShort(quiz.no, locale), '', t(locale, 'badge.take-the-challenge'), '3178c6', '?logo=typescript&logoColor=white')\\n 129| + (availableLocales.length ? (' ' + availableLocales.map(l => toBadgeLink(toNearborREADME(quiz, l), '', t(l, 'display'), 'gray')).join(' ')) : '')\\n 130| + '</p>'\\n 131| + '<!--info-header-end-->',\\n 132| )\\n 133| .replace(\\n 134| /<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/,\\n 135| '<!--info-footer-start--><br>'\\n 136| + toBadgeLink(`../../${f('README', locale, 'md')}`, '', t(locale, 'badge.back'), 'grey')\\n 137| + toBadgeLink(toAnswerShort(quiz.no, locale), '', t(locale, 'badge.share-your-solutions'), 'teal')\\n 138| + toBadgeLink(toSolutionsShort(quiz.no), '', t(locale, 'badge.checkout-solutions'), 'de5a77', '?logo=awesome-lists&logoColor=white')\\n 139| + (Array.isArray(info.related) && info.related.length ? `<hr><h3>${t(locale, 'readme.related-challenges')}</h3>${quizNoToBadges(info.related, quizzes, locale, true)}` : '')\\n 140| + '<!--info-footer-end-->',\\n 141| )\\n 142| \\n 143| /* eslint-enable prefer-template */\\n 144| \\n 145| await fs.writeFile(filepath, text, 'utf-8')\\n 146| }\\n 147| \\n 148| async function updateIndexREADME(quizzes: Quiz[]) {\\n 149| // update index README\\n 150| for (const locale of supportedLocales) {\\n 151| const filepath = path.resolve(__dirname, '..', f('README', locale, 'md'))\\n 152| \\n 153| let challengesREADME = ''\\n 154| let prev = ''\\n 155| \\n 156| // difficulty\\n 157| const quizzesByDifficulty = [...quizzes].sort((a, b) => DifficultyRank.indexOf(a.difficulty) - DifficultyRank.indexOf(b.difficulty))\\n 158| \\n 159| for (const quiz of quizzesByDifficulty) {\\n 160| if (prev !== quiz.difficulty)\\n 161| challengesREADME += `${prev ? '<br><br>' : ''}${toDifficultyBadgeInverted(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}<br>`\\n 162| \\n 163| challengesREADME += quizToBadge(quiz, locale)\\n 164| \\n 165| prev = quiz.difficulty\\n 166| }\\n 167| \\n 168| // by tags\\n 169| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-tags', locale)}</summary><br><table><tbody>`\\n 170| const tags = getAllTags(quizzes, locale)\\n 171| for (const tag of tags) {\\n 172| challengesREADME += `<tr><td>${toBadge('', `#${tag}`, '999')}</td><td>`\\n 173| getQuizzesByTag(quizzesByDifficulty, locale, tag)\\n 174| .forEach((quiz) => {\\n 175| challengesREADME += quizToBadge(quiz, locale)\\n 176| })\\n 177| challengesREADME += '</td></tr>'\\n 178| }\\n 179| challengesREADME += '<tr><td><code> </code></td><td></td></tr>'\\n 180| challengesREADME += '</tbody></table></details>'\\n 181| \\n 182| // by plain text\\n 183| prev = ''\\n 184| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-plain-text', locale)}</summary><br>`\\n 185| for (const quiz of quizzesByDifficulty) {\\n 186| if (prev !== quiz.difficulty)\\n 187| challengesREADME += `${prev ? '</ul>' : ''}<h3>${toDifficultyPlainText(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}</h3><ul>`\\n 188| challengesREADME += `<li>${quizToBadge(quiz, locale, false, false)}</li>`\\n 189| prev = quiz.difficulty\\n 190| }\\n 191| challengesREADME += '</ul></details><br>'\\n 192| \\n 193| let readme = await fs.readFile(filepath, 'utf-8')\\n 194| readme = readme.replace(\\n 195| /<!--challenges-start-->[\\\\s\\\\S]*<!--challenges-end-->/m,\\n 196| `<!--challenges-start-->\\\\n${challengesREADME}\\\\n<!--challenges-end-->`,\\n 197| )\\n 198| await fs.writeFile(filepath, readme, 'utf-8')\\n 199| }\\n 200| }\\n 201| \\n 202| async function updateQuestionsREADME(quizzes: Quiz[]) {\\n 203| const questionsDir = path.resolve(__dirname, '../questions')\\n 204| \\n 205| // update each questions' readme\\n 206| for (const quiz of quizzes) {\\n 207| for (const locale of supportedLocales) {\\n 208| await insertInfoReadme(\\n 209| path.join(\\n 210| questionsDir,\\n 211| quiz.path,\\n 212| f('README', locale, 'md'),\\n 213| ),\\n 214| quiz,\\n 215| locale,\\n 216| quizzes,\\n 217| )\\n 218| }\\n 219| }\\n 220| }\\n 221| \\n 222| export async function updateREADMEs(type?: 'quiz' | 'index') {\\n 223| const quizzes = await loadQuizzes()\\n 224| quizzes.sort((a, b) => a.no - b.no)\\n 225| \\n 226| if (type === 'quiz') {\\n 227| await updateQuestionsREADME(quizzes)\\n 228| }\\n 229| else if (type === 'index') {\\n 230| await updateIndexREADME(quizzes)\\n 231| }\\n 232| else {\\n 233| await Promise.all([\\n 234| updateIndexREADME(quizzes),\\n 235| updateQuestionsREADME(quizzes),\\n 236| ])\\n 237| }\\n 238| }\\n 239| \\n 240| updateREADMEs(process.argv.slice(2)[0] as any)\\n```\\n\\n### FILE: scripts/toUrl.ts (85 lines)\\n\\n```\\n 1| import lzs from 'lz-string'\\n 2| import type { Quiz } from './types'\\n 3| import { defaultLocale } from './locales'\\n 4| import { resolveInfo } from './loader'\\n 5| \\n 6| export const REPO = 'https://github.com/type-challenges/type-challenges'\\n 7| export const DOMAIN = 'https://tsch.js.org'\\n 8| export const TYPESCRIPT_PLAYGROUND = 'https://www.typescriptlang.org/play'\\n 9| \\n 10| // https://github.com/microsoft/TypeScript-Website/tree/v2/packages/playground\\n 11| export function toPlaygroundUrl(\\n 12| code: string,\\n 13| config: Object = {},\\n 14| site = TYPESCRIPT_PLAYGROUND,\\n 15| ) {\\n 16| return `${site}?${Object.entries(config).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}#code/${lzs.compressToEncodedURIComponent(code)}`\\n 17| }\\n 18| \\n 19| export function toSolutionsFull(no: number) {\\n 20| return `${REPO}/issues?q=label%3A${no}+label%3Aanswer+sort%3Areactions-%2B1-desc`\\n 21| }\\n 22| \\n 23| export function toQuizREADME(quiz: Quiz, locale?: string, absolute = false) {\\n 24| const prefix = absolute ? `${REPO}/blob/main` : '.'\\n 25| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 26| ? `${prefix}/questions/${quiz.path}/README.${locale}.md`\\n 27| : `${prefix}/questions/${quiz.path}/README.md`\\n 28| }\\n 29| \\n 30| export function toRawREADME(quiz: Quiz, locale?: string) {\\n 31| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\\n 32| // const provider = 'https://raw.githubusercontent.com/type-challenges/type-challenges/main'\\n 33| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 34| ? `${provider}/questions/${quiz.path}/README.${locale}.md`\\n 35| : `${provider}/questions/${quiz.path}/README.md`\\n 36| }\\n 37| \\n 38| export function toQuestionsRawREADME(locale?: string) {\\n 39| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\\n 40| return locale && locale !== defaultLocale ? `${provider}/README.${locale}.md` : `${provider}/README.md`\\n 41| }\\n 42| \\n 43| export function toNearborREADME(quiz: Quiz, locale?: string) {\\n 44| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 45| ? `./README.${locale}.md`\\n 46| : './README.md'\\n 47| }\\n 48| \\n 49| export function toShareAnswerFull(quiz: Quiz, locale: string = defaultLocale) {\\n 50| const info = resolveInfo(quiz, locale)\\n 51| if (locale === defaultLocale)\\n 52| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=0-answer.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\\n 53| else\\n 54| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=1-answer.${locale}.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\\n 55| }\\n 56| \\n 57| // Short\\n 58| \\n 59| export function toReadmeShort(no: number, locale?: string) {\\n 60| return locale !== defaultLocale\\n 61| ? `${DOMAIN}/${no}/${locale}`\\n 62| : `${DOMAIN}/${no}`\\n 63| }\\n 64| \\n 65| export function toSolutionsShort(no: number) {\\n 66| return `${DOMAIN}/${no}/solutions`\\n 67| }\\n 68| \\n 69| export function toPlayShort(no: number, locale?: string) {\\n 70| return locale !== defaultLocale\\n 71| ? `${DOMAIN}/${no}/play/${locale}`\\n 72| : `${DOMAIN}/${no}/play`\\n 73| }\\n 74| \\n 75| export function toAnswerShort(no: number, locale?: string) {\\n 76| return locale !== defaultLocale\\n 77| ? `${DOMAIN}/${no}/answer/${locale}`\\n 78| : `${DOMAIN}/${no}/answer`\\n 79| }\\n 80| \\n 81| export function toHomepageShort(locale?: string) {\\n 82| return locale !== defaultLocale\\n 83| ? `${DOMAIN}/${locale}`\\n 84| : `${DOMAIN}`\\n 85| }\\n```\\n\\n### FILE: scripts/translate.ts (73 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import { translate } from '@vitalets/google-translate-api'\\n 4| import { QUIZ_ROOT, loadQuizByNo, loadQuizzes } from './loader'\\n 5| import { resolveFilePath } from './utils/resolve'\\n 6| import type { Quiz } from './types'\\n 7| import type { SupportedLocale } from './locales'\\n 8| import { t } from './locales'\\n 9| \\n 10| export async function translateQuizByNo(no: number, from: SupportedLocale, to: SupportedLocale) {\\n 11| const quiz = await loadQuizByNo(no)\\n 12| if (!quiz)\\n 13| throw new Error(`Quiz #${no} not founded`)\\n 14| return await translateQuiz(quiz, from, to)\\n 15| }\\n 16| \\n 17| export async function translateQuiz(quiz: Quiz, from: SupportedLocale, to: SupportedLocale) {\\n 18| let translatedReadme = await translateMarkdown(quiz.readme[from], from, to)\\n 19| \\n 20| if (!translatedReadme)\\n 21| throw new Error(`Quiz #${quiz.no} empty translation`)\\n 22| \\n 23| translatedReadme = `> ${t(to, 'readme.google-translated')}\\\\n\\\\n${translatedReadme.trim()}`\\n 24| \\n 25| const readmePath = resolveFilePath(path.join(QUIZ_ROOT, quiz.path), 'README', 'md', to)\\n 26| await fs.writeFile(readmePath, translatedReadme, 'utf-8')\\n 27| \\n 28| console.log(`Translated [${quiz.no}] ${from} → ${to} | saved to ${readmePath}`)\\n 29| }\\n 30| \\n 31| export async function translateMarkdown(code: string, from: SupportedLocale, to: SupportedLocale) {\\n 32| // to replace the code blocks intro a placeholder then feed it into translator\\n 33| // then replace back for the results\\n 34| const codeBlocks: string[] = []\\n 35| \\n 36| const source = code\\n 37| .replace(/```[\\\\s\\\\S\\\\n]+?```/g, (v) => {\\n 38| const placeholder = `__${codeBlocks.length}__`\\n 39| codeBlocks.push(v)\\n 40| return placeholder\\n 41| })\\n 42| .replace(/`[\\\\s\\\\S\\\\n]+?`/g, (v) => {\\n 43| const placeholder = `__${codeBlocks.length}__`\\n 44| codeBlocks.push(v)\\n 45| return placeholder\\n 46| })\\n 47| \\n 48| const { text } = await translate(source, {\\n 49| from,\\n 50| to,\\n 51| })\\n 52| \\n 53| if (!text)\\n 54| return\\n 55| \\n 56| const result = text.replace(/__\\\\s*?(\\\\d+?)\\\\s*?__/g, (_, i) => codeBlocks[+i])\\n 57| \\n 58| return result\\n 59| }\\n 60| \\n 61| export async function translateAllQuizzes(from: SupportedLocale, to: SupportedLocale) {\\n 62| const quizzes = await loadQuizzes()\\n 63| \\n 64| for (const quiz of quizzes) {\\n 65| if (quiz.readme[to] || !quiz.readme[from]) {\\n 66| console.log(`Skipped #${quiz.no}`)\\n 67| continue\\n 68| }\\n 69| \\n 70| console.log(`Translating #${quiz.no} to ${to}`)\\n 71| await translateQuiz(quiz, from, to)\\n 72| }\\n 73| }\\n```\\n\\n### FILE: scripts/types.ts (38 lines)\\n\\n```\\n 1| import type { DeepPartial } from 'utility-types'\\n 2| import type { context, getOctokit } from '@actions/github'\\n 3| import type Core from '@actions/core'\\n 4| import type IO from '@actions/io'\\n 5| \\n 6| export type Github = ReturnType<typeof getOctokit>\\n 7| export type Context = typeof context\\n 8| export type Action = (github: Github, context: Context, core: typeof Core, io: typeof IO) => Promise<void>\\n 9| \\n 10| export interface QuizMetaInfo {\\n 11| title: string\\n 12| author: {\\n 13| name: string\\n 14| email: string\\n 15| github: string\\n 16| }\\n 17| tsconfig?: Record<string, any>\\n 18| original_issues: number[]\\n 19| recommended_solutions: number[]\\n 20| tags: string[]\\n 21| related?: string[]\\n 22| }\\n 23| \\n 24| export type Difficulty = 'warm' | 'easy' | 'medium' | 'hard' | 'extreme' | 'pending'\\n 25| \\n 26| export interface Quiz {\\n 27| no: number\\n 28| difficulty: Difficulty\\n 29| path: string\\n 30| readme: Record<string, string>\\n 31| template: string\\n 32| info: Record<string, DeepPartial<QuizMetaInfo> | undefined>\\n 33| tests?: string\\n 34| solutions?: {\\n 35| code?: string\\n 36| readme?: Record<string, string>\\n 37| }\\n 38| }\\n```\\n\\n### FILE: utils/index.d.test.ts (35 lines)\\n\\n```\\n 1| import type { Alike, Equal, Expect, ExpectFalse, IsAny, NotEqual } from './index'\\n 2| \\n 3| type cases = [\\n 4| /* Expect */\\n 5| Expect<true>,\\n 6| // @ts-expect-error\\n 7| Expect<false>,\\n 8| \\n 9| /* ExpectFalse */\\n 10| ExpectFalse<false>,\\n 11| // @ts-expect-error\\n 12| ExpectFalse<true>,\\n 13| \\n 14| /* Equal */\\n 15| Expect<Equal<true, true>>,\\n 16| ExpectFalse<Equal<false, true>>,\\n 17| Expect<Equal<'123', '123'>>,\\n 18| ExpectFalse<Equal<'123', string>>,\\n 19| Expect<Equal<{ a: number }, { a: number }>>,\\n 20| ExpectFalse<Equal<{ a: number }, { b: number }>>,\\n 21| ExpectFalse<Equal<any, '123'>>,\\n 22| ExpectFalse<Equal<any, unknown>>,\\n 23| \\n 24| /* Not Equal */\\n 25| Expect<NotEqual<false, true>>,\\n 26| ExpectFalse<NotEqual<true, true>>,\\n 27| \\n 28| /* IsAny */\\n 29| Expect<IsAny<any>>,\\n 30| ExpectFalse<IsAny<1>>,\\n 31| \\n 32| /* Alike */\\n 33| Expect<Alike<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\\n 34| ExpectFalse<Equal<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\\n 35| ]\\n```\\n\\n### FILE: utils/index.d.ts (29 lines)\\n\\n```\\n 1| export type Expect<T extends true> = T\\n 2| export type ExpectTrue<T extends true> = T\\n 3| export type ExpectFalse<T extends false> = T\\n 4| export type IsTrue<T extends true> = T\\n 5| export type IsFalse<T extends false> = T\\n 6| \\n 7| export type Equal<X, Y> =\\n 8| (<T>() => T extends X ? 1 : 2) extends\\n 9| (<T>() => T extends Y ? 1 : 2) ? true : false\\n 10| export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true\\n 11| \\n 12| // https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\\n 13| export type IsAny<T> = 0 extends (1 & T) ? true : false\\n 14| export type NotAny<T> = true extends IsAny<T> ? false : true\\n 15| \\n 16| export type Debug<T> = { [K in keyof T]: T[K] }\\n 17| export type MergeInsertions<T> =\\n 18| T extends object\\n 19| ? { [K in keyof T]: MergeInsertions<T[K]> }\\n 20| : T\\n 21| \\n 22| export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>\\n 23| \\n 24| export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE ? true : false\\n 25| export type ExpectValidArgs<FUNC extends (...args: any[]) => any, ARGS extends any[]> = ARGS extends Parameters<FUNC>\\n 26| ? true\\n 27| : false\\n 28| \\n 29| export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never\\n```\\n<END_OF_CONTEXT>\\n\\n<query>\\nGenerate a wiki page describing the overall architecture of this codebase: the main components, how they interact, entry points, and the public interface. Include a Mermaid flowchart of the component structure.\\n</query>\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"# Type Challenges Codebase Architecture\\n\\n## Overview\\n\\nThe Type Challenges codebase is a TypeScript-based platform for generating and managing coding challenges focused on TypeScript type manipulation. It's designed to provide a framework for creating, organizing, and sharing type-level programming challenges with automated testing and translation capabilities.\\n\\nThe system is composed of several core components that work together to manage challenges, generate code templates, handle localization, and provide web interfaces for users.\\n\\n## Detailed Analysis\\n\\n### Core Components\\n\\nThe codebase is structured around several key components:\\n\\n1. **Quiz Management System** (`scripts/loader.ts`) - Handles loading and organizing challenge data from the filesystem\\n2. **Build System** (`scripts/build.ts`) - Generates static content and redirects for deployment\\n3. **Code Generation** (`scripts/generate-play.ts`) - Creates local playground files for user practice\\n4. **Documentation Generation** (`scripts/readme.ts`) - Updates README files with challenge metadata\\n5. **URL Generation** (`scripts/toUrl.ts`) - Creates URLs for various interfaces and services\\n6. **Localization System** (`scripts/locales.ts`) - Manages multi-language support\\n7. **Challenge Templates** (`questions/00002-medium-return-type/test-cases.ts`) - Example challenge files with test cases\\n\\n### Component Interactions\\n\\nThe architecture follows a data-driven approach where data flows through several processing stages:\\n\\n1. **Data Loading**: The `loader.ts` module reads challenge data from the filesystem structure (`questions/{number}-{difficulty}-{name}/`) [scripts/loader.ts:68-93]\\n2. **Data Processing**: Scripts process this data through various transformations:\\n - `build.ts` creates redirect rules and playground URLs [scripts/build.ts:8-54]\\n - `generate-play.ts` creates local development files [scripts/generate-play.ts:93-180]\\n - `readme.ts` updates documentation with metadata [scripts/readme.ts:148-240]\\n3. **Output Generation**: Final outputs include:\\n - Playground files for local development\\n - README files with embedded metadata\\n - Static redirect configurations\\n\\n### Entry Points\\n\\nThe main entry points are:\\n\\n- **Build Process** (`scripts/build.ts`): Called during deployment to generate all static assets [scripts/build.ts:8-54]\\n- **Playground Generator** (`scripts/generate-play.ts`): Generates local playground files for user practice [scripts/generate-play.ts:93-180]\\n- **README Generator** (`scripts/readme.ts`): Updates documentation files with challenge metadata [scripts/readme.ts:148-240]\\n- **Translation System** (`scripts/translate.ts`): Handles language translation of challenges [scripts/translate.ts:10-73]\\n\\n### Public Interface\\n\\nThe public interface is primarily accessed through:\\n\\n1. **URL Routes**:\\n - `/questions/{no}` - Challenge page\\n - `/questions/{no}/play` - Playground link\\n - `/questions/{no}/answer` - Answer submission\\n - `/questions/{no}/solutions` - Solutions page\\n\\n2. **CLI Commands**:\\n - `pnpm generate` - Generates playground files\\n - `pnpm build` - Builds static assets\\n - `pnpm readme` - Updates README files\\n\\n3. **File Structure**:\\n - `questions/{number}-{difficulty}-{name}/` - Challenge directory structure\\n - `questions/{number}-{difficulty}-{name}/README.md` - Challenge description\\n - `questions/{number}-{difficulty}-{name}/test-cases.ts` - Test cases\\n - `questions/{number}-{difficulty}-{name}/template.ts` - Template code\\n\\n## Mermaid Component Diagram\\n\\n```mermaid\\nflowchart TD\\n A[File System] --> B[Loader Module]\\n B --> C[Build System]\\n B --> D[Playground Generator]\\n B --> E[README Generator]\\n B --> F[Translation System]\\n \\n C --> G[Static Redirects]\\n C --> H[Playground URLs]\\n \\n D --> I[Local Playground Files]\\n D --> J[Cache Management]\\n \\n E --> K[Documentation Updates]\\n E --> L[Metadata Embedding]\\n \\n F --> M[Translated READMEs]\\n \\n G --> N[Deployment]\\n H --> O[Web Interface]\\n I --> P[Developer Tools]\\n K --> Q[Documentation]\\n M --> R[Localization]\\n \\n subgraph \\\"Core Components\\\"\\n B\\n C\\n D\\n E\\n F\\n end\\n \\n subgraph \\\"Outputs\\\"\\n G\\n H\\n I\\n K\\n M\\n end\\n \\n subgraph \\\"External Services\\\"\\n N\\n O\\n P\\n Q\\n R\\n end\\n```\\n\\n## Design Rationale\\n\\nThe architecture emphasizes modularity and separation of concerns. Each component has a single responsibility:\\n\\n1. **Data Abstraction**: The loader abstracts filesystem access, making it easy to change storage mechanisms [scripts/loader.ts:68-93]\\n2. **Immutability**: Data processing is largely immutable, with transformations creating new structures\\n3. **Extensibility**: The component-based approach allows easy addition of new processing steps\\n4. **Localization**: Built-in support for multiple languages through the locale system [scripts/locales.ts:1-26]\\n5. **Developer Experience**: Local playground generation enables immediate experimentation\\n\\nThe system's design reflects a balance between providing rich functionality for challenge creators and maintaining simplicity for end users, with a strong emphasis on automation and consistency across all generated content.\"\n }\n]","isConversational":true},"source":{"kind":"string","value":"type-challenges/type-challenges"},"category":{"kind":"string","value":"architecture_overview"},"quality_score":{"kind":"number","value":100,"string":"100"},"citation_stats":{"kind":"string","value":"{\n \"total_citations\": 6,\n \"validity_rate\": 1,\n \"invalid\": []\n}"},"license":{"kind":"string","value":"MIT"},"language":{"kind":"string","value":"typescript"}}},{"rowIdx":97,"cells":{"messages":{"kind":"list like","value":[{"role":"system","content":["You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\n4. Explain the WHY behind design decisions, not only the WHAT.\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\n7. Example of the correct citation style, inline and attached to a path:\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon."]},{"role":"user","content":"<START_OF_CONTEXT>\n# Repository: type-challenges/type-challenges (language: typescript)\n\n# Selected files (windows)\n- eslint.config.js (24 lines)\n- questions/00002-medium-return-type/test-cases.ts (20 lines)\n- questions/00003-medium-omit/test-cases.ts (32 lines)\n- questions/00004-easy-pick/test-cases.ts (23 lines)\n- questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\n- questions/00006-hard-simple-vue/test-cases.ts (37 lines)\n- questions/00008-medium-readonly-2/test-cases.ts (29 lines)\n- questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\n- questions/00599-medium-merge/test-cases.ts (18 lines)\n- scripts/actions/utils/formatToCode.ts (26 lines)\n- scripts/actions/utils/toInfoHeader.ts (15 lines)\n- scripts/build.ts (54 lines)\n- scripts/generate-play.ts (180 lines)\n- scripts/loader.ts (117 lines)\n- scripts/locales.ts (26 lines)\n- scripts/readme.ts (240 lines)\n- scripts/toUrl.ts (85 lines)\n- scripts/translate.ts (73 lines)\n- scripts/types.ts (38 lines)\n- utils/index.d.test.ts (35 lines)\n- utils/index.d.ts (29 lines)\n\n\n### FILE: eslint.config.js (24 lines)\n\n```\n 1| const antfu = require('@antfu/eslint-config').default\n 2| \n 3| module.exports = antfu(\n 4| {\n 5| markdown: false,\n 6| },\n 7| {\n 8| rules: {\n 9| 'import/first': 'off',\n 10| 'no-alert': 'off',\n 11| 'no-unused-expressions': 'off',\n 12| 'no-unused-vars': 'off',\n 13| 'no-use-before-define': 'off',\n 14| 'prefer-const': 'off',\n 15| 'ts/ban-ts-comment': 'off',\n 16| 'ts/ban-types': 'off',\n 17| 'ts/consistent-type-definitions': 'off',\n 18| 'ts/no-namespace': 'off',\n 19| 'ts/no-require-imports': 'off',\n 20| 'ts/no-unused-vars': 'off',\n 21| 'unused-imports/no-unused-vars': 'off',\n 22| },\n 23| },\n 24| )\n```\n\n### FILE: questions/00002-medium-return-type/test-cases.ts (20 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<string, MyReturnType<() => string>>>,\n 5| Expect<Equal<123, MyReturnType<() => 123>>>,\n 6| Expect<Equal<ComplexObject, MyReturnType<() => ComplexObject>>>,\n 7| Expect<Equal<Promise<boolean>, MyReturnType<() => Promise<boolean>>>>,\n 8| Expect<Equal<() => 'foo', MyReturnType<() => () => 'foo'>>>,\n 9| Expect<Equal<1 | 2, MyReturnType<typeof fn>>>,\n 10| Expect<Equal<1 | 2, MyReturnType<typeof fn1>>>,\n 11| ]\n 12| \n 13| type ComplexObject = {\n 14| a: [12, 'foo']\n 15| bar: 'hello'\n 16| prev(): number\n 17| }\n 18| \n 19| const fn = (v: boolean) => v ? 1 : 2\n 20| const fn1 = (v: boolean, w: any) => v ? 1 : 2\n```\n\n### FILE: questions/00003-medium-omit/test-cases.ts (32 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<Expected1, MyOmit<Todo, 'description'>>>,\n 5| Expect<Equal<Expected2, MyOmit<Todo, 'description' | 'completed'>>>,\n 6| Expect<Equal<Expected3, MyOmit<Todo1, 'description' | 'completed'>>>,\n 7| ]\n 8| \n 9| interface Todo {\n 10| title: string\n 11| description: string\n 12| completed: boolean\n 13| }\n 14| \n 15| interface Todo1 {\n 16| readonly title: string\n 17| description: string\n 18| completed: boolean\n 19| }\n 20| \n 21| interface Expected1 {\n 22| title: string\n 23| completed: boolean\n 24| }\n 25| \n 26| interface Expected2 {\n 27| title: string\n 28| }\n 29| \n 30| interface Expected3 {\n 31| readonly title: string\n 32| }\n```\n\n### FILE: questions/00004-easy-pick/test-cases.ts (23 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<Expected1, MyPick<Todo, 'title'>>>,\n 5| Expect<Equal<Expected2, MyPick<Todo, 'title' | 'completed'>>>,\n 6| // @ts-expect-error\n 7| MyPick<Todo, 'title' | 'completed' | 'invalid'>,\n 8| ]\n 9| \n 10| interface Todo {\n 11| title: string\n 12| description: string\n 13| completed: boolean\n 14| }\n 15| \n 16| interface Expected1 {\n 17| title: string\n 18| }\n 19| \n 20| interface Expected2 {\n 21| title: string\n 22| completed: boolean\n 23| }\n```\n\n### FILE: questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<'title', GetReadonlyKeys<Todo1>>>,\n 5| Expect<Equal<'title' | 'description', GetReadonlyKeys<Todo2>>>,\n 6| ]\n 7| \n 8| interface Todo1 {\n 9| readonly title: string\n 10| description: string\n 11| completed: boolean\n 12| }\n 13| \n 14| interface Todo2 {\n 15| readonly title: string\n 16| readonly description: string\n 17| completed?: boolean\n 18| }\n```\n\n### FILE: questions/00006-hard-simple-vue/test-cases.ts (37 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| SimpleVue({\n 4| data() {\n 5| // @ts-expect-error\n 6| this.firstname\n 7| // @ts-expect-error\n 8| this.getRandom()\n 9| // @ts-expect-error\n 10| this.data()\n 11| \n 12| return {\n 13| firstname: 'Type',\n 14| lastname: 'Challenges',\n 15| amount: 10,\n 16| }\n 17| },\n 18| computed: {\n 19| fullname() {\n 20| return `${this.firstname} ${this.lastname}`\n 21| },\n 22| },\n 23| methods: {\n 24| getRandom() {\n 25| return Math.random()\n 26| },\n 27| hi() {\n 28| alert(this.amount)\n 29| alert(this.fullname.toLowerCase())\n 30| alert(this.getRandom())\n 31| },\n 32| test() {\n 33| const fullname = this.fullname\n 34| const cases: [Expect<Equal<typeof fullname, string>>] = [] as any\n 35| },\n 36| },\n 37| })\n```\n\n### FILE: questions/00008-medium-readonly-2/test-cases.ts (29 lines)\n\n```\n 1| import type { Alike, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Alike<MyReadonly2<Todo1>, Readonly<Todo1>>>,\n 5| Expect<Alike<MyReadonly2<Todo1, 'title' | 'description'>, Expected>>,\n 6| Expect<Alike<MyReadonly2<Todo2, 'title' | 'description'>, Expected>>,\n 7| Expect<Alike<MyReadonly2<Todo2, 'description' >, Expected>>,\n 8| ]\n 9| \n 10| // @ts-expect-error\n 11| type error = MyReadonly2<Todo1, 'title' | 'invalid'>\n 12| \n 13| interface Todo1 {\n 14| title: string\n 15| description?: string\n 16| completed: boolean\n 17| }\n 18| \n 19| interface Todo2 {\n 20| readonly title: string\n 21| description?: string\n 22| completed: boolean\n 23| }\n 24| \n 25| interface Expected {\n 26| readonly title: string\n 27| readonly description?: string\n 28| completed: boolean\n 29| }\n```\n\n### FILE: questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<DeepReadonly<X1>, Expected1>>,\n 5| Expect<Equal<DeepReadonly<X2>, Expected2>>,\n 6| ]\n 7| \n 8| type X1 = {\n 9| a: () => 22\n 10| b: string\n 11| c: {\n 12| d: boolean\n 13| e: {\n 14| g: {\n 15| h: {\n 16| i: true\n 17| j: 'string'\n 18| }\n 19| k: 'hello'\n 20| }\n 21| l: [\n 22| 'hi',\n 23| {\n 24| m: ['hey']\n 25| },\n 26| ]\n 27| }\n 28| }\n 29| }\n 30| \n 31| type X2 = { a: string } | { b: number }\n 32| \n 33| type Expected1 = {\n 34| readonly a: () => 22\n 35| readonly b: string\n 36| readonly c: {\n 37| readonly d: boolean\n 38| readonly e: {\n 39| readonly g: {\n 40| readonly h: {\n 41| readonly i: true\n 42| readonly j: 'string'\n 43| }\n 44| readonly k: 'hello'\n 45| }\n 46| readonly l: readonly [\n 47| 'hi',\n 48| {\n 49| readonly m: readonly ['hey']\n 50| },\n 51| ]\n 52| }\n 53| }\n 54| }\n 55| \n 56| type Expected2 = { readonly a: string } | { readonly b: number }\n```\n\n### FILE: questions/00599-medium-merge/test-cases.ts (18 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type Foo = {\n 4| a: number\n 5| b: string\n 6| }\n 7| type Bar = {\n 8| b: number\n 9| c: boolean\n 10| }\n 11| \n 12| type cases = [\n 13| Expect<Equal<Merge<Foo, Bar>, {\n 14| a: number\n 15| b: number\n 16| c: boolean\n 17| }>>,\n 18| ]\n```\n\n### FILE: scripts/actions/utils/formatToCode.ts (26 lines)\n\n```\n 1| import type { Quiz } from '../../types'\n 2| import type { SupportedLocale } from '../../locales'\n 3| import { defaultLocale, t } from '../../locales'\n 4| import { toCommentBlock } from './toCommentBlock'\n 5| import { toInfoHeader } from './toInfoHeader'\n 6| import { toLinks } from './toLinks'\n 7| import { toDivider } from './toDivider'\n 8| import { toFooter } from './toFooter'\n 9| \n 10| export function formatToCode(quiz: Quiz, locale: SupportedLocale) {\n 11| return `${toCommentBlock(\n 12| toInfoHeader(quiz, locale)\n 13| + (quiz.readme[locale] || quiz.readme[defaultLocale])\n 14| + toLinks(quiz, locale),\n 15| )\n 16| + toDivider(t(locale, 'divider.code-start'))\n 17| }\\n${\n 18| (quiz.template || '').trim()\n 19| }\\n${\n 20| toDivider(t(locale, 'divider.test-cases'))\n 21| }${\n 22| (quiz.tests || '').trim()\n 23| }\\n${\n 24| toDivider(t(locale, 'divider.further-steps'))\n 25| }${toCommentBlock(toFooter(quiz, locale))}`\n 26| }\n```\n\n### FILE: scripts/actions/utils/toInfoHeader.ts (15 lines)\n\n```\n 1| import type { Quiz } from '../../types'\n 2| import type { SupportedLocale } from '../../locales'\n 3| import { t } from '../../locales'\n 4| import { resolveInfo } from '../../loader'\n 5| \n 6| export const toInfoHeader = function toInfoHeader(quiz: Quiz, locale: SupportedLocale) {\n 7| const info = resolveInfo(quiz, locale)\n 8| \n 9| const author = `${info.author?.name} (@${info?.author?.github})`\n 10| \n 11| return `${quiz.no} - ${info.title || ''}\\n`\n 12| + '-------\\n'\n 13| + `by ${author} #${t(locale, `difficulty.${quiz.difficulty}`)} ${info?.tags?.map(i => `#${i}`).join(' ') || ''}\\n\\n`\n 14| + `### ${t(locale, 'title.question')}\\n\\n`\n 15| }\n```\n\n### FILE: scripts/build.ts (54 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import { loadQuizzes, resolveInfo } from './loader'\n 4| import { REPO, toPlaygroundUrl, toQuestionsRawREADME, toQuizREADME, toRawREADME, toShareAnswerFull, toSolutionsFull } from './toUrl'\n 5| import { defaultLocale, supportedLocales } from './locales'\n 6| import { formatToCode } from './actions/utils/formatToCode'\n 7| \n 8| export async function build() {\n 9| const quizzes = await loadQuizzes()\n 10| const redirects: [string, string, number][] = []\n 11| \n 12| // redirect homepage to github repo\n 13| supportedLocales.filter(locale => locale !== defaultLocale).forEach((locale) => {\n 14| redirects.push([`/${locale}`, `${REPO}/blob/main/README.${locale}.md`, 302])\n 15| })\n 16| \n 17| supportedLocales.forEach((locale) => {\n 18| redirects.push([`/raw/${locale}`, toQuestionsRawREADME(locale), 302])\n 19| })\n 20| \n 21| for (const quiz of quizzes) {\n 22| for (const locale of supportedLocales) {\n 23| const info = resolveInfo(quiz, locale)\n 24| \n 25| const code = formatToCode(quiz, locale)\n 26| \n 27| const url = toPlaygroundUrl(code, info.tsconfig || {})\n 28| \n 29| if (locale === defaultLocale) {\n 30| redirects.push([`/${quiz.no}`, toQuizREADME(quiz, locale, true), 302])\n 31| redirects.push([`/${quiz.no}/raw`, toRawREADME(quiz, locale), 302])\n 32| redirects.push([`/${quiz.no}/play`, url, 302])\n 33| redirects.push([`/${quiz.no}/answer`, toShareAnswerFull(quiz), 302])\n 34| }\n 35| else {\n 36| redirects.push([`/${quiz.no}/${locale}`, toQuizREADME(quiz, locale, true), 302])\n 37| redirects.push([`/${quiz.no}/raw/${locale}`, toRawREADME(quiz, locale), 302])\n 38| redirects.push([`/${quiz.no}/play/${locale}`, url, 302])\n 39| redirects.push([`/${quiz.no}/answer/${locale}`, toShareAnswerFull(quiz, locale), 302])\n 40| }\n 41| }\n 42| \n 43| redirects.push([`/${quiz.no}/solutions`, toSolutionsFull(quiz.no), 302])\n 44| }\n 45| \n 46| const dist = path.resolve(__dirname, 'dist')\n 47| \n 48| await fs.remove(dist)\n 49| await fs.ensureDir(dist)\n 50| \n 51| await fs.writeFileSync(path.join(dist, '_redirects'), redirects.map(i => i.join('\\t')).join('\\n'), 'utf-8')\n 52| }\n 53| \n 54| build()\n```\n\n### FILE: scripts/generate-play.ts (180 lines)\n\n```\n 1| import path from 'node:path'\n 2| import process from 'node:process'\n 3| import crypto from 'node:crypto'\n 4| import fs from 'fs-extra'\n 5| import c from 'ansis'\n 6| import prompts from 'prompts'\n 7| import { formatToCode } from './actions/utils/formatToCode'\n 8| import { loadQuizzes, resolveInfo } from './loader'\n 9| import { supportedLocales } from './locales'\n 10| import { getQuestionFullName } from './actions/issue-pr'\n 11| import type { QuizMetaInfo } from './types'\n 12| \n 13| type Snapshot = Record<string, string>\n 14| \n 15| function calculateFileHash(filePathFull: string): Promise<string> {\n 16| return new Promise((resolve, reject) => {\n 17| const hash = crypto.createHash('sha1')\n 18| const fileStream = fs.createReadStream(filePathFull)\n 19| \n 20| fileStream.on('data', (data) => {\n 21| hash.update(data)\n 22| })\n 23| \n 24| fileStream.on('end', () => {\n 25| hash.update(filePathFull)\n 26| resolve(hash.digest('hex'))\n 27| })\n 28| \n 29| fileStream.on('error', (err) => {\n 30| reject(err)\n 31| })\n 32| })\n 33| }\n 34| \n 35| async function takeSnapshot(quizzesPath: string) {\n 36| let snapshot: Snapshot = {}\n 37| \n 38| const files = fs.readdirSync(quizzesPath)\n 39| \n 40| for (const file of files) {\n 41| // Might be a file, or a folder\n 42| const fPath = path.join(quizzesPath, file)\n 43| const fStats = fs.statSync(fPath)\n 44| \n 45| if (fStats.isDirectory()) {\n 46| snapshot = {\n 47| ...snapshot,\n 48| ...(await takeSnapshot(fPath)),\n 49| }\n 50| }\n 51| else {\n 52| snapshot[file] = await calculateFileHash(fPath)\n 53| }\n 54| }\n 55| \n 56| return snapshot\n 57| }\n 58| \n 59| function readPlaygroundCache(playgroundCachePath: string): Snapshot {\n 60| if (!fs.existsSync(playgroundCachePath))\n 61| return {}\n 62| \n 63| try {\n 64| const rawCacheContent = fs.readFileSync(playgroundCachePath)\n 65| return JSON.parse(rawCacheContent.toString())\n 66| }\n 67| catch (err) {\n 68| console.log(c.red('Playground cache corrupted. '\n 69| + 'Cannot generate playground without keeping your changes intact'))\n 70| console.log(c.cyan('Please ensure you have run this: \"pnpm generate\"'))\n 71| process.exit(1)\n 72| }\n 73| }\n 74| \n 75| function calculateOverridableFiles(cache: Snapshot, snapshot: Snapshot) {\n 76| const result: Snapshot = {}\n 77| \n 78| for (const quizName in snapshot) {\n 79| if (snapshot[quizName] === cache[quizName])\n 80| result[quizName] = snapshot[quizName]\n 81| }\n 82| \n 83| return result\n 84| }\n 85| \n 86| function isQuizWritable(quizFileName: string, overridableFiles: Snapshot, playgroundSnapshot: Snapshot): boolean {\n 87| return !!(\n 88| overridableFiles[quizFileName]\n 89| || (!overridableFiles[quizFileName] && !playgroundSnapshot[quizFileName])\n 90| )\n 91| }\n 92| \n 93| async function generatePlayground() {\n 94| const playgroundPath = path.join(__dirname, '../playground')\n 95| const playgroundCachePath = path.join(__dirname, '../.playgroundcache')\n 96| \n 97| let locale = supportedLocales.find(locale => locale === process.argv[2])!\n 98| \n 99| console.log(c.bold.cyan('Generating local playground...\\n'))\n 100| \n 101| let overridableFiles: Snapshot\n 102| let keepChanges = false\n 103| const currentPlaygroundCache = readPlaygroundCache(playgroundCachePath)\n 104| let playgroundSnapshot: Snapshot\n 105| \n 106| if (process.argv.length === 3 && (process.argv[2] === '--keep-changes' || process.argv[2] === '-K')) {\n 107| console.log(c.bold.cyan('We will keep your changes while generating.\\n'))\n 108| keepChanges = true\n 109| \n 110| playgroundSnapshot = await takeSnapshot(playgroundPath)\n 111| \n 112| overridableFiles = calculateOverridableFiles(currentPlaygroundCache, playgroundSnapshot)\n 113| }\n 114| else if (fs.existsSync(playgroundPath)) {\n 115| const result = await prompts([{\n 116| name: 'confirm',\n 117| type: 'confirm',\n 118| initial: false,\n 119| message: 'The playground directory already exists, it may contains the answers you did. Do you want to override it?',\n 120| }])\n 121| if (!result?.confirm)\n 122| return console.log(c.yellow('Skipped.'))\n 123| }\n 124| \n 125| if (!locale) {\n 126| const result = await prompts([{\n 127| name: 'locale',\n 128| type: 'select',\n 129| message: 'Select language:',\n 130| choices: supportedLocales.map(i => ({\n 131| title: i,\n 132| value: i,\n 133| })),\n 134| }])\n 135| if (!result)\n 136| return console.log(c.yellow('Skipped.'))\n 137| locale = result.locale\n 138| }\n 139| \n 140| if (!keepChanges) {\n 141| await fs.remove(playgroundPath)\n 142| await fs.ensureDir(playgroundPath)\n 143| }\n 144| \n 145| const quizzes = await loadQuizzes()\n 146| const incomingQuizzesCache: Snapshot = {}\n 147| \n 148| for (const quiz of quizzes) {\n 149| const { difficulty, title } = resolveInfo(quiz, locale) as QuizMetaInfo & { difficulty: string }\n 150| const code = formatToCode(quiz, locale)\n 151| \n 152| if (difficulty === undefined || title === undefined) {\n 153| console.log(c.yellow`${quiz.no} has no ${locale.toUpperCase()} version. Skipping`)\n 154| continue\n 155| }\n 156| \n 157| const quizzesPathByDifficulty = path.join(playgroundPath, difficulty)\n 158| \n 159| const quizFileName = `${getQuestionFullName(quiz.no, difficulty, title)}.ts`\n 160| const quizPathFull = path.join(quizzesPathByDifficulty, quizFileName)\n 161| \n 162| if (!keepChanges || (keepChanges && isQuizWritable(quizFileName, overridableFiles!, playgroundSnapshot!))) {\n 163| if (!fs.existsSync(quizzesPathByDifficulty))\n 164| fs.mkdirSync(quizzesPathByDifficulty)\n 165| await fs.writeFile(quizPathFull, code, 'utf-8')\n 166| incomingQuizzesCache[quizFileName] = await calculateFileHash(quizPathFull)\n 167| }\n 168| }\n 169| \n 170| fs.writeFile(playgroundCachePath, JSON.stringify({\n 171| ...currentPlaygroundCache,\n 172| ...incomingQuizzesCache,\n 173| }))\n 174| \n 175| console.log()\n 176| console.log(c.bold.green('Local playground generated at: ') + c.dim(playgroundPath))\n 177| console.log()\n 178| }\n 179| \n 180| generatePlayground()\n```\n\n### FILE: scripts/loader.ts (117 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import fg from 'fast-glob'\n 4| import YAML from 'js-yaml'\n 5| import type { Quiz, QuizMetaInfo } from './types'\n 6| import { defaultLocale, supportedLocales } from './locales'\n 7| \n 8| export async function loadFile(filepath: string) {\n 9| if (fs.existsSync(filepath))\n 10| return await fs.readFile(filepath, 'utf-8')\n 11| return undefined\n 12| }\n 13| \n 14| export async function loadLocaleVariations<T = string>(\n 15| filepath: string,\n 16| preprocessor: (s: string) => T = s => s as any as T,\n 17| ) {\n 18| const { ext, dir, name } = path.parse(filepath)\n 19| const data: Record<string, T> = {}\n 20| \n 21| for (const locale of supportedLocales) {\n 22| const file = preprocessor(await loadFile(path.join(dir, `${name}.${locale}${ext}`)) || '')\n 23| \n 24| if (file)\n 25| data[locale] = file\n 26| }\n 27| \n 28| if (!data[defaultLocale]) {\n 29| // default version\n 30| const file = preprocessor(await loadFile(filepath) || '')\n 31| if (file)\n 32| data[defaultLocale] = file\n 33| }\n 34| \n 35| return data\n 36| }\n 37| \n 38| export function readmeCleanUp(text: string) {\n 39| return text\n 40| .replace(/<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/, '')\n 41| .replace(/<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/, '')\n 42| .trim()\n 43| }\n 44| \n 45| export function loadInfo(s: string): Partial<QuizMetaInfo> | undefined {\n 46| const object = YAML.load(s) as any\n 47| if (!object)\n 48| return undefined\n 49| \n 50| const arrayKeys = ['tags', 'related']\n 51| \n 52| for (const key of arrayKeys) {\n 53| if (object[key]) {\n 54| object[key] = (object[key] || '')\n 55| .toString()\n 56| .split(',')\n 57| .map((i: string) => i.trim())\n 58| .filter(Boolean)\n 59| }\n 60| else {\n 61| object[key] = undefined\n 62| }\n 63| }\n 64| \n 65| return object\n 66| }\n 67| \n 68| export const QUIZ_ROOT = path.resolve(__dirname, '../questions')\n 69| \n 70| export async function loadQuizzes(): Promise<Quiz[]> {\n 71| const folders = await fg('{0..9}*-*', {\n 72| onlyDirectories: true,\n 73| cwd: QUIZ_ROOT,\n 74| })\n 75| \n 76| const quizzes = await Promise.all(\n 77| folders.map(async dir => loadQuiz(dir)),\n 78| )\n 79| \n 80| return quizzes\n 81| }\n 82| \n 83| export async function loadQuiz(dir: string): Promise<Quiz> {\n 84| return {\n 85| no: Number(dir.replace(/^(\\d+)-.*/, '$1')),\n 86| difficulty: dir.replace(/^\\d+-(.+?)-.*$/, '$1') as any,\n 87| path: dir,\n 88| info: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'info.yml'), loadInfo),\n 89| readme: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'README.md'), readmeCleanUp),\n 90| template: await loadFile(path.join(QUIZ_ROOT, dir, 'template.ts')) || '',\n 91| tests: await loadFile(path.join(QUIZ_ROOT, dir, 'test-cases.ts')),\n 92| }\n 93| }\n 94| \n 95| export async function loadQuizByNo(no: number | string) {\n 96| const folders = await fg(`${no}-*`, {\n 97| onlyDirectories: true,\n 98| cwd: QUIZ_ROOT,\n 99| })\n 100| \n 101| if (folders.length)\n 102| return await loadQuiz(folders[0])\n 103| \n 104| return undefined\n 105| }\n 106| \n 107| export function resolveInfo(quiz: Quiz, locale: string = defaultLocale) {\n 108| const info = { ...quiz.info[defaultLocale], ...quiz.info[locale] }\n 109| info.tags = quiz.info[locale]?.tags || quiz.info[defaultLocale]?.tags || []\n 110| info.related = quiz.info[locale]?.related || quiz.info[defaultLocale]?.related || []\n 111| \n 112| if (typeof info.tags === 'string')\n 113| // @ts-expect-error\n 114| info.tags = info.tags.split(',').map(i => i.trim()).filter(Boolean)\n 115| \n 116| return info as QuizMetaInfo\n 117| }\n```\n\n### FILE: scripts/locales.ts (26 lines)\n\n```\n 1| export const defaultLocale = 'en'\n 2| \n 3| export const supportedLocales = ['en', 'zh-CN', 'ja', 'ko', 'pt-BR'] as const\n 4| \n 5| export const messages = {\n 6| 'en': require('./locales/en.json'),\n 7| 'zh-CN': require('./locales/zh-CN.json'),\n 8| 'ja': require('./locales/ja.json'),\n 9| 'ko': require('./locales/ko.json'),\n 10| 'pt-BR': require('./locales/pt-BR.json'),\n 11| }\n 12| \n 13| export type SupportedLocale = keyof typeof messages\n 14| \n 15| export function t(locale: SupportedLocale, key: string): string {\n 16| const result = (messages[locale] && messages[locale][key]) || messages[defaultLocale][key]\n 17| if (!result)\n 18| throw new Error(`Missing message for key \"${key}\"`)\n 19| return result\n 20| }\n 21| \n 22| export function f(name: string, locale: string, ext: string) {\n 23| if (locale === defaultLocale)\n 24| return `${name}.${ext}`\n 25| return `${name}.${locale}.${ext}`\n 26| }\n```\n\n### FILE: scripts/readme.ts (240 lines)\n\n```\n 1| import path from 'node:path'\n 2| import process from 'node:process'\n 3| import fs from 'fs-extra'\n 4| import type { SupportedLocale } from './locales'\n 5| import { defaultLocale, f, supportedLocales, t } from './locales'\n 6| import { loadQuizzes, resolveInfo } from './loader'\n 7| import { toAnswerShort, toNearborREADME, toPlayShort, toQuizREADME, toSolutionsShort } from './toUrl'\n 8| import type { Quiz, QuizMetaInfo } from './types'\n 9| \n 10| const DifficultyColors: Record<string, string> = {\n 11| warm: 'teal',\n 12| easy: '7aad0c',\n 13| medium: 'd9901a',\n 14| hard: 'de3d37',\n 15| extreme: 'b11b8d',\n 16| }\n 17| \n 18| const DifficultyRank = [\n 19| 'warm',\n 20| 'easy',\n 21| 'medium',\n 22| 'hard',\n 23| 'extreme',\n 24| ]\n 25| \n 26| function escapeHtml(unsafe: string) {\n 27| return unsafe\n 28| .replace(/&/g, '&')\n 29| .replace(/</g, '<')\n 30| .replace(/>/g, '>')\n 31| .replace(/\"/g, '"')\n 32| .replace(/'/g, ''')\n 33| }\n 34| \n 35| function toBadgeURL(label: string, text: string, color: string, args = '') {\n 36| return `https://img.shields.io/badge/${encodeURIComponent(label.replace(/-/g, '--'))}-${encodeURIComponent(text.replace(/-/g, '--'))}-${color}${args}`\n 37| }\n 38| \n 39| function toBadge(label: string, text: string, color: string, args = '') {\n 40| return `<img src=\"${toBadgeURL(label, text, color, args)}\" alt=\"${text}\"/>`\n 41| }\n 42| \n 43| export function toBadgeLink(url: string, label: string, text: string, color: string, args = '') {\n 44| return `<a href=\"${url}\" target=\"_blank\">${toBadge(label, text, color, args)}</a> `\n 45| }\n 46| \n 47| export function toPlanTextLink(url: string, _label: string, text: string, _color: string, _args = '') {\n 48| return `<a href=\"${url}\" target=\"_blank\">${text}</a> `\n 49| }\n 50| \n 51| function toAuthorInfo(author: Partial<QuizMetaInfo['author']> = {}) {\n 52| return `by ${author.name}${author.github ? ` <a href=\"https://github.com/${author.github}\" target=\"_blank\">@${author.github}</a>` : ''}`\n 53| }\n 54| \n 55| function toDifficultyBadge(difficulty: string, locale: SupportedLocale) {\n 56| return toBadge('', t(locale, `difficulty.${difficulty}`), DifficultyColors[difficulty])\n 57| }\n 58| \n 59| function toDifficultyBadgeInverted(difficulty: string, locale: SupportedLocale, count: number) {\n 60| return toBadge(t(locale, `difficulty.${difficulty}`), count.toString(), DifficultyColors[difficulty])\n 61| }\n 62| \n 63| function toDifficultyPlainText(difficulty: string, locale: SupportedLocale, count: number) {\n 64| return `${t(locale, `difficulty.${difficulty}`)} (${count.toString()})`\n 65| }\n 66| \n 67| function toDetailsInnerText(text: string, locale: SupportedLocale) {\n 68| return `${t(locale, `details.${text}`)}`\n 69| }\n 70| \n 71| function quizToBadge(quiz: Quiz, locale: string, absolute = false, badge = true) {\n 72| const fn = badge ? toBadgeLink : toPlanTextLink\n 73| return fn(\n 74| toQuizREADME(quiz, locale, absolute),\n 75| '',\n 76| `${quiz.no}・${quiz.info[locale]?.title || quiz.info[defaultLocale]?.title}`,\n 77| DifficultyColors[quiz.difficulty],\n 78| )\n 79| }\n 80| \n 81| function quizNoToBadges(ids: (string | number)[], quizzes: Quiz[], locale: string, absolute = false) {\n 82| return ids\n 83| .map(i => quizzes.find(q => q.no === Number(i)))\n 84| .filter(Boolean)\n 85| .map(i => quizToBadge(i!, locale, absolute))\n 86| .join(' ')\n 87| }\n 88| \n 89| function getAllTags(quizzes: Quiz[], locale: string) {\n 90| const set = new Set<string>()\n 91| for (const quiz of quizzes) {\n 92| const info = resolveInfo(quiz, locale)\n 93| for (const tag of (info?.tags || []))\n 94| set.add(tag)\n 95| }\n 96| return Array.from(set).sort()\n 97| }\n 98| \n 99| function getQuizzesByTag(quizzes: Quiz[], locale: string, tag: string) {\n 100| return quizzes.filter((quiz) => {\n 101| const info = resolveInfo(quiz, locale)\n 102| return !!info.tags?.includes(tag)\n 103| })\n 104| }\n 105| \n 106| async function insertInfoReadme(filepath: string, quiz: Quiz, locale: SupportedLocale, quizzes: Quiz[]) {\n 107| if (!fs.existsSync(filepath))\n 108| return\n 109| let text = await fs.readFile(filepath, 'utf-8')\n 110| /* eslint-disable prefer-template */\n 111| \n 112| if (!text.match(/<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/))\n 113| text = `<!--info-header-start--><!--info-header-end-->\\n\\n${text}`\n 114| if (!text.match(/<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/))\n 115| text = `${text}\\n\\n<!--info-footer-start--><!--info-footer-end-->`\n 116| \n 117| const info = resolveInfo(quiz, locale)\n 118| \n 119| const availableLocales = supportedLocales.filter(l => l !== locale).filter(l => !!quiz.readme[l])\n 120| \n 121| text = text\n 122| .replace(\n 123| /<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/,\n 124| '<!--info-header-start-->'\n 125| + `<h1>${escapeHtml(info.title || '')} ${toDifficultyBadge(quiz.difficulty, locale)} ${(info.tags || []).map(i => toBadge('', `#${i}`, '999')).join(' ')}</h1>`\n 126| + `<blockquote><p>${toAuthorInfo(info.author)}</p></blockquote>`\n 127| + '<p>'\n 128| + toBadgeLink(toPlayShort(quiz.no, locale), '', t(locale, 'badge.take-the-challenge'), '3178c6', '?logo=typescript&logoColor=white')\n 129| + (availableLocales.length ? (' ' + availableLocales.map(l => toBadgeLink(toNearborREADME(quiz, l), '', t(l, 'display'), 'gray')).join(' ')) : '')\n 130| + '</p>'\n 131| + '<!--info-header-end-->',\n 132| )\n 133| .replace(\n 134| /<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/,\n 135| '<!--info-footer-start--><br>'\n 136| + toBadgeLink(`../../${f('README', locale, 'md')}`, '', t(locale, 'badge.back'), 'grey')\n 137| + toBadgeLink(toAnswerShort(quiz.no, locale), '', t(locale, 'badge.share-your-solutions'), 'teal')\n 138| + toBadgeLink(toSolutionsShort(quiz.no), '', t(locale, 'badge.checkout-solutions'), 'de5a77', '?logo=awesome-lists&logoColor=white')\n 139| + (Array.isArray(info.related) && info.related.length ? `<hr><h3>${t(locale, 'readme.related-challenges')}</h3>${quizNoToBadges(info.related, quizzes, locale, true)}` : '')\n 140| + '<!--info-footer-end-->',\n 141| )\n 142| \n 143| /* eslint-enable prefer-template */\n 144| \n 145| await fs.writeFile(filepath, text, 'utf-8')\n 146| }\n 147| \n 148| async function updateIndexREADME(quizzes: Quiz[]) {\n 149| // update index README\n 150| for (const locale of supportedLocales) {\n 151| const filepath = path.resolve(__dirname, '..', f('README', locale, 'md'))\n 152| \n 153| let challengesREADME = ''\n 154| let prev = ''\n 155| \n 156| // difficulty\n 157| const quizzesByDifficulty = [...quizzes].sort((a, b) => DifficultyRank.indexOf(a.difficulty) - DifficultyRank.indexOf(b.difficulty))\n 158| \n 159| for (const quiz of quizzesByDifficulty) {\n 160| if (prev !== quiz.difficulty)\n 161| challengesREADME += `${prev ? '<br><br>' : ''}${toDifficultyBadgeInverted(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}<br>`\n 162| \n 163| challengesREADME += quizToBadge(quiz, locale)\n 164| \n 165| prev = quiz.difficulty\n 166| }\n 167| \n 168| // by tags\n 169| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-tags', locale)}</summary><br><table><tbody>`\n 170| const tags = getAllTags(quizzes, locale)\n 171| for (const tag of tags) {\n 172| challengesREADME += `<tr><td>${toBadge('', `#${tag}`, '999')}</td><td>`\n 173| getQuizzesByTag(quizzesByDifficulty, locale, tag)\n 174| .forEach((quiz) => {\n 175| challengesREADME += quizToBadge(quiz, locale)\n 176| })\n 177| challengesREADME += '</td></tr>'\n 178| }\n 179| challengesREADME += '<tr><td><code> </code></td><td></td></tr>'\n 180| challengesREADME += '</tbody></table></details>'\n 181| \n 182| // by plain text\n 183| prev = ''\n 184| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-plain-text', locale)}</summary><br>`\n 185| for (const quiz of quizzesByDifficulty) {\n 186| if (prev !== quiz.difficulty)\n 187| challengesREADME += `${prev ? '</ul>' : ''}<h3>${toDifficultyPlainText(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}</h3><ul>`\n 188| challengesREADME += `<li>${quizToBadge(quiz, locale, false, false)}</li>`\n 189| prev = quiz.difficulty\n 190| }\n 191| challengesREADME += '</ul></details><br>'\n 192| \n 193| let readme = await fs.readFile(filepath, 'utf-8')\n 194| readme = readme.replace(\n 195| /<!--challenges-start-->[\\s\\S]*<!--challenges-end-->/m,\n 196| `<!--challenges-start-->\\n${challengesREADME}\\n<!--challenges-end-->`,\n 197| )\n 198| await fs.writeFile(filepath, readme, 'utf-8')\n 199| }\n 200| }\n 201| \n 202| async function updateQuestionsREADME(quizzes: Quiz[]) {\n 203| const questionsDir = path.resolve(__dirname, '../questions')\n 204| \n 205| // update each questions' readme\n 206| for (const quiz of quizzes) {\n 207| for (const locale of supportedLocales) {\n 208| await insertInfoReadme(\n 209| path.join(\n 210| questionsDir,\n 211| quiz.path,\n 212| f('README', locale, 'md'),\n 213| ),\n 214| quiz,\n 215| locale,\n 216| quizzes,\n 217| )\n 218| }\n 219| }\n 220| }\n 221| \n 222| export async function updateREADMEs(type?: 'quiz' | 'index') {\n 223| const quizzes = await loadQuizzes()\n 224| quizzes.sort((a, b) => a.no - b.no)\n 225| \n 226| if (type === 'quiz') {\n 227| await updateQuestionsREADME(quizzes)\n 228| }\n 229| else if (type === 'index') {\n 230| await updateIndexREADME(quizzes)\n 231| }\n 232| else {\n 233| await Promise.all([\n 234| updateIndexREADME(quizzes),\n 235| updateQuestionsREADME(quizzes),\n 236| ])\n 237| }\n 238| }\n 239| \n 240| updateREADMEs(process.argv.slice(2)[0] as any)\n```\n\n### FILE: scripts/toUrl.ts (85 lines)\n\n```\n 1| import lzs from 'lz-string'\n 2| import type { Quiz } from './types'\n 3| import { defaultLocale } from './locales'\n 4| import { resolveInfo } from './loader'\n 5| \n 6| export const REPO = 'https://github.com/type-challenges/type-challenges'\n 7| export const DOMAIN = 'https://tsch.js.org'\n 8| export const TYPESCRIPT_PLAYGROUND = 'https://www.typescriptlang.org/play'\n 9| \n 10| // https://github.com/microsoft/TypeScript-Website/tree/v2/packages/playground\n 11| export function toPlaygroundUrl(\n 12| code: string,\n 13| config: Object = {},\n 14| site = TYPESCRIPT_PLAYGROUND,\n 15| ) {\n 16| return `${site}?${Object.entries(config).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}#code/${lzs.compressToEncodedURIComponent(code)}`\n 17| }\n 18| \n 19| export function toSolutionsFull(no: number) {\n 20| return `${REPO}/issues?q=label%3A${no}+label%3Aanswer+sort%3Areactions-%2B1-desc`\n 21| }\n 22| \n 23| export function toQuizREADME(quiz: Quiz, locale?: string, absolute = false) {\n 24| const prefix = absolute ? `${REPO}/blob/main` : '.'\n 25| return locale && locale !== defaultLocale && quiz.readme[locale]\n 26| ? `${prefix}/questions/${quiz.path}/README.${locale}.md`\n 27| : `${prefix}/questions/${quiz.path}/README.md`\n 28| }\n 29| \n 30| export function toRawREADME(quiz: Quiz, locale?: string) {\n 31| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\n 32| // const provider = 'https://raw.githubusercontent.com/type-challenges/type-challenges/main'\n 33| return locale && locale !== defaultLocale && quiz.readme[locale]\n 34| ? `${provider}/questions/${quiz.path}/README.${locale}.md`\n 35| : `${provider}/questions/${quiz.path}/README.md`\n 36| }\n 37| \n 38| export function toQuestionsRawREADME(locale?: string) {\n 39| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\n 40| return locale && locale !== defaultLocale ? `${provider}/README.${locale}.md` : `${provider}/README.md`\n 41| }\n 42| \n 43| export function toNearborREADME(quiz: Quiz, locale?: string) {\n 44| return locale && locale !== defaultLocale && quiz.readme[locale]\n 45| ? `./README.${locale}.md`\n 46| : './README.md'\n 47| }\n 48| \n 49| export function toShareAnswerFull(quiz: Quiz, locale: string = defaultLocale) {\n 50| const info = resolveInfo(quiz, locale)\n 51| if (locale === defaultLocale)\n 52| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=0-answer.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\n 53| else\n 54| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=1-answer.${locale}.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\n 55| }\n 56| \n 57| // Short\n 58| \n 59| export function toReadmeShort(no: number, locale?: string) {\n 60| return locale !== defaultLocale\n 61| ? `${DOMAIN}/${no}/${locale}`\n 62| : `${DOMAIN}/${no}`\n 63| }\n 64| \n 65| export function toSolutionsShort(no: number) {\n 66| return `${DOMAIN}/${no}/solutions`\n 67| }\n 68| \n 69| export function toPlayShort(no: number, locale?: string) {\n 70| return locale !== defaultLocale\n 71| ? `${DOMAIN}/${no}/play/${locale}`\n 72| : `${DOMAIN}/${no}/play`\n 73| }\n 74| \n 75| export function toAnswerShort(no: number, locale?: string) {\n 76| return locale !== defaultLocale\n 77| ? `${DOMAIN}/${no}/answer/${locale}`\n 78| : `${DOMAIN}/${no}/answer`\n 79| }\n 80| \n 81| export function toHomepageShort(locale?: string) {\n 82| return locale !== defaultLocale\n 83| ? `${DOMAIN}/${locale}`\n 84| : `${DOMAIN}`\n 85| }\n```\n\n### FILE: scripts/translate.ts (73 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import { translate } from '@vitalets/google-translate-api'\n 4| import { QUIZ_ROOT, loadQuizByNo, loadQuizzes } from './loader'\n 5| import { resolveFilePath } from './utils/resolve'\n 6| import type { Quiz } from './types'\n 7| import type { SupportedLocale } from './locales'\n 8| import { t } from './locales'\n 9| \n 10| export async function translateQuizByNo(no: number, from: SupportedLocale, to: SupportedLocale) {\n 11| const quiz = await loadQuizByNo(no)\n 12| if (!quiz)\n 13| throw new Error(`Quiz #${no} not founded`)\n 14| return await translateQuiz(quiz, from, to)\n 15| }\n 16| \n 17| export async function translateQuiz(quiz: Quiz, from: SupportedLocale, to: SupportedLocale) {\n 18| let translatedReadme = await translateMarkdown(quiz.readme[from], from, to)\n 19| \n 20| if (!translatedReadme)\n 21| throw new Error(`Quiz #${quiz.no} empty translation`)\n 22| \n 23| translatedReadme = `> ${t(to, 'readme.google-translated')}\\n\\n${translatedReadme.trim()}`\n 24| \n 25| const readmePath = resolveFilePath(path.join(QUIZ_ROOT, quiz.path), 'README', 'md', to)\n 26| await fs.writeFile(readmePath, translatedReadme, 'utf-8')\n 27| \n 28| console.log(`Translated [${quiz.no}] ${from} → ${to} | saved to ${readmePath}`)\n 29| }\n 30| \n 31| export async function translateMarkdown(code: string, from: SupportedLocale, to: SupportedLocale) {\n 32| // to replace the code blocks intro a placeholder then feed it into translator\n 33| // then replace back for the results\n 34| const codeBlocks: string[] = []\n 35| \n 36| const source = code\n 37| .replace(/```[\\s\\S\\n]+?```/g, (v) => {\n 38| const placeholder = `__${codeBlocks.length}__`\n 39| codeBlocks.push(v)\n 40| return placeholder\n 41| })\n 42| .replace(/`[\\s\\S\\n]+?`/g, (v) => {\n 43| const placeholder = `__${codeBlocks.length}__`\n 44| codeBlocks.push(v)\n 45| return placeholder\n 46| })\n 47| \n 48| const { text } = await translate(source, {\n 49| from,\n 50| to,\n 51| })\n 52| \n 53| if (!text)\n 54| return\n 55| \n 56| const result = text.replace(/__\\s*?(\\d+?)\\s*?__/g, (_, i) => codeBlocks[+i])\n 57| \n 58| return result\n 59| }\n 60| \n 61| export async function translateAllQuizzes(from: SupportedLocale, to: SupportedLocale) {\n 62| const quizzes = await loadQuizzes()\n 63| \n 64| for (const quiz of quizzes) {\n 65| if (quiz.readme[to] || !quiz.readme[from]) {\n 66| console.log(`Skipped #${quiz.no}`)\n 67| continue\n 68| }\n 69| \n 70| console.log(`Translating #${quiz.no} to ${to}`)\n 71| await translateQuiz(quiz, from, to)\n 72| }\n 73| }\n```\n\n### FILE: scripts/types.ts (38 lines)\n\n```\n 1| import type { DeepPartial } from 'utility-types'\n 2| import type { context, getOctokit } from '@actions/github'\n 3| import type Core from '@actions/core'\n 4| import type IO from '@actions/io'\n 5| \n 6| export type Github = ReturnType<typeof getOctokit>\n 7| export type Context = typeof context\n 8| export type Action = (github: Github, context: Context, core: typeof Core, io: typeof IO) => Promise<void>\n 9| \n 10| export interface QuizMetaInfo {\n 11| title: string\n 12| author: {\n 13| name: string\n 14| email: string\n 15| github: string\n 16| }\n 17| tsconfig?: Record<string, any>\n 18| original_issues: number[]\n 19| recommended_solutions: number[]\n 20| tags: string[]\n 21| related?: string[]\n 22| }\n 23| \n 24| export type Difficulty = 'warm' | 'easy' | 'medium' | 'hard' | 'extreme' | 'pending'\n 25| \n 26| export interface Quiz {\n 27| no: number\n 28| difficulty: Difficulty\n 29| path: string\n 30| readme: Record<string, string>\n 31| template: string\n 32| info: Record<string, DeepPartial<QuizMetaInfo> | undefined>\n 33| tests?: string\n 34| solutions?: {\n 35| code?: string\n 36| readme?: Record<string, string>\n 37| }\n 38| }\n```\n\n### FILE: utils/index.d.test.ts (35 lines)\n\n```\n 1| import type { Alike, Equal, Expect, ExpectFalse, IsAny, NotEqual } from './index'\n 2| \n 3| type cases = [\n 4| /* Expect */\n 5| Expect<true>,\n 6| // @ts-expect-error\n 7| Expect<false>,\n 8| \n 9| /* ExpectFalse */\n 10| ExpectFalse<false>,\n 11| // @ts-expect-error\n 12| ExpectFalse<true>,\n 13| \n 14| /* Equal */\n 15| Expect<Equal<true, true>>,\n 16| ExpectFalse<Equal<false, true>>,\n 17| Expect<Equal<'123', '123'>>,\n 18| ExpectFalse<Equal<'123', string>>,\n 19| Expect<Equal<{ a: number }, { a: number }>>,\n 20| ExpectFalse<Equal<{ a: number }, { b: number }>>,\n 21| ExpectFalse<Equal<any, '123'>>,\n 22| ExpectFalse<Equal<any, unknown>>,\n 23| \n 24| /* Not Equal */\n 25| Expect<NotEqual<false, true>>,\n 26| ExpectFalse<NotEqual<true, true>>,\n 27| \n 28| /* IsAny */\n 29| Expect<IsAny<any>>,\n 30| ExpectFalse<IsAny<1>>,\n 31| \n 32| /* Alike */\n 33| Expect<Alike<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\n 34| ExpectFalse<Equal<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\n 35| ]\n```\n\n### FILE: utils/index.d.ts (29 lines)\n\n```\n 1| export type Expect<T extends true> = T\n 2| export type ExpectTrue<T extends true> = T\n 3| export type ExpectFalse<T extends false> = T\n 4| export type IsTrue<T extends true> = T\n 5| export type IsFalse<T extends false> = T\n 6| \n 7| export type Equal<X, Y> =\n 8| (<T>() => T extends X ? 1 : 2) extends\n 9| (<T>() => T extends Y ? 1 : 2) ? true : false\n 10| export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true\n 11| \n 12| // https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\n 13| export type IsAny<T> = 0 extends (1 & T) ? true : false\n 14| export type NotAny<T> = true extends IsAny<T> ? false : true\n 15| \n 16| export type Debug<T> = { [K in keyof T]: T[K] }\n 17| export type MergeInsertions<T> =\n 18| T extends object\n 19| ? { [K in keyof T]: MergeInsertions<T[K]> }\n 20| : T\n 21| \n 22| export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>\n 23| \n 24| export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE ? true : false\n 25| export type ExpectValidArgs<FUNC extends (...args: any[]) => any, ARGS extends any[]> = ARGS extends Parameters<FUNC>\n 26| ? true\n 27| : false\n 28| \n 29| export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never\n```\n<END_OF_CONTEXT>\n\n<query>\nIdentify the most architecturally significant module in the provided context and write an in-depth wiki page analyzing it: its responsibilities, key abstractions, control flow, and how other parts of the system depend on it.\n</query>"},{"role":"assistant","content":"# Architecture Analysis: `scripts/loader.ts`\n\n## Overview\n\nThe `scripts/loader.ts` module serves as the core data loading and processing layer for the Type Challenges repository. It is responsible for loading quiz data from the file system, parsing metadata, and providing standardized access to quiz information across the entire application. This module is architecturally significant because it acts as the central data source that all other scripts depend upon for accessing quiz content, metadata, and structure.\n\n## Detailed Analysis\n\n### Responsibilities\n\nThe loader module has several key responsibilities:\n\n1. **File System Operations**: Loading files from the quiz directory structure (`questions/{number}-{difficulty}-{name}/`)\n2. **Locale-aware Content Loading**: Handling multiple language versions of quiz content\n3. **Metadata Parsing**: Converting YAML information files into structured data\n4. **Quiz Data Aggregation**: Combining various file components (README, info, templates, tests) into complete quiz objects\n5. **Data Normalization**: Standardizing how quiz information is accessed across different locales\n\n### Key Abstractions\n\nThe module defines several important abstractions:\n\n- **Quiz Interface**: The `Quiz` type represents a complete quiz with properties like `no`, `difficulty`, `path`, `info`, `readme`, `template`, and `tests` [scripts/types.ts:26-38]. This abstraction provides a consistent interface for all quiz-related operations.\n\n- **Locale Variations**: The `loadLocaleVariations` function abstracts the process of loading content in multiple languages, falling back to a default locale when specific language versions don't exist [scripts/loader.ts:14-36].\n\n- **Metadata Loading**: The `loadInfo` function handles parsing YAML metadata files into structured objects with proper array handling for tags and related challenges [scripts/loader.ts:45-66].\n\n- **Quiz Loading**: The `loadQuiz` function orchestrates the loading of all components of a single quiz [scripts/loader.ts:83-93].\n\n### Control Flow\n\nThe control flow within `loader.ts` follows a predictable pattern:\n\n1. **Initialization**: The module exports constants like `QUIZ_ROOT` and utility functions for file loading [scripts/loader.ts:68-93].\n2. **Quiz Discovery**: `loadQuizzes` uses `fast-glob` to discover all quiz directories [scripts/loader.ts:70-81].\n3. **Individual Quiz Loading**: For each discovered directory, `loadQuiz` is called to construct a complete quiz object [scripts/loader.ts:76-78].\n4. **File Loading**: `loadFile` and `loadLocaleVariations` handle the actual reading of files and their locale-specific variants [scripts/loader.ts:8-36].\n5. **Metadata Processing**: `loadInfo` processes YAML metadata files into structured objects [scripts/loader.ts:45-66].\n6. **Data Aggregation**: The `loadQuiz` function combines all loaded components into a single `Quiz` object [scripts/loader.ts:84-93].\n7. **Info Resolution**: `resolveInfo` merges default and locale-specific metadata, handling fallbacks appropriately [scripts/loader.ts:107-117].\n\n### Dependencies and Usage Patterns\n\nThe loader module is depended upon by several other modules in the system:\n\n- **`scripts/build.ts`**: Uses `loadQuizzes` to get all quiz data for building redirects and generating playground code [scripts/build.ts:9].\n- **`scripts/generate-play.ts`**: Relies on `loadQuizzes` and `resolveInfo` to generate local playground files [scripts/generate-play.ts:145-149].\n- **`scripts/readme.ts`**: Depends on `loadQuizzes` and `resolveInfo` to update README files with quiz metadata [scripts/readme.ts:6-7].\n- **`scripts/toUrl.ts`**: Uses `resolveInfo` to get quiz metadata for URL generation [scripts/toUrl.ts:4].\n- **`scripts/translate.ts`**: Calls `loadQuizByNo` to load specific quizzes for translation [scripts/translate.ts:10-15].\n\nThe module's design enables a clean separation of concerns where other modules can depend on the standardized `Quiz` interface without worrying about the underlying file structure or localization complexities.\n\n### Architectural Design Decisions\n\nSeveral design decisions make this module robust and maintainable:\n\n1. **Separation of Concerns**: The module separates file I/O operations from data processing, making it easier to test and modify individual components.\n\n2. **Locale Flexibility**: The use of `loadLocaleVariations` allows for easy extension to new languages without changing core logic [scripts/loader.ts:14-36].\n\n3. **Fallback Strategy**: The system automatically falls back to default locale content when localized versions don't exist, ensuring robustness [scripts/loader.ts:28-33].\n\n4. **Type Safety**: The module leverages TypeScript interfaces and generics to provide compile-time guarantees about data structure [scripts/types.ts:26-38].\n\n5. **Reusable Utilities**: Functions like `loadFile` and `loadLocaleVariations` are generic enough to be reused across different parts of the system [scripts/loader.ts:8-36].\n\n## Mermaid Flowchart: Quiz Loading Process\n\n```mermaid\nflowchart TD\n A[loadQuizzes] --> B[Discover quiz directories]\n B --> C[For each directory, call loadQuiz]\n C --> D[loadQuiz function]\n D --> E[Load quiz number and difficulty]\n D --> F[Load info.yml with loadLocaleVariations]\n D --> G[Load README.md with loadLocaleVariations]\n D --> H[Load template.ts]\n D --> I[Load test-cases.ts]\n D --> J[Return complete Quiz object]\n \n subgraph \"loadLocaleVariations\"\n K[Load base file]\n L[Load locale-specific files]\n M[Combine into record]\n end\n \n F --> K\n G --> K\n K --> M\n L --> M\n \n subgraph \"loadFile\"\n N[Check if file exists]\n O[Read file content]\n P[Return content or undefined]\n end\n \n H --> N\n I --> N\n N --> O\n O --> P\n```\n\n## Conclusion\n\nThe `scripts/loader.ts` module is the architectural backbone of the Type Challenges system. Its design enables a clean separation of data loading from business logic, provides robust support for internationalization, and establishes a consistent interface for accessing quiz data throughout the application. The module's reliance on well-defined abstractions and its integration with TypeScript's type system make it both maintainable and extensible. All other scripts in the system depend on this module's stable interface, making it a critical component that requires careful attention when making changes."}],"string":"[\n {\n \"role\": \"system\",\n \"content\": [\n \"You are an expert software architect writing wiki documentation for codebases.\\nRequirements:\\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\\n4. Explain the WHY behind design decisions, not only the WHAT.\\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\\n7. Example of the correct citation style, inline and attached to a path:\\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon.\"\n ]\n },\n {\n \"role\": \"user\",\n \"content\": \"<START_OF_CONTEXT>\\n# Repository: type-challenges/type-challenges (language: typescript)\\n\\n# Selected files (windows)\\n- eslint.config.js (24 lines)\\n- questions/00002-medium-return-type/test-cases.ts (20 lines)\\n- questions/00003-medium-omit/test-cases.ts (32 lines)\\n- questions/00004-easy-pick/test-cases.ts (23 lines)\\n- questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\\n- questions/00006-hard-simple-vue/test-cases.ts (37 lines)\\n- questions/00008-medium-readonly-2/test-cases.ts (29 lines)\\n- questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\\n- questions/00599-medium-merge/test-cases.ts (18 lines)\\n- scripts/actions/utils/formatToCode.ts (26 lines)\\n- scripts/actions/utils/toInfoHeader.ts (15 lines)\\n- scripts/build.ts (54 lines)\\n- scripts/generate-play.ts (180 lines)\\n- scripts/loader.ts (117 lines)\\n- scripts/locales.ts (26 lines)\\n- scripts/readme.ts (240 lines)\\n- scripts/toUrl.ts (85 lines)\\n- scripts/translate.ts (73 lines)\\n- scripts/types.ts (38 lines)\\n- utils/index.d.test.ts (35 lines)\\n- utils/index.d.ts (29 lines)\\n\\n\\n### FILE: eslint.config.js (24 lines)\\n\\n```\\n 1| const antfu = require('@antfu/eslint-config').default\\n 2| \\n 3| module.exports = antfu(\\n 4| {\\n 5| markdown: false,\\n 6| },\\n 7| {\\n 8| rules: {\\n 9| 'import/first': 'off',\\n 10| 'no-alert': 'off',\\n 11| 'no-unused-expressions': 'off',\\n 12| 'no-unused-vars': 'off',\\n 13| 'no-use-before-define': 'off',\\n 14| 'prefer-const': 'off',\\n 15| 'ts/ban-ts-comment': 'off',\\n 16| 'ts/ban-types': 'off',\\n 17| 'ts/consistent-type-definitions': 'off',\\n 18| 'ts/no-namespace': 'off',\\n 19| 'ts/no-require-imports': 'off',\\n 20| 'ts/no-unused-vars': 'off',\\n 21| 'unused-imports/no-unused-vars': 'off',\\n 22| },\\n 23| },\\n 24| )\\n```\\n\\n### FILE: questions/00002-medium-return-type/test-cases.ts (20 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<string, MyReturnType<() => string>>>,\\n 5| Expect<Equal<123, MyReturnType<() => 123>>>,\\n 6| Expect<Equal<ComplexObject, MyReturnType<() => ComplexObject>>>,\\n 7| Expect<Equal<Promise<boolean>, MyReturnType<() => Promise<boolean>>>>,\\n 8| Expect<Equal<() => 'foo', MyReturnType<() => () => 'foo'>>>,\\n 9| Expect<Equal<1 | 2, MyReturnType<typeof fn>>>,\\n 10| Expect<Equal<1 | 2, MyReturnType<typeof fn1>>>,\\n 11| ]\\n 12| \\n 13| type ComplexObject = {\\n 14| a: [12, 'foo']\\n 15| bar: 'hello'\\n 16| prev(): number\\n 17| }\\n 18| \\n 19| const fn = (v: boolean) => v ? 1 : 2\\n 20| const fn1 = (v: boolean, w: any) => v ? 1 : 2\\n```\\n\\n### FILE: questions/00003-medium-omit/test-cases.ts (32 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<Expected1, MyOmit<Todo, 'description'>>>,\\n 5| Expect<Equal<Expected2, MyOmit<Todo, 'description' | 'completed'>>>,\\n 6| Expect<Equal<Expected3, MyOmit<Todo1, 'description' | 'completed'>>>,\\n 7| ]\\n 8| \\n 9| interface Todo {\\n 10| title: string\\n 11| description: string\\n 12| completed: boolean\\n 13| }\\n 14| \\n 15| interface Todo1 {\\n 16| readonly title: string\\n 17| description: string\\n 18| completed: boolean\\n 19| }\\n 20| \\n 21| interface Expected1 {\\n 22| title: string\\n 23| completed: boolean\\n 24| }\\n 25| \\n 26| interface Expected2 {\\n 27| title: string\\n 28| }\\n 29| \\n 30| interface Expected3 {\\n 31| readonly title: string\\n 32| }\\n```\\n\\n### FILE: questions/00004-easy-pick/test-cases.ts (23 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<Expected1, MyPick<Todo, 'title'>>>,\\n 5| Expect<Equal<Expected2, MyPick<Todo, 'title' | 'completed'>>>,\\n 6| // @ts-expect-error\\n 7| MyPick<Todo, 'title' | 'completed' | 'invalid'>,\\n 8| ]\\n 9| \\n 10| interface Todo {\\n 11| title: string\\n 12| description: string\\n 13| completed: boolean\\n 14| }\\n 15| \\n 16| interface Expected1 {\\n 17| title: string\\n 18| }\\n 19| \\n 20| interface Expected2 {\\n 21| title: string\\n 22| completed: boolean\\n 23| }\\n```\\n\\n### FILE: questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<'title', GetReadonlyKeys<Todo1>>>,\\n 5| Expect<Equal<'title' | 'description', GetReadonlyKeys<Todo2>>>,\\n 6| ]\\n 7| \\n 8| interface Todo1 {\\n 9| readonly title: string\\n 10| description: string\\n 11| completed: boolean\\n 12| }\\n 13| \\n 14| interface Todo2 {\\n 15| readonly title: string\\n 16| readonly description: string\\n 17| completed?: boolean\\n 18| }\\n```\\n\\n### FILE: questions/00006-hard-simple-vue/test-cases.ts (37 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| SimpleVue({\\n 4| data() {\\n 5| // @ts-expect-error\\n 6| this.firstname\\n 7| // @ts-expect-error\\n 8| this.getRandom()\\n 9| // @ts-expect-error\\n 10| this.data()\\n 11| \\n 12| return {\\n 13| firstname: 'Type',\\n 14| lastname: 'Challenges',\\n 15| amount: 10,\\n 16| }\\n 17| },\\n 18| computed: {\\n 19| fullname() {\\n 20| return `${this.firstname} ${this.lastname}`\\n 21| },\\n 22| },\\n 23| methods: {\\n 24| getRandom() {\\n 25| return Math.random()\\n 26| },\\n 27| hi() {\\n 28| alert(this.amount)\\n 29| alert(this.fullname.toLowerCase())\\n 30| alert(this.getRandom())\\n 31| },\\n 32| test() {\\n 33| const fullname = this.fullname\\n 34| const cases: [Expect<Equal<typeof fullname, string>>] = [] as any\\n 35| },\\n 36| },\\n 37| })\\n```\\n\\n### FILE: questions/00008-medium-readonly-2/test-cases.ts (29 lines)\\n\\n```\\n 1| import type { Alike, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Alike<MyReadonly2<Todo1>, Readonly<Todo1>>>,\\n 5| Expect<Alike<MyReadonly2<Todo1, 'title' | 'description'>, Expected>>,\\n 6| Expect<Alike<MyReadonly2<Todo2, 'title' | 'description'>, Expected>>,\\n 7| Expect<Alike<MyReadonly2<Todo2, 'description' >, Expected>>,\\n 8| ]\\n 9| \\n 10| // @ts-expect-error\\n 11| type error = MyReadonly2<Todo1, 'title' | 'invalid'>\\n 12| \\n 13| interface Todo1 {\\n 14| title: string\\n 15| description?: string\\n 16| completed: boolean\\n 17| }\\n 18| \\n 19| interface Todo2 {\\n 20| readonly title: string\\n 21| description?: string\\n 22| completed: boolean\\n 23| }\\n 24| \\n 25| interface Expected {\\n 26| readonly title: string\\n 27| readonly description?: string\\n 28| completed: boolean\\n 29| }\\n```\\n\\n### FILE: questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<DeepReadonly<X1>, Expected1>>,\\n 5| Expect<Equal<DeepReadonly<X2>, Expected2>>,\\n 6| ]\\n 7| \\n 8| type X1 = {\\n 9| a: () => 22\\n 10| b: string\\n 11| c: {\\n 12| d: boolean\\n 13| e: {\\n 14| g: {\\n 15| h: {\\n 16| i: true\\n 17| j: 'string'\\n 18| }\\n 19| k: 'hello'\\n 20| }\\n 21| l: [\\n 22| 'hi',\\n 23| {\\n 24| m: ['hey']\\n 25| },\\n 26| ]\\n 27| }\\n 28| }\\n 29| }\\n 30| \\n 31| type X2 = { a: string } | { b: number }\\n 32| \\n 33| type Expected1 = {\\n 34| readonly a: () => 22\\n 35| readonly b: string\\n 36| readonly c: {\\n 37| readonly d: boolean\\n 38| readonly e: {\\n 39| readonly g: {\\n 40| readonly h: {\\n 41| readonly i: true\\n 42| readonly j: 'string'\\n 43| }\\n 44| readonly k: 'hello'\\n 45| }\\n 46| readonly l: readonly [\\n 47| 'hi',\\n 48| {\\n 49| readonly m: readonly ['hey']\\n 50| },\\n 51| ]\\n 52| }\\n 53| }\\n 54| }\\n 55| \\n 56| type Expected2 = { readonly a: string } | { readonly b: number }\\n```\\n\\n### FILE: questions/00599-medium-merge/test-cases.ts (18 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type Foo = {\\n 4| a: number\\n 5| b: string\\n 6| }\\n 7| type Bar = {\\n 8| b: number\\n 9| c: boolean\\n 10| }\\n 11| \\n 12| type cases = [\\n 13| Expect<Equal<Merge<Foo, Bar>, {\\n 14| a: number\\n 15| b: number\\n 16| c: boolean\\n 17| }>>,\\n 18| ]\\n```\\n\\n### FILE: scripts/actions/utils/formatToCode.ts (26 lines)\\n\\n```\\n 1| import type { Quiz } from '../../types'\\n 2| import type { SupportedLocale } from '../../locales'\\n 3| import { defaultLocale, t } from '../../locales'\\n 4| import { toCommentBlock } from './toCommentBlock'\\n 5| import { toInfoHeader } from './toInfoHeader'\\n 6| import { toLinks } from './toLinks'\\n 7| import { toDivider } from './toDivider'\\n 8| import { toFooter } from './toFooter'\\n 9| \\n 10| export function formatToCode(quiz: Quiz, locale: SupportedLocale) {\\n 11| return `${toCommentBlock(\\n 12| toInfoHeader(quiz, locale)\\n 13| + (quiz.readme[locale] || quiz.readme[defaultLocale])\\n 14| + toLinks(quiz, locale),\\n 15| )\\n 16| + toDivider(t(locale, 'divider.code-start'))\\n 17| }\\\\n${\\n 18| (quiz.template || '').trim()\\n 19| }\\\\n${\\n 20| toDivider(t(locale, 'divider.test-cases'))\\n 21| }${\\n 22| (quiz.tests || '').trim()\\n 23| }\\\\n${\\n 24| toDivider(t(locale, 'divider.further-steps'))\\n 25| }${toCommentBlock(toFooter(quiz, locale))}`\\n 26| }\\n```\\n\\n### FILE: scripts/actions/utils/toInfoHeader.ts (15 lines)\\n\\n```\\n 1| import type { Quiz } from '../../types'\\n 2| import type { SupportedLocale } from '../../locales'\\n 3| import { t } from '../../locales'\\n 4| import { resolveInfo } from '../../loader'\\n 5| \\n 6| export const toInfoHeader = function toInfoHeader(quiz: Quiz, locale: SupportedLocale) {\\n 7| const info = resolveInfo(quiz, locale)\\n 8| \\n 9| const author = `${info.author?.name} (@${info?.author?.github})`\\n 10| \\n 11| return `${quiz.no} - ${info.title || ''}\\\\n`\\n 12| + '-------\\\\n'\\n 13| + `by ${author} #${t(locale, `difficulty.${quiz.difficulty}`)} ${info?.tags?.map(i => `#${i}`).join(' ') || ''}\\\\n\\\\n`\\n 14| + `### ${t(locale, 'title.question')}\\\\n\\\\n`\\n 15| }\\n```\\n\\n### FILE: scripts/build.ts (54 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import { loadQuizzes, resolveInfo } from './loader'\\n 4| import { REPO, toPlaygroundUrl, toQuestionsRawREADME, toQuizREADME, toRawREADME, toShareAnswerFull, toSolutionsFull } from './toUrl'\\n 5| import { defaultLocale, supportedLocales } from './locales'\\n 6| import { formatToCode } from './actions/utils/formatToCode'\\n 7| \\n 8| export async function build() {\\n 9| const quizzes = await loadQuizzes()\\n 10| const redirects: [string, string, number][] = []\\n 11| \\n 12| // redirect homepage to github repo\\n 13| supportedLocales.filter(locale => locale !== defaultLocale).forEach((locale) => {\\n 14| redirects.push([`/${locale}`, `${REPO}/blob/main/README.${locale}.md`, 302])\\n 15| })\\n 16| \\n 17| supportedLocales.forEach((locale) => {\\n 18| redirects.push([`/raw/${locale}`, toQuestionsRawREADME(locale), 302])\\n 19| })\\n 20| \\n 21| for (const quiz of quizzes) {\\n 22| for (const locale of supportedLocales) {\\n 23| const info = resolveInfo(quiz, locale)\\n 24| \\n 25| const code = formatToCode(quiz, locale)\\n 26| \\n 27| const url = toPlaygroundUrl(code, info.tsconfig || {})\\n 28| \\n 29| if (locale === defaultLocale) {\\n 30| redirects.push([`/${quiz.no}`, toQuizREADME(quiz, locale, true), 302])\\n 31| redirects.push([`/${quiz.no}/raw`, toRawREADME(quiz, locale), 302])\\n 32| redirects.push([`/${quiz.no}/play`, url, 302])\\n 33| redirects.push([`/${quiz.no}/answer`, toShareAnswerFull(quiz), 302])\\n 34| }\\n 35| else {\\n 36| redirects.push([`/${quiz.no}/${locale}`, toQuizREADME(quiz, locale, true), 302])\\n 37| redirects.push([`/${quiz.no}/raw/${locale}`, toRawREADME(quiz, locale), 302])\\n 38| redirects.push([`/${quiz.no}/play/${locale}`, url, 302])\\n 39| redirects.push([`/${quiz.no}/answer/${locale}`, toShareAnswerFull(quiz, locale), 302])\\n 40| }\\n 41| }\\n 42| \\n 43| redirects.push([`/${quiz.no}/solutions`, toSolutionsFull(quiz.no), 302])\\n 44| }\\n 45| \\n 46| const dist = path.resolve(__dirname, 'dist')\\n 47| \\n 48| await fs.remove(dist)\\n 49| await fs.ensureDir(dist)\\n 50| \\n 51| await fs.writeFileSync(path.join(dist, '_redirects'), redirects.map(i => i.join('\\\\t')).join('\\\\n'), 'utf-8')\\n 52| }\\n 53| \\n 54| build()\\n```\\n\\n### FILE: scripts/generate-play.ts (180 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import process from 'node:process'\\n 3| import crypto from 'node:crypto'\\n 4| import fs from 'fs-extra'\\n 5| import c from 'ansis'\\n 6| import prompts from 'prompts'\\n 7| import { formatToCode } from './actions/utils/formatToCode'\\n 8| import { loadQuizzes, resolveInfo } from './loader'\\n 9| import { supportedLocales } from './locales'\\n 10| import { getQuestionFullName } from './actions/issue-pr'\\n 11| import type { QuizMetaInfo } from './types'\\n 12| \\n 13| type Snapshot = Record<string, string>\\n 14| \\n 15| function calculateFileHash(filePathFull: string): Promise<string> {\\n 16| return new Promise((resolve, reject) => {\\n 17| const hash = crypto.createHash('sha1')\\n 18| const fileStream = fs.createReadStream(filePathFull)\\n 19| \\n 20| fileStream.on('data', (data) => {\\n 21| hash.update(data)\\n 22| })\\n 23| \\n 24| fileStream.on('end', () => {\\n 25| hash.update(filePathFull)\\n 26| resolve(hash.digest('hex'))\\n 27| })\\n 28| \\n 29| fileStream.on('error', (err) => {\\n 30| reject(err)\\n 31| })\\n 32| })\\n 33| }\\n 34| \\n 35| async function takeSnapshot(quizzesPath: string) {\\n 36| let snapshot: Snapshot = {}\\n 37| \\n 38| const files = fs.readdirSync(quizzesPath)\\n 39| \\n 40| for (const file of files) {\\n 41| // Might be a file, or a folder\\n 42| const fPath = path.join(quizzesPath, file)\\n 43| const fStats = fs.statSync(fPath)\\n 44| \\n 45| if (fStats.isDirectory()) {\\n 46| snapshot = {\\n 47| ...snapshot,\\n 48| ...(await takeSnapshot(fPath)),\\n 49| }\\n 50| }\\n 51| else {\\n 52| snapshot[file] = await calculateFileHash(fPath)\\n 53| }\\n 54| }\\n 55| \\n 56| return snapshot\\n 57| }\\n 58| \\n 59| function readPlaygroundCache(playgroundCachePath: string): Snapshot {\\n 60| if (!fs.existsSync(playgroundCachePath))\\n 61| return {}\\n 62| \\n 63| try {\\n 64| const rawCacheContent = fs.readFileSync(playgroundCachePath)\\n 65| return JSON.parse(rawCacheContent.toString())\\n 66| }\\n 67| catch (err) {\\n 68| console.log(c.red('Playground cache corrupted. '\\n 69| + 'Cannot generate playground without keeping your changes intact'))\\n 70| console.log(c.cyan('Please ensure you have run this: \\\"pnpm generate\\\"'))\\n 71| process.exit(1)\\n 72| }\\n 73| }\\n 74| \\n 75| function calculateOverridableFiles(cache: Snapshot, snapshot: Snapshot) {\\n 76| const result: Snapshot = {}\\n 77| \\n 78| for (const quizName in snapshot) {\\n 79| if (snapshot[quizName] === cache[quizName])\\n 80| result[quizName] = snapshot[quizName]\\n 81| }\\n 82| \\n 83| return result\\n 84| }\\n 85| \\n 86| function isQuizWritable(quizFileName: string, overridableFiles: Snapshot, playgroundSnapshot: Snapshot): boolean {\\n 87| return !!(\\n 88| overridableFiles[quizFileName]\\n 89| || (!overridableFiles[quizFileName] && !playgroundSnapshot[quizFileName])\\n 90| )\\n 91| }\\n 92| \\n 93| async function generatePlayground() {\\n 94| const playgroundPath = path.join(__dirname, '../playground')\\n 95| const playgroundCachePath = path.join(__dirname, '../.playgroundcache')\\n 96| \\n 97| let locale = supportedLocales.find(locale => locale === process.argv[2])!\\n 98| \\n 99| console.log(c.bold.cyan('Generating local playground...\\\\n'))\\n 100| \\n 101| let overridableFiles: Snapshot\\n 102| let keepChanges = false\\n 103| const currentPlaygroundCache = readPlaygroundCache(playgroundCachePath)\\n 104| let playgroundSnapshot: Snapshot\\n 105| \\n 106| if (process.argv.length === 3 && (process.argv[2] === '--keep-changes' || process.argv[2] === '-K')) {\\n 107| console.log(c.bold.cyan('We will keep your changes while generating.\\\\n'))\\n 108| keepChanges = true\\n 109| \\n 110| playgroundSnapshot = await takeSnapshot(playgroundPath)\\n 111| \\n 112| overridableFiles = calculateOverridableFiles(currentPlaygroundCache, playgroundSnapshot)\\n 113| }\\n 114| else if (fs.existsSync(playgroundPath)) {\\n 115| const result = await prompts([{\\n 116| name: 'confirm',\\n 117| type: 'confirm',\\n 118| initial: false,\\n 119| message: 'The playground directory already exists, it may contains the answers you did. Do you want to override it?',\\n 120| }])\\n 121| if (!result?.confirm)\\n 122| return console.log(c.yellow('Skipped.'))\\n 123| }\\n 124| \\n 125| if (!locale) {\\n 126| const result = await prompts([{\\n 127| name: 'locale',\\n 128| type: 'select',\\n 129| message: 'Select language:',\\n 130| choices: supportedLocales.map(i => ({\\n 131| title: i,\\n 132| value: i,\\n 133| })),\\n 134| }])\\n 135| if (!result)\\n 136| return console.log(c.yellow('Skipped.'))\\n 137| locale = result.locale\\n 138| }\\n 139| \\n 140| if (!keepChanges) {\\n 141| await fs.remove(playgroundPath)\\n 142| await fs.ensureDir(playgroundPath)\\n 143| }\\n 144| \\n 145| const quizzes = await loadQuizzes()\\n 146| const incomingQuizzesCache: Snapshot = {}\\n 147| \\n 148| for (const quiz of quizzes) {\\n 149| const { difficulty, title } = resolveInfo(quiz, locale) as QuizMetaInfo & { difficulty: string }\\n 150| const code = formatToCode(quiz, locale)\\n 151| \\n 152| if (difficulty === undefined || title === undefined) {\\n 153| console.log(c.yellow`${quiz.no} has no ${locale.toUpperCase()} version. Skipping`)\\n 154| continue\\n 155| }\\n 156| \\n 157| const quizzesPathByDifficulty = path.join(playgroundPath, difficulty)\\n 158| \\n 159| const quizFileName = `${getQuestionFullName(quiz.no, difficulty, title)}.ts`\\n 160| const quizPathFull = path.join(quizzesPathByDifficulty, quizFileName)\\n 161| \\n 162| if (!keepChanges || (keepChanges && isQuizWritable(quizFileName, overridableFiles!, playgroundSnapshot!))) {\\n 163| if (!fs.existsSync(quizzesPathByDifficulty))\\n 164| fs.mkdirSync(quizzesPathByDifficulty)\\n 165| await fs.writeFile(quizPathFull, code, 'utf-8')\\n 166| incomingQuizzesCache[quizFileName] = await calculateFileHash(quizPathFull)\\n 167| }\\n 168| }\\n 169| \\n 170| fs.writeFile(playgroundCachePath, JSON.stringify({\\n 171| ...currentPlaygroundCache,\\n 172| ...incomingQuizzesCache,\\n 173| }))\\n 174| \\n 175| console.log()\\n 176| console.log(c.bold.green('Local playground generated at: ') + c.dim(playgroundPath))\\n 177| console.log()\\n 178| }\\n 179| \\n 180| generatePlayground()\\n```\\n\\n### FILE: scripts/loader.ts (117 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import fg from 'fast-glob'\\n 4| import YAML from 'js-yaml'\\n 5| import type { Quiz, QuizMetaInfo } from './types'\\n 6| import { defaultLocale, supportedLocales } from './locales'\\n 7| \\n 8| export async function loadFile(filepath: string) {\\n 9| if (fs.existsSync(filepath))\\n 10| return await fs.readFile(filepath, 'utf-8')\\n 11| return undefined\\n 12| }\\n 13| \\n 14| export async function loadLocaleVariations<T = string>(\\n 15| filepath: string,\\n 16| preprocessor: (s: string) => T = s => s as any as T,\\n 17| ) {\\n 18| const { ext, dir, name } = path.parse(filepath)\\n 19| const data: Record<string, T> = {}\\n 20| \\n 21| for (const locale of supportedLocales) {\\n 22| const file = preprocessor(await loadFile(path.join(dir, `${name}.${locale}${ext}`)) || '')\\n 23| \\n 24| if (file)\\n 25| data[locale] = file\\n 26| }\\n 27| \\n 28| if (!data[defaultLocale]) {\\n 29| // default version\\n 30| const file = preprocessor(await loadFile(filepath) || '')\\n 31| if (file)\\n 32| data[defaultLocale] = file\\n 33| }\\n 34| \\n 35| return data\\n 36| }\\n 37| \\n 38| export function readmeCleanUp(text: string) {\\n 39| return text\\n 40| .replace(/<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/, '')\\n 41| .replace(/<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/, '')\\n 42| .trim()\\n 43| }\\n 44| \\n 45| export function loadInfo(s: string): Partial<QuizMetaInfo> | undefined {\\n 46| const object = YAML.load(s) as any\\n 47| if (!object)\\n 48| return undefined\\n 49| \\n 50| const arrayKeys = ['tags', 'related']\\n 51| \\n 52| for (const key of arrayKeys) {\\n 53| if (object[key]) {\\n 54| object[key] = (object[key] || '')\\n 55| .toString()\\n 56| .split(',')\\n 57| .map((i: string) => i.trim())\\n 58| .filter(Boolean)\\n 59| }\\n 60| else {\\n 61| object[key] = undefined\\n 62| }\\n 63| }\\n 64| \\n 65| return object\\n 66| }\\n 67| \\n 68| export const QUIZ_ROOT = path.resolve(__dirname, '../questions')\\n 69| \\n 70| export async function loadQuizzes(): Promise<Quiz[]> {\\n 71| const folders = await fg('{0..9}*-*', {\\n 72| onlyDirectories: true,\\n 73| cwd: QUIZ_ROOT,\\n 74| })\\n 75| \\n 76| const quizzes = await Promise.all(\\n 77| folders.map(async dir => loadQuiz(dir)),\\n 78| )\\n 79| \\n 80| return quizzes\\n 81| }\\n 82| \\n 83| export async function loadQuiz(dir: string): Promise<Quiz> {\\n 84| return {\\n 85| no: Number(dir.replace(/^(\\\\d+)-.*/, '$1')),\\n 86| difficulty: dir.replace(/^\\\\d+-(.+?)-.*$/, '$1') as any,\\n 87| path: dir,\\n 88| info: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'info.yml'), loadInfo),\\n 89| readme: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'README.md'), readmeCleanUp),\\n 90| template: await loadFile(path.join(QUIZ_ROOT, dir, 'template.ts')) || '',\\n 91| tests: await loadFile(path.join(QUIZ_ROOT, dir, 'test-cases.ts')),\\n 92| }\\n 93| }\\n 94| \\n 95| export async function loadQuizByNo(no: number | string) {\\n 96| const folders = await fg(`${no}-*`, {\\n 97| onlyDirectories: true,\\n 98| cwd: QUIZ_ROOT,\\n 99| })\\n 100| \\n 101| if (folders.length)\\n 102| return await loadQuiz(folders[0])\\n 103| \\n 104| return undefined\\n 105| }\\n 106| \\n 107| export function resolveInfo(quiz: Quiz, locale: string = defaultLocale) {\\n 108| const info = { ...quiz.info[defaultLocale], ...quiz.info[locale] }\\n 109| info.tags = quiz.info[locale]?.tags || quiz.info[defaultLocale]?.tags || []\\n 110| info.related = quiz.info[locale]?.related || quiz.info[defaultLocale]?.related || []\\n 111| \\n 112| if (typeof info.tags === 'string')\\n 113| // @ts-expect-error\\n 114| info.tags = info.tags.split(',').map(i => i.trim()).filter(Boolean)\\n 115| \\n 116| return info as QuizMetaInfo\\n 117| }\\n```\\n\\n### FILE: scripts/locales.ts (26 lines)\\n\\n```\\n 1| export const defaultLocale = 'en'\\n 2| \\n 3| export const supportedLocales = ['en', 'zh-CN', 'ja', 'ko', 'pt-BR'] as const\\n 4| \\n 5| export const messages = {\\n 6| 'en': require('./locales/en.json'),\\n 7| 'zh-CN': require('./locales/zh-CN.json'),\\n 8| 'ja': require('./locales/ja.json'),\\n 9| 'ko': require('./locales/ko.json'),\\n 10| 'pt-BR': require('./locales/pt-BR.json'),\\n 11| }\\n 12| \\n 13| export type SupportedLocale = keyof typeof messages\\n 14| \\n 15| export function t(locale: SupportedLocale, key: string): string {\\n 16| const result = (messages[locale] && messages[locale][key]) || messages[defaultLocale][key]\\n 17| if (!result)\\n 18| throw new Error(`Missing message for key \\\"${key}\\\"`)\\n 19| return result\\n 20| }\\n 21| \\n 22| export function f(name: string, locale: string, ext: string) {\\n 23| if (locale === defaultLocale)\\n 24| return `${name}.${ext}`\\n 25| return `${name}.${locale}.${ext}`\\n 26| }\\n```\\n\\n### FILE: scripts/readme.ts (240 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import process from 'node:process'\\n 3| import fs from 'fs-extra'\\n 4| import type { SupportedLocale } from './locales'\\n 5| import { defaultLocale, f, supportedLocales, t } from './locales'\\n 6| import { loadQuizzes, resolveInfo } from './loader'\\n 7| import { toAnswerShort, toNearborREADME, toPlayShort, toQuizREADME, toSolutionsShort } from './toUrl'\\n 8| import type { Quiz, QuizMetaInfo } from './types'\\n 9| \\n 10| const DifficultyColors: Record<string, string> = {\\n 11| warm: 'teal',\\n 12| easy: '7aad0c',\\n 13| medium: 'd9901a',\\n 14| hard: 'de3d37',\\n 15| extreme: 'b11b8d',\\n 16| }\\n 17| \\n 18| const DifficultyRank = [\\n 19| 'warm',\\n 20| 'easy',\\n 21| 'medium',\\n 22| 'hard',\\n 23| 'extreme',\\n 24| ]\\n 25| \\n 26| function escapeHtml(unsafe: string) {\\n 27| return unsafe\\n 28| .replace(/&/g, '&')\\n 29| .replace(/</g, '<')\\n 30| .replace(/>/g, '>')\\n 31| .replace(/\\\"/g, '"')\\n 32| .replace(/'/g, ''')\\n 33| }\\n 34| \\n 35| function toBadgeURL(label: string, text: string, color: string, args = '') {\\n 36| return `https://img.shields.io/badge/${encodeURIComponent(label.replace(/-/g, '--'))}-${encodeURIComponent(text.replace(/-/g, '--'))}-${color}${args}`\\n 37| }\\n 38| \\n 39| function toBadge(label: string, text: string, color: string, args = '') {\\n 40| return `<img src=\\\"${toBadgeURL(label, text, color, args)}\\\" alt=\\\"${text}\\\"/>`\\n 41| }\\n 42| \\n 43| export function toBadgeLink(url: string, label: string, text: string, color: string, args = '') {\\n 44| return `<a href=\\\"${url}\\\" target=\\\"_blank\\\">${toBadge(label, text, color, args)}</a> `\\n 45| }\\n 46| \\n 47| export function toPlanTextLink(url: string, _label: string, text: string, _color: string, _args = '') {\\n 48| return `<a href=\\\"${url}\\\" target=\\\"_blank\\\">${text}</a> `\\n 49| }\\n 50| \\n 51| function toAuthorInfo(author: Partial<QuizMetaInfo['author']> = {}) {\\n 52| return `by ${author.name}${author.github ? ` <a href=\\\"https://github.com/${author.github}\\\" target=\\\"_blank\\\">@${author.github}</a>` : ''}`\\n 53| }\\n 54| \\n 55| function toDifficultyBadge(difficulty: string, locale: SupportedLocale) {\\n 56| return toBadge('', t(locale, `difficulty.${difficulty}`), DifficultyColors[difficulty])\\n 57| }\\n 58| \\n 59| function toDifficultyBadgeInverted(difficulty: string, locale: SupportedLocale, count: number) {\\n 60| return toBadge(t(locale, `difficulty.${difficulty}`), count.toString(), DifficultyColors[difficulty])\\n 61| }\\n 62| \\n 63| function toDifficultyPlainText(difficulty: string, locale: SupportedLocale, count: number) {\\n 64| return `${t(locale, `difficulty.${difficulty}`)} (${count.toString()})`\\n 65| }\\n 66| \\n 67| function toDetailsInnerText(text: string, locale: SupportedLocale) {\\n 68| return `${t(locale, `details.${text}`)}`\\n 69| }\\n 70| \\n 71| function quizToBadge(quiz: Quiz, locale: string, absolute = false, badge = true) {\\n 72| const fn = badge ? toBadgeLink : toPlanTextLink\\n 73| return fn(\\n 74| toQuizREADME(quiz, locale, absolute),\\n 75| '',\\n 76| `${quiz.no}・${quiz.info[locale]?.title || quiz.info[defaultLocale]?.title}`,\\n 77| DifficultyColors[quiz.difficulty],\\n 78| )\\n 79| }\\n 80| \\n 81| function quizNoToBadges(ids: (string | number)[], quizzes: Quiz[], locale: string, absolute = false) {\\n 82| return ids\\n 83| .map(i => quizzes.find(q => q.no === Number(i)))\\n 84| .filter(Boolean)\\n 85| .map(i => quizToBadge(i!, locale, absolute))\\n 86| .join(' ')\\n 87| }\\n 88| \\n 89| function getAllTags(quizzes: Quiz[], locale: string) {\\n 90| const set = new Set<string>()\\n 91| for (const quiz of quizzes) {\\n 92| const info = resolveInfo(quiz, locale)\\n 93| for (const tag of (info?.tags || []))\\n 94| set.add(tag)\\n 95| }\\n 96| return Array.from(set).sort()\\n 97| }\\n 98| \\n 99| function getQuizzesByTag(quizzes: Quiz[], locale: string, tag: string) {\\n 100| return quizzes.filter((quiz) => {\\n 101| const info = resolveInfo(quiz, locale)\\n 102| return !!info.tags?.includes(tag)\\n 103| })\\n 104| }\\n 105| \\n 106| async function insertInfoReadme(filepath: string, quiz: Quiz, locale: SupportedLocale, quizzes: Quiz[]) {\\n 107| if (!fs.existsSync(filepath))\\n 108| return\\n 109| let text = await fs.readFile(filepath, 'utf-8')\\n 110| /* eslint-disable prefer-template */\\n 111| \\n 112| if (!text.match(/<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/))\\n 113| text = `<!--info-header-start--><!--info-header-end-->\\\\n\\\\n${text}`\\n 114| if (!text.match(/<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/))\\n 115| text = `${text}\\\\n\\\\n<!--info-footer-start--><!--info-footer-end-->`\\n 116| \\n 117| const info = resolveInfo(quiz, locale)\\n 118| \\n 119| const availableLocales = supportedLocales.filter(l => l !== locale).filter(l => !!quiz.readme[l])\\n 120| \\n 121| text = text\\n 122| .replace(\\n 123| /<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/,\\n 124| '<!--info-header-start-->'\\n 125| + `<h1>${escapeHtml(info.title || '')} ${toDifficultyBadge(quiz.difficulty, locale)} ${(info.tags || []).map(i => toBadge('', `#${i}`, '999')).join(' ')}</h1>`\\n 126| + `<blockquote><p>${toAuthorInfo(info.author)}</p></blockquote>`\\n 127| + '<p>'\\n 128| + toBadgeLink(toPlayShort(quiz.no, locale), '', t(locale, 'badge.take-the-challenge'), '3178c6', '?logo=typescript&logoColor=white')\\n 129| + (availableLocales.length ? (' ' + availableLocales.map(l => toBadgeLink(toNearborREADME(quiz, l), '', t(l, 'display'), 'gray')).join(' ')) : '')\\n 130| + '</p>'\\n 131| + '<!--info-header-end-->',\\n 132| )\\n 133| .replace(\\n 134| /<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/,\\n 135| '<!--info-footer-start--><br>'\\n 136| + toBadgeLink(`../../${f('README', locale, 'md')}`, '', t(locale, 'badge.back'), 'grey')\\n 137| + toBadgeLink(toAnswerShort(quiz.no, locale), '', t(locale, 'badge.share-your-solutions'), 'teal')\\n 138| + toBadgeLink(toSolutionsShort(quiz.no), '', t(locale, 'badge.checkout-solutions'), 'de5a77', '?logo=awesome-lists&logoColor=white')\\n 139| + (Array.isArray(info.related) && info.related.length ? `<hr><h3>${t(locale, 'readme.related-challenges')}</h3>${quizNoToBadges(info.related, quizzes, locale, true)}` : '')\\n 140| + '<!--info-footer-end-->',\\n 141| )\\n 142| \\n 143| /* eslint-enable prefer-template */\\n 144| \\n 145| await fs.writeFile(filepath, text, 'utf-8')\\n 146| }\\n 147| \\n 148| async function updateIndexREADME(quizzes: Quiz[]) {\\n 149| // update index README\\n 150| for (const locale of supportedLocales) {\\n 151| const filepath = path.resolve(__dirname, '..', f('README', locale, 'md'))\\n 152| \\n 153| let challengesREADME = ''\\n 154| let prev = ''\\n 155| \\n 156| // difficulty\\n 157| const quizzesByDifficulty = [...quizzes].sort((a, b) => DifficultyRank.indexOf(a.difficulty) - DifficultyRank.indexOf(b.difficulty))\\n 158| \\n 159| for (const quiz of quizzesByDifficulty) {\\n 160| if (prev !== quiz.difficulty)\\n 161| challengesREADME += `${prev ? '<br><br>' : ''}${toDifficultyBadgeInverted(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}<br>`\\n 162| \\n 163| challengesREADME += quizToBadge(quiz, locale)\\n 164| \\n 165| prev = quiz.difficulty\\n 166| }\\n 167| \\n 168| // by tags\\n 169| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-tags', locale)}</summary><br><table><tbody>`\\n 170| const tags = getAllTags(quizzes, locale)\\n 171| for (const tag of tags) {\\n 172| challengesREADME += `<tr><td>${toBadge('', `#${tag}`, '999')}</td><td>`\\n 173| getQuizzesByTag(quizzesByDifficulty, locale, tag)\\n 174| .forEach((quiz) => {\\n 175| challengesREADME += quizToBadge(quiz, locale)\\n 176| })\\n 177| challengesREADME += '</td></tr>'\\n 178| }\\n 179| challengesREADME += '<tr><td><code> </code></td><td></td></tr>'\\n 180| challengesREADME += '</tbody></table></details>'\\n 181| \\n 182| // by plain text\\n 183| prev = ''\\n 184| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-plain-text', locale)}</summary><br>`\\n 185| for (const quiz of quizzesByDifficulty) {\\n 186| if (prev !== quiz.difficulty)\\n 187| challengesREADME += `${prev ? '</ul>' : ''}<h3>${toDifficultyPlainText(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}</h3><ul>`\\n 188| challengesREADME += `<li>${quizToBadge(quiz, locale, false, false)}</li>`\\n 189| prev = quiz.difficulty\\n 190| }\\n 191| challengesREADME += '</ul></details><br>'\\n 192| \\n 193| let readme = await fs.readFile(filepath, 'utf-8')\\n 194| readme = readme.replace(\\n 195| /<!--challenges-start-->[\\\\s\\\\S]*<!--challenges-end-->/m,\\n 196| `<!--challenges-start-->\\\\n${challengesREADME}\\\\n<!--challenges-end-->`,\\n 197| )\\n 198| await fs.writeFile(filepath, readme, 'utf-8')\\n 199| }\\n 200| }\\n 201| \\n 202| async function updateQuestionsREADME(quizzes: Quiz[]) {\\n 203| const questionsDir = path.resolve(__dirname, '../questions')\\n 204| \\n 205| // update each questions' readme\\n 206| for (const quiz of quizzes) {\\n 207| for (const locale of supportedLocales) {\\n 208| await insertInfoReadme(\\n 209| path.join(\\n 210| questionsDir,\\n 211| quiz.path,\\n 212| f('README', locale, 'md'),\\n 213| ),\\n 214| quiz,\\n 215| locale,\\n 216| quizzes,\\n 217| )\\n 218| }\\n 219| }\\n 220| }\\n 221| \\n 222| export async function updateREADMEs(type?: 'quiz' | 'index') {\\n 223| const quizzes = await loadQuizzes()\\n 224| quizzes.sort((a, b) => a.no - b.no)\\n 225| \\n 226| if (type === 'quiz') {\\n 227| await updateQuestionsREADME(quizzes)\\n 228| }\\n 229| else if (type === 'index') {\\n 230| await updateIndexREADME(quizzes)\\n 231| }\\n 232| else {\\n 233| await Promise.all([\\n 234| updateIndexREADME(quizzes),\\n 235| updateQuestionsREADME(quizzes),\\n 236| ])\\n 237| }\\n 238| }\\n 239| \\n 240| updateREADMEs(process.argv.slice(2)[0] as any)\\n```\\n\\n### FILE: scripts/toUrl.ts (85 lines)\\n\\n```\\n 1| import lzs from 'lz-string'\\n 2| import type { Quiz } from './types'\\n 3| import { defaultLocale } from './locales'\\n 4| import { resolveInfo } from './loader'\\n 5| \\n 6| export const REPO = 'https://github.com/type-challenges/type-challenges'\\n 7| export const DOMAIN = 'https://tsch.js.org'\\n 8| export const TYPESCRIPT_PLAYGROUND = 'https://www.typescriptlang.org/play'\\n 9| \\n 10| // https://github.com/microsoft/TypeScript-Website/tree/v2/packages/playground\\n 11| export function toPlaygroundUrl(\\n 12| code: string,\\n 13| config: Object = {},\\n 14| site = TYPESCRIPT_PLAYGROUND,\\n 15| ) {\\n 16| return `${site}?${Object.entries(config).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}#code/${lzs.compressToEncodedURIComponent(code)}`\\n 17| }\\n 18| \\n 19| export function toSolutionsFull(no: number) {\\n 20| return `${REPO}/issues?q=label%3A${no}+label%3Aanswer+sort%3Areactions-%2B1-desc`\\n 21| }\\n 22| \\n 23| export function toQuizREADME(quiz: Quiz, locale?: string, absolute = false) {\\n 24| const prefix = absolute ? `${REPO}/blob/main` : '.'\\n 25| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 26| ? `${prefix}/questions/${quiz.path}/README.${locale}.md`\\n 27| : `${prefix}/questions/${quiz.path}/README.md`\\n 28| }\\n 29| \\n 30| export function toRawREADME(quiz: Quiz, locale?: string) {\\n 31| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\\n 32| // const provider = 'https://raw.githubusercontent.com/type-challenges/type-challenges/main'\\n 33| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 34| ? `${provider}/questions/${quiz.path}/README.${locale}.md`\\n 35| : `${provider}/questions/${quiz.path}/README.md`\\n 36| }\\n 37| \\n 38| export function toQuestionsRawREADME(locale?: string) {\\n 39| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\\n 40| return locale && locale !== defaultLocale ? `${provider}/README.${locale}.md` : `${provider}/README.md`\\n 41| }\\n 42| \\n 43| export function toNearborREADME(quiz: Quiz, locale?: string) {\\n 44| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 45| ? `./README.${locale}.md`\\n 46| : './README.md'\\n 47| }\\n 48| \\n 49| export function toShareAnswerFull(quiz: Quiz, locale: string = defaultLocale) {\\n 50| const info = resolveInfo(quiz, locale)\\n 51| if (locale === defaultLocale)\\n 52| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=0-answer.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\\n 53| else\\n 54| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=1-answer.${locale}.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\\n 55| }\\n 56| \\n 57| // Short\\n 58| \\n 59| export function toReadmeShort(no: number, locale?: string) {\\n 60| return locale !== defaultLocale\\n 61| ? `${DOMAIN}/${no}/${locale}`\\n 62| : `${DOMAIN}/${no}`\\n 63| }\\n 64| \\n 65| export function toSolutionsShort(no: number) {\\n 66| return `${DOMAIN}/${no}/solutions`\\n 67| }\\n 68| \\n 69| export function toPlayShort(no: number, locale?: string) {\\n 70| return locale !== defaultLocale\\n 71| ? `${DOMAIN}/${no}/play/${locale}`\\n 72| : `${DOMAIN}/${no}/play`\\n 73| }\\n 74| \\n 75| export function toAnswerShort(no: number, locale?: string) {\\n 76| return locale !== defaultLocale\\n 77| ? `${DOMAIN}/${no}/answer/${locale}`\\n 78| : `${DOMAIN}/${no}/answer`\\n 79| }\\n 80| \\n 81| export function toHomepageShort(locale?: string) {\\n 82| return locale !== defaultLocale\\n 83| ? `${DOMAIN}/${locale}`\\n 84| : `${DOMAIN}`\\n 85| }\\n```\\n\\n### FILE: scripts/translate.ts (73 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import { translate } from '@vitalets/google-translate-api'\\n 4| import { QUIZ_ROOT, loadQuizByNo, loadQuizzes } from './loader'\\n 5| import { resolveFilePath } from './utils/resolve'\\n 6| import type { Quiz } from './types'\\n 7| import type { SupportedLocale } from './locales'\\n 8| import { t } from './locales'\\n 9| \\n 10| export async function translateQuizByNo(no: number, from: SupportedLocale, to: SupportedLocale) {\\n 11| const quiz = await loadQuizByNo(no)\\n 12| if (!quiz)\\n 13| throw new Error(`Quiz #${no} not founded`)\\n 14| return await translateQuiz(quiz, from, to)\\n 15| }\\n 16| \\n 17| export async function translateQuiz(quiz: Quiz, from: SupportedLocale, to: SupportedLocale) {\\n 18| let translatedReadme = await translateMarkdown(quiz.readme[from], from, to)\\n 19| \\n 20| if (!translatedReadme)\\n 21| throw new Error(`Quiz #${quiz.no} empty translation`)\\n 22| \\n 23| translatedReadme = `> ${t(to, 'readme.google-translated')}\\\\n\\\\n${translatedReadme.trim()}`\\n 24| \\n 25| const readmePath = resolveFilePath(path.join(QUIZ_ROOT, quiz.path), 'README', 'md', to)\\n 26| await fs.writeFile(readmePath, translatedReadme, 'utf-8')\\n 27| \\n 28| console.log(`Translated [${quiz.no}] ${from} → ${to} | saved to ${readmePath}`)\\n 29| }\\n 30| \\n 31| export async function translateMarkdown(code: string, from: SupportedLocale, to: SupportedLocale) {\\n 32| // to replace the code blocks intro a placeholder then feed it into translator\\n 33| // then replace back for the results\\n 34| const codeBlocks: string[] = []\\n 35| \\n 36| const source = code\\n 37| .replace(/```[\\\\s\\\\S\\\\n]+?```/g, (v) => {\\n 38| const placeholder = `__${codeBlocks.length}__`\\n 39| codeBlocks.push(v)\\n 40| return placeholder\\n 41| })\\n 42| .replace(/`[\\\\s\\\\S\\\\n]+?`/g, (v) => {\\n 43| const placeholder = `__${codeBlocks.length}__`\\n 44| codeBlocks.push(v)\\n 45| return placeholder\\n 46| })\\n 47| \\n 48| const { text } = await translate(source, {\\n 49| from,\\n 50| to,\\n 51| })\\n 52| \\n 53| if (!text)\\n 54| return\\n 55| \\n 56| const result = text.replace(/__\\\\s*?(\\\\d+?)\\\\s*?__/g, (_, i) => codeBlocks[+i])\\n 57| \\n 58| return result\\n 59| }\\n 60| \\n 61| export async function translateAllQuizzes(from: SupportedLocale, to: SupportedLocale) {\\n 62| const quizzes = await loadQuizzes()\\n 63| \\n 64| for (const quiz of quizzes) {\\n 65| if (quiz.readme[to] || !quiz.readme[from]) {\\n 66| console.log(`Skipped #${quiz.no}`)\\n 67| continue\\n 68| }\\n 69| \\n 70| console.log(`Translating #${quiz.no} to ${to}`)\\n 71| await translateQuiz(quiz, from, to)\\n 72| }\\n 73| }\\n```\\n\\n### FILE: scripts/types.ts (38 lines)\\n\\n```\\n 1| import type { DeepPartial } from 'utility-types'\\n 2| import type { context, getOctokit } from '@actions/github'\\n 3| import type Core from '@actions/core'\\n 4| import type IO from '@actions/io'\\n 5| \\n 6| export type Github = ReturnType<typeof getOctokit>\\n 7| export type Context = typeof context\\n 8| export type Action = (github: Github, context: Context, core: typeof Core, io: typeof IO) => Promise<void>\\n 9| \\n 10| export interface QuizMetaInfo {\\n 11| title: string\\n 12| author: {\\n 13| name: string\\n 14| email: string\\n 15| github: string\\n 16| }\\n 17| tsconfig?: Record<string, any>\\n 18| original_issues: number[]\\n 19| recommended_solutions: number[]\\n 20| tags: string[]\\n 21| related?: string[]\\n 22| }\\n 23| \\n 24| export type Difficulty = 'warm' | 'easy' | 'medium' | 'hard' | 'extreme' | 'pending'\\n 25| \\n 26| export interface Quiz {\\n 27| no: number\\n 28| difficulty: Difficulty\\n 29| path: string\\n 30| readme: Record<string, string>\\n 31| template: string\\n 32| info: Record<string, DeepPartial<QuizMetaInfo> | undefined>\\n 33| tests?: string\\n 34| solutions?: {\\n 35| code?: string\\n 36| readme?: Record<string, string>\\n 37| }\\n 38| }\\n```\\n\\n### FILE: utils/index.d.test.ts (35 lines)\\n\\n```\\n 1| import type { Alike, Equal, Expect, ExpectFalse, IsAny, NotEqual } from './index'\\n 2| \\n 3| type cases = [\\n 4| /* Expect */\\n 5| Expect<true>,\\n 6| // @ts-expect-error\\n 7| Expect<false>,\\n 8| \\n 9| /* ExpectFalse */\\n 10| ExpectFalse<false>,\\n 11| // @ts-expect-error\\n 12| ExpectFalse<true>,\\n 13| \\n 14| /* Equal */\\n 15| Expect<Equal<true, true>>,\\n 16| ExpectFalse<Equal<false, true>>,\\n 17| Expect<Equal<'123', '123'>>,\\n 18| ExpectFalse<Equal<'123', string>>,\\n 19| Expect<Equal<{ a: number }, { a: number }>>,\\n 20| ExpectFalse<Equal<{ a: number }, { b: number }>>,\\n 21| ExpectFalse<Equal<any, '123'>>,\\n 22| ExpectFalse<Equal<any, unknown>>,\\n 23| \\n 24| /* Not Equal */\\n 25| Expect<NotEqual<false, true>>,\\n 26| ExpectFalse<NotEqual<true, true>>,\\n 27| \\n 28| /* IsAny */\\n 29| Expect<IsAny<any>>,\\n 30| ExpectFalse<IsAny<1>>,\\n 31| \\n 32| /* Alike */\\n 33| Expect<Alike<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\\n 34| ExpectFalse<Equal<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\\n 35| ]\\n```\\n\\n### FILE: utils/index.d.ts (29 lines)\\n\\n```\\n 1| export type Expect<T extends true> = T\\n 2| export type ExpectTrue<T extends true> = T\\n 3| export type ExpectFalse<T extends false> = T\\n 4| export type IsTrue<T extends true> = T\\n 5| export type IsFalse<T extends false> = T\\n 6| \\n 7| export type Equal<X, Y> =\\n 8| (<T>() => T extends X ? 1 : 2) extends\\n 9| (<T>() => T extends Y ? 1 : 2) ? true : false\\n 10| export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true\\n 11| \\n 12| // https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\\n 13| export type IsAny<T> = 0 extends (1 & T) ? true : false\\n 14| export type NotAny<T> = true extends IsAny<T> ? false : true\\n 15| \\n 16| export type Debug<T> = { [K in keyof T]: T[K] }\\n 17| export type MergeInsertions<T> =\\n 18| T extends object\\n 19| ? { [K in keyof T]: MergeInsertions<T[K]> }\\n 20| : T\\n 21| \\n 22| export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>\\n 23| \\n 24| export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE ? true : false\\n 25| export type ExpectValidArgs<FUNC extends (...args: any[]) => any, ARGS extends any[]> = ARGS extends Parameters<FUNC>\\n 26| ? true\\n 27| : false\\n 28| \\n 29| export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never\\n```\\n<END_OF_CONTEXT>\\n\\n<query>\\nIdentify the most architecturally significant module in the provided context and write an in-depth wiki page analyzing it: its responsibilities, key abstractions, control flow, and how other parts of the system depend on it.\\n</query>\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"# Architecture Analysis: `scripts/loader.ts`\\n\\n## Overview\\n\\nThe `scripts/loader.ts` module serves as the core data loading and processing layer for the Type Challenges repository. It is responsible for loading quiz data from the file system, parsing metadata, and providing standardized access to quiz information across the entire application. This module is architecturally significant because it acts as the central data source that all other scripts depend upon for accessing quiz content, metadata, and structure.\\n\\n## Detailed Analysis\\n\\n### Responsibilities\\n\\nThe loader module has several key responsibilities:\\n\\n1. **File System Operations**: Loading files from the quiz directory structure (`questions/{number}-{difficulty}-{name}/`)\\n2. **Locale-aware Content Loading**: Handling multiple language versions of quiz content\\n3. **Metadata Parsing**: Converting YAML information files into structured data\\n4. **Quiz Data Aggregation**: Combining various file components (README, info, templates, tests) into complete quiz objects\\n5. **Data Normalization**: Standardizing how quiz information is accessed across different locales\\n\\n### Key Abstractions\\n\\nThe module defines several important abstractions:\\n\\n- **Quiz Interface**: The `Quiz` type represents a complete quiz with properties like `no`, `difficulty`, `path`, `info`, `readme`, `template`, and `tests` [scripts/types.ts:26-38]. This abstraction provides a consistent interface for all quiz-related operations.\\n\\n- **Locale Variations**: The `loadLocaleVariations` function abstracts the process of loading content in multiple languages, falling back to a default locale when specific language versions don't exist [scripts/loader.ts:14-36].\\n\\n- **Metadata Loading**: The `loadInfo` function handles parsing YAML metadata files into structured objects with proper array handling for tags and related challenges [scripts/loader.ts:45-66].\\n\\n- **Quiz Loading**: The `loadQuiz` function orchestrates the loading of all components of a single quiz [scripts/loader.ts:83-93].\\n\\n### Control Flow\\n\\nThe control flow within `loader.ts` follows a predictable pattern:\\n\\n1. **Initialization**: The module exports constants like `QUIZ_ROOT` and utility functions for file loading [scripts/loader.ts:68-93].\\n2. **Quiz Discovery**: `loadQuizzes` uses `fast-glob` to discover all quiz directories [scripts/loader.ts:70-81].\\n3. **Individual Quiz Loading**: For each discovered directory, `loadQuiz` is called to construct a complete quiz object [scripts/loader.ts:76-78].\\n4. **File Loading**: `loadFile` and `loadLocaleVariations` handle the actual reading of files and their locale-specific variants [scripts/loader.ts:8-36].\\n5. **Metadata Processing**: `loadInfo` processes YAML metadata files into structured objects [scripts/loader.ts:45-66].\\n6. **Data Aggregation**: The `loadQuiz` function combines all loaded components into a single `Quiz` object [scripts/loader.ts:84-93].\\n7. **Info Resolution**: `resolveInfo` merges default and locale-specific metadata, handling fallbacks appropriately [scripts/loader.ts:107-117].\\n\\n### Dependencies and Usage Patterns\\n\\nThe loader module is depended upon by several other modules in the system:\\n\\n- **`scripts/build.ts`**: Uses `loadQuizzes` to get all quiz data for building redirects and generating playground code [scripts/build.ts:9].\\n- **`scripts/generate-play.ts`**: Relies on `loadQuizzes` and `resolveInfo` to generate local playground files [scripts/generate-play.ts:145-149].\\n- **`scripts/readme.ts`**: Depends on `loadQuizzes` and `resolveInfo` to update README files with quiz metadata [scripts/readme.ts:6-7].\\n- **`scripts/toUrl.ts`**: Uses `resolveInfo` to get quiz metadata for URL generation [scripts/toUrl.ts:4].\\n- **`scripts/translate.ts`**: Calls `loadQuizByNo` to load specific quizzes for translation [scripts/translate.ts:10-15].\\n\\nThe module's design enables a clean separation of concerns where other modules can depend on the standardized `Quiz` interface without worrying about the underlying file structure or localization complexities.\\n\\n### Architectural Design Decisions\\n\\nSeveral design decisions make this module robust and maintainable:\\n\\n1. **Separation of Concerns**: The module separates file I/O operations from data processing, making it easier to test and modify individual components.\\n\\n2. **Locale Flexibility**: The use of `loadLocaleVariations` allows for easy extension to new languages without changing core logic [scripts/loader.ts:14-36].\\n\\n3. **Fallback Strategy**: The system automatically falls back to default locale content when localized versions don't exist, ensuring robustness [scripts/loader.ts:28-33].\\n\\n4. **Type Safety**: The module leverages TypeScript interfaces and generics to provide compile-time guarantees about data structure [scripts/types.ts:26-38].\\n\\n5. **Reusable Utilities**: Functions like `loadFile` and `loadLocaleVariations` are generic enough to be reused across different parts of the system [scripts/loader.ts:8-36].\\n\\n## Mermaid Flowchart: Quiz Loading Process\\n\\n```mermaid\\nflowchart TD\\n A[loadQuizzes] --> B[Discover quiz directories]\\n B --> C[For each directory, call loadQuiz]\\n C --> D[loadQuiz function]\\n D --> E[Load quiz number and difficulty]\\n D --> F[Load info.yml with loadLocaleVariations]\\n D --> G[Load README.md with loadLocaleVariations]\\n D --> H[Load template.ts]\\n D --> I[Load test-cases.ts]\\n D --> J[Return complete Quiz object]\\n \\n subgraph \\\"loadLocaleVariations\\\"\\n K[Load base file]\\n L[Load locale-specific files]\\n M[Combine into record]\\n end\\n \\n F --> K\\n G --> K\\n K --> M\\n L --> M\\n \\n subgraph \\\"loadFile\\\"\\n N[Check if file exists]\\n O[Read file content]\\n P[Return content or undefined]\\n end\\n \\n H --> N\\n I --> N\\n N --> O\\n O --> P\\n```\\n\\n## Conclusion\\n\\nThe `scripts/loader.ts` module is the architectural backbone of the Type Challenges system. Its design enables a clean separation of data loading from business logic, provides robust support for internationalization, and establishes a consistent interface for accessing quiz data throughout the application. The module's reliance on well-defined abstractions and its integration with TypeScript's type system make it both maintainable and extensible. All other scripts in the system depend on this module's stable interface, making it a critical component that requires careful attention when making changes.\"\n }\n]","isConversational":true},"source":{"kind":"string","value":"type-challenges/type-challenges"},"category":{"kind":"string","value":"module_deep_dive"},"quality_score":{"kind":"number","value":100,"string":"100"},"citation_stats":{"kind":"string","value":"{\n \"total_citations\": 16,\n \"validity_rate\": 1,\n \"invalid\": []\n}"},"license":{"kind":"string","value":"MIT"},"language":{"kind":"string","value":"typescript"}}},{"rowIdx":98,"cells":{"messages":{"kind":"list like","value":[{"role":"system","content":["You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\n4. Explain the WHY behind design decisions, not only the WHAT.\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\n7. Example of the correct citation style, inline and attached to a path:\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon."]},{"role":"user","content":"<START_OF_CONTEXT>\n# Repository: type-challenges/type-challenges (language: typescript)\n\n# Selected files (windows)\n- eslint.config.js (24 lines)\n- questions/00002-medium-return-type/test-cases.ts (20 lines)\n- questions/00003-medium-omit/test-cases.ts (32 lines)\n- questions/00004-easy-pick/test-cases.ts (23 lines)\n- questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\n- questions/00006-hard-simple-vue/test-cases.ts (37 lines)\n- questions/00008-medium-readonly-2/test-cases.ts (29 lines)\n- questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\n- questions/00599-medium-merge/test-cases.ts (18 lines)\n- scripts/actions/utils/formatToCode.ts (26 lines)\n- scripts/actions/utils/toInfoHeader.ts (15 lines)\n- scripts/build.ts (54 lines)\n- scripts/generate-play.ts (180 lines)\n- scripts/loader.ts (117 lines)\n- scripts/locales.ts (26 lines)\n- scripts/readme.ts (240 lines)\n- scripts/toUrl.ts (85 lines)\n- scripts/translate.ts (73 lines)\n- scripts/types.ts (38 lines)\n- utils/index.d.test.ts (35 lines)\n- utils/index.d.ts (29 lines)\n\n\n### FILE: eslint.config.js (24 lines)\n\n```\n 1| const antfu = require('@antfu/eslint-config').default\n 2| \n 3| module.exports = antfu(\n 4| {\n 5| markdown: false,\n 6| },\n 7| {\n 8| rules: {\n 9| 'import/first': 'off',\n 10| 'no-alert': 'off',\n 11| 'no-unused-expressions': 'off',\n 12| 'no-unused-vars': 'off',\n 13| 'no-use-before-define': 'off',\n 14| 'prefer-const': 'off',\n 15| 'ts/ban-ts-comment': 'off',\n 16| 'ts/ban-types': 'off',\n 17| 'ts/consistent-type-definitions': 'off',\n 18| 'ts/no-namespace': 'off',\n 19| 'ts/no-require-imports': 'off',\n 20| 'ts/no-unused-vars': 'off',\n 21| 'unused-imports/no-unused-vars': 'off',\n 22| },\n 23| },\n 24| )\n```\n\n### FILE: questions/00002-medium-return-type/test-cases.ts (20 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<string, MyReturnType<() => string>>>,\n 5| Expect<Equal<123, MyReturnType<() => 123>>>,\n 6| Expect<Equal<ComplexObject, MyReturnType<() => ComplexObject>>>,\n 7| Expect<Equal<Promise<boolean>, MyReturnType<() => Promise<boolean>>>>,\n 8| Expect<Equal<() => 'foo', MyReturnType<() => () => 'foo'>>>,\n 9| Expect<Equal<1 | 2, MyReturnType<typeof fn>>>,\n 10| Expect<Equal<1 | 2, MyReturnType<typeof fn1>>>,\n 11| ]\n 12| \n 13| type ComplexObject = {\n 14| a: [12, 'foo']\n 15| bar: 'hello'\n 16| prev(): number\n 17| }\n 18| \n 19| const fn = (v: boolean) => v ? 1 : 2\n 20| const fn1 = (v: boolean, w: any) => v ? 1 : 2\n```\n\n### FILE: questions/00003-medium-omit/test-cases.ts (32 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<Expected1, MyOmit<Todo, 'description'>>>,\n 5| Expect<Equal<Expected2, MyOmit<Todo, 'description' | 'completed'>>>,\n 6| Expect<Equal<Expected3, MyOmit<Todo1, 'description' | 'completed'>>>,\n 7| ]\n 8| \n 9| interface Todo {\n 10| title: string\n 11| description: string\n 12| completed: boolean\n 13| }\n 14| \n 15| interface Todo1 {\n 16| readonly title: string\n 17| description: string\n 18| completed: boolean\n 19| }\n 20| \n 21| interface Expected1 {\n 22| title: string\n 23| completed: boolean\n 24| }\n 25| \n 26| interface Expected2 {\n 27| title: string\n 28| }\n 29| \n 30| interface Expected3 {\n 31| readonly title: string\n 32| }\n```\n\n### FILE: questions/00004-easy-pick/test-cases.ts (23 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<Expected1, MyPick<Todo, 'title'>>>,\n 5| Expect<Equal<Expected2, MyPick<Todo, 'title' | 'completed'>>>,\n 6| // @ts-expect-error\n 7| MyPick<Todo, 'title' | 'completed' | 'invalid'>,\n 8| ]\n 9| \n 10| interface Todo {\n 11| title: string\n 12| description: string\n 13| completed: boolean\n 14| }\n 15| \n 16| interface Expected1 {\n 17| title: string\n 18| }\n 19| \n 20| interface Expected2 {\n 21| title: string\n 22| completed: boolean\n 23| }\n```\n\n### FILE: questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<'title', GetReadonlyKeys<Todo1>>>,\n 5| Expect<Equal<'title' | 'description', GetReadonlyKeys<Todo2>>>,\n 6| ]\n 7| \n 8| interface Todo1 {\n 9| readonly title: string\n 10| description: string\n 11| completed: boolean\n 12| }\n 13| \n 14| interface Todo2 {\n 15| readonly title: string\n 16| readonly description: string\n 17| completed?: boolean\n 18| }\n```\n\n### FILE: questions/00006-hard-simple-vue/test-cases.ts (37 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| SimpleVue({\n 4| data() {\n 5| // @ts-expect-error\n 6| this.firstname\n 7| // @ts-expect-error\n 8| this.getRandom()\n 9| // @ts-expect-error\n 10| this.data()\n 11| \n 12| return {\n 13| firstname: 'Type',\n 14| lastname: 'Challenges',\n 15| amount: 10,\n 16| }\n 17| },\n 18| computed: {\n 19| fullname() {\n 20| return `${this.firstname} ${this.lastname}`\n 21| },\n 22| },\n 23| methods: {\n 24| getRandom() {\n 25| return Math.random()\n 26| },\n 27| hi() {\n 28| alert(this.amount)\n 29| alert(this.fullname.toLowerCase())\n 30| alert(this.getRandom())\n 31| },\n 32| test() {\n 33| const fullname = this.fullname\n 34| const cases: [Expect<Equal<typeof fullname, string>>] = [] as any\n 35| },\n 36| },\n 37| })\n```\n\n### FILE: questions/00008-medium-readonly-2/test-cases.ts (29 lines)\n\n```\n 1| import type { Alike, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Alike<MyReadonly2<Todo1>, Readonly<Todo1>>>,\n 5| Expect<Alike<MyReadonly2<Todo1, 'title' | 'description'>, Expected>>,\n 6| Expect<Alike<MyReadonly2<Todo2, 'title' | 'description'>, Expected>>,\n 7| Expect<Alike<MyReadonly2<Todo2, 'description' >, Expected>>,\n 8| ]\n 9| \n 10| // @ts-expect-error\n 11| type error = MyReadonly2<Todo1, 'title' | 'invalid'>\n 12| \n 13| interface Todo1 {\n 14| title: string\n 15| description?: string\n 16| completed: boolean\n 17| }\n 18| \n 19| interface Todo2 {\n 20| readonly title: string\n 21| description?: string\n 22| completed: boolean\n 23| }\n 24| \n 25| interface Expected {\n 26| readonly title: string\n 27| readonly description?: string\n 28| completed: boolean\n 29| }\n```\n\n### FILE: questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<DeepReadonly<X1>, Expected1>>,\n 5| Expect<Equal<DeepReadonly<X2>, Expected2>>,\n 6| ]\n 7| \n 8| type X1 = {\n 9| a: () => 22\n 10| b: string\n 11| c: {\n 12| d: boolean\n 13| e: {\n 14| g: {\n 15| h: {\n 16| i: true\n 17| j: 'string'\n 18| }\n 19| k: 'hello'\n 20| }\n 21| l: [\n 22| 'hi',\n 23| {\n 24| m: ['hey']\n 25| },\n 26| ]\n 27| }\n 28| }\n 29| }\n 30| \n 31| type X2 = { a: string } | { b: number }\n 32| \n 33| type Expected1 = {\n 34| readonly a: () => 22\n 35| readonly b: string\n 36| readonly c: {\n 37| readonly d: boolean\n 38| readonly e: {\n 39| readonly g: {\n 40| readonly h: {\n 41| readonly i: true\n 42| readonly j: 'string'\n 43| }\n 44| readonly k: 'hello'\n 45| }\n 46| readonly l: readonly [\n 47| 'hi',\n 48| {\n 49| readonly m: readonly ['hey']\n 50| },\n 51| ]\n 52| }\n 53| }\n 54| }\n 55| \n 56| type Expected2 = { readonly a: string } | { readonly b: number }\n```\n\n### FILE: questions/00599-medium-merge/test-cases.ts (18 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type Foo = {\n 4| a: number\n 5| b: string\n 6| }\n 7| type Bar = {\n 8| b: number\n 9| c: boolean\n 10| }\n 11| \n 12| type cases = [\n 13| Expect<Equal<Merge<Foo, Bar>, {\n 14| a: number\n 15| b: number\n 16| c: boolean\n 17| }>>,\n 18| ]\n```\n\n### FILE: scripts/actions/utils/formatToCode.ts (26 lines)\n\n```\n 1| import type { Quiz } from '../../types'\n 2| import type { SupportedLocale } from '../../locales'\n 3| import { defaultLocale, t } from '../../locales'\n 4| import { toCommentBlock } from './toCommentBlock'\n 5| import { toInfoHeader } from './toInfoHeader'\n 6| import { toLinks } from './toLinks'\n 7| import { toDivider } from './toDivider'\n 8| import { toFooter } from './toFooter'\n 9| \n 10| export function formatToCode(quiz: Quiz, locale: SupportedLocale) {\n 11| return `${toCommentBlock(\n 12| toInfoHeader(quiz, locale)\n 13| + (quiz.readme[locale] || quiz.readme[defaultLocale])\n 14| + toLinks(quiz, locale),\n 15| )\n 16| + toDivider(t(locale, 'divider.code-start'))\n 17| }\\n${\n 18| (quiz.template || '').trim()\n 19| }\\n${\n 20| toDivider(t(locale, 'divider.test-cases'))\n 21| }${\n 22| (quiz.tests || '').trim()\n 23| }\\n${\n 24| toDivider(t(locale, 'divider.further-steps'))\n 25| }${toCommentBlock(toFooter(quiz, locale))}`\n 26| }\n```\n\n### FILE: scripts/actions/utils/toInfoHeader.ts (15 lines)\n\n```\n 1| import type { Quiz } from '../../types'\n 2| import type { SupportedLocale } from '../../locales'\n 3| import { t } from '../../locales'\n 4| import { resolveInfo } from '../../loader'\n 5| \n 6| export const toInfoHeader = function toInfoHeader(quiz: Quiz, locale: SupportedLocale) {\n 7| const info = resolveInfo(quiz, locale)\n 8| \n 9| const author = `${info.author?.name} (@${info?.author?.github})`\n 10| \n 11| return `${quiz.no} - ${info.title || ''}\\n`\n 12| + '-------\\n'\n 13| + `by ${author} #${t(locale, `difficulty.${quiz.difficulty}`)} ${info?.tags?.map(i => `#${i}`).join(' ') || ''}\\n\\n`\n 14| + `### ${t(locale, 'title.question')}\\n\\n`\n 15| }\n```\n\n### FILE: scripts/build.ts (54 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import { loadQuizzes, resolveInfo } from './loader'\n 4| import { REPO, toPlaygroundUrl, toQuestionsRawREADME, toQuizREADME, toRawREADME, toShareAnswerFull, toSolutionsFull } from './toUrl'\n 5| import { defaultLocale, supportedLocales } from './locales'\n 6| import { formatToCode } from './actions/utils/formatToCode'\n 7| \n 8| export async function build() {\n 9| const quizzes = await loadQuizzes()\n 10| const redirects: [string, string, number][] = []\n 11| \n 12| // redirect homepage to github repo\n 13| supportedLocales.filter(locale => locale !== defaultLocale).forEach((locale) => {\n 14| redirects.push([`/${locale}`, `${REPO}/blob/main/README.${locale}.md`, 302])\n 15| })\n 16| \n 17| supportedLocales.forEach((locale) => {\n 18| redirects.push([`/raw/${locale}`, toQuestionsRawREADME(locale), 302])\n 19| })\n 20| \n 21| for (const quiz of quizzes) {\n 22| for (const locale of supportedLocales) {\n 23| const info = resolveInfo(quiz, locale)\n 24| \n 25| const code = formatToCode(quiz, locale)\n 26| \n 27| const url = toPlaygroundUrl(code, info.tsconfig || {})\n 28| \n 29| if (locale === defaultLocale) {\n 30| redirects.push([`/${quiz.no}`, toQuizREADME(quiz, locale, true), 302])\n 31| redirects.push([`/${quiz.no}/raw`, toRawREADME(quiz, locale), 302])\n 32| redirects.push([`/${quiz.no}/play`, url, 302])\n 33| redirects.push([`/${quiz.no}/answer`, toShareAnswerFull(quiz), 302])\n 34| }\n 35| else {\n 36| redirects.push([`/${quiz.no}/${locale}`, toQuizREADME(quiz, locale, true), 302])\n 37| redirects.push([`/${quiz.no}/raw/${locale}`, toRawREADME(quiz, locale), 302])\n 38| redirects.push([`/${quiz.no}/play/${locale}`, url, 302])\n 39| redirects.push([`/${quiz.no}/answer/${locale}`, toShareAnswerFull(quiz, locale), 302])\n 40| }\n 41| }\n 42| \n 43| redirects.push([`/${quiz.no}/solutions`, toSolutionsFull(quiz.no), 302])\n 44| }\n 45| \n 46| const dist = path.resolve(__dirname, 'dist')\n 47| \n 48| await fs.remove(dist)\n 49| await fs.ensureDir(dist)\n 50| \n 51| await fs.writeFileSync(path.join(dist, '_redirects'), redirects.map(i => i.join('\\t')).join('\\n'), 'utf-8')\n 52| }\n 53| \n 54| build()\n```\n\n### FILE: scripts/generate-play.ts (180 lines)\n\n```\n 1| import path from 'node:path'\n 2| import process from 'node:process'\n 3| import crypto from 'node:crypto'\n 4| import fs from 'fs-extra'\n 5| import c from 'ansis'\n 6| import prompts from 'prompts'\n 7| import { formatToCode } from './actions/utils/formatToCode'\n 8| import { loadQuizzes, resolveInfo } from './loader'\n 9| import { supportedLocales } from './locales'\n 10| import { getQuestionFullName } from './actions/issue-pr'\n 11| import type { QuizMetaInfo } from './types'\n 12| \n 13| type Snapshot = Record<string, string>\n 14| \n 15| function calculateFileHash(filePathFull: string): Promise<string> {\n 16| return new Promise((resolve, reject) => {\n 17| const hash = crypto.createHash('sha1')\n 18| const fileStream = fs.createReadStream(filePathFull)\n 19| \n 20| fileStream.on('data', (data) => {\n 21| hash.update(data)\n 22| })\n 23| \n 24| fileStream.on('end', () => {\n 25| hash.update(filePathFull)\n 26| resolve(hash.digest('hex'))\n 27| })\n 28| \n 29| fileStream.on('error', (err) => {\n 30| reject(err)\n 31| })\n 32| })\n 33| }\n 34| \n 35| async function takeSnapshot(quizzesPath: string) {\n 36| let snapshot: Snapshot = {}\n 37| \n 38| const files = fs.readdirSync(quizzesPath)\n 39| \n 40| for (const file of files) {\n 41| // Might be a file, or a folder\n 42| const fPath = path.join(quizzesPath, file)\n 43| const fStats = fs.statSync(fPath)\n 44| \n 45| if (fStats.isDirectory()) {\n 46| snapshot = {\n 47| ...snapshot,\n 48| ...(await takeSnapshot(fPath)),\n 49| }\n 50| }\n 51| else {\n 52| snapshot[file] = await calculateFileHash(fPath)\n 53| }\n 54| }\n 55| \n 56| return snapshot\n 57| }\n 58| \n 59| function readPlaygroundCache(playgroundCachePath: string): Snapshot {\n 60| if (!fs.existsSync(playgroundCachePath))\n 61| return {}\n 62| \n 63| try {\n 64| const rawCacheContent = fs.readFileSync(playgroundCachePath)\n 65| return JSON.parse(rawCacheContent.toString())\n 66| }\n 67| catch (err) {\n 68| console.log(c.red('Playground cache corrupted. '\n 69| + 'Cannot generate playground without keeping your changes intact'))\n 70| console.log(c.cyan('Please ensure you have run this: \"pnpm generate\"'))\n 71| process.exit(1)\n 72| }\n 73| }\n 74| \n 75| function calculateOverridableFiles(cache: Snapshot, snapshot: Snapshot) {\n 76| const result: Snapshot = {}\n 77| \n 78| for (const quizName in snapshot) {\n 79| if (snapshot[quizName] === cache[quizName])\n 80| result[quizName] = snapshot[quizName]\n 81| }\n 82| \n 83| return result\n 84| }\n 85| \n 86| function isQuizWritable(quizFileName: string, overridableFiles: Snapshot, playgroundSnapshot: Snapshot): boolean {\n 87| return !!(\n 88| overridableFiles[quizFileName]\n 89| || (!overridableFiles[quizFileName] && !playgroundSnapshot[quizFileName])\n 90| )\n 91| }\n 92| \n 93| async function generatePlayground() {\n 94| const playgroundPath = path.join(__dirname, '../playground')\n 95| const playgroundCachePath = path.join(__dirname, '../.playgroundcache')\n 96| \n 97| let locale = supportedLocales.find(locale => locale === process.argv[2])!\n 98| \n 99| console.log(c.bold.cyan('Generating local playground...\\n'))\n 100| \n 101| let overridableFiles: Snapshot\n 102| let keepChanges = false\n 103| const currentPlaygroundCache = readPlaygroundCache(playgroundCachePath)\n 104| let playgroundSnapshot: Snapshot\n 105| \n 106| if (process.argv.length === 3 && (process.argv[2] === '--keep-changes' || process.argv[2] === '-K')) {\n 107| console.log(c.bold.cyan('We will keep your changes while generating.\\n'))\n 108| keepChanges = true\n 109| \n 110| playgroundSnapshot = await takeSnapshot(playgroundPath)\n 111| \n 112| overridableFiles = calculateOverridableFiles(currentPlaygroundCache, playgroundSnapshot)\n 113| }\n 114| else if (fs.existsSync(playgroundPath)) {\n 115| const result = await prompts([{\n 116| name: 'confirm',\n 117| type: 'confirm',\n 118| initial: false,\n 119| message: 'The playground directory already exists, it may contains the answers you did. Do you want to override it?',\n 120| }])\n 121| if (!result?.confirm)\n 122| return console.log(c.yellow('Skipped.'))\n 123| }\n 124| \n 125| if (!locale) {\n 126| const result = await prompts([{\n 127| name: 'locale',\n 128| type: 'select',\n 129| message: 'Select language:',\n 130| choices: supportedLocales.map(i => ({\n 131| title: i,\n 132| value: i,\n 133| })),\n 134| }])\n 135| if (!result)\n 136| return console.log(c.yellow('Skipped.'))\n 137| locale = result.locale\n 138| }\n 139| \n 140| if (!keepChanges) {\n 141| await fs.remove(playgroundPath)\n 142| await fs.ensureDir(playgroundPath)\n 143| }\n 144| \n 145| const quizzes = await loadQuizzes()\n 146| const incomingQuizzesCache: Snapshot = {}\n 147| \n 148| for (const quiz of quizzes) {\n 149| const { difficulty, title } = resolveInfo(quiz, locale) as QuizMetaInfo & { difficulty: string }\n 150| const code = formatToCode(quiz, locale)\n 151| \n 152| if (difficulty === undefined || title === undefined) {\n 153| console.log(c.yellow`${quiz.no} has no ${locale.toUpperCase()} version. Skipping`)\n 154| continue\n 155| }\n 156| \n 157| const quizzesPathByDifficulty = path.join(playgroundPath, difficulty)\n 158| \n 159| const quizFileName = `${getQuestionFullName(quiz.no, difficulty, title)}.ts`\n 160| const quizPathFull = path.join(quizzesPathByDifficulty, quizFileName)\n 161| \n 162| if (!keepChanges || (keepChanges && isQuizWritable(quizFileName, overridableFiles!, playgroundSnapshot!))) {\n 163| if (!fs.existsSync(quizzesPathByDifficulty))\n 164| fs.mkdirSync(quizzesPathByDifficulty)\n 165| await fs.writeFile(quizPathFull, code, 'utf-8')\n 166| incomingQuizzesCache[quizFileName] = await calculateFileHash(quizPathFull)\n 167| }\n 168| }\n 169| \n 170| fs.writeFile(playgroundCachePath, JSON.stringify({\n 171| ...currentPlaygroundCache,\n 172| ...incomingQuizzesCache,\n 173| }))\n 174| \n 175| console.log()\n 176| console.log(c.bold.green('Local playground generated at: ') + c.dim(playgroundPath))\n 177| console.log()\n 178| }\n 179| \n 180| generatePlayground()\n```\n\n### FILE: scripts/loader.ts (117 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import fg from 'fast-glob'\n 4| import YAML from 'js-yaml'\n 5| import type { Quiz, QuizMetaInfo } from './types'\n 6| import { defaultLocale, supportedLocales } from './locales'\n 7| \n 8| export async function loadFile(filepath: string) {\n 9| if (fs.existsSync(filepath))\n 10| return await fs.readFile(filepath, 'utf-8')\n 11| return undefined\n 12| }\n 13| \n 14| export async function loadLocaleVariations<T = string>(\n 15| filepath: string,\n 16| preprocessor: (s: string) => T = s => s as any as T,\n 17| ) {\n 18| const { ext, dir, name } = path.parse(filepath)\n 19| const data: Record<string, T> = {}\n 20| \n 21| for (const locale of supportedLocales) {\n 22| const file = preprocessor(await loadFile(path.join(dir, `${name}.${locale}${ext}`)) || '')\n 23| \n 24| if (file)\n 25| data[locale] = file\n 26| }\n 27| \n 28| if (!data[defaultLocale]) {\n 29| // default version\n 30| const file = preprocessor(await loadFile(filepath) || '')\n 31| if (file)\n 32| data[defaultLocale] = file\n 33| }\n 34| \n 35| return data\n 36| }\n 37| \n 38| export function readmeCleanUp(text: string) {\n 39| return text\n 40| .replace(/<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/, '')\n 41| .replace(/<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/, '')\n 42| .trim()\n 43| }\n 44| \n 45| export function loadInfo(s: string): Partial<QuizMetaInfo> | undefined {\n 46| const object = YAML.load(s) as any\n 47| if (!object)\n 48| return undefined\n 49| \n 50| const arrayKeys = ['tags', 'related']\n 51| \n 52| for (const key of arrayKeys) {\n 53| if (object[key]) {\n 54| object[key] = (object[key] || '')\n 55| .toString()\n 56| .split(',')\n 57| .map((i: string) => i.trim())\n 58| .filter(Boolean)\n 59| }\n 60| else {\n 61| object[key] = undefined\n 62| }\n 63| }\n 64| \n 65| return object\n 66| }\n 67| \n 68| export const QUIZ_ROOT = path.resolve(__dirname, '../questions')\n 69| \n 70| export async function loadQuizzes(): Promise<Quiz[]> {\n 71| const folders = await fg('{0..9}*-*', {\n 72| onlyDirectories: true,\n 73| cwd: QUIZ_ROOT,\n 74| })\n 75| \n 76| const quizzes = await Promise.all(\n 77| folders.map(async dir => loadQuiz(dir)),\n 78| )\n 79| \n 80| return quizzes\n 81| }\n 82| \n 83| export async function loadQuiz(dir: string): Promise<Quiz> {\n 84| return {\n 85| no: Number(dir.replace(/^(\\d+)-.*/, '$1')),\n 86| difficulty: dir.replace(/^\\d+-(.+?)-.*$/, '$1') as any,\n 87| path: dir,\n 88| info: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'info.yml'), loadInfo),\n 89| readme: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'README.md'), readmeCleanUp),\n 90| template: await loadFile(path.join(QUIZ_ROOT, dir, 'template.ts')) || '',\n 91| tests: await loadFile(path.join(QUIZ_ROOT, dir, 'test-cases.ts')),\n 92| }\n 93| }\n 94| \n 95| export async function loadQuizByNo(no: number | string) {\n 96| const folders = await fg(`${no}-*`, {\n 97| onlyDirectories: true,\n 98| cwd: QUIZ_ROOT,\n 99| })\n 100| \n 101| if (folders.length)\n 102| return await loadQuiz(folders[0])\n 103| \n 104| return undefined\n 105| }\n 106| \n 107| export function resolveInfo(quiz: Quiz, locale: string = defaultLocale) {\n 108| const info = { ...quiz.info[defaultLocale], ...quiz.info[locale] }\n 109| info.tags = quiz.info[locale]?.tags || quiz.info[defaultLocale]?.tags || []\n 110| info.related = quiz.info[locale]?.related || quiz.info[defaultLocale]?.related || []\n 111| \n 112| if (typeof info.tags === 'string')\n 113| // @ts-expect-error\n 114| info.tags = info.tags.split(',').map(i => i.trim()).filter(Boolean)\n 115| \n 116| return info as QuizMetaInfo\n 117| }\n```\n\n### FILE: scripts/locales.ts (26 lines)\n\n```\n 1| export const defaultLocale = 'en'\n 2| \n 3| export const supportedLocales = ['en', 'zh-CN', 'ja', 'ko', 'pt-BR'] as const\n 4| \n 5| export const messages = {\n 6| 'en': require('./locales/en.json'),\n 7| 'zh-CN': require('./locales/zh-CN.json'),\n 8| 'ja': require('./locales/ja.json'),\n 9| 'ko': require('./locales/ko.json'),\n 10| 'pt-BR': require('./locales/pt-BR.json'),\n 11| }\n 12| \n 13| export type SupportedLocale = keyof typeof messages\n 14| \n 15| export function t(locale: SupportedLocale, key: string): string {\n 16| const result = (messages[locale] && messages[locale][key]) || messages[defaultLocale][key]\n 17| if (!result)\n 18| throw new Error(`Missing message for key \"${key}\"`)\n 19| return result\n 20| }\n 21| \n 22| export function f(name: string, locale: string, ext: string) {\n 23| if (locale === defaultLocale)\n 24| return `${name}.${ext}`\n 25| return `${name}.${locale}.${ext}`\n 26| }\n```\n\n### FILE: scripts/readme.ts (240 lines)\n\n```\n 1| import path from 'node:path'\n 2| import process from 'node:process'\n 3| import fs from 'fs-extra'\n 4| import type { SupportedLocale } from './locales'\n 5| import { defaultLocale, f, supportedLocales, t } from './locales'\n 6| import { loadQuizzes, resolveInfo } from './loader'\n 7| import { toAnswerShort, toNearborREADME, toPlayShort, toQuizREADME, toSolutionsShort } from './toUrl'\n 8| import type { Quiz, QuizMetaInfo } from './types'\n 9| \n 10| const DifficultyColors: Record<string, string> = {\n 11| warm: 'teal',\n 12| easy: '7aad0c',\n 13| medium: 'd9901a',\n 14| hard: 'de3d37',\n 15| extreme: 'b11b8d',\n 16| }\n 17| \n 18| const DifficultyRank = [\n 19| 'warm',\n 20| 'easy',\n 21| 'medium',\n 22| 'hard',\n 23| 'extreme',\n 24| ]\n 25| \n 26| function escapeHtml(unsafe: string) {\n 27| return unsafe\n 28| .replace(/&/g, '&')\n 29| .replace(/</g, '<')\n 30| .replace(/>/g, '>')\n 31| .replace(/\"/g, '"')\n 32| .replace(/'/g, ''')\n 33| }\n 34| \n 35| function toBadgeURL(label: string, text: string, color: string, args = '') {\n 36| return `https://img.shields.io/badge/${encodeURIComponent(label.replace(/-/g, '--'))}-${encodeURIComponent(text.replace(/-/g, '--'))}-${color}${args}`\n 37| }\n 38| \n 39| function toBadge(label: string, text: string, color: string, args = '') {\n 40| return `<img src=\"${toBadgeURL(label, text, color, args)}\" alt=\"${text}\"/>`\n 41| }\n 42| \n 43| export function toBadgeLink(url: string, label: string, text: string, color: string, args = '') {\n 44| return `<a href=\"${url}\" target=\"_blank\">${toBadge(label, text, color, args)}</a> `\n 45| }\n 46| \n 47| export function toPlanTextLink(url: string, _label: string, text: string, _color: string, _args = '') {\n 48| return `<a href=\"${url}\" target=\"_blank\">${text}</a> `\n 49| }\n 50| \n 51| function toAuthorInfo(author: Partial<QuizMetaInfo['author']> = {}) {\n 52| return `by ${author.name}${author.github ? ` <a href=\"https://github.com/${author.github}\" target=\"_blank\">@${author.github}</a>` : ''}`\n 53| }\n 54| \n 55| function toDifficultyBadge(difficulty: string, locale: SupportedLocale) {\n 56| return toBadge('', t(locale, `difficulty.${difficulty}`), DifficultyColors[difficulty])\n 57| }\n 58| \n 59| function toDifficultyBadgeInverted(difficulty: string, locale: SupportedLocale, count: number) {\n 60| return toBadge(t(locale, `difficulty.${difficulty}`), count.toString(), DifficultyColors[difficulty])\n 61| }\n 62| \n 63| function toDifficultyPlainText(difficulty: string, locale: SupportedLocale, count: number) {\n 64| return `${t(locale, `difficulty.${difficulty}`)} (${count.toString()})`\n 65| }\n 66| \n 67| function toDetailsInnerText(text: string, locale: SupportedLocale) {\n 68| return `${t(locale, `details.${text}`)}`\n 69| }\n 70| \n 71| function quizToBadge(quiz: Quiz, locale: string, absolute = false, badge = true) {\n 72| const fn = badge ? toBadgeLink : toPlanTextLink\n 73| return fn(\n 74| toQuizREADME(quiz, locale, absolute),\n 75| '',\n 76| `${quiz.no}・${quiz.info[locale]?.title || quiz.info[defaultLocale]?.title}`,\n 77| DifficultyColors[quiz.difficulty],\n 78| )\n 79| }\n 80| \n 81| function quizNoToBadges(ids: (string | number)[], quizzes: Quiz[], locale: string, absolute = false) {\n 82| return ids\n 83| .map(i => quizzes.find(q => q.no === Number(i)))\n 84| .filter(Boolean)\n 85| .map(i => quizToBadge(i!, locale, absolute))\n 86| .join(' ')\n 87| }\n 88| \n 89| function getAllTags(quizzes: Quiz[], locale: string) {\n 90| const set = new Set<string>()\n 91| for (const quiz of quizzes) {\n 92| const info = resolveInfo(quiz, locale)\n 93| for (const tag of (info?.tags || []))\n 94| set.add(tag)\n 95| }\n 96| return Array.from(set).sort()\n 97| }\n 98| \n 99| function getQuizzesByTag(quizzes: Quiz[], locale: string, tag: string) {\n 100| return quizzes.filter((quiz) => {\n 101| const info = resolveInfo(quiz, locale)\n 102| return !!info.tags?.includes(tag)\n 103| })\n 104| }\n 105| \n 106| async function insertInfoReadme(filepath: string, quiz: Quiz, locale: SupportedLocale, quizzes: Quiz[]) {\n 107| if (!fs.existsSync(filepath))\n 108| return\n 109| let text = await fs.readFile(filepath, 'utf-8')\n 110| /* eslint-disable prefer-template */\n 111| \n 112| if (!text.match(/<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/))\n 113| text = `<!--info-header-start--><!--info-header-end-->\\n\\n${text}`\n 114| if (!text.match(/<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/))\n 115| text = `${text}\\n\\n<!--info-footer-start--><!--info-footer-end-->`\n 116| \n 117| const info = resolveInfo(quiz, locale)\n 118| \n 119| const availableLocales = supportedLocales.filter(l => l !== locale).filter(l => !!quiz.readme[l])\n 120| \n 121| text = text\n 122| .replace(\n 123| /<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/,\n 124| '<!--info-header-start-->'\n 125| + `<h1>${escapeHtml(info.title || '')} ${toDifficultyBadge(quiz.difficulty, locale)} ${(info.tags || []).map(i => toBadge('', `#${i}`, '999')).join(' ')}</h1>`\n 126| + `<blockquote><p>${toAuthorInfo(info.author)}</p></blockquote>`\n 127| + '<p>'\n 128| + toBadgeLink(toPlayShort(quiz.no, locale), '', t(locale, 'badge.take-the-challenge'), '3178c6', '?logo=typescript&logoColor=white')\n 129| + (availableLocales.length ? (' ' + availableLocales.map(l => toBadgeLink(toNearborREADME(quiz, l), '', t(l, 'display'), 'gray')).join(' ')) : '')\n 130| + '</p>'\n 131| + '<!--info-header-end-->',\n 132| )\n 133| .replace(\n 134| /<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/,\n 135| '<!--info-footer-start--><br>'\n 136| + toBadgeLink(`../../${f('README', locale, 'md')}`, '', t(locale, 'badge.back'), 'grey')\n 137| + toBadgeLink(toAnswerShort(quiz.no, locale), '', t(locale, 'badge.share-your-solutions'), 'teal')\n 138| + toBadgeLink(toSolutionsShort(quiz.no), '', t(locale, 'badge.checkout-solutions'), 'de5a77', '?logo=awesome-lists&logoColor=white')\n 139| + (Array.isArray(info.related) && info.related.length ? `<hr><h3>${t(locale, 'readme.related-challenges')}</h3>${quizNoToBadges(info.related, quizzes, locale, true)}` : '')\n 140| + '<!--info-footer-end-->',\n 141| )\n 142| \n 143| /* eslint-enable prefer-template */\n 144| \n 145| await fs.writeFile(filepath, text, 'utf-8')\n 146| }\n 147| \n 148| async function updateIndexREADME(quizzes: Quiz[]) {\n 149| // update index README\n 150| for (const locale of supportedLocales) {\n 151| const filepath = path.resolve(__dirname, '..', f('README', locale, 'md'))\n 152| \n 153| let challengesREADME = ''\n 154| let prev = ''\n 155| \n 156| // difficulty\n 157| const quizzesByDifficulty = [...quizzes].sort((a, b) => DifficultyRank.indexOf(a.difficulty) - DifficultyRank.indexOf(b.difficulty))\n 158| \n 159| for (const quiz of quizzesByDifficulty) {\n 160| if (prev !== quiz.difficulty)\n 161| challengesREADME += `${prev ? '<br><br>' : ''}${toDifficultyBadgeInverted(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}<br>`\n 162| \n 163| challengesREADME += quizToBadge(quiz, locale)\n 164| \n 165| prev = quiz.difficulty\n 166| }\n 167| \n 168| // by tags\n 169| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-tags', locale)}</summary><br><table><tbody>`\n 170| const tags = getAllTags(quizzes, locale)\n 171| for (const tag of tags) {\n 172| challengesREADME += `<tr><td>${toBadge('', `#${tag}`, '999')}</td><td>`\n 173| getQuizzesByTag(quizzesByDifficulty, locale, tag)\n 174| .forEach((quiz) => {\n 175| challengesREADME += quizToBadge(quiz, locale)\n 176| })\n 177| challengesREADME += '</td></tr>'\n 178| }\n 179| challengesREADME += '<tr><td><code> </code></td><td></td></tr>'\n 180| challengesREADME += '</tbody></table></details>'\n 181| \n 182| // by plain text\n 183| prev = ''\n 184| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-plain-text', locale)}</summary><br>`\n 185| for (const quiz of quizzesByDifficulty) {\n 186| if (prev !== quiz.difficulty)\n 187| challengesREADME += `${prev ? '</ul>' : ''}<h3>${toDifficultyPlainText(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}</h3><ul>`\n 188| challengesREADME += `<li>${quizToBadge(quiz, locale, false, false)}</li>`\n 189| prev = quiz.difficulty\n 190| }\n 191| challengesREADME += '</ul></details><br>'\n 192| \n 193| let readme = await fs.readFile(filepath, 'utf-8')\n 194| readme = readme.replace(\n 195| /<!--challenges-start-->[\\s\\S]*<!--challenges-end-->/m,\n 196| `<!--challenges-start-->\\n${challengesREADME}\\n<!--challenges-end-->`,\n 197| )\n 198| await fs.writeFile(filepath, readme, 'utf-8')\n 199| }\n 200| }\n 201| \n 202| async function updateQuestionsREADME(quizzes: Quiz[]) {\n 203| const questionsDir = path.resolve(__dirname, '../questions')\n 204| \n 205| // update each questions' readme\n 206| for (const quiz of quizzes) {\n 207| for (const locale of supportedLocales) {\n 208| await insertInfoReadme(\n 209| path.join(\n 210| questionsDir,\n 211| quiz.path,\n 212| f('README', locale, 'md'),\n 213| ),\n 214| quiz,\n 215| locale,\n 216| quizzes,\n 217| )\n 218| }\n 219| }\n 220| }\n 221| \n 222| export async function updateREADMEs(type?: 'quiz' | 'index') {\n 223| const quizzes = await loadQuizzes()\n 224| quizzes.sort((a, b) => a.no - b.no)\n 225| \n 226| if (type === 'quiz') {\n 227| await updateQuestionsREADME(quizzes)\n 228| }\n 229| else if (type === 'index') {\n 230| await updateIndexREADME(quizzes)\n 231| }\n 232| else {\n 233| await Promise.all([\n 234| updateIndexREADME(quizzes),\n 235| updateQuestionsREADME(quizzes),\n 236| ])\n 237| }\n 238| }\n 239| \n 240| updateREADMEs(process.argv.slice(2)[0] as any)\n```\n\n### FILE: scripts/toUrl.ts (85 lines)\n\n```\n 1| import lzs from 'lz-string'\n 2| import type { Quiz } from './types'\n 3| import { defaultLocale } from './locales'\n 4| import { resolveInfo } from './loader'\n 5| \n 6| export const REPO = 'https://github.com/type-challenges/type-challenges'\n 7| export const DOMAIN = 'https://tsch.js.org'\n 8| export const TYPESCRIPT_PLAYGROUND = 'https://www.typescriptlang.org/play'\n 9| \n 10| // https://github.com/microsoft/TypeScript-Website/tree/v2/packages/playground\n 11| export function toPlaygroundUrl(\n 12| code: string,\n 13| config: Object = {},\n 14| site = TYPESCRIPT_PLAYGROUND,\n 15| ) {\n 16| return `${site}?${Object.entries(config).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}#code/${lzs.compressToEncodedURIComponent(code)}`\n 17| }\n 18| \n 19| export function toSolutionsFull(no: number) {\n 20| return `${REPO}/issues?q=label%3A${no}+label%3Aanswer+sort%3Areactions-%2B1-desc`\n 21| }\n 22| \n 23| export function toQuizREADME(quiz: Quiz, locale?: string, absolute = false) {\n 24| const prefix = absolute ? `${REPO}/blob/main` : '.'\n 25| return locale && locale !== defaultLocale && quiz.readme[locale]\n 26| ? `${prefix}/questions/${quiz.path}/README.${locale}.md`\n 27| : `${prefix}/questions/${quiz.path}/README.md`\n 28| }\n 29| \n 30| export function toRawREADME(quiz: Quiz, locale?: string) {\n 31| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\n 32| // const provider = 'https://raw.githubusercontent.com/type-challenges/type-challenges/main'\n 33| return locale && locale !== defaultLocale && quiz.readme[locale]\n 34| ? `${provider}/questions/${quiz.path}/README.${locale}.md`\n 35| : `${provider}/questions/${quiz.path}/README.md`\n 36| }\n 37| \n 38| export function toQuestionsRawREADME(locale?: string) {\n 39| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\n 40| return locale && locale !== defaultLocale ? `${provider}/README.${locale}.md` : `${provider}/README.md`\n 41| }\n 42| \n 43| export function toNearborREADME(quiz: Quiz, locale?: string) {\n 44| return locale && locale !== defaultLocale && quiz.readme[locale]\n 45| ? `./README.${locale}.md`\n 46| : './README.md'\n 47| }\n 48| \n 49| export function toShareAnswerFull(quiz: Quiz, locale: string = defaultLocale) {\n 50| const info = resolveInfo(quiz, locale)\n 51| if (locale === defaultLocale)\n 52| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=0-answer.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\n 53| else\n 54| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=1-answer.${locale}.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\n 55| }\n 56| \n 57| // Short\n 58| \n 59| export function toReadmeShort(no: number, locale?: string) {\n 60| return locale !== defaultLocale\n 61| ? `${DOMAIN}/${no}/${locale}`\n 62| : `${DOMAIN}/${no}`\n 63| }\n 64| \n 65| export function toSolutionsShort(no: number) {\n 66| return `${DOMAIN}/${no}/solutions`\n 67| }\n 68| \n 69| export function toPlayShort(no: number, locale?: string) {\n 70| return locale !== defaultLocale\n 71| ? `${DOMAIN}/${no}/play/${locale}`\n 72| : `${DOMAIN}/${no}/play`\n 73| }\n 74| \n 75| export function toAnswerShort(no: number, locale?: string) {\n 76| return locale !== defaultLocale\n 77| ? `${DOMAIN}/${no}/answer/${locale}`\n 78| : `${DOMAIN}/${no}/answer`\n 79| }\n 80| \n 81| export function toHomepageShort(locale?: string) {\n 82| return locale !== defaultLocale\n 83| ? `${DOMAIN}/${locale}`\n 84| : `${DOMAIN}`\n 85| }\n```\n\n### FILE: scripts/translate.ts (73 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import { translate } from '@vitalets/google-translate-api'\n 4| import { QUIZ_ROOT, loadQuizByNo, loadQuizzes } from './loader'\n 5| import { resolveFilePath } from './utils/resolve'\n 6| import type { Quiz } from './types'\n 7| import type { SupportedLocale } from './locales'\n 8| import { t } from './locales'\n 9| \n 10| export async function translateQuizByNo(no: number, from: SupportedLocale, to: SupportedLocale) {\n 11| const quiz = await loadQuizByNo(no)\n 12| if (!quiz)\n 13| throw new Error(`Quiz #${no} not founded`)\n 14| return await translateQuiz(quiz, from, to)\n 15| }\n 16| \n 17| export async function translateQuiz(quiz: Quiz, from: SupportedLocale, to: SupportedLocale) {\n 18| let translatedReadme = await translateMarkdown(quiz.readme[from], from, to)\n 19| \n 20| if (!translatedReadme)\n 21| throw new Error(`Quiz #${quiz.no} empty translation`)\n 22| \n 23| translatedReadme = `> ${t(to, 'readme.google-translated')}\\n\\n${translatedReadme.trim()}`\n 24| \n 25| const readmePath = resolveFilePath(path.join(QUIZ_ROOT, quiz.path), 'README', 'md', to)\n 26| await fs.writeFile(readmePath, translatedReadme, 'utf-8')\n 27| \n 28| console.log(`Translated [${quiz.no}] ${from} → ${to} | saved to ${readmePath}`)\n 29| }\n 30| \n 31| export async function translateMarkdown(code: string, from: SupportedLocale, to: SupportedLocale) {\n 32| // to replace the code blocks intro a placeholder then feed it into translator\n 33| // then replace back for the results\n 34| const codeBlocks: string[] = []\n 35| \n 36| const source = code\n 37| .replace(/```[\\s\\S\\n]+?```/g, (v) => {\n 38| const placeholder = `__${codeBlocks.length}__`\n 39| codeBlocks.push(v)\n 40| return placeholder\n 41| })\n 42| .replace(/`[\\s\\S\\n]+?`/g, (v) => {\n 43| const placeholder = `__${codeBlocks.length}__`\n 44| codeBlocks.push(v)\n 45| return placeholder\n 46| })\n 47| \n 48| const { text } = await translate(source, {\n 49| from,\n 50| to,\n 51| })\n 52| \n 53| if (!text)\n 54| return\n 55| \n 56| const result = text.replace(/__\\s*?(\\d+?)\\s*?__/g, (_, i) => codeBlocks[+i])\n 57| \n 58| return result\n 59| }\n 60| \n 61| export async function translateAllQuizzes(from: SupportedLocale, to: SupportedLocale) {\n 62| const quizzes = await loadQuizzes()\n 63| \n 64| for (const quiz of quizzes) {\n 65| if (quiz.readme[to] || !quiz.readme[from]) {\n 66| console.log(`Skipped #${quiz.no}`)\n 67| continue\n 68| }\n 69| \n 70| console.log(`Translating #${quiz.no} to ${to}`)\n 71| await translateQuiz(quiz, from, to)\n 72| }\n 73| }\n```\n\n### FILE: scripts/types.ts (38 lines)\n\n```\n 1| import type { DeepPartial } from 'utility-types'\n 2| import type { context, getOctokit } from '@actions/github'\n 3| import type Core from '@actions/core'\n 4| import type IO from '@actions/io'\n 5| \n 6| export type Github = ReturnType<typeof getOctokit>\n 7| export type Context = typeof context\n 8| export type Action = (github: Github, context: Context, core: typeof Core, io: typeof IO) => Promise<void>\n 9| \n 10| export interface QuizMetaInfo {\n 11| title: string\n 12| author: {\n 13| name: string\n 14| email: string\n 15| github: string\n 16| }\n 17| tsconfig?: Record<string, any>\n 18| original_issues: number[]\n 19| recommended_solutions: number[]\n 20| tags: string[]\n 21| related?: string[]\n 22| }\n 23| \n 24| export type Difficulty = 'warm' | 'easy' | 'medium' | 'hard' | 'extreme' | 'pending'\n 25| \n 26| export interface Quiz {\n 27| no: number\n 28| difficulty: Difficulty\n 29| path: string\n 30| readme: Record<string, string>\n 31| template: string\n 32| info: Record<string, DeepPartial<QuizMetaInfo> | undefined>\n 33| tests?: string\n 34| solutions?: {\n 35| code?: string\n 36| readme?: Record<string, string>\n 37| }\n 38| }\n```\n\n### FILE: utils/index.d.test.ts (35 lines)\n\n```\n 1| import type { Alike, Equal, Expect, ExpectFalse, IsAny, NotEqual } from './index'\n 2| \n 3| type cases = [\n 4| /* Expect */\n 5| Expect<true>,\n 6| // @ts-expect-error\n 7| Expect<false>,\n 8| \n 9| /* ExpectFalse */\n 10| ExpectFalse<false>,\n 11| // @ts-expect-error\n 12| ExpectFalse<true>,\n 13| \n 14| /* Equal */\n 15| Expect<Equal<true, true>>,\n 16| ExpectFalse<Equal<false, true>>,\n 17| Expect<Equal<'123', '123'>>,\n 18| ExpectFalse<Equal<'123', string>>,\n 19| Expect<Equal<{ a: number }, { a: number }>>,\n 20| ExpectFalse<Equal<{ a: number }, { b: number }>>,\n 21| ExpectFalse<Equal<any, '123'>>,\n 22| ExpectFalse<Equal<any, unknown>>,\n 23| \n 24| /* Not Equal */\n 25| Expect<NotEqual<false, true>>,\n 26| ExpectFalse<NotEqual<true, true>>,\n 27| \n 28| /* IsAny */\n 29| Expect<IsAny<any>>,\n 30| ExpectFalse<IsAny<1>>,\n 31| \n 32| /* Alike */\n 33| Expect<Alike<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\n 34| ExpectFalse<Equal<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\n 35| ]\n```\n\n### FILE: utils/index.d.ts (29 lines)\n\n```\n 1| export type Expect<T extends true> = T\n 2| export type ExpectTrue<T extends true> = T\n 3| export type ExpectFalse<T extends false> = T\n 4| export type IsTrue<T extends true> = T\n 5| export type IsFalse<T extends false> = T\n 6| \n 7| export type Equal<X, Y> =\n 8| (<T>() => T extends X ? 1 : 2) extends\n 9| (<T>() => T extends Y ? 1 : 2) ? true : false\n 10| export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true\n 11| \n 12| // https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\n 13| export type IsAny<T> = 0 extends (1 & T) ? true : false\n 14| export type NotAny<T> = true extends IsAny<T> ? false : true\n 15| \n 16| export type Debug<T> = { [K in keyof T]: T[K] }\n 17| export type MergeInsertions<T> =\n 18| T extends object\n 19| ? { [K in keyof T]: MergeInsertions<T[K]> }\n 20| : T\n 21| \n 22| export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>\n 23| \n 24| export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE ? true : false\n 25| export type ExpectValidArgs<FUNC extends (...args: any[]) => any, ARGS extends any[]> = ARGS extends Parameters<FUNC>\n 26| ? true\n 27| : false\n 28| \n 29| export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never\n```\n<END_OF_CONTEXT>\n\n<query>\nGenerate a wiki page tracing the primary data or control flow through this system from entry to exit. Include a Mermaid sequenceDiagram showing the interactions between components.\n</query>"},{"role":"assistant","content":"# Type Challenges System Architecture\n\n## Overview\n\nThe Type Challenges system is a TypeScript challenge platform that provides coding exercises with type-level challenges. The system manages a collection of challenges, each with metadata, documentation, test cases, and template code. It supports multiple languages and provides tooling for building, generating playgrounds, and translating content.\n\nThe core architecture follows a data-driven approach where challenges are loaded from filesystem directories, processed through various utility functions, and then rendered into different formats for web display, local playground generation, and documentation.\n\n## Detailed Analysis\n\n### Data Flow and Structure\n\nThe system's primary data structure is the `Quiz` interface defined in `scripts/types.ts:26-38`. Each quiz represents a challenge with:\n- `no`: Challenge number\n- `difficulty`: Difficulty level (warm, easy, medium, hard, extreme)\n- `path`: Filesystem path to the challenge directory\n- `readme`: Translated README content per locale\n- `template`: Template code for the challenge\n- `info`: Metadata per locale\n- `tests`: Test cases for the challenge\n\nChallenges are loaded from the `questions` directory using `loadQuizzes()` in `scripts/loader.ts:70-81`. This function uses `fast-glob` to find all challenge directories and processes each one through `loadQuiz()` which reads the necessary files including `info.yml`, `README.md`, `template.ts`, and `test-cases.ts`.\n\n### Control Flow Through Build Process\n\nThe build process starts in `scripts/build.ts:8-54`. It:\n1. Loads all quizzes using `loadQuizzes()`\n2. For each quiz, generates multiple URL redirects for different locales and formats\n3. Formats each quiz into code using `formatToCode()` from `scripts/actions/utils/formatToCode.ts:10-26`\n4. Creates playground URLs for each quiz using `toPlaygroundUrl()` from `scripts/toUrl.ts:11-17`\n5. Generates redirect rules for the static site\n\nThe `formatToCode()` function orchestrates the code generation by:\n1. Creating an info header with `toInfoHeader()` from `scripts/actions/utils/toInfoHeader.ts:6-15`\n2. Adding the README content\n3. Including links via `toLinks()` \n4. Adding divider comments\n5. Inserting the template code\n6. Adding test cases\n7. Adding footer comments\n\n### Playground Generation\n\nThe `generate-play.ts` script creates local playground environments. It:\n1. Takes a snapshot of existing playground files to determine what can be safely overridden\n2. Loads quizzes using `loadQuizzes()` from `scripts/loader.ts:145`\n3. For each quiz, formats the code using `formatToCode()` and writes it to the appropriate difficulty directory\n4. Maintains a cache of file hashes to preserve user changes when requested\n\n### Localization and Translation\n\nThe system supports multiple locales through `scripts/locales.ts:1-26`. It uses `loadLocaleVariations()` in `scripts/loader.ts:14-36` to load localized content for each challenge. The `resolveInfo()` function in `scripts/loader.ts:107-117` merges default and locale-specific metadata.\n\nTranslation is handled by `scripts/translate.ts:10-73` which uses Google Translate API to translate README content while preserving code blocks.\n\n### README Generation and Updates\n\nThe `scripts/readme.ts` file handles README generation and updates:\n1. `updateREADMEs()` function updates both index READMEs and individual challenge READMEs\n2. `insertInfoReadme()` modifies challenge READMEs with metadata, badges, and navigation links\n3. `updateIndexREADME()` generates the main index README with categorized challenges\n4. `toBadgeLink()` and related functions create HTML badges for difficulty levels and navigation\n\n## Mermaid Sequence Diagram\n\n```mermaid\nsequenceDiagram\n participant User\n participant BuildScript\n participant Loader\n participant Formatter\n participant URLGenerator\n participant FS as File System\n participant Redirects\n\n User->>BuildScript: Run build process\n BuildScript->>Loader: Load all quizzes\n Loader->>FS: Read challenge directories\n Loader->>Loader: Parse info.yml, README.md, template.ts, test-cases.ts\n Loader-->>BuildScript: Return Quiz[]\n \n BuildScript->>Formatter: Format quiz to code\n Formatter->>Loader: Get localized info\n Formatter->>FS: Read template and test files\n Formatter->>Formatter: Generate code with headers, links, and dividers\n Formatter-->>BuildScript: Return formatted code\n \n BuildScript->>URLGenerator: Generate playground URL\n URLGenerator->>URLGenerator: Compress code with LZ-string\n URLGenerator-->>BuildScript: Return playground URL\n \n BuildScript->>Redirects: Generate redirect rules\n Redirects-->>User: Return redirect configuration\n \n User->>BuildScript: Generate playground\n BuildScript->>Loader: Load quizzes\n BuildScript->>Formatter: Format each quiz\n Formatter->>FS: Write to playground directory\n BuildScript->>FS: Update cache file\n```\n\n## Conclusion\n\nThe Type Challenges system demonstrates a well-structured approach to managing a collection of TypeScript challenges. The architecture separates concerns between data loading (`loader.ts`), formatting (`formatToCode.ts`), URL generation (`toUrl.ts`), and documentation updates (`readme.ts`). The system's modular design allows for easy extension with new locales, challenge types, and generation targets.\n\nThe use of TypeScript's type system throughout the codebase ensures strong type safety for the challenge definitions and metadata, while the build and generation scripts provide a robust pipeline for creating both web-ready content and local development environments. The system's design allows for easy maintenance and expansion, with clear separation between data loading, processing, and output generation phases."}],"string":"[\n {\n \"role\": \"system\",\n \"content\": [\n \"You are an expert software architect writing wiki documentation for codebases.\\nRequirements:\\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\\n4. Explain the WHY behind design decisions, not only the WHAT.\\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\\n7. Example of the correct citation style, inline and attached to a path:\\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon.\"\n ]\n },\n {\n \"role\": \"user\",\n \"content\": \"<START_OF_CONTEXT>\\n# Repository: type-challenges/type-challenges (language: typescript)\\n\\n# Selected files (windows)\\n- eslint.config.js (24 lines)\\n- questions/00002-medium-return-type/test-cases.ts (20 lines)\\n- questions/00003-medium-omit/test-cases.ts (32 lines)\\n- questions/00004-easy-pick/test-cases.ts (23 lines)\\n- questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\\n- questions/00006-hard-simple-vue/test-cases.ts (37 lines)\\n- questions/00008-medium-readonly-2/test-cases.ts (29 lines)\\n- questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\\n- questions/00599-medium-merge/test-cases.ts (18 lines)\\n- scripts/actions/utils/formatToCode.ts (26 lines)\\n- scripts/actions/utils/toInfoHeader.ts (15 lines)\\n- scripts/build.ts (54 lines)\\n- scripts/generate-play.ts (180 lines)\\n- scripts/loader.ts (117 lines)\\n- scripts/locales.ts (26 lines)\\n- scripts/readme.ts (240 lines)\\n- scripts/toUrl.ts (85 lines)\\n- scripts/translate.ts (73 lines)\\n- scripts/types.ts (38 lines)\\n- utils/index.d.test.ts (35 lines)\\n- utils/index.d.ts (29 lines)\\n\\n\\n### FILE: eslint.config.js (24 lines)\\n\\n```\\n 1| const antfu = require('@antfu/eslint-config').default\\n 2| \\n 3| module.exports = antfu(\\n 4| {\\n 5| markdown: false,\\n 6| },\\n 7| {\\n 8| rules: {\\n 9| 'import/first': 'off',\\n 10| 'no-alert': 'off',\\n 11| 'no-unused-expressions': 'off',\\n 12| 'no-unused-vars': 'off',\\n 13| 'no-use-before-define': 'off',\\n 14| 'prefer-const': 'off',\\n 15| 'ts/ban-ts-comment': 'off',\\n 16| 'ts/ban-types': 'off',\\n 17| 'ts/consistent-type-definitions': 'off',\\n 18| 'ts/no-namespace': 'off',\\n 19| 'ts/no-require-imports': 'off',\\n 20| 'ts/no-unused-vars': 'off',\\n 21| 'unused-imports/no-unused-vars': 'off',\\n 22| },\\n 23| },\\n 24| )\\n```\\n\\n### FILE: questions/00002-medium-return-type/test-cases.ts (20 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<string, MyReturnType<() => string>>>,\\n 5| Expect<Equal<123, MyReturnType<() => 123>>>,\\n 6| Expect<Equal<ComplexObject, MyReturnType<() => ComplexObject>>>,\\n 7| Expect<Equal<Promise<boolean>, MyReturnType<() => Promise<boolean>>>>,\\n 8| Expect<Equal<() => 'foo', MyReturnType<() => () => 'foo'>>>,\\n 9| Expect<Equal<1 | 2, MyReturnType<typeof fn>>>,\\n 10| Expect<Equal<1 | 2, MyReturnType<typeof fn1>>>,\\n 11| ]\\n 12| \\n 13| type ComplexObject = {\\n 14| a: [12, 'foo']\\n 15| bar: 'hello'\\n 16| prev(): number\\n 17| }\\n 18| \\n 19| const fn = (v: boolean) => v ? 1 : 2\\n 20| const fn1 = (v: boolean, w: any) => v ? 1 : 2\\n```\\n\\n### FILE: questions/00003-medium-omit/test-cases.ts (32 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<Expected1, MyOmit<Todo, 'description'>>>,\\n 5| Expect<Equal<Expected2, MyOmit<Todo, 'description' | 'completed'>>>,\\n 6| Expect<Equal<Expected3, MyOmit<Todo1, 'description' | 'completed'>>>,\\n 7| ]\\n 8| \\n 9| interface Todo {\\n 10| title: string\\n 11| description: string\\n 12| completed: boolean\\n 13| }\\n 14| \\n 15| interface Todo1 {\\n 16| readonly title: string\\n 17| description: string\\n 18| completed: boolean\\n 19| }\\n 20| \\n 21| interface Expected1 {\\n 22| title: string\\n 23| completed: boolean\\n 24| }\\n 25| \\n 26| interface Expected2 {\\n 27| title: string\\n 28| }\\n 29| \\n 30| interface Expected3 {\\n 31| readonly title: string\\n 32| }\\n```\\n\\n### FILE: questions/00004-easy-pick/test-cases.ts (23 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<Expected1, MyPick<Todo, 'title'>>>,\\n 5| Expect<Equal<Expected2, MyPick<Todo, 'title' | 'completed'>>>,\\n 6| // @ts-expect-error\\n 7| MyPick<Todo, 'title' | 'completed' | 'invalid'>,\\n 8| ]\\n 9| \\n 10| interface Todo {\\n 11| title: string\\n 12| description: string\\n 13| completed: boolean\\n 14| }\\n 15| \\n 16| interface Expected1 {\\n 17| title: string\\n 18| }\\n 19| \\n 20| interface Expected2 {\\n 21| title: string\\n 22| completed: boolean\\n 23| }\\n```\\n\\n### FILE: questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<'title', GetReadonlyKeys<Todo1>>>,\\n 5| Expect<Equal<'title' | 'description', GetReadonlyKeys<Todo2>>>,\\n 6| ]\\n 7| \\n 8| interface Todo1 {\\n 9| readonly title: string\\n 10| description: string\\n 11| completed: boolean\\n 12| }\\n 13| \\n 14| interface Todo2 {\\n 15| readonly title: string\\n 16| readonly description: string\\n 17| completed?: boolean\\n 18| }\\n```\\n\\n### FILE: questions/00006-hard-simple-vue/test-cases.ts (37 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| SimpleVue({\\n 4| data() {\\n 5| // @ts-expect-error\\n 6| this.firstname\\n 7| // @ts-expect-error\\n 8| this.getRandom()\\n 9| // @ts-expect-error\\n 10| this.data()\\n 11| \\n 12| return {\\n 13| firstname: 'Type',\\n 14| lastname: 'Challenges',\\n 15| amount: 10,\\n 16| }\\n 17| },\\n 18| computed: {\\n 19| fullname() {\\n 20| return `${this.firstname} ${this.lastname}`\\n 21| },\\n 22| },\\n 23| methods: {\\n 24| getRandom() {\\n 25| return Math.random()\\n 26| },\\n 27| hi() {\\n 28| alert(this.amount)\\n 29| alert(this.fullname.toLowerCase())\\n 30| alert(this.getRandom())\\n 31| },\\n 32| test() {\\n 33| const fullname = this.fullname\\n 34| const cases: [Expect<Equal<typeof fullname, string>>] = [] as any\\n 35| },\\n 36| },\\n 37| })\\n```\\n\\n### FILE: questions/00008-medium-readonly-2/test-cases.ts (29 lines)\\n\\n```\\n 1| import type { Alike, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Alike<MyReadonly2<Todo1>, Readonly<Todo1>>>,\\n 5| Expect<Alike<MyReadonly2<Todo1, 'title' | 'description'>, Expected>>,\\n 6| Expect<Alike<MyReadonly2<Todo2, 'title' | 'description'>, Expected>>,\\n 7| Expect<Alike<MyReadonly2<Todo2, 'description' >, Expected>>,\\n 8| ]\\n 9| \\n 10| // @ts-expect-error\\n 11| type error = MyReadonly2<Todo1, 'title' | 'invalid'>\\n 12| \\n 13| interface Todo1 {\\n 14| title: string\\n 15| description?: string\\n 16| completed: boolean\\n 17| }\\n 18| \\n 19| interface Todo2 {\\n 20| readonly title: string\\n 21| description?: string\\n 22| completed: boolean\\n 23| }\\n 24| \\n 25| interface Expected {\\n 26| readonly title: string\\n 27| readonly description?: string\\n 28| completed: boolean\\n 29| }\\n```\\n\\n### FILE: questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<DeepReadonly<X1>, Expected1>>,\\n 5| Expect<Equal<DeepReadonly<X2>, Expected2>>,\\n 6| ]\\n 7| \\n 8| type X1 = {\\n 9| a: () => 22\\n 10| b: string\\n 11| c: {\\n 12| d: boolean\\n 13| e: {\\n 14| g: {\\n 15| h: {\\n 16| i: true\\n 17| j: 'string'\\n 18| }\\n 19| k: 'hello'\\n 20| }\\n 21| l: [\\n 22| 'hi',\\n 23| {\\n 24| m: ['hey']\\n 25| },\\n 26| ]\\n 27| }\\n 28| }\\n 29| }\\n 30| \\n 31| type X2 = { a: string } | { b: number }\\n 32| \\n 33| type Expected1 = {\\n 34| readonly a: () => 22\\n 35| readonly b: string\\n 36| readonly c: {\\n 37| readonly d: boolean\\n 38| readonly e: {\\n 39| readonly g: {\\n 40| readonly h: {\\n 41| readonly i: true\\n 42| readonly j: 'string'\\n 43| }\\n 44| readonly k: 'hello'\\n 45| }\\n 46| readonly l: readonly [\\n 47| 'hi',\\n 48| {\\n 49| readonly m: readonly ['hey']\\n 50| },\\n 51| ]\\n 52| }\\n 53| }\\n 54| }\\n 55| \\n 56| type Expected2 = { readonly a: string } | { readonly b: number }\\n```\\n\\n### FILE: questions/00599-medium-merge/test-cases.ts (18 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type Foo = {\\n 4| a: number\\n 5| b: string\\n 6| }\\n 7| type Bar = {\\n 8| b: number\\n 9| c: boolean\\n 10| }\\n 11| \\n 12| type cases = [\\n 13| Expect<Equal<Merge<Foo, Bar>, {\\n 14| a: number\\n 15| b: number\\n 16| c: boolean\\n 17| }>>,\\n 18| ]\\n```\\n\\n### FILE: scripts/actions/utils/formatToCode.ts (26 lines)\\n\\n```\\n 1| import type { Quiz } from '../../types'\\n 2| import type { SupportedLocale } from '../../locales'\\n 3| import { defaultLocale, t } from '../../locales'\\n 4| import { toCommentBlock } from './toCommentBlock'\\n 5| import { toInfoHeader } from './toInfoHeader'\\n 6| import { toLinks } from './toLinks'\\n 7| import { toDivider } from './toDivider'\\n 8| import { toFooter } from './toFooter'\\n 9| \\n 10| export function formatToCode(quiz: Quiz, locale: SupportedLocale) {\\n 11| return `${toCommentBlock(\\n 12| toInfoHeader(quiz, locale)\\n 13| + (quiz.readme[locale] || quiz.readme[defaultLocale])\\n 14| + toLinks(quiz, locale),\\n 15| )\\n 16| + toDivider(t(locale, 'divider.code-start'))\\n 17| }\\\\n${\\n 18| (quiz.template || '').trim()\\n 19| }\\\\n${\\n 20| toDivider(t(locale, 'divider.test-cases'))\\n 21| }${\\n 22| (quiz.tests || '').trim()\\n 23| }\\\\n${\\n 24| toDivider(t(locale, 'divider.further-steps'))\\n 25| }${toCommentBlock(toFooter(quiz, locale))}`\\n 26| }\\n```\\n\\n### FILE: scripts/actions/utils/toInfoHeader.ts (15 lines)\\n\\n```\\n 1| import type { Quiz } from '../../types'\\n 2| import type { SupportedLocale } from '../../locales'\\n 3| import { t } from '../../locales'\\n 4| import { resolveInfo } from '../../loader'\\n 5| \\n 6| export const toInfoHeader = function toInfoHeader(quiz: Quiz, locale: SupportedLocale) {\\n 7| const info = resolveInfo(quiz, locale)\\n 8| \\n 9| const author = `${info.author?.name} (@${info?.author?.github})`\\n 10| \\n 11| return `${quiz.no} - ${info.title || ''}\\\\n`\\n 12| + '-------\\\\n'\\n 13| + `by ${author} #${t(locale, `difficulty.${quiz.difficulty}`)} ${info?.tags?.map(i => `#${i}`).join(' ') || ''}\\\\n\\\\n`\\n 14| + `### ${t(locale, 'title.question')}\\\\n\\\\n`\\n 15| }\\n```\\n\\n### FILE: scripts/build.ts (54 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import { loadQuizzes, resolveInfo } from './loader'\\n 4| import { REPO, toPlaygroundUrl, toQuestionsRawREADME, toQuizREADME, toRawREADME, toShareAnswerFull, toSolutionsFull } from './toUrl'\\n 5| import { defaultLocale, supportedLocales } from './locales'\\n 6| import { formatToCode } from './actions/utils/formatToCode'\\n 7| \\n 8| export async function build() {\\n 9| const quizzes = await loadQuizzes()\\n 10| const redirects: [string, string, number][] = []\\n 11| \\n 12| // redirect homepage to github repo\\n 13| supportedLocales.filter(locale => locale !== defaultLocale).forEach((locale) => {\\n 14| redirects.push([`/${locale}`, `${REPO}/blob/main/README.${locale}.md`, 302])\\n 15| })\\n 16| \\n 17| supportedLocales.forEach((locale) => {\\n 18| redirects.push([`/raw/${locale}`, toQuestionsRawREADME(locale), 302])\\n 19| })\\n 20| \\n 21| for (const quiz of quizzes) {\\n 22| for (const locale of supportedLocales) {\\n 23| const info = resolveInfo(quiz, locale)\\n 24| \\n 25| const code = formatToCode(quiz, locale)\\n 26| \\n 27| const url = toPlaygroundUrl(code, info.tsconfig || {})\\n 28| \\n 29| if (locale === defaultLocale) {\\n 30| redirects.push([`/${quiz.no}`, toQuizREADME(quiz, locale, true), 302])\\n 31| redirects.push([`/${quiz.no}/raw`, toRawREADME(quiz, locale), 302])\\n 32| redirects.push([`/${quiz.no}/play`, url, 302])\\n 33| redirects.push([`/${quiz.no}/answer`, toShareAnswerFull(quiz), 302])\\n 34| }\\n 35| else {\\n 36| redirects.push([`/${quiz.no}/${locale}`, toQuizREADME(quiz, locale, true), 302])\\n 37| redirects.push([`/${quiz.no}/raw/${locale}`, toRawREADME(quiz, locale), 302])\\n 38| redirects.push([`/${quiz.no}/play/${locale}`, url, 302])\\n 39| redirects.push([`/${quiz.no}/answer/${locale}`, toShareAnswerFull(quiz, locale), 302])\\n 40| }\\n 41| }\\n 42| \\n 43| redirects.push([`/${quiz.no}/solutions`, toSolutionsFull(quiz.no), 302])\\n 44| }\\n 45| \\n 46| const dist = path.resolve(__dirname, 'dist')\\n 47| \\n 48| await fs.remove(dist)\\n 49| await fs.ensureDir(dist)\\n 50| \\n 51| await fs.writeFileSync(path.join(dist, '_redirects'), redirects.map(i => i.join('\\\\t')).join('\\\\n'), 'utf-8')\\n 52| }\\n 53| \\n 54| build()\\n```\\n\\n### FILE: scripts/generate-play.ts (180 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import process from 'node:process'\\n 3| import crypto from 'node:crypto'\\n 4| import fs from 'fs-extra'\\n 5| import c from 'ansis'\\n 6| import prompts from 'prompts'\\n 7| import { formatToCode } from './actions/utils/formatToCode'\\n 8| import { loadQuizzes, resolveInfo } from './loader'\\n 9| import { supportedLocales } from './locales'\\n 10| import { getQuestionFullName } from './actions/issue-pr'\\n 11| import type { QuizMetaInfo } from './types'\\n 12| \\n 13| type Snapshot = Record<string, string>\\n 14| \\n 15| function calculateFileHash(filePathFull: string): Promise<string> {\\n 16| return new Promise((resolve, reject) => {\\n 17| const hash = crypto.createHash('sha1')\\n 18| const fileStream = fs.createReadStream(filePathFull)\\n 19| \\n 20| fileStream.on('data', (data) => {\\n 21| hash.update(data)\\n 22| })\\n 23| \\n 24| fileStream.on('end', () => {\\n 25| hash.update(filePathFull)\\n 26| resolve(hash.digest('hex'))\\n 27| })\\n 28| \\n 29| fileStream.on('error', (err) => {\\n 30| reject(err)\\n 31| })\\n 32| })\\n 33| }\\n 34| \\n 35| async function takeSnapshot(quizzesPath: string) {\\n 36| let snapshot: Snapshot = {}\\n 37| \\n 38| const files = fs.readdirSync(quizzesPath)\\n 39| \\n 40| for (const file of files) {\\n 41| // Might be a file, or a folder\\n 42| const fPath = path.join(quizzesPath, file)\\n 43| const fStats = fs.statSync(fPath)\\n 44| \\n 45| if (fStats.isDirectory()) {\\n 46| snapshot = {\\n 47| ...snapshot,\\n 48| ...(await takeSnapshot(fPath)),\\n 49| }\\n 50| }\\n 51| else {\\n 52| snapshot[file] = await calculateFileHash(fPath)\\n 53| }\\n 54| }\\n 55| \\n 56| return snapshot\\n 57| }\\n 58| \\n 59| function readPlaygroundCache(playgroundCachePath: string): Snapshot {\\n 60| if (!fs.existsSync(playgroundCachePath))\\n 61| return {}\\n 62| \\n 63| try {\\n 64| const rawCacheContent = fs.readFileSync(playgroundCachePath)\\n 65| return JSON.parse(rawCacheContent.toString())\\n 66| }\\n 67| catch (err) {\\n 68| console.log(c.red('Playground cache corrupted. '\\n 69| + 'Cannot generate playground without keeping your changes intact'))\\n 70| console.log(c.cyan('Please ensure you have run this: \\\"pnpm generate\\\"'))\\n 71| process.exit(1)\\n 72| }\\n 73| }\\n 74| \\n 75| function calculateOverridableFiles(cache: Snapshot, snapshot: Snapshot) {\\n 76| const result: Snapshot = {}\\n 77| \\n 78| for (const quizName in snapshot) {\\n 79| if (snapshot[quizName] === cache[quizName])\\n 80| result[quizName] = snapshot[quizName]\\n 81| }\\n 82| \\n 83| return result\\n 84| }\\n 85| \\n 86| function isQuizWritable(quizFileName: string, overridableFiles: Snapshot, playgroundSnapshot: Snapshot): boolean {\\n 87| return !!(\\n 88| overridableFiles[quizFileName]\\n 89| || (!overridableFiles[quizFileName] && !playgroundSnapshot[quizFileName])\\n 90| )\\n 91| }\\n 92| \\n 93| async function generatePlayground() {\\n 94| const playgroundPath = path.join(__dirname, '../playground')\\n 95| const playgroundCachePath = path.join(__dirname, '../.playgroundcache')\\n 96| \\n 97| let locale = supportedLocales.find(locale => locale === process.argv[2])!\\n 98| \\n 99| console.log(c.bold.cyan('Generating local playground...\\\\n'))\\n 100| \\n 101| let overridableFiles: Snapshot\\n 102| let keepChanges = false\\n 103| const currentPlaygroundCache = readPlaygroundCache(playgroundCachePath)\\n 104| let playgroundSnapshot: Snapshot\\n 105| \\n 106| if (process.argv.length === 3 && (process.argv[2] === '--keep-changes' || process.argv[2] === '-K')) {\\n 107| console.log(c.bold.cyan('We will keep your changes while generating.\\\\n'))\\n 108| keepChanges = true\\n 109| \\n 110| playgroundSnapshot = await takeSnapshot(playgroundPath)\\n 111| \\n 112| overridableFiles = calculateOverridableFiles(currentPlaygroundCache, playgroundSnapshot)\\n 113| }\\n 114| else if (fs.existsSync(playgroundPath)) {\\n 115| const result = await prompts([{\\n 116| name: 'confirm',\\n 117| type: 'confirm',\\n 118| initial: false,\\n 119| message: 'The playground directory already exists, it may contains the answers you did. Do you want to override it?',\\n 120| }])\\n 121| if (!result?.confirm)\\n 122| return console.log(c.yellow('Skipped.'))\\n 123| }\\n 124| \\n 125| if (!locale) {\\n 126| const result = await prompts([{\\n 127| name: 'locale',\\n 128| type: 'select',\\n 129| message: 'Select language:',\\n 130| choices: supportedLocales.map(i => ({\\n 131| title: i,\\n 132| value: i,\\n 133| })),\\n 134| }])\\n 135| if (!result)\\n 136| return console.log(c.yellow('Skipped.'))\\n 137| locale = result.locale\\n 138| }\\n 139| \\n 140| if (!keepChanges) {\\n 141| await fs.remove(playgroundPath)\\n 142| await fs.ensureDir(playgroundPath)\\n 143| }\\n 144| \\n 145| const quizzes = await loadQuizzes()\\n 146| const incomingQuizzesCache: Snapshot = {}\\n 147| \\n 148| for (const quiz of quizzes) {\\n 149| const { difficulty, title } = resolveInfo(quiz, locale) as QuizMetaInfo & { difficulty: string }\\n 150| const code = formatToCode(quiz, locale)\\n 151| \\n 152| if (difficulty === undefined || title === undefined) {\\n 153| console.log(c.yellow`${quiz.no} has no ${locale.toUpperCase()} version. Skipping`)\\n 154| continue\\n 155| }\\n 156| \\n 157| const quizzesPathByDifficulty = path.join(playgroundPath, difficulty)\\n 158| \\n 159| const quizFileName = `${getQuestionFullName(quiz.no, difficulty, title)}.ts`\\n 160| const quizPathFull = path.join(quizzesPathByDifficulty, quizFileName)\\n 161| \\n 162| if (!keepChanges || (keepChanges && isQuizWritable(quizFileName, overridableFiles!, playgroundSnapshot!))) {\\n 163| if (!fs.existsSync(quizzesPathByDifficulty))\\n 164| fs.mkdirSync(quizzesPathByDifficulty)\\n 165| await fs.writeFile(quizPathFull, code, 'utf-8')\\n 166| incomingQuizzesCache[quizFileName] = await calculateFileHash(quizPathFull)\\n 167| }\\n 168| }\\n 169| \\n 170| fs.writeFile(playgroundCachePath, JSON.stringify({\\n 171| ...currentPlaygroundCache,\\n 172| ...incomingQuizzesCache,\\n 173| }))\\n 174| \\n 175| console.log()\\n 176| console.log(c.bold.green('Local playground generated at: ') + c.dim(playgroundPath))\\n 177| console.log()\\n 178| }\\n 179| \\n 180| generatePlayground()\\n```\\n\\n### FILE: scripts/loader.ts (117 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import fg from 'fast-glob'\\n 4| import YAML from 'js-yaml'\\n 5| import type { Quiz, QuizMetaInfo } from './types'\\n 6| import { defaultLocale, supportedLocales } from './locales'\\n 7| \\n 8| export async function loadFile(filepath: string) {\\n 9| if (fs.existsSync(filepath))\\n 10| return await fs.readFile(filepath, 'utf-8')\\n 11| return undefined\\n 12| }\\n 13| \\n 14| export async function loadLocaleVariations<T = string>(\\n 15| filepath: string,\\n 16| preprocessor: (s: string) => T = s => s as any as T,\\n 17| ) {\\n 18| const { ext, dir, name } = path.parse(filepath)\\n 19| const data: Record<string, T> = {}\\n 20| \\n 21| for (const locale of supportedLocales) {\\n 22| const file = preprocessor(await loadFile(path.join(dir, `${name}.${locale}${ext}`)) || '')\\n 23| \\n 24| if (file)\\n 25| data[locale] = file\\n 26| }\\n 27| \\n 28| if (!data[defaultLocale]) {\\n 29| // default version\\n 30| const file = preprocessor(await loadFile(filepath) || '')\\n 31| if (file)\\n 32| data[defaultLocale] = file\\n 33| }\\n 34| \\n 35| return data\\n 36| }\\n 37| \\n 38| export function readmeCleanUp(text: string) {\\n 39| return text\\n 40| .replace(/<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/, '')\\n 41| .replace(/<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/, '')\\n 42| .trim()\\n 43| }\\n 44| \\n 45| export function loadInfo(s: string): Partial<QuizMetaInfo> | undefined {\\n 46| const object = YAML.load(s) as any\\n 47| if (!object)\\n 48| return undefined\\n 49| \\n 50| const arrayKeys = ['tags', 'related']\\n 51| \\n 52| for (const key of arrayKeys) {\\n 53| if (object[key]) {\\n 54| object[key] = (object[key] || '')\\n 55| .toString()\\n 56| .split(',')\\n 57| .map((i: string) => i.trim())\\n 58| .filter(Boolean)\\n 59| }\\n 60| else {\\n 61| object[key] = undefined\\n 62| }\\n 63| }\\n 64| \\n 65| return object\\n 66| }\\n 67| \\n 68| export const QUIZ_ROOT = path.resolve(__dirname, '../questions')\\n 69| \\n 70| export async function loadQuizzes(): Promise<Quiz[]> {\\n 71| const folders = await fg('{0..9}*-*', {\\n 72| onlyDirectories: true,\\n 73| cwd: QUIZ_ROOT,\\n 74| })\\n 75| \\n 76| const quizzes = await Promise.all(\\n 77| folders.map(async dir => loadQuiz(dir)),\\n 78| )\\n 79| \\n 80| return quizzes\\n 81| }\\n 82| \\n 83| export async function loadQuiz(dir: string): Promise<Quiz> {\\n 84| return {\\n 85| no: Number(dir.replace(/^(\\\\d+)-.*/, '$1')),\\n 86| difficulty: dir.replace(/^\\\\d+-(.+?)-.*$/, '$1') as any,\\n 87| path: dir,\\n 88| info: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'info.yml'), loadInfo),\\n 89| readme: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'README.md'), readmeCleanUp),\\n 90| template: await loadFile(path.join(QUIZ_ROOT, dir, 'template.ts')) || '',\\n 91| tests: await loadFile(path.join(QUIZ_ROOT, dir, 'test-cases.ts')),\\n 92| }\\n 93| }\\n 94| \\n 95| export async function loadQuizByNo(no: number | string) {\\n 96| const folders = await fg(`${no}-*`, {\\n 97| onlyDirectories: true,\\n 98| cwd: QUIZ_ROOT,\\n 99| })\\n 100| \\n 101| if (folders.length)\\n 102| return await loadQuiz(folders[0])\\n 103| \\n 104| return undefined\\n 105| }\\n 106| \\n 107| export function resolveInfo(quiz: Quiz, locale: string = defaultLocale) {\\n 108| const info = { ...quiz.info[defaultLocale], ...quiz.info[locale] }\\n 109| info.tags = quiz.info[locale]?.tags || quiz.info[defaultLocale]?.tags || []\\n 110| info.related = quiz.info[locale]?.related || quiz.info[defaultLocale]?.related || []\\n 111| \\n 112| if (typeof info.tags === 'string')\\n 113| // @ts-expect-error\\n 114| info.tags = info.tags.split(',').map(i => i.trim()).filter(Boolean)\\n 115| \\n 116| return info as QuizMetaInfo\\n 117| }\\n```\\n\\n### FILE: scripts/locales.ts (26 lines)\\n\\n```\\n 1| export const defaultLocale = 'en'\\n 2| \\n 3| export const supportedLocales = ['en', 'zh-CN', 'ja', 'ko', 'pt-BR'] as const\\n 4| \\n 5| export const messages = {\\n 6| 'en': require('./locales/en.json'),\\n 7| 'zh-CN': require('./locales/zh-CN.json'),\\n 8| 'ja': require('./locales/ja.json'),\\n 9| 'ko': require('./locales/ko.json'),\\n 10| 'pt-BR': require('./locales/pt-BR.json'),\\n 11| }\\n 12| \\n 13| export type SupportedLocale = keyof typeof messages\\n 14| \\n 15| export function t(locale: SupportedLocale, key: string): string {\\n 16| const result = (messages[locale] && messages[locale][key]) || messages[defaultLocale][key]\\n 17| if (!result)\\n 18| throw new Error(`Missing message for key \\\"${key}\\\"`)\\n 19| return result\\n 20| }\\n 21| \\n 22| export function f(name: string, locale: string, ext: string) {\\n 23| if (locale === defaultLocale)\\n 24| return `${name}.${ext}`\\n 25| return `${name}.${locale}.${ext}`\\n 26| }\\n```\\n\\n### FILE: scripts/readme.ts (240 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import process from 'node:process'\\n 3| import fs from 'fs-extra'\\n 4| import type { SupportedLocale } from './locales'\\n 5| import { defaultLocale, f, supportedLocales, t } from './locales'\\n 6| import { loadQuizzes, resolveInfo } from './loader'\\n 7| import { toAnswerShort, toNearborREADME, toPlayShort, toQuizREADME, toSolutionsShort } from './toUrl'\\n 8| import type { Quiz, QuizMetaInfo } from './types'\\n 9| \\n 10| const DifficultyColors: Record<string, string> = {\\n 11| warm: 'teal',\\n 12| easy: '7aad0c',\\n 13| medium: 'd9901a',\\n 14| hard: 'de3d37',\\n 15| extreme: 'b11b8d',\\n 16| }\\n 17| \\n 18| const DifficultyRank = [\\n 19| 'warm',\\n 20| 'easy',\\n 21| 'medium',\\n 22| 'hard',\\n 23| 'extreme',\\n 24| ]\\n 25| \\n 26| function escapeHtml(unsafe: string) {\\n 27| return unsafe\\n 28| .replace(/&/g, '&')\\n 29| .replace(/</g, '<')\\n 30| .replace(/>/g, '>')\\n 31| .replace(/\\\"/g, '"')\\n 32| .replace(/'/g, ''')\\n 33| }\\n 34| \\n 35| function toBadgeURL(label: string, text: string, color: string, args = '') {\\n 36| return `https://img.shields.io/badge/${encodeURIComponent(label.replace(/-/g, '--'))}-${encodeURIComponent(text.replace(/-/g, '--'))}-${color}${args}`\\n 37| }\\n 38| \\n 39| function toBadge(label: string, text: string, color: string, args = '') {\\n 40| return `<img src=\\\"${toBadgeURL(label, text, color, args)}\\\" alt=\\\"${text}\\\"/>`\\n 41| }\\n 42| \\n 43| export function toBadgeLink(url: string, label: string, text: string, color: string, args = '') {\\n 44| return `<a href=\\\"${url}\\\" target=\\\"_blank\\\">${toBadge(label, text, color, args)}</a> `\\n 45| }\\n 46| \\n 47| export function toPlanTextLink(url: string, _label: string, text: string, _color: string, _args = '') {\\n 48| return `<a href=\\\"${url}\\\" target=\\\"_blank\\\">${text}</a> `\\n 49| }\\n 50| \\n 51| function toAuthorInfo(author: Partial<QuizMetaInfo['author']> = {}) {\\n 52| return `by ${author.name}${author.github ? ` <a href=\\\"https://github.com/${author.github}\\\" target=\\\"_blank\\\">@${author.github}</a>` : ''}`\\n 53| }\\n 54| \\n 55| function toDifficultyBadge(difficulty: string, locale: SupportedLocale) {\\n 56| return toBadge('', t(locale, `difficulty.${difficulty}`), DifficultyColors[difficulty])\\n 57| }\\n 58| \\n 59| function toDifficultyBadgeInverted(difficulty: string, locale: SupportedLocale, count: number) {\\n 60| return toBadge(t(locale, `difficulty.${difficulty}`), count.toString(), DifficultyColors[difficulty])\\n 61| }\\n 62| \\n 63| function toDifficultyPlainText(difficulty: string, locale: SupportedLocale, count: number) {\\n 64| return `${t(locale, `difficulty.${difficulty}`)} (${count.toString()})`\\n 65| }\\n 66| \\n 67| function toDetailsInnerText(text: string, locale: SupportedLocale) {\\n 68| return `${t(locale, `details.${text}`)}`\\n 69| }\\n 70| \\n 71| function quizToBadge(quiz: Quiz, locale: string, absolute = false, badge = true) {\\n 72| const fn = badge ? toBadgeLink : toPlanTextLink\\n 73| return fn(\\n 74| toQuizREADME(quiz, locale, absolute),\\n 75| '',\\n 76| `${quiz.no}・${quiz.info[locale]?.title || quiz.info[defaultLocale]?.title}`,\\n 77| DifficultyColors[quiz.difficulty],\\n 78| )\\n 79| }\\n 80| \\n 81| function quizNoToBadges(ids: (string | number)[], quizzes: Quiz[], locale: string, absolute = false) {\\n 82| return ids\\n 83| .map(i => quizzes.find(q => q.no === Number(i)))\\n 84| .filter(Boolean)\\n 85| .map(i => quizToBadge(i!, locale, absolute))\\n 86| .join(' ')\\n 87| }\\n 88| \\n 89| function getAllTags(quizzes: Quiz[], locale: string) {\\n 90| const set = new Set<string>()\\n 91| for (const quiz of quizzes) {\\n 92| const info = resolveInfo(quiz, locale)\\n 93| for (const tag of (info?.tags || []))\\n 94| set.add(tag)\\n 95| }\\n 96| return Array.from(set).sort()\\n 97| }\\n 98| \\n 99| function getQuizzesByTag(quizzes: Quiz[], locale: string, tag: string) {\\n 100| return quizzes.filter((quiz) => {\\n 101| const info = resolveInfo(quiz, locale)\\n 102| return !!info.tags?.includes(tag)\\n 103| })\\n 104| }\\n 105| \\n 106| async function insertInfoReadme(filepath: string, quiz: Quiz, locale: SupportedLocale, quizzes: Quiz[]) {\\n 107| if (!fs.existsSync(filepath))\\n 108| return\\n 109| let text = await fs.readFile(filepath, 'utf-8')\\n 110| /* eslint-disable prefer-template */\\n 111| \\n 112| if (!text.match(/<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/))\\n 113| text = `<!--info-header-start--><!--info-header-end-->\\\\n\\\\n${text}`\\n 114| if (!text.match(/<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/))\\n 115| text = `${text}\\\\n\\\\n<!--info-footer-start--><!--info-footer-end-->`\\n 116| \\n 117| const info = resolveInfo(quiz, locale)\\n 118| \\n 119| const availableLocales = supportedLocales.filter(l => l !== locale).filter(l => !!quiz.readme[l])\\n 120| \\n 121| text = text\\n 122| .replace(\\n 123| /<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/,\\n 124| '<!--info-header-start-->'\\n 125| + `<h1>${escapeHtml(info.title || '')} ${toDifficultyBadge(quiz.difficulty, locale)} ${(info.tags || []).map(i => toBadge('', `#${i}`, '999')).join(' ')}</h1>`\\n 126| + `<blockquote><p>${toAuthorInfo(info.author)}</p></blockquote>`\\n 127| + '<p>'\\n 128| + toBadgeLink(toPlayShort(quiz.no, locale), '', t(locale, 'badge.take-the-challenge'), '3178c6', '?logo=typescript&logoColor=white')\\n 129| + (availableLocales.length ? (' ' + availableLocales.map(l => toBadgeLink(toNearborREADME(quiz, l), '', t(l, 'display'), 'gray')).join(' ')) : '')\\n 130| + '</p>'\\n 131| + '<!--info-header-end-->',\\n 132| )\\n 133| .replace(\\n 134| /<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/,\\n 135| '<!--info-footer-start--><br>'\\n 136| + toBadgeLink(`../../${f('README', locale, 'md')}`, '', t(locale, 'badge.back'), 'grey')\\n 137| + toBadgeLink(toAnswerShort(quiz.no, locale), '', t(locale, 'badge.share-your-solutions'), 'teal')\\n 138| + toBadgeLink(toSolutionsShort(quiz.no), '', t(locale, 'badge.checkout-solutions'), 'de5a77', '?logo=awesome-lists&logoColor=white')\\n 139| + (Array.isArray(info.related) && info.related.length ? `<hr><h3>${t(locale, 'readme.related-challenges')}</h3>${quizNoToBadges(info.related, quizzes, locale, true)}` : '')\\n 140| + '<!--info-footer-end-->',\\n 141| )\\n 142| \\n 143| /* eslint-enable prefer-template */\\n 144| \\n 145| await fs.writeFile(filepath, text, 'utf-8')\\n 146| }\\n 147| \\n 148| async function updateIndexREADME(quizzes: Quiz[]) {\\n 149| // update index README\\n 150| for (const locale of supportedLocales) {\\n 151| const filepath = path.resolve(__dirname, '..', f('README', locale, 'md'))\\n 152| \\n 153| let challengesREADME = ''\\n 154| let prev = ''\\n 155| \\n 156| // difficulty\\n 157| const quizzesByDifficulty = [...quizzes].sort((a, b) => DifficultyRank.indexOf(a.difficulty) - DifficultyRank.indexOf(b.difficulty))\\n 158| \\n 159| for (const quiz of quizzesByDifficulty) {\\n 160| if (prev !== quiz.difficulty)\\n 161| challengesREADME += `${prev ? '<br><br>' : ''}${toDifficultyBadgeInverted(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}<br>`\\n 162| \\n 163| challengesREADME += quizToBadge(quiz, locale)\\n 164| \\n 165| prev = quiz.difficulty\\n 166| }\\n 167| \\n 168| // by tags\\n 169| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-tags', locale)}</summary><br><table><tbody>`\\n 170| const tags = getAllTags(quizzes, locale)\\n 171| for (const tag of tags) {\\n 172| challengesREADME += `<tr><td>${toBadge('', `#${tag}`, '999')}</td><td>`\\n 173| getQuizzesByTag(quizzesByDifficulty, locale, tag)\\n 174| .forEach((quiz) => {\\n 175| challengesREADME += quizToBadge(quiz, locale)\\n 176| })\\n 177| challengesREADME += '</td></tr>'\\n 178| }\\n 179| challengesREADME += '<tr><td><code> </code></td><td></td></tr>'\\n 180| challengesREADME += '</tbody></table></details>'\\n 181| \\n 182| // by plain text\\n 183| prev = ''\\n 184| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-plain-text', locale)}</summary><br>`\\n 185| for (const quiz of quizzesByDifficulty) {\\n 186| if (prev !== quiz.difficulty)\\n 187| challengesREADME += `${prev ? '</ul>' : ''}<h3>${toDifficultyPlainText(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}</h3><ul>`\\n 188| challengesREADME += `<li>${quizToBadge(quiz, locale, false, false)}</li>`\\n 189| prev = quiz.difficulty\\n 190| }\\n 191| challengesREADME += '</ul></details><br>'\\n 192| \\n 193| let readme = await fs.readFile(filepath, 'utf-8')\\n 194| readme = readme.replace(\\n 195| /<!--challenges-start-->[\\\\s\\\\S]*<!--challenges-end-->/m,\\n 196| `<!--challenges-start-->\\\\n${challengesREADME}\\\\n<!--challenges-end-->`,\\n 197| )\\n 198| await fs.writeFile(filepath, readme, 'utf-8')\\n 199| }\\n 200| }\\n 201| \\n 202| async function updateQuestionsREADME(quizzes: Quiz[]) {\\n 203| const questionsDir = path.resolve(__dirname, '../questions')\\n 204| \\n 205| // update each questions' readme\\n 206| for (const quiz of quizzes) {\\n 207| for (const locale of supportedLocales) {\\n 208| await insertInfoReadme(\\n 209| path.join(\\n 210| questionsDir,\\n 211| quiz.path,\\n 212| f('README', locale, 'md'),\\n 213| ),\\n 214| quiz,\\n 215| locale,\\n 216| quizzes,\\n 217| )\\n 218| }\\n 219| }\\n 220| }\\n 221| \\n 222| export async function updateREADMEs(type?: 'quiz' | 'index') {\\n 223| const quizzes = await loadQuizzes()\\n 224| quizzes.sort((a, b) => a.no - b.no)\\n 225| \\n 226| if (type === 'quiz') {\\n 227| await updateQuestionsREADME(quizzes)\\n 228| }\\n 229| else if (type === 'index') {\\n 230| await updateIndexREADME(quizzes)\\n 231| }\\n 232| else {\\n 233| await Promise.all([\\n 234| updateIndexREADME(quizzes),\\n 235| updateQuestionsREADME(quizzes),\\n 236| ])\\n 237| }\\n 238| }\\n 239| \\n 240| updateREADMEs(process.argv.slice(2)[0] as any)\\n```\\n\\n### FILE: scripts/toUrl.ts (85 lines)\\n\\n```\\n 1| import lzs from 'lz-string'\\n 2| import type { Quiz } from './types'\\n 3| import { defaultLocale } from './locales'\\n 4| import { resolveInfo } from './loader'\\n 5| \\n 6| export const REPO = 'https://github.com/type-challenges/type-challenges'\\n 7| export const DOMAIN = 'https://tsch.js.org'\\n 8| export const TYPESCRIPT_PLAYGROUND = 'https://www.typescriptlang.org/play'\\n 9| \\n 10| // https://github.com/microsoft/TypeScript-Website/tree/v2/packages/playground\\n 11| export function toPlaygroundUrl(\\n 12| code: string,\\n 13| config: Object = {},\\n 14| site = TYPESCRIPT_PLAYGROUND,\\n 15| ) {\\n 16| return `${site}?${Object.entries(config).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}#code/${lzs.compressToEncodedURIComponent(code)}`\\n 17| }\\n 18| \\n 19| export function toSolutionsFull(no: number) {\\n 20| return `${REPO}/issues?q=label%3A${no}+label%3Aanswer+sort%3Areactions-%2B1-desc`\\n 21| }\\n 22| \\n 23| export function toQuizREADME(quiz: Quiz, locale?: string, absolute = false) {\\n 24| const prefix = absolute ? `${REPO}/blob/main` : '.'\\n 25| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 26| ? `${prefix}/questions/${quiz.path}/README.${locale}.md`\\n 27| : `${prefix}/questions/${quiz.path}/README.md`\\n 28| }\\n 29| \\n 30| export function toRawREADME(quiz: Quiz, locale?: string) {\\n 31| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\\n 32| // const provider = 'https://raw.githubusercontent.com/type-challenges/type-challenges/main'\\n 33| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 34| ? `${provider}/questions/${quiz.path}/README.${locale}.md`\\n 35| : `${provider}/questions/${quiz.path}/README.md`\\n 36| }\\n 37| \\n 38| export function toQuestionsRawREADME(locale?: string) {\\n 39| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\\n 40| return locale && locale !== defaultLocale ? `${provider}/README.${locale}.md` : `${provider}/README.md`\\n 41| }\\n 42| \\n 43| export function toNearborREADME(quiz: Quiz, locale?: string) {\\n 44| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 45| ? `./README.${locale}.md`\\n 46| : './README.md'\\n 47| }\\n 48| \\n 49| export function toShareAnswerFull(quiz: Quiz, locale: string = defaultLocale) {\\n 50| const info = resolveInfo(quiz, locale)\\n 51| if (locale === defaultLocale)\\n 52| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=0-answer.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\\n 53| else\\n 54| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=1-answer.${locale}.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\\n 55| }\\n 56| \\n 57| // Short\\n 58| \\n 59| export function toReadmeShort(no: number, locale?: string) {\\n 60| return locale !== defaultLocale\\n 61| ? `${DOMAIN}/${no}/${locale}`\\n 62| : `${DOMAIN}/${no}`\\n 63| }\\n 64| \\n 65| export function toSolutionsShort(no: number) {\\n 66| return `${DOMAIN}/${no}/solutions`\\n 67| }\\n 68| \\n 69| export function toPlayShort(no: number, locale?: string) {\\n 70| return locale !== defaultLocale\\n 71| ? `${DOMAIN}/${no}/play/${locale}`\\n 72| : `${DOMAIN}/${no}/play`\\n 73| }\\n 74| \\n 75| export function toAnswerShort(no: number, locale?: string) {\\n 76| return locale !== defaultLocale\\n 77| ? `${DOMAIN}/${no}/answer/${locale}`\\n 78| : `${DOMAIN}/${no}/answer`\\n 79| }\\n 80| \\n 81| export function toHomepageShort(locale?: string) {\\n 82| return locale !== defaultLocale\\n 83| ? `${DOMAIN}/${locale}`\\n 84| : `${DOMAIN}`\\n 85| }\\n```\\n\\n### FILE: scripts/translate.ts (73 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import { translate } from '@vitalets/google-translate-api'\\n 4| import { QUIZ_ROOT, loadQuizByNo, loadQuizzes } from './loader'\\n 5| import { resolveFilePath } from './utils/resolve'\\n 6| import type { Quiz } from './types'\\n 7| import type { SupportedLocale } from './locales'\\n 8| import { t } from './locales'\\n 9| \\n 10| export async function translateQuizByNo(no: number, from: SupportedLocale, to: SupportedLocale) {\\n 11| const quiz = await loadQuizByNo(no)\\n 12| if (!quiz)\\n 13| throw new Error(`Quiz #${no} not founded`)\\n 14| return await translateQuiz(quiz, from, to)\\n 15| }\\n 16| \\n 17| export async function translateQuiz(quiz: Quiz, from: SupportedLocale, to: SupportedLocale) {\\n 18| let translatedReadme = await translateMarkdown(quiz.readme[from], from, to)\\n 19| \\n 20| if (!translatedReadme)\\n 21| throw new Error(`Quiz #${quiz.no} empty translation`)\\n 22| \\n 23| translatedReadme = `> ${t(to, 'readme.google-translated')}\\\\n\\\\n${translatedReadme.trim()}`\\n 24| \\n 25| const readmePath = resolveFilePath(path.join(QUIZ_ROOT, quiz.path), 'README', 'md', to)\\n 26| await fs.writeFile(readmePath, translatedReadme, 'utf-8')\\n 27| \\n 28| console.log(`Translated [${quiz.no}] ${from} → ${to} | saved to ${readmePath}`)\\n 29| }\\n 30| \\n 31| export async function translateMarkdown(code: string, from: SupportedLocale, to: SupportedLocale) {\\n 32| // to replace the code blocks intro a placeholder then feed it into translator\\n 33| // then replace back for the results\\n 34| const codeBlocks: string[] = []\\n 35| \\n 36| const source = code\\n 37| .replace(/```[\\\\s\\\\S\\\\n]+?```/g, (v) => {\\n 38| const placeholder = `__${codeBlocks.length}__`\\n 39| codeBlocks.push(v)\\n 40| return placeholder\\n 41| })\\n 42| .replace(/`[\\\\s\\\\S\\\\n]+?`/g, (v) => {\\n 43| const placeholder = `__${codeBlocks.length}__`\\n 44| codeBlocks.push(v)\\n 45| return placeholder\\n 46| })\\n 47| \\n 48| const { text } = await translate(source, {\\n 49| from,\\n 50| to,\\n 51| })\\n 52| \\n 53| if (!text)\\n 54| return\\n 55| \\n 56| const result = text.replace(/__\\\\s*?(\\\\d+?)\\\\s*?__/g, (_, i) => codeBlocks[+i])\\n 57| \\n 58| return result\\n 59| }\\n 60| \\n 61| export async function translateAllQuizzes(from: SupportedLocale, to: SupportedLocale) {\\n 62| const quizzes = await loadQuizzes()\\n 63| \\n 64| for (const quiz of quizzes) {\\n 65| if (quiz.readme[to] || !quiz.readme[from]) {\\n 66| console.log(`Skipped #${quiz.no}`)\\n 67| continue\\n 68| }\\n 69| \\n 70| console.log(`Translating #${quiz.no} to ${to}`)\\n 71| await translateQuiz(quiz, from, to)\\n 72| }\\n 73| }\\n```\\n\\n### FILE: scripts/types.ts (38 lines)\\n\\n```\\n 1| import type { DeepPartial } from 'utility-types'\\n 2| import type { context, getOctokit } from '@actions/github'\\n 3| import type Core from '@actions/core'\\n 4| import type IO from '@actions/io'\\n 5| \\n 6| export type Github = ReturnType<typeof getOctokit>\\n 7| export type Context = typeof context\\n 8| export type Action = (github: Github, context: Context, core: typeof Core, io: typeof IO) => Promise<void>\\n 9| \\n 10| export interface QuizMetaInfo {\\n 11| title: string\\n 12| author: {\\n 13| name: string\\n 14| email: string\\n 15| github: string\\n 16| }\\n 17| tsconfig?: Record<string, any>\\n 18| original_issues: number[]\\n 19| recommended_solutions: number[]\\n 20| tags: string[]\\n 21| related?: string[]\\n 22| }\\n 23| \\n 24| export type Difficulty = 'warm' | 'easy' | 'medium' | 'hard' | 'extreme' | 'pending'\\n 25| \\n 26| export interface Quiz {\\n 27| no: number\\n 28| difficulty: Difficulty\\n 29| path: string\\n 30| readme: Record<string, string>\\n 31| template: string\\n 32| info: Record<string, DeepPartial<QuizMetaInfo> | undefined>\\n 33| tests?: string\\n 34| solutions?: {\\n 35| code?: string\\n 36| readme?: Record<string, string>\\n 37| }\\n 38| }\\n```\\n\\n### FILE: utils/index.d.test.ts (35 lines)\\n\\n```\\n 1| import type { Alike, Equal, Expect, ExpectFalse, IsAny, NotEqual } from './index'\\n 2| \\n 3| type cases = [\\n 4| /* Expect */\\n 5| Expect<true>,\\n 6| // @ts-expect-error\\n 7| Expect<false>,\\n 8| \\n 9| /* ExpectFalse */\\n 10| ExpectFalse<false>,\\n 11| // @ts-expect-error\\n 12| ExpectFalse<true>,\\n 13| \\n 14| /* Equal */\\n 15| Expect<Equal<true, true>>,\\n 16| ExpectFalse<Equal<false, true>>,\\n 17| Expect<Equal<'123', '123'>>,\\n 18| ExpectFalse<Equal<'123', string>>,\\n 19| Expect<Equal<{ a: number }, { a: number }>>,\\n 20| ExpectFalse<Equal<{ a: number }, { b: number }>>,\\n 21| ExpectFalse<Equal<any, '123'>>,\\n 22| ExpectFalse<Equal<any, unknown>>,\\n 23| \\n 24| /* Not Equal */\\n 25| Expect<NotEqual<false, true>>,\\n 26| ExpectFalse<NotEqual<true, true>>,\\n 27| \\n 28| /* IsAny */\\n 29| Expect<IsAny<any>>,\\n 30| ExpectFalse<IsAny<1>>,\\n 31| \\n 32| /* Alike */\\n 33| Expect<Alike<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\\n 34| ExpectFalse<Equal<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\\n 35| ]\\n```\\n\\n### FILE: utils/index.d.ts (29 lines)\\n\\n```\\n 1| export type Expect<T extends true> = T\\n 2| export type ExpectTrue<T extends true> = T\\n 3| export type ExpectFalse<T extends false> = T\\n 4| export type IsTrue<T extends true> = T\\n 5| export type IsFalse<T extends false> = T\\n 6| \\n 7| export type Equal<X, Y> =\\n 8| (<T>() => T extends X ? 1 : 2) extends\\n 9| (<T>() => T extends Y ? 1 : 2) ? true : false\\n 10| export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true\\n 11| \\n 12| // https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\\n 13| export type IsAny<T> = 0 extends (1 & T) ? true : false\\n 14| export type NotAny<T> = true extends IsAny<T> ? false : true\\n 15| \\n 16| export type Debug<T> = { [K in keyof T]: T[K] }\\n 17| export type MergeInsertions<T> =\\n 18| T extends object\\n 19| ? { [K in keyof T]: MergeInsertions<T[K]> }\\n 20| : T\\n 21| \\n 22| export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>\\n 23| \\n 24| export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE ? true : false\\n 25| export type ExpectValidArgs<FUNC extends (...args: any[]) => any, ARGS extends any[]> = ARGS extends Parameters<FUNC>\\n 26| ? true\\n 27| : false\\n 28| \\n 29| export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never\\n```\\n<END_OF_CONTEXT>\\n\\n<query>\\nGenerate a wiki page tracing the primary data or control flow through this system from entry to exit. Include a Mermaid sequenceDiagram showing the interactions between components.\\n</query>\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"# Type Challenges System Architecture\\n\\n## Overview\\n\\nThe Type Challenges system is a TypeScript challenge platform that provides coding exercises with type-level challenges. The system manages a collection of challenges, each with metadata, documentation, test cases, and template code. It supports multiple languages and provides tooling for building, generating playgrounds, and translating content.\\n\\nThe core architecture follows a data-driven approach where challenges are loaded from filesystem directories, processed through various utility functions, and then rendered into different formats for web display, local playground generation, and documentation.\\n\\n## Detailed Analysis\\n\\n### Data Flow and Structure\\n\\nThe system's primary data structure is the `Quiz` interface defined in `scripts/types.ts:26-38`. Each quiz represents a challenge with:\\n- `no`: Challenge number\\n- `difficulty`: Difficulty level (warm, easy, medium, hard, extreme)\\n- `path`: Filesystem path to the challenge directory\\n- `readme`: Translated README content per locale\\n- `template`: Template code for the challenge\\n- `info`: Metadata per locale\\n- `tests`: Test cases for the challenge\\n\\nChallenges are loaded from the `questions` directory using `loadQuizzes()` in `scripts/loader.ts:70-81`. This function uses `fast-glob` to find all challenge directories and processes each one through `loadQuiz()` which reads the necessary files including `info.yml`, `README.md`, `template.ts`, and `test-cases.ts`.\\n\\n### Control Flow Through Build Process\\n\\nThe build process starts in `scripts/build.ts:8-54`. It:\\n1. Loads all quizzes using `loadQuizzes()`\\n2. For each quiz, generates multiple URL redirects for different locales and formats\\n3. Formats each quiz into code using `formatToCode()` from `scripts/actions/utils/formatToCode.ts:10-26`\\n4. Creates playground URLs for each quiz using `toPlaygroundUrl()` from `scripts/toUrl.ts:11-17`\\n5. Generates redirect rules for the static site\\n\\nThe `formatToCode()` function orchestrates the code generation by:\\n1. Creating an info header with `toInfoHeader()` from `scripts/actions/utils/toInfoHeader.ts:6-15`\\n2. Adding the README content\\n3. Including links via `toLinks()` \\n4. Adding divider comments\\n5. Inserting the template code\\n6. Adding test cases\\n7. Adding footer comments\\n\\n### Playground Generation\\n\\nThe `generate-play.ts` script creates local playground environments. It:\\n1. Takes a snapshot of existing playground files to determine what can be safely overridden\\n2. Loads quizzes using `loadQuizzes()` from `scripts/loader.ts:145`\\n3. For each quiz, formats the code using `formatToCode()` and writes it to the appropriate difficulty directory\\n4. Maintains a cache of file hashes to preserve user changes when requested\\n\\n### Localization and Translation\\n\\nThe system supports multiple locales through `scripts/locales.ts:1-26`. It uses `loadLocaleVariations()` in `scripts/loader.ts:14-36` to load localized content for each challenge. The `resolveInfo()` function in `scripts/loader.ts:107-117` merges default and locale-specific metadata.\\n\\nTranslation is handled by `scripts/translate.ts:10-73` which uses Google Translate API to translate README content while preserving code blocks.\\n\\n### README Generation and Updates\\n\\nThe `scripts/readme.ts` file handles README generation and updates:\\n1. `updateREADMEs()` function updates both index READMEs and individual challenge READMEs\\n2. `insertInfoReadme()` modifies challenge READMEs with metadata, badges, and navigation links\\n3. `updateIndexREADME()` generates the main index README with categorized challenges\\n4. `toBadgeLink()` and related functions create HTML badges for difficulty levels and navigation\\n\\n## Mermaid Sequence Diagram\\n\\n```mermaid\\nsequenceDiagram\\n participant User\\n participant BuildScript\\n participant Loader\\n participant Formatter\\n participant URLGenerator\\n participant FS as File System\\n participant Redirects\\n\\n User->>BuildScript: Run build process\\n BuildScript->>Loader: Load all quizzes\\n Loader->>FS: Read challenge directories\\n Loader->>Loader: Parse info.yml, README.md, template.ts, test-cases.ts\\n Loader-->>BuildScript: Return Quiz[]\\n \\n BuildScript->>Formatter: Format quiz to code\\n Formatter->>Loader: Get localized info\\n Formatter->>FS: Read template and test files\\n Formatter->>Formatter: Generate code with headers, links, and dividers\\n Formatter-->>BuildScript: Return formatted code\\n \\n BuildScript->>URLGenerator: Generate playground URL\\n URLGenerator->>URLGenerator: Compress code with LZ-string\\n URLGenerator-->>BuildScript: Return playground URL\\n \\n BuildScript->>Redirects: Generate redirect rules\\n Redirects-->>User: Return redirect configuration\\n \\n User->>BuildScript: Generate playground\\n BuildScript->>Loader: Load quizzes\\n BuildScript->>Formatter: Format each quiz\\n Formatter->>FS: Write to playground directory\\n BuildScript->>FS: Update cache file\\n```\\n\\n## Conclusion\\n\\nThe Type Challenges system demonstrates a well-structured approach to managing a collection of TypeScript challenges. The architecture separates concerns between data loading (`loader.ts`), formatting (`formatToCode.ts`), URL generation (`toUrl.ts`), and documentation updates (`readme.ts`). The system's modular design allows for easy extension with new locales, challenge types, and generation targets.\\n\\nThe use of TypeScript's type system throughout the codebase ensures strong type safety for the challenge definitions and metadata, while the build and generation scripts provide a robust pipeline for creating both web-ready content and local development environments. The system's design allows for easy maintenance and expansion, with clear separation between data loading, processing, and output generation phases.\"\n }\n]","isConversational":true},"source":{"kind":"string","value":"type-challenges/type-challenges"},"category":{"kind":"string","value":"data_flow"},"quality_score":{"kind":"number","value":91,"string":"91"},"citation_stats":{"kind":"string","value":"{\n \"total_citations\": 11,\n \"validity_rate\": 0.909,\n \"invalid\": [\n {\n \"file\": \"scripts/loader.ts\",\n \"start\": 145,\n \"end\": 145,\n \"error\": \"line-out-of-bounds(117)\"\n }\n ]\n}"},"license":{"kind":"string","value":"MIT"},"language":{"kind":"string","value":"typescript"}}},{"rowIdx":99,"cells":{"messages":{"kind":"list like","value":[{"role":"system","content":["You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\n4. Explain the WHY behind design decisions, not only the WHAT.\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\n7. Example of the correct citation style, inline and attached to a path:\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon."]},{"role":"user","content":"<START_OF_CONTEXT>\n# Repository: type-challenges/type-challenges (language: typescript)\n\n# Selected files (windows)\n- eslint.config.js (24 lines)\n- questions/00002-medium-return-type/test-cases.ts (20 lines)\n- questions/00003-medium-omit/test-cases.ts (32 lines)\n- questions/00004-easy-pick/test-cases.ts (23 lines)\n- questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\n- questions/00006-hard-simple-vue/test-cases.ts (37 lines)\n- questions/00008-medium-readonly-2/test-cases.ts (29 lines)\n- questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\n- questions/00599-medium-merge/test-cases.ts (18 lines)\n- scripts/actions/utils/formatToCode.ts (26 lines)\n- scripts/actions/utils/toInfoHeader.ts (15 lines)\n- scripts/build.ts (54 lines)\n- scripts/generate-play.ts (180 lines)\n- scripts/loader.ts (117 lines)\n- scripts/locales.ts (26 lines)\n- scripts/readme.ts (240 lines)\n- scripts/toUrl.ts (85 lines)\n- scripts/translate.ts (73 lines)\n- scripts/types.ts (38 lines)\n- utils/index.d.test.ts (35 lines)\n- utils/index.d.ts (29 lines)\n\n\n### FILE: eslint.config.js (24 lines)\n\n```\n 1| const antfu = require('@antfu/eslint-config').default\n 2| \n 3| module.exports = antfu(\n 4| {\n 5| markdown: false,\n 6| },\n 7| {\n 8| rules: {\n 9| 'import/first': 'off',\n 10| 'no-alert': 'off',\n 11| 'no-unused-expressions': 'off',\n 12| 'no-unused-vars': 'off',\n 13| 'no-use-before-define': 'off',\n 14| 'prefer-const': 'off',\n 15| 'ts/ban-ts-comment': 'off',\n 16| 'ts/ban-types': 'off',\n 17| 'ts/consistent-type-definitions': 'off',\n 18| 'ts/no-namespace': 'off',\n 19| 'ts/no-require-imports': 'off',\n 20| 'ts/no-unused-vars': 'off',\n 21| 'unused-imports/no-unused-vars': 'off',\n 22| },\n 23| },\n 24| )\n```\n\n### FILE: questions/00002-medium-return-type/test-cases.ts (20 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<string, MyReturnType<() => string>>>,\n 5| Expect<Equal<123, MyReturnType<() => 123>>>,\n 6| Expect<Equal<ComplexObject, MyReturnType<() => ComplexObject>>>,\n 7| Expect<Equal<Promise<boolean>, MyReturnType<() => Promise<boolean>>>>,\n 8| Expect<Equal<() => 'foo', MyReturnType<() => () => 'foo'>>>,\n 9| Expect<Equal<1 | 2, MyReturnType<typeof fn>>>,\n 10| Expect<Equal<1 | 2, MyReturnType<typeof fn1>>>,\n 11| ]\n 12| \n 13| type ComplexObject = {\n 14| a: [12, 'foo']\n 15| bar: 'hello'\n 16| prev(): number\n 17| }\n 18| \n 19| const fn = (v: boolean) => v ? 1 : 2\n 20| const fn1 = (v: boolean, w: any) => v ? 1 : 2\n```\n\n### FILE: questions/00003-medium-omit/test-cases.ts (32 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<Expected1, MyOmit<Todo, 'description'>>>,\n 5| Expect<Equal<Expected2, MyOmit<Todo, 'description' | 'completed'>>>,\n 6| Expect<Equal<Expected3, MyOmit<Todo1, 'description' | 'completed'>>>,\n 7| ]\n 8| \n 9| interface Todo {\n 10| title: string\n 11| description: string\n 12| completed: boolean\n 13| }\n 14| \n 15| interface Todo1 {\n 16| readonly title: string\n 17| description: string\n 18| completed: boolean\n 19| }\n 20| \n 21| interface Expected1 {\n 22| title: string\n 23| completed: boolean\n 24| }\n 25| \n 26| interface Expected2 {\n 27| title: string\n 28| }\n 29| \n 30| interface Expected3 {\n 31| readonly title: string\n 32| }\n```\n\n### FILE: questions/00004-easy-pick/test-cases.ts (23 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<Expected1, MyPick<Todo, 'title'>>>,\n 5| Expect<Equal<Expected2, MyPick<Todo, 'title' | 'completed'>>>,\n 6| // @ts-expect-error\n 7| MyPick<Todo, 'title' | 'completed' | 'invalid'>,\n 8| ]\n 9| \n 10| interface Todo {\n 11| title: string\n 12| description: string\n 13| completed: boolean\n 14| }\n 15| \n 16| interface Expected1 {\n 17| title: string\n 18| }\n 19| \n 20| interface Expected2 {\n 21| title: string\n 22| completed: boolean\n 23| }\n```\n\n### FILE: questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<'title', GetReadonlyKeys<Todo1>>>,\n 5| Expect<Equal<'title' | 'description', GetReadonlyKeys<Todo2>>>,\n 6| ]\n 7| \n 8| interface Todo1 {\n 9| readonly title: string\n 10| description: string\n 11| completed: boolean\n 12| }\n 13| \n 14| interface Todo2 {\n 15| readonly title: string\n 16| readonly description: string\n 17| completed?: boolean\n 18| }\n```\n\n### FILE: questions/00006-hard-simple-vue/test-cases.ts (37 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| SimpleVue({\n 4| data() {\n 5| // @ts-expect-error\n 6| this.firstname\n 7| // @ts-expect-error\n 8| this.getRandom()\n 9| // @ts-expect-error\n 10| this.data()\n 11| \n 12| return {\n 13| firstname: 'Type',\n 14| lastname: 'Challenges',\n 15| amount: 10,\n 16| }\n 17| },\n 18| computed: {\n 19| fullname() {\n 20| return `${this.firstname} ${this.lastname}`\n 21| },\n 22| },\n 23| methods: {\n 24| getRandom() {\n 25| return Math.random()\n 26| },\n 27| hi() {\n 28| alert(this.amount)\n 29| alert(this.fullname.toLowerCase())\n 30| alert(this.getRandom())\n 31| },\n 32| test() {\n 33| const fullname = this.fullname\n 34| const cases: [Expect<Equal<typeof fullname, string>>] = [] as any\n 35| },\n 36| },\n 37| })\n```\n\n### FILE: questions/00008-medium-readonly-2/test-cases.ts (29 lines)\n\n```\n 1| import type { Alike, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Alike<MyReadonly2<Todo1>, Readonly<Todo1>>>,\n 5| Expect<Alike<MyReadonly2<Todo1, 'title' | 'description'>, Expected>>,\n 6| Expect<Alike<MyReadonly2<Todo2, 'title' | 'description'>, Expected>>,\n 7| Expect<Alike<MyReadonly2<Todo2, 'description' >, Expected>>,\n 8| ]\n 9| \n 10| // @ts-expect-error\n 11| type error = MyReadonly2<Todo1, 'title' | 'invalid'>\n 12| \n 13| interface Todo1 {\n 14| title: string\n 15| description?: string\n 16| completed: boolean\n 17| }\n 18| \n 19| interface Todo2 {\n 20| readonly title: string\n 21| description?: string\n 22| completed: boolean\n 23| }\n 24| \n 25| interface Expected {\n 26| readonly title: string\n 27| readonly description?: string\n 28| completed: boolean\n 29| }\n```\n\n### FILE: questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type cases = [\n 4| Expect<Equal<DeepReadonly<X1>, Expected1>>,\n 5| Expect<Equal<DeepReadonly<X2>, Expected2>>,\n 6| ]\n 7| \n 8| type X1 = {\n 9| a: () => 22\n 10| b: string\n 11| c: {\n 12| d: boolean\n 13| e: {\n 14| g: {\n 15| h: {\n 16| i: true\n 17| j: 'string'\n 18| }\n 19| k: 'hello'\n 20| }\n 21| l: [\n 22| 'hi',\n 23| {\n 24| m: ['hey']\n 25| },\n 26| ]\n 27| }\n 28| }\n 29| }\n 30| \n 31| type X2 = { a: string } | { b: number }\n 32| \n 33| type Expected1 = {\n 34| readonly a: () => 22\n 35| readonly b: string\n 36| readonly c: {\n 37| readonly d: boolean\n 38| readonly e: {\n 39| readonly g: {\n 40| readonly h: {\n 41| readonly i: true\n 42| readonly j: 'string'\n 43| }\n 44| readonly k: 'hello'\n 45| }\n 46| readonly l: readonly [\n 47| 'hi',\n 48| {\n 49| readonly m: readonly ['hey']\n 50| },\n 51| ]\n 52| }\n 53| }\n 54| }\n 55| \n 56| type Expected2 = { readonly a: string } | { readonly b: number }\n```\n\n### FILE: questions/00599-medium-merge/test-cases.ts (18 lines)\n\n```\n 1| import type { Equal, Expect } from '@type-challenges/utils'\n 2| \n 3| type Foo = {\n 4| a: number\n 5| b: string\n 6| }\n 7| type Bar = {\n 8| b: number\n 9| c: boolean\n 10| }\n 11| \n 12| type cases = [\n 13| Expect<Equal<Merge<Foo, Bar>, {\n 14| a: number\n 15| b: number\n 16| c: boolean\n 17| }>>,\n 18| ]\n```\n\n### FILE: scripts/actions/utils/formatToCode.ts (26 lines)\n\n```\n 1| import type { Quiz } from '../../types'\n 2| import type { SupportedLocale } from '../../locales'\n 3| import { defaultLocale, t } from '../../locales'\n 4| import { toCommentBlock } from './toCommentBlock'\n 5| import { toInfoHeader } from './toInfoHeader'\n 6| import { toLinks } from './toLinks'\n 7| import { toDivider } from './toDivider'\n 8| import { toFooter } from './toFooter'\n 9| \n 10| export function formatToCode(quiz: Quiz, locale: SupportedLocale) {\n 11| return `${toCommentBlock(\n 12| toInfoHeader(quiz, locale)\n 13| + (quiz.readme[locale] || quiz.readme[defaultLocale])\n 14| + toLinks(quiz, locale),\n 15| )\n 16| + toDivider(t(locale, 'divider.code-start'))\n 17| }\\n${\n 18| (quiz.template || '').trim()\n 19| }\\n${\n 20| toDivider(t(locale, 'divider.test-cases'))\n 21| }${\n 22| (quiz.tests || '').trim()\n 23| }\\n${\n 24| toDivider(t(locale, 'divider.further-steps'))\n 25| }${toCommentBlock(toFooter(quiz, locale))}`\n 26| }\n```\n\n### FILE: scripts/actions/utils/toInfoHeader.ts (15 lines)\n\n```\n 1| import type { Quiz } from '../../types'\n 2| import type { SupportedLocale } from '../../locales'\n 3| import { t } from '../../locales'\n 4| import { resolveInfo } from '../../loader'\n 5| \n 6| export const toInfoHeader = function toInfoHeader(quiz: Quiz, locale: SupportedLocale) {\n 7| const info = resolveInfo(quiz, locale)\n 8| \n 9| const author = `${info.author?.name} (@${info?.author?.github})`\n 10| \n 11| return `${quiz.no} - ${info.title || ''}\\n`\n 12| + '-------\\n'\n 13| + `by ${author} #${t(locale, `difficulty.${quiz.difficulty}`)} ${info?.tags?.map(i => `#${i}`).join(' ') || ''}\\n\\n`\n 14| + `### ${t(locale, 'title.question')}\\n\\n`\n 15| }\n```\n\n### FILE: scripts/build.ts (54 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import { loadQuizzes, resolveInfo } from './loader'\n 4| import { REPO, toPlaygroundUrl, toQuestionsRawREADME, toQuizREADME, toRawREADME, toShareAnswerFull, toSolutionsFull } from './toUrl'\n 5| import { defaultLocale, supportedLocales } from './locales'\n 6| import { formatToCode } from './actions/utils/formatToCode'\n 7| \n 8| export async function build() {\n 9| const quizzes = await loadQuizzes()\n 10| const redirects: [string, string, number][] = []\n 11| \n 12| // redirect homepage to github repo\n 13| supportedLocales.filter(locale => locale !== defaultLocale).forEach((locale) => {\n 14| redirects.push([`/${locale}`, `${REPO}/blob/main/README.${locale}.md`, 302])\n 15| })\n 16| \n 17| supportedLocales.forEach((locale) => {\n 18| redirects.push([`/raw/${locale}`, toQuestionsRawREADME(locale), 302])\n 19| })\n 20| \n 21| for (const quiz of quizzes) {\n 22| for (const locale of supportedLocales) {\n 23| const info = resolveInfo(quiz, locale)\n 24| \n 25| const code = formatToCode(quiz, locale)\n 26| \n 27| const url = toPlaygroundUrl(code, info.tsconfig || {})\n 28| \n 29| if (locale === defaultLocale) {\n 30| redirects.push([`/${quiz.no}`, toQuizREADME(quiz, locale, true), 302])\n 31| redirects.push([`/${quiz.no}/raw`, toRawREADME(quiz, locale), 302])\n 32| redirects.push([`/${quiz.no}/play`, url, 302])\n 33| redirects.push([`/${quiz.no}/answer`, toShareAnswerFull(quiz), 302])\n 34| }\n 35| else {\n 36| redirects.push([`/${quiz.no}/${locale}`, toQuizREADME(quiz, locale, true), 302])\n 37| redirects.push([`/${quiz.no}/raw/${locale}`, toRawREADME(quiz, locale), 302])\n 38| redirects.push([`/${quiz.no}/play/${locale}`, url, 302])\n 39| redirects.push([`/${quiz.no}/answer/${locale}`, toShareAnswerFull(quiz, locale), 302])\n 40| }\n 41| }\n 42| \n 43| redirects.push([`/${quiz.no}/solutions`, toSolutionsFull(quiz.no), 302])\n 44| }\n 45| \n 46| const dist = path.resolve(__dirname, 'dist')\n 47| \n 48| await fs.remove(dist)\n 49| await fs.ensureDir(dist)\n 50| \n 51| await fs.writeFileSync(path.join(dist, '_redirects'), redirects.map(i => i.join('\\t')).join('\\n'), 'utf-8')\n 52| }\n 53| \n 54| build()\n```\n\n### FILE: scripts/generate-play.ts (180 lines)\n\n```\n 1| import path from 'node:path'\n 2| import process from 'node:process'\n 3| import crypto from 'node:crypto'\n 4| import fs from 'fs-extra'\n 5| import c from 'ansis'\n 6| import prompts from 'prompts'\n 7| import { formatToCode } from './actions/utils/formatToCode'\n 8| import { loadQuizzes, resolveInfo } from './loader'\n 9| import { supportedLocales } from './locales'\n 10| import { getQuestionFullName } from './actions/issue-pr'\n 11| import type { QuizMetaInfo } from './types'\n 12| \n 13| type Snapshot = Record<string, string>\n 14| \n 15| function calculateFileHash(filePathFull: string): Promise<string> {\n 16| return new Promise((resolve, reject) => {\n 17| const hash = crypto.createHash('sha1')\n 18| const fileStream = fs.createReadStream(filePathFull)\n 19| \n 20| fileStream.on('data', (data) => {\n 21| hash.update(data)\n 22| })\n 23| \n 24| fileStream.on('end', () => {\n 25| hash.update(filePathFull)\n 26| resolve(hash.digest('hex'))\n 27| })\n 28| \n 29| fileStream.on('error', (err) => {\n 30| reject(err)\n 31| })\n 32| })\n 33| }\n 34| \n 35| async function takeSnapshot(quizzesPath: string) {\n 36| let snapshot: Snapshot = {}\n 37| \n 38| const files = fs.readdirSync(quizzesPath)\n 39| \n 40| for (const file of files) {\n 41| // Might be a file, or a folder\n 42| const fPath = path.join(quizzesPath, file)\n 43| const fStats = fs.statSync(fPath)\n 44| \n 45| if (fStats.isDirectory()) {\n 46| snapshot = {\n 47| ...snapshot,\n 48| ...(await takeSnapshot(fPath)),\n 49| }\n 50| }\n 51| else {\n 52| snapshot[file] = await calculateFileHash(fPath)\n 53| }\n 54| }\n 55| \n 56| return snapshot\n 57| }\n 58| \n 59| function readPlaygroundCache(playgroundCachePath: string): Snapshot {\n 60| if (!fs.existsSync(playgroundCachePath))\n 61| return {}\n 62| \n 63| try {\n 64| const rawCacheContent = fs.readFileSync(playgroundCachePath)\n 65| return JSON.parse(rawCacheContent.toString())\n 66| }\n 67| catch (err) {\n 68| console.log(c.red('Playground cache corrupted. '\n 69| + 'Cannot generate playground without keeping your changes intact'))\n 70| console.log(c.cyan('Please ensure you have run this: \"pnpm generate\"'))\n 71| process.exit(1)\n 72| }\n 73| }\n 74| \n 75| function calculateOverridableFiles(cache: Snapshot, snapshot: Snapshot) {\n 76| const result: Snapshot = {}\n 77| \n 78| for (const quizName in snapshot) {\n 79| if (snapshot[quizName] === cache[quizName])\n 80| result[quizName] = snapshot[quizName]\n 81| }\n 82| \n 83| return result\n 84| }\n 85| \n 86| function isQuizWritable(quizFileName: string, overridableFiles: Snapshot, playgroundSnapshot: Snapshot): boolean {\n 87| return !!(\n 88| overridableFiles[quizFileName]\n 89| || (!overridableFiles[quizFileName] && !playgroundSnapshot[quizFileName])\n 90| )\n 91| }\n 92| \n 93| async function generatePlayground() {\n 94| const playgroundPath = path.join(__dirname, '../playground')\n 95| const playgroundCachePath = path.join(__dirname, '../.playgroundcache')\n 96| \n 97| let locale = supportedLocales.find(locale => locale === process.argv[2])!\n 98| \n 99| console.log(c.bold.cyan('Generating local playground...\\n'))\n 100| \n 101| let overridableFiles: Snapshot\n 102| let keepChanges = false\n 103| const currentPlaygroundCache = readPlaygroundCache(playgroundCachePath)\n 104| let playgroundSnapshot: Snapshot\n 105| \n 106| if (process.argv.length === 3 && (process.argv[2] === '--keep-changes' || process.argv[2] === '-K')) {\n 107| console.log(c.bold.cyan('We will keep your changes while generating.\\n'))\n 108| keepChanges = true\n 109| \n 110| playgroundSnapshot = await takeSnapshot(playgroundPath)\n 111| \n 112| overridableFiles = calculateOverridableFiles(currentPlaygroundCache, playgroundSnapshot)\n 113| }\n 114| else if (fs.existsSync(playgroundPath)) {\n 115| const result = await prompts([{\n 116| name: 'confirm',\n 117| type: 'confirm',\n 118| initial: false,\n 119| message: 'The playground directory already exists, it may contains the answers you did. Do you want to override it?',\n 120| }])\n 121| if (!result?.confirm)\n 122| return console.log(c.yellow('Skipped.'))\n 123| }\n 124| \n 125| if (!locale) {\n 126| const result = await prompts([{\n 127| name: 'locale',\n 128| type: 'select',\n 129| message: 'Select language:',\n 130| choices: supportedLocales.map(i => ({\n 131| title: i,\n 132| value: i,\n 133| })),\n 134| }])\n 135| if (!result)\n 136| return console.log(c.yellow('Skipped.'))\n 137| locale = result.locale\n 138| }\n 139| \n 140| if (!keepChanges) {\n 141| await fs.remove(playgroundPath)\n 142| await fs.ensureDir(playgroundPath)\n 143| }\n 144| \n 145| const quizzes = await loadQuizzes()\n 146| const incomingQuizzesCache: Snapshot = {}\n 147| \n 148| for (const quiz of quizzes) {\n 149| const { difficulty, title } = resolveInfo(quiz, locale) as QuizMetaInfo & { difficulty: string }\n 150| const code = formatToCode(quiz, locale)\n 151| \n 152| if (difficulty === undefined || title === undefined) {\n 153| console.log(c.yellow`${quiz.no} has no ${locale.toUpperCase()} version. Skipping`)\n 154| continue\n 155| }\n 156| \n 157| const quizzesPathByDifficulty = path.join(playgroundPath, difficulty)\n 158| \n 159| const quizFileName = `${getQuestionFullName(quiz.no, difficulty, title)}.ts`\n 160| const quizPathFull = path.join(quizzesPathByDifficulty, quizFileName)\n 161| \n 162| if (!keepChanges || (keepChanges && isQuizWritable(quizFileName, overridableFiles!, playgroundSnapshot!))) {\n 163| if (!fs.existsSync(quizzesPathByDifficulty))\n 164| fs.mkdirSync(quizzesPathByDifficulty)\n 165| await fs.writeFile(quizPathFull, code, 'utf-8')\n 166| incomingQuizzesCache[quizFileName] = await calculateFileHash(quizPathFull)\n 167| }\n 168| }\n 169| \n 170| fs.writeFile(playgroundCachePath, JSON.stringify({\n 171| ...currentPlaygroundCache,\n 172| ...incomingQuizzesCache,\n 173| }))\n 174| \n 175| console.log()\n 176| console.log(c.bold.green('Local playground generated at: ') + c.dim(playgroundPath))\n 177| console.log()\n 178| }\n 179| \n 180| generatePlayground()\n```\n\n### FILE: scripts/loader.ts (117 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import fg from 'fast-glob'\n 4| import YAML from 'js-yaml'\n 5| import type { Quiz, QuizMetaInfo } from './types'\n 6| import { defaultLocale, supportedLocales } from './locales'\n 7| \n 8| export async function loadFile(filepath: string) {\n 9| if (fs.existsSync(filepath))\n 10| return await fs.readFile(filepath, 'utf-8')\n 11| return undefined\n 12| }\n 13| \n 14| export async function loadLocaleVariations<T = string>(\n 15| filepath: string,\n 16| preprocessor: (s: string) => T = s => s as any as T,\n 17| ) {\n 18| const { ext, dir, name } = path.parse(filepath)\n 19| const data: Record<string, T> = {}\n 20| \n 21| for (const locale of supportedLocales) {\n 22| const file = preprocessor(await loadFile(path.join(dir, `${name}.${locale}${ext}`)) || '')\n 23| \n 24| if (file)\n 25| data[locale] = file\n 26| }\n 27| \n 28| if (!data[defaultLocale]) {\n 29| // default version\n 30| const file = preprocessor(await loadFile(filepath) || '')\n 31| if (file)\n 32| data[defaultLocale] = file\n 33| }\n 34| \n 35| return data\n 36| }\n 37| \n 38| export function readmeCleanUp(text: string) {\n 39| return text\n 40| .replace(/<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/, '')\n 41| .replace(/<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/, '')\n 42| .trim()\n 43| }\n 44| \n 45| export function loadInfo(s: string): Partial<QuizMetaInfo> | undefined {\n 46| const object = YAML.load(s) as any\n 47| if (!object)\n 48| return undefined\n 49| \n 50| const arrayKeys = ['tags', 'related']\n 51| \n 52| for (const key of arrayKeys) {\n 53| if (object[key]) {\n 54| object[key] = (object[key] || '')\n 55| .toString()\n 56| .split(',')\n 57| .map((i: string) => i.trim())\n 58| .filter(Boolean)\n 59| }\n 60| else {\n 61| object[key] = undefined\n 62| }\n 63| }\n 64| \n 65| return object\n 66| }\n 67| \n 68| export const QUIZ_ROOT = path.resolve(__dirname, '../questions')\n 69| \n 70| export async function loadQuizzes(): Promise<Quiz[]> {\n 71| const folders = await fg('{0..9}*-*', {\n 72| onlyDirectories: true,\n 73| cwd: QUIZ_ROOT,\n 74| })\n 75| \n 76| const quizzes = await Promise.all(\n 77| folders.map(async dir => loadQuiz(dir)),\n 78| )\n 79| \n 80| return quizzes\n 81| }\n 82| \n 83| export async function loadQuiz(dir: string): Promise<Quiz> {\n 84| return {\n 85| no: Number(dir.replace(/^(\\d+)-.*/, '$1')),\n 86| difficulty: dir.replace(/^\\d+-(.+?)-.*$/, '$1') as any,\n 87| path: dir,\n 88| info: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'info.yml'), loadInfo),\n 89| readme: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'README.md'), readmeCleanUp),\n 90| template: await loadFile(path.join(QUIZ_ROOT, dir, 'template.ts')) || '',\n 91| tests: await loadFile(path.join(QUIZ_ROOT, dir, 'test-cases.ts')),\n 92| }\n 93| }\n 94| \n 95| export async function loadQuizByNo(no: number | string) {\n 96| const folders = await fg(`${no}-*`, {\n 97| onlyDirectories: true,\n 98| cwd: QUIZ_ROOT,\n 99| })\n 100| \n 101| if (folders.length)\n 102| return await loadQuiz(folders[0])\n 103| \n 104| return undefined\n 105| }\n 106| \n 107| export function resolveInfo(quiz: Quiz, locale: string = defaultLocale) {\n 108| const info = { ...quiz.info[defaultLocale], ...quiz.info[locale] }\n 109| info.tags = quiz.info[locale]?.tags || quiz.info[defaultLocale]?.tags || []\n 110| info.related = quiz.info[locale]?.related || quiz.info[defaultLocale]?.related || []\n 111| \n 112| if (typeof info.tags === 'string')\n 113| // @ts-expect-error\n 114| info.tags = info.tags.split(',').map(i => i.trim()).filter(Boolean)\n 115| \n 116| return info as QuizMetaInfo\n 117| }\n```\n\n### FILE: scripts/locales.ts (26 lines)\n\n```\n 1| export const defaultLocale = 'en'\n 2| \n 3| export const supportedLocales = ['en', 'zh-CN', 'ja', 'ko', 'pt-BR'] as const\n 4| \n 5| export const messages = {\n 6| 'en': require('./locales/en.json'),\n 7| 'zh-CN': require('./locales/zh-CN.json'),\n 8| 'ja': require('./locales/ja.json'),\n 9| 'ko': require('./locales/ko.json'),\n 10| 'pt-BR': require('./locales/pt-BR.json'),\n 11| }\n 12| \n 13| export type SupportedLocale = keyof typeof messages\n 14| \n 15| export function t(locale: SupportedLocale, key: string): string {\n 16| const result = (messages[locale] && messages[locale][key]) || messages[defaultLocale][key]\n 17| if (!result)\n 18| throw new Error(`Missing message for key \"${key}\"`)\n 19| return result\n 20| }\n 21| \n 22| export function f(name: string, locale: string, ext: string) {\n 23| if (locale === defaultLocale)\n 24| return `${name}.${ext}`\n 25| return `${name}.${locale}.${ext}`\n 26| }\n```\n\n### FILE: scripts/readme.ts (240 lines)\n\n```\n 1| import path from 'node:path'\n 2| import process from 'node:process'\n 3| import fs from 'fs-extra'\n 4| import type { SupportedLocale } from './locales'\n 5| import { defaultLocale, f, supportedLocales, t } from './locales'\n 6| import { loadQuizzes, resolveInfo } from './loader'\n 7| import { toAnswerShort, toNearborREADME, toPlayShort, toQuizREADME, toSolutionsShort } from './toUrl'\n 8| import type { Quiz, QuizMetaInfo } from './types'\n 9| \n 10| const DifficultyColors: Record<string, string> = {\n 11| warm: 'teal',\n 12| easy: '7aad0c',\n 13| medium: 'd9901a',\n 14| hard: 'de3d37',\n 15| extreme: 'b11b8d',\n 16| }\n 17| \n 18| const DifficultyRank = [\n 19| 'warm',\n 20| 'easy',\n 21| 'medium',\n 22| 'hard',\n 23| 'extreme',\n 24| ]\n 25| \n 26| function escapeHtml(unsafe: string) {\n 27| return unsafe\n 28| .replace(/&/g, '&')\n 29| .replace(/</g, '<')\n 30| .replace(/>/g, '>')\n 31| .replace(/\"/g, '"')\n 32| .replace(/'/g, ''')\n 33| }\n 34| \n 35| function toBadgeURL(label: string, text: string, color: string, args = '') {\n 36| return `https://img.shields.io/badge/${encodeURIComponent(label.replace(/-/g, '--'))}-${encodeURIComponent(text.replace(/-/g, '--'))}-${color}${args}`\n 37| }\n 38| \n 39| function toBadge(label: string, text: string, color: string, args = '') {\n 40| return `<img src=\"${toBadgeURL(label, text, color, args)}\" alt=\"${text}\"/>`\n 41| }\n 42| \n 43| export function toBadgeLink(url: string, label: string, text: string, color: string, args = '') {\n 44| return `<a href=\"${url}\" target=\"_blank\">${toBadge(label, text, color, args)}</a> `\n 45| }\n 46| \n 47| export function toPlanTextLink(url: string, _label: string, text: string, _color: string, _args = '') {\n 48| return `<a href=\"${url}\" target=\"_blank\">${text}</a> `\n 49| }\n 50| \n 51| function toAuthorInfo(author: Partial<QuizMetaInfo['author']> = {}) {\n 52| return `by ${author.name}${author.github ? ` <a href=\"https://github.com/${author.github}\" target=\"_blank\">@${author.github}</a>` : ''}`\n 53| }\n 54| \n 55| function toDifficultyBadge(difficulty: string, locale: SupportedLocale) {\n 56| return toBadge('', t(locale, `difficulty.${difficulty}`), DifficultyColors[difficulty])\n 57| }\n 58| \n 59| function toDifficultyBadgeInverted(difficulty: string, locale: SupportedLocale, count: number) {\n 60| return toBadge(t(locale, `difficulty.${difficulty}`), count.toString(), DifficultyColors[difficulty])\n 61| }\n 62| \n 63| function toDifficultyPlainText(difficulty: string, locale: SupportedLocale, count: number) {\n 64| return `${t(locale, `difficulty.${difficulty}`)} (${count.toString()})`\n 65| }\n 66| \n 67| function toDetailsInnerText(text: string, locale: SupportedLocale) {\n 68| return `${t(locale, `details.${text}`)}`\n 69| }\n 70| \n 71| function quizToBadge(quiz: Quiz, locale: string, absolute = false, badge = true) {\n 72| const fn = badge ? toBadgeLink : toPlanTextLink\n 73| return fn(\n 74| toQuizREADME(quiz, locale, absolute),\n 75| '',\n 76| `${quiz.no}・${quiz.info[locale]?.title || quiz.info[defaultLocale]?.title}`,\n 77| DifficultyColors[quiz.difficulty],\n 78| )\n 79| }\n 80| \n 81| function quizNoToBadges(ids: (string | number)[], quizzes: Quiz[], locale: string, absolute = false) {\n 82| return ids\n 83| .map(i => quizzes.find(q => q.no === Number(i)))\n 84| .filter(Boolean)\n 85| .map(i => quizToBadge(i!, locale, absolute))\n 86| .join(' ')\n 87| }\n 88| \n 89| function getAllTags(quizzes: Quiz[], locale: string) {\n 90| const set = new Set<string>()\n 91| for (const quiz of quizzes) {\n 92| const info = resolveInfo(quiz, locale)\n 93| for (const tag of (info?.tags || []))\n 94| set.add(tag)\n 95| }\n 96| return Array.from(set).sort()\n 97| }\n 98| \n 99| function getQuizzesByTag(quizzes: Quiz[], locale: string, tag: string) {\n 100| return quizzes.filter((quiz) => {\n 101| const info = resolveInfo(quiz, locale)\n 102| return !!info.tags?.includes(tag)\n 103| })\n 104| }\n 105| \n 106| async function insertInfoReadme(filepath: string, quiz: Quiz, locale: SupportedLocale, quizzes: Quiz[]) {\n 107| if (!fs.existsSync(filepath))\n 108| return\n 109| let text = await fs.readFile(filepath, 'utf-8')\n 110| /* eslint-disable prefer-template */\n 111| \n 112| if (!text.match(/<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/))\n 113| text = `<!--info-header-start--><!--info-header-end-->\\n\\n${text}`\n 114| if (!text.match(/<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/))\n 115| text = `${text}\\n\\n<!--info-footer-start--><!--info-footer-end-->`\n 116| \n 117| const info = resolveInfo(quiz, locale)\n 118| \n 119| const availableLocales = supportedLocales.filter(l => l !== locale).filter(l => !!quiz.readme[l])\n 120| \n 121| text = text\n 122| .replace(\n 123| /<!--info-header-start-->[\\s\\S]*<!--info-header-end-->/,\n 124| '<!--info-header-start-->'\n 125| + `<h1>${escapeHtml(info.title || '')} ${toDifficultyBadge(quiz.difficulty, locale)} ${(info.tags || []).map(i => toBadge('', `#${i}`, '999')).join(' ')}</h1>`\n 126| + `<blockquote><p>${toAuthorInfo(info.author)}</p></blockquote>`\n 127| + '<p>'\n 128| + toBadgeLink(toPlayShort(quiz.no, locale), '', t(locale, 'badge.take-the-challenge'), '3178c6', '?logo=typescript&logoColor=white')\n 129| + (availableLocales.length ? (' ' + availableLocales.map(l => toBadgeLink(toNearborREADME(quiz, l), '', t(l, 'display'), 'gray')).join(' ')) : '')\n 130| + '</p>'\n 131| + '<!--info-header-end-->',\n 132| )\n 133| .replace(\n 134| /<!--info-footer-start-->[\\s\\S]*<!--info-footer-end-->/,\n 135| '<!--info-footer-start--><br>'\n 136| + toBadgeLink(`../../${f('README', locale, 'md')}`, '', t(locale, 'badge.back'), 'grey')\n 137| + toBadgeLink(toAnswerShort(quiz.no, locale), '', t(locale, 'badge.share-your-solutions'), 'teal')\n 138| + toBadgeLink(toSolutionsShort(quiz.no), '', t(locale, 'badge.checkout-solutions'), 'de5a77', '?logo=awesome-lists&logoColor=white')\n 139| + (Array.isArray(info.related) && info.related.length ? `<hr><h3>${t(locale, 'readme.related-challenges')}</h3>${quizNoToBadges(info.related, quizzes, locale, true)}` : '')\n 140| + '<!--info-footer-end-->',\n 141| )\n 142| \n 143| /* eslint-enable prefer-template */\n 144| \n 145| await fs.writeFile(filepath, text, 'utf-8')\n 146| }\n 147| \n 148| async function updateIndexREADME(quizzes: Quiz[]) {\n 149| // update index README\n 150| for (const locale of supportedLocales) {\n 151| const filepath = path.resolve(__dirname, '..', f('README', locale, 'md'))\n 152| \n 153| let challengesREADME = ''\n 154| let prev = ''\n 155| \n 156| // difficulty\n 157| const quizzesByDifficulty = [...quizzes].sort((a, b) => DifficultyRank.indexOf(a.difficulty) - DifficultyRank.indexOf(b.difficulty))\n 158| \n 159| for (const quiz of quizzesByDifficulty) {\n 160| if (prev !== quiz.difficulty)\n 161| challengesREADME += `${prev ? '<br><br>' : ''}${toDifficultyBadgeInverted(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}<br>`\n 162| \n 163| challengesREADME += quizToBadge(quiz, locale)\n 164| \n 165| prev = quiz.difficulty\n 166| }\n 167| \n 168| // by tags\n 169| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-tags', locale)}</summary><br><table><tbody>`\n 170| const tags = getAllTags(quizzes, locale)\n 171| for (const tag of tags) {\n 172| challengesREADME += `<tr><td>${toBadge('', `#${tag}`, '999')}</td><td>`\n 173| getQuizzesByTag(quizzesByDifficulty, locale, tag)\n 174| .forEach((quiz) => {\n 175| challengesREADME += quizToBadge(quiz, locale)\n 176| })\n 177| challengesREADME += '</td></tr>'\n 178| }\n 179| challengesREADME += '<tr><td><code> </code></td><td></td></tr>'\n 180| challengesREADME += '</tbody></table></details>'\n 181| \n 182| // by plain text\n 183| prev = ''\n 184| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-plain-text', locale)}</summary><br>`\n 185| for (const quiz of quizzesByDifficulty) {\n 186| if (prev !== quiz.difficulty)\n 187| challengesREADME += `${prev ? '</ul>' : ''}<h3>${toDifficultyPlainText(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}</h3><ul>`\n 188| challengesREADME += `<li>${quizToBadge(quiz, locale, false, false)}</li>`\n 189| prev = quiz.difficulty\n 190| }\n 191| challengesREADME += '</ul></details><br>'\n 192| \n 193| let readme = await fs.readFile(filepath, 'utf-8')\n 194| readme = readme.replace(\n 195| /<!--challenges-start-->[\\s\\S]*<!--challenges-end-->/m,\n 196| `<!--challenges-start-->\\n${challengesREADME}\\n<!--challenges-end-->`,\n 197| )\n 198| await fs.writeFile(filepath, readme, 'utf-8')\n 199| }\n 200| }\n 201| \n 202| async function updateQuestionsREADME(quizzes: Quiz[]) {\n 203| const questionsDir = path.resolve(__dirname, '../questions')\n 204| \n 205| // update each questions' readme\n 206| for (const quiz of quizzes) {\n 207| for (const locale of supportedLocales) {\n 208| await insertInfoReadme(\n 209| path.join(\n 210| questionsDir,\n 211| quiz.path,\n 212| f('README', locale, 'md'),\n 213| ),\n 214| quiz,\n 215| locale,\n 216| quizzes,\n 217| )\n 218| }\n 219| }\n 220| }\n 221| \n 222| export async function updateREADMEs(type?: 'quiz' | 'index') {\n 223| const quizzes = await loadQuizzes()\n 224| quizzes.sort((a, b) => a.no - b.no)\n 225| \n 226| if (type === 'quiz') {\n 227| await updateQuestionsREADME(quizzes)\n 228| }\n 229| else if (type === 'index') {\n 230| await updateIndexREADME(quizzes)\n 231| }\n 232| else {\n 233| await Promise.all([\n 234| updateIndexREADME(quizzes),\n 235| updateQuestionsREADME(quizzes),\n 236| ])\n 237| }\n 238| }\n 239| \n 240| updateREADMEs(process.argv.slice(2)[0] as any)\n```\n\n### FILE: scripts/toUrl.ts (85 lines)\n\n```\n 1| import lzs from 'lz-string'\n 2| import type { Quiz } from './types'\n 3| import { defaultLocale } from './locales'\n 4| import { resolveInfo } from './loader'\n 5| \n 6| export const REPO = 'https://github.com/type-challenges/type-challenges'\n 7| export const DOMAIN = 'https://tsch.js.org'\n 8| export const TYPESCRIPT_PLAYGROUND = 'https://www.typescriptlang.org/play'\n 9| \n 10| // https://github.com/microsoft/TypeScript-Website/tree/v2/packages/playground\n 11| export function toPlaygroundUrl(\n 12| code: string,\n 13| config: Object = {},\n 14| site = TYPESCRIPT_PLAYGROUND,\n 15| ) {\n 16| return `${site}?${Object.entries(config).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}#code/${lzs.compressToEncodedURIComponent(code)}`\n 17| }\n 18| \n 19| export function toSolutionsFull(no: number) {\n 20| return `${REPO}/issues?q=label%3A${no}+label%3Aanswer+sort%3Areactions-%2B1-desc`\n 21| }\n 22| \n 23| export function toQuizREADME(quiz: Quiz, locale?: string, absolute = false) {\n 24| const prefix = absolute ? `${REPO}/blob/main` : '.'\n 25| return locale && locale !== defaultLocale && quiz.readme[locale]\n 26| ? `${prefix}/questions/${quiz.path}/README.${locale}.md`\n 27| : `${prefix}/questions/${quiz.path}/README.md`\n 28| }\n 29| \n 30| export function toRawREADME(quiz: Quiz, locale?: string) {\n 31| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\n 32| // const provider = 'https://raw.githubusercontent.com/type-challenges/type-challenges/main'\n 33| return locale && locale !== defaultLocale && quiz.readme[locale]\n 34| ? `${provider}/questions/${quiz.path}/README.${locale}.md`\n 35| : `${provider}/questions/${quiz.path}/README.md`\n 36| }\n 37| \n 38| export function toQuestionsRawREADME(locale?: string) {\n 39| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\n 40| return locale && locale !== defaultLocale ? `${provider}/README.${locale}.md` : `${provider}/README.md`\n 41| }\n 42| \n 43| export function toNearborREADME(quiz: Quiz, locale?: string) {\n 44| return locale && locale !== defaultLocale && quiz.readme[locale]\n 45| ? `./README.${locale}.md`\n 46| : './README.md'\n 47| }\n 48| \n 49| export function toShareAnswerFull(quiz: Quiz, locale: string = defaultLocale) {\n 50| const info = resolveInfo(quiz, locale)\n 51| if (locale === defaultLocale)\n 52| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=0-answer.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\n 53| else\n 54| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=1-answer.${locale}.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\n 55| }\n 56| \n 57| // Short\n 58| \n 59| export function toReadmeShort(no: number, locale?: string) {\n 60| return locale !== defaultLocale\n 61| ? `${DOMAIN}/${no}/${locale}`\n 62| : `${DOMAIN}/${no}`\n 63| }\n 64| \n 65| export function toSolutionsShort(no: number) {\n 66| return `${DOMAIN}/${no}/solutions`\n 67| }\n 68| \n 69| export function toPlayShort(no: number, locale?: string) {\n 70| return locale !== defaultLocale\n 71| ? `${DOMAIN}/${no}/play/${locale}`\n 72| : `${DOMAIN}/${no}/play`\n 73| }\n 74| \n 75| export function toAnswerShort(no: number, locale?: string) {\n 76| return locale !== defaultLocale\n 77| ? `${DOMAIN}/${no}/answer/${locale}`\n 78| : `${DOMAIN}/${no}/answer`\n 79| }\n 80| \n 81| export function toHomepageShort(locale?: string) {\n 82| return locale !== defaultLocale\n 83| ? `${DOMAIN}/${locale}`\n 84| : `${DOMAIN}`\n 85| }\n```\n\n### FILE: scripts/translate.ts (73 lines)\n\n```\n 1| import path from 'node:path'\n 2| import fs from 'fs-extra'\n 3| import { translate } from '@vitalets/google-translate-api'\n 4| import { QUIZ_ROOT, loadQuizByNo, loadQuizzes } from './loader'\n 5| import { resolveFilePath } from './utils/resolve'\n 6| import type { Quiz } from './types'\n 7| import type { SupportedLocale } from './locales'\n 8| import { t } from './locales'\n 9| \n 10| export async function translateQuizByNo(no: number, from: SupportedLocale, to: SupportedLocale) {\n 11| const quiz = await loadQuizByNo(no)\n 12| if (!quiz)\n 13| throw new Error(`Quiz #${no} not founded`)\n 14| return await translateQuiz(quiz, from, to)\n 15| }\n 16| \n 17| export async function translateQuiz(quiz: Quiz, from: SupportedLocale, to: SupportedLocale) {\n 18| let translatedReadme = await translateMarkdown(quiz.readme[from], from, to)\n 19| \n 20| if (!translatedReadme)\n 21| throw new Error(`Quiz #${quiz.no} empty translation`)\n 22| \n 23| translatedReadme = `> ${t(to, 'readme.google-translated')}\\n\\n${translatedReadme.trim()}`\n 24| \n 25| const readmePath = resolveFilePath(path.join(QUIZ_ROOT, quiz.path), 'README', 'md', to)\n 26| await fs.writeFile(readmePath, translatedReadme, 'utf-8')\n 27| \n 28| console.log(`Translated [${quiz.no}] ${from} → ${to} | saved to ${readmePath}`)\n 29| }\n 30| \n 31| export async function translateMarkdown(code: string, from: SupportedLocale, to: SupportedLocale) {\n 32| // to replace the code blocks intro a placeholder then feed it into translator\n 33| // then replace back for the results\n 34| const codeBlocks: string[] = []\n 35| \n 36| const source = code\n 37| .replace(/```[\\s\\S\\n]+?```/g, (v) => {\n 38| const placeholder = `__${codeBlocks.length}__`\n 39| codeBlocks.push(v)\n 40| return placeholder\n 41| })\n 42| .replace(/`[\\s\\S\\n]+?`/g, (v) => {\n 43| const placeholder = `__${codeBlocks.length}__`\n 44| codeBlocks.push(v)\n 45| return placeholder\n 46| })\n 47| \n 48| const { text } = await translate(source, {\n 49| from,\n 50| to,\n 51| })\n 52| \n 53| if (!text)\n 54| return\n 55| \n 56| const result = text.replace(/__\\s*?(\\d+?)\\s*?__/g, (_, i) => codeBlocks[+i])\n 57| \n 58| return result\n 59| }\n 60| \n 61| export async function translateAllQuizzes(from: SupportedLocale, to: SupportedLocale) {\n 62| const quizzes = await loadQuizzes()\n 63| \n 64| for (const quiz of quizzes) {\n 65| if (quiz.readme[to] || !quiz.readme[from]) {\n 66| console.log(`Skipped #${quiz.no}`)\n 67| continue\n 68| }\n 69| \n 70| console.log(`Translating #${quiz.no} to ${to}`)\n 71| await translateQuiz(quiz, from, to)\n 72| }\n 73| }\n```\n\n### FILE: scripts/types.ts (38 lines)\n\n```\n 1| import type { DeepPartial } from 'utility-types'\n 2| import type { context, getOctokit } from '@actions/github'\n 3| import type Core from '@actions/core'\n 4| import type IO from '@actions/io'\n 5| \n 6| export type Github = ReturnType<typeof getOctokit>\n 7| export type Context = typeof context\n 8| export type Action = (github: Github, context: Context, core: typeof Core, io: typeof IO) => Promise<void>\n 9| \n 10| export interface QuizMetaInfo {\n 11| title: string\n 12| author: {\n 13| name: string\n 14| email: string\n 15| github: string\n 16| }\n 17| tsconfig?: Record<string, any>\n 18| original_issues: number[]\n 19| recommended_solutions: number[]\n 20| tags: string[]\n 21| related?: string[]\n 22| }\n 23| \n 24| export type Difficulty = 'warm' | 'easy' | 'medium' | 'hard' | 'extreme' | 'pending'\n 25| \n 26| export interface Quiz {\n 27| no: number\n 28| difficulty: Difficulty\n 29| path: string\n 30| readme: Record<string, string>\n 31| template: string\n 32| info: Record<string, DeepPartial<QuizMetaInfo> | undefined>\n 33| tests?: string\n 34| solutions?: {\n 35| code?: string\n 36| readme?: Record<string, string>\n 37| }\n 38| }\n```\n\n### FILE: utils/index.d.test.ts (35 lines)\n\n```\n 1| import type { Alike, Equal, Expect, ExpectFalse, IsAny, NotEqual } from './index'\n 2| \n 3| type cases = [\n 4| /* Expect */\n 5| Expect<true>,\n 6| // @ts-expect-error\n 7| Expect<false>,\n 8| \n 9| /* ExpectFalse */\n 10| ExpectFalse<false>,\n 11| // @ts-expect-error\n 12| ExpectFalse<true>,\n 13| \n 14| /* Equal */\n 15| Expect<Equal<true, true>>,\n 16| ExpectFalse<Equal<false, true>>,\n 17| Expect<Equal<'123', '123'>>,\n 18| ExpectFalse<Equal<'123', string>>,\n 19| Expect<Equal<{ a: number }, { a: number }>>,\n 20| ExpectFalse<Equal<{ a: number }, { b: number }>>,\n 21| ExpectFalse<Equal<any, '123'>>,\n 22| ExpectFalse<Equal<any, unknown>>,\n 23| \n 24| /* Not Equal */\n 25| Expect<NotEqual<false, true>>,\n 26| ExpectFalse<NotEqual<true, true>>,\n 27| \n 28| /* IsAny */\n 29| Expect<IsAny<any>>,\n 30| ExpectFalse<IsAny<1>>,\n 31| \n 32| /* Alike */\n 33| Expect<Alike<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\n 34| ExpectFalse<Equal<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\n 35| ]\n```\n\n### FILE: utils/index.d.ts (29 lines)\n\n```\n 1| export type Expect<T extends true> = T\n 2| export type ExpectTrue<T extends true> = T\n 3| export type ExpectFalse<T extends false> = T\n 4| export type IsTrue<T extends true> = T\n 5| export type IsFalse<T extends false> = T\n 6| \n 7| export type Equal<X, Y> =\n 8| (<T>() => T extends X ? 1 : 2) extends\n 9| (<T>() => T extends Y ? 1 : 2) ? true : false\n 10| export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true\n 11| \n 12| // https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\n 13| export type IsAny<T> = 0 extends (1 & T) ? true : false\n 14| export type NotAny<T> = true extends IsAny<T> ? false : true\n 15| \n 16| export type Debug<T> = { [K in keyof T]: T[K] }\n 17| export type MergeInsertions<T> =\n 18| T extends object\n 19| ? { [K in keyof T]: MergeInsertions<T[K]> }\n 20| : T\n 21| \n 22| export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>\n 23| \n 24| export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE ? true : false\n 25| export type ExpectValidArgs<FUNC extends (...args: any[]) => any, ARGS extends any[]> = ARGS extends Parameters<FUNC>\n 26| ? true\n 27| : false\n 28| \n 29| export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never\n```\n<END_OF_CONTEXT>\n\n<query>\nGenerate a wiki page explaining WHY this codebase is designed the way it is: the constraints it balances, the patterns it uses and what problems they solve, and the trade-offs visible in the code.\n</query>"},{"role":"assistant","content":"# Type Challenges Codebase Design Analysis\n\n## Overview\n\nThe type-challenges repository is a TypeScript learning platform that presents type manipulation challenges with automated testing. The codebase balances several constraints: developer experience, internationalization, maintainability, and performance. It uses a modular architecture with clear separation of concerns between challenge definition, generation, and presentation layers.\n\n## Detailed Analysis\n\n### Architecture and Design Patterns\n\nThe codebase follows a **modular monolith pattern** with distinct responsibilities:\n\n1. **Challenge Definition Layer** (`questions/` directory structure)\n2. **Generation/Build Layer** (`scripts/` directory)\n3. **Presentation Layer** (README generation, URL routing)\n\nThe core design decision is to store challenges as **directory-based structures** with metadata files. Each challenge is organized in a folder named with a pattern like `00002-medium-return-type`, where:\n- `00002` is the challenge number\n- `medium` is the difficulty level\n- `return-type` is the challenge topic\n\nThis structure allows for **scalable organization** of challenges while maintaining a clear hierarchy. The `scripts/loader.ts` file demonstrates this pattern by using `fast-glob` to discover and load challenges based on directory naming conventions (`{0..9}*-*`).\n\n### Internationalization Strategy\n\nThe codebase implements **locale-aware content management** through the `scripts/locales.ts` module, which supports multiple languages including English, Chinese, Japanese, Korean, and Portuguese. The internationalization strategy is:\n\n1. **File-based localization**: Each challenge has localized README files (`README.zh-CN.md`, `README.ja.md`, etc.)\n2. **Metadata localization**: `info.yml` files contain localized metadata\n3. **Dynamic fallback**: The `resolveInfo` function in `scripts/loader.ts` implements a fallback mechanism that prioritizes locale-specific content over default content\n\nThis approach ensures that challenges can be easily translated while maintaining a consistent structure. The `loadLocaleVariations` function in `scripts/loader.ts:14` handles the loading of localized files with appropriate fallbacks.\n\n### Build and Generation Process\n\nThe build process in `scripts/build.ts` demonstrates a **static site generation approach** with URL routing:\n\n1. **Code Generation**: `formatToCode` in `scripts/actions/utils/formatToCode.ts` combines challenge metadata, templates, and test cases into a single TypeScript file\n2. **URL Generation**: Functions in `scripts/toUrl.ts` create both short URLs and playground links\n3. **Redirect Management**: The build process generates `_redirects` file for Netlify deployment\n\nThe `build()` function in `scripts/build.ts:8` orchestrates this process by:\n- Loading all quizzes using `loadQuizzes()` \n- Generating code snippets for each locale\n- Creating playground URLs for TypeScript Playground integration\n- Setting up redirects for web navigation\n\n### Challenge Structure and Testing\n\nEach challenge follows a consistent structure:\n1. **Metadata** in `info.yml` (title, author, tags, difficulty)\n2. **Template** in `template.ts` (the starting point for the challenge)\n3. **Test cases** in `test-cases.ts` (the validation logic)\n4. **Documentation** in `README.md` (the challenge description)\n\nThe test cases use a custom utility type system in `utils/index.d.ts` that provides strong type checking for challenge solutions. The `Equal` type alias in `utils/index.d.ts:7-9` implements a sophisticated type equality check using conditional types and function signatures, ensuring that challenge solutions must match expected types exactly.\n\n### Trade-offs and Constraints\n\n#### Performance vs. Developer Experience\nThe codebase makes trade-offs between performance and developer experience:\n- **Large test suite**: The `utils/index.d.test.ts` file contains 35 test cases that validate the utility types, ensuring robustness but potentially slowing down compilation\n- **Code generation**: The build process generates code snippets for playground use, which adds build time but improves user experience\n\n#### Flexibility vs. Consistency\nThe directory structure provides consistency across challenges but limits flexibility:\n- All challenges must follow the same naming convention (`{number}-{difficulty}-{topic}`)\n- All challenges must have the same file structure (README, template, test-cases)\n- This constraint makes it easy to generate and maintain challenges but reduces customization options\n\n#### Localization vs. Maintenance Overhead\nThe internationalization system adds significant maintenance overhead:\n- Each challenge requires multiple localized files\n- The `loadLocaleVariations` function in `scripts/loader.ts:14` must handle multiple file loading scenarios\n- The `resolveInfo` function in `scripts/loader.ts:107` handles complex fallback logic for metadata\n\n### Key Design Decisions\n\n#### 1. TypeScript Playground Integration\nThe decision to integrate with TypeScript Playground (`scripts/toUrl.ts:11-17`) was made to provide an immediate coding environment. The `toPlaygroundUrl` function uses LZ compression to encode challenge code, making it suitable for URL sharing.\n\n#### 2. Test Case Validation System\nThe custom utility types in `utils/index.d.ts` were designed to provide clear feedback to challenge participants. The `Equal` type implementation (lines 7-9) uses a technique called \"conditional type inference\" to determine type equality, which is more reliable than simple type comparison.\n\n#### 3. Modular File Structure\nThe separation of concerns between:\n- `scripts/loader.ts` (challenge loading and parsing)\n- `scripts/generate-play.ts` (local playground generation)\n- `scripts/build.ts` (production build and redirects)\n- `scripts/readme.ts` (README generation)\n\nThis modular approach makes it easier to maintain and extend specific functionality without affecting others.\n\n## Mermaid Flow Diagram\n\n```mermaid\nflowchart TD\n A[Challenge Definition] --> B[Directory Structure]\n B --> C[info.yml]\n B --> D[README.md]\n B --> E[template.ts]\n B --> F[test-cases.ts]\n \n A --> G[Build Process]\n G --> H[scripts/loader.ts]\n G --> I[scripts/build.ts]\n G --> J[scripts/readme.ts]\n G --> K[scripts/generate-play.ts]\n \n H --> L[Challenge Metadata Loading]\n I --> M[Static Site Generation]\n J --> N[README Updates]\n K --> O[Local Playground Generation]\n \n L --> P[scripts/toUrl.ts]\n M --> P\n N --> P\n O --> P\n \n P --> Q[TypeScript Playground]\n P --> R[GitHub Issues]\n P --> S[Netlify Redirects]\n P --> T[Local File System]\n \n style A fill:#e1f5fe\n style G fill:#f3e5f5\n style P fill:#e8f5e9\n```\n\n## Conclusion\n\nThe type-challenges codebase demonstrates a well-thought-out approach to building a scalable TypeScript learning platform. The design balances multiple constraints:\n\n1. **Scalability**: Directory-based organization allows for easy addition of new challenges\n2. **Maintainability**: Clear separation of concerns makes the codebase easy to understand and modify\n3. **Internationalization**: Robust locale support enables global reach\n4. **Developer Experience**: Integration with TypeScript Playground and clear test validation provide immediate feedback\n\nThe architecture shows that the team prioritized consistency and automation over flexibility, which is appropriate for a learning platform where predictable behavior and clear expectations are important. The trade-offs made—such as the maintenance overhead of localization and the performance cost of comprehensive testing—reflect the project's primary goal of being an educational tool rather than a high-performance application."}],"string":"[\n {\n \"role\": \"system\",\n \"content\": [\n \"You are an expert software architect writing wiki documentation for codebases.\\nRequirements:\\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\\n2. Include at least one Mermaid diagram (flowchart or sequenceDiagram) when it clarifies structure or flow.\\n3. Organize with H1 title and H2/H3 sections: overview, detailed analysis, and a conclusion.\\n4. Explain the WHY behind design decisions, not only the WHAT.\\n5. Never invent files, symbols, or line numbers - cite only what the context shows.\\n6. Citation format is strict. Every citation must be the token `path/file.ext:line` or `path/file.ext:start-end` - for example `src/click/core.py:370-545`. Do NOT write 'path lines X-Y' or '(lines X-Y)': those are not valid citations in this format.\\n7. Example of the correct citation style, inline and attached to a path:\\n 'The `Context` class (`src/click/core.py:238-987`) manages state, and its cleanup logic (`src/click/core.py:579-596`) releases resources.'\\n A line number or range NEVER stands alone or in bare parentheses - it must be bound to a file path with a colon.\"\n ]\n },\n {\n \"role\": \"user\",\n \"content\": \"<START_OF_CONTEXT>\\n# Repository: type-challenges/type-challenges (language: typescript)\\n\\n# Selected files (windows)\\n- eslint.config.js (24 lines)\\n- questions/00002-medium-return-type/test-cases.ts (20 lines)\\n- questions/00003-medium-omit/test-cases.ts (32 lines)\\n- questions/00004-easy-pick/test-cases.ts (23 lines)\\n- questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\\n- questions/00006-hard-simple-vue/test-cases.ts (37 lines)\\n- questions/00008-medium-readonly-2/test-cases.ts (29 lines)\\n- questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\\n- questions/00599-medium-merge/test-cases.ts (18 lines)\\n- scripts/actions/utils/formatToCode.ts (26 lines)\\n- scripts/actions/utils/toInfoHeader.ts (15 lines)\\n- scripts/build.ts (54 lines)\\n- scripts/generate-play.ts (180 lines)\\n- scripts/loader.ts (117 lines)\\n- scripts/locales.ts (26 lines)\\n- scripts/readme.ts (240 lines)\\n- scripts/toUrl.ts (85 lines)\\n- scripts/translate.ts (73 lines)\\n- scripts/types.ts (38 lines)\\n- utils/index.d.test.ts (35 lines)\\n- utils/index.d.ts (29 lines)\\n\\n\\n### FILE: eslint.config.js (24 lines)\\n\\n```\\n 1| const antfu = require('@antfu/eslint-config').default\\n 2| \\n 3| module.exports = antfu(\\n 4| {\\n 5| markdown: false,\\n 6| },\\n 7| {\\n 8| rules: {\\n 9| 'import/first': 'off',\\n 10| 'no-alert': 'off',\\n 11| 'no-unused-expressions': 'off',\\n 12| 'no-unused-vars': 'off',\\n 13| 'no-use-before-define': 'off',\\n 14| 'prefer-const': 'off',\\n 15| 'ts/ban-ts-comment': 'off',\\n 16| 'ts/ban-types': 'off',\\n 17| 'ts/consistent-type-definitions': 'off',\\n 18| 'ts/no-namespace': 'off',\\n 19| 'ts/no-require-imports': 'off',\\n 20| 'ts/no-unused-vars': 'off',\\n 21| 'unused-imports/no-unused-vars': 'off',\\n 22| },\\n 23| },\\n 24| )\\n```\\n\\n### FILE: questions/00002-medium-return-type/test-cases.ts (20 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<string, MyReturnType<() => string>>>,\\n 5| Expect<Equal<123, MyReturnType<() => 123>>>,\\n 6| Expect<Equal<ComplexObject, MyReturnType<() => ComplexObject>>>,\\n 7| Expect<Equal<Promise<boolean>, MyReturnType<() => Promise<boolean>>>>,\\n 8| Expect<Equal<() => 'foo', MyReturnType<() => () => 'foo'>>>,\\n 9| Expect<Equal<1 | 2, MyReturnType<typeof fn>>>,\\n 10| Expect<Equal<1 | 2, MyReturnType<typeof fn1>>>,\\n 11| ]\\n 12| \\n 13| type ComplexObject = {\\n 14| a: [12, 'foo']\\n 15| bar: 'hello'\\n 16| prev(): number\\n 17| }\\n 18| \\n 19| const fn = (v: boolean) => v ? 1 : 2\\n 20| const fn1 = (v: boolean, w: any) => v ? 1 : 2\\n```\\n\\n### FILE: questions/00003-medium-omit/test-cases.ts (32 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<Expected1, MyOmit<Todo, 'description'>>>,\\n 5| Expect<Equal<Expected2, MyOmit<Todo, 'description' | 'completed'>>>,\\n 6| Expect<Equal<Expected3, MyOmit<Todo1, 'description' | 'completed'>>>,\\n 7| ]\\n 8| \\n 9| interface Todo {\\n 10| title: string\\n 11| description: string\\n 12| completed: boolean\\n 13| }\\n 14| \\n 15| interface Todo1 {\\n 16| readonly title: string\\n 17| description: string\\n 18| completed: boolean\\n 19| }\\n 20| \\n 21| interface Expected1 {\\n 22| title: string\\n 23| completed: boolean\\n 24| }\\n 25| \\n 26| interface Expected2 {\\n 27| title: string\\n 28| }\\n 29| \\n 30| interface Expected3 {\\n 31| readonly title: string\\n 32| }\\n```\\n\\n### FILE: questions/00004-easy-pick/test-cases.ts (23 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<Expected1, MyPick<Todo, 'title'>>>,\\n 5| Expect<Equal<Expected2, MyPick<Todo, 'title' | 'completed'>>>,\\n 6| // @ts-expect-error\\n 7| MyPick<Todo, 'title' | 'completed' | 'invalid'>,\\n 8| ]\\n 9| \\n 10| interface Todo {\\n 11| title: string\\n 12| description: string\\n 13| completed: boolean\\n 14| }\\n 15| \\n 16| interface Expected1 {\\n 17| title: string\\n 18| }\\n 19| \\n 20| interface Expected2 {\\n 21| title: string\\n 22| completed: boolean\\n 23| }\\n```\\n\\n### FILE: questions/00005-extreme-readonly-keys/test-cases.ts (18 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<'title', GetReadonlyKeys<Todo1>>>,\\n 5| Expect<Equal<'title' | 'description', GetReadonlyKeys<Todo2>>>,\\n 6| ]\\n 7| \\n 8| interface Todo1 {\\n 9| readonly title: string\\n 10| description: string\\n 11| completed: boolean\\n 12| }\\n 13| \\n 14| interface Todo2 {\\n 15| readonly title: string\\n 16| readonly description: string\\n 17| completed?: boolean\\n 18| }\\n```\\n\\n### FILE: questions/00006-hard-simple-vue/test-cases.ts (37 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| SimpleVue({\\n 4| data() {\\n 5| // @ts-expect-error\\n 6| this.firstname\\n 7| // @ts-expect-error\\n 8| this.getRandom()\\n 9| // @ts-expect-error\\n 10| this.data()\\n 11| \\n 12| return {\\n 13| firstname: 'Type',\\n 14| lastname: 'Challenges',\\n 15| amount: 10,\\n 16| }\\n 17| },\\n 18| computed: {\\n 19| fullname() {\\n 20| return `${this.firstname} ${this.lastname}`\\n 21| },\\n 22| },\\n 23| methods: {\\n 24| getRandom() {\\n 25| return Math.random()\\n 26| },\\n 27| hi() {\\n 28| alert(this.amount)\\n 29| alert(this.fullname.toLowerCase())\\n 30| alert(this.getRandom())\\n 31| },\\n 32| test() {\\n 33| const fullname = this.fullname\\n 34| const cases: [Expect<Equal<typeof fullname, string>>] = [] as any\\n 35| },\\n 36| },\\n 37| })\\n```\\n\\n### FILE: questions/00008-medium-readonly-2/test-cases.ts (29 lines)\\n\\n```\\n 1| import type { Alike, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Alike<MyReadonly2<Todo1>, Readonly<Todo1>>>,\\n 5| Expect<Alike<MyReadonly2<Todo1, 'title' | 'description'>, Expected>>,\\n 6| Expect<Alike<MyReadonly2<Todo2, 'title' | 'description'>, Expected>>,\\n 7| Expect<Alike<MyReadonly2<Todo2, 'description' >, Expected>>,\\n 8| ]\\n 9| \\n 10| // @ts-expect-error\\n 11| type error = MyReadonly2<Todo1, 'title' | 'invalid'>\\n 12| \\n 13| interface Todo1 {\\n 14| title: string\\n 15| description?: string\\n 16| completed: boolean\\n 17| }\\n 18| \\n 19| interface Todo2 {\\n 20| readonly title: string\\n 21| description?: string\\n 22| completed: boolean\\n 23| }\\n 24| \\n 25| interface Expected {\\n 26| readonly title: string\\n 27| readonly description?: string\\n 28| completed: boolean\\n 29| }\\n```\\n\\n### FILE: questions/00009-medium-deep-readonly/test-cases.ts (56 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type cases = [\\n 4| Expect<Equal<DeepReadonly<X1>, Expected1>>,\\n 5| Expect<Equal<DeepReadonly<X2>, Expected2>>,\\n 6| ]\\n 7| \\n 8| type X1 = {\\n 9| a: () => 22\\n 10| b: string\\n 11| c: {\\n 12| d: boolean\\n 13| e: {\\n 14| g: {\\n 15| h: {\\n 16| i: true\\n 17| j: 'string'\\n 18| }\\n 19| k: 'hello'\\n 20| }\\n 21| l: [\\n 22| 'hi',\\n 23| {\\n 24| m: ['hey']\\n 25| },\\n 26| ]\\n 27| }\\n 28| }\\n 29| }\\n 30| \\n 31| type X2 = { a: string } | { b: number }\\n 32| \\n 33| type Expected1 = {\\n 34| readonly a: () => 22\\n 35| readonly b: string\\n 36| readonly c: {\\n 37| readonly d: boolean\\n 38| readonly e: {\\n 39| readonly g: {\\n 40| readonly h: {\\n 41| readonly i: true\\n 42| readonly j: 'string'\\n 43| }\\n 44| readonly k: 'hello'\\n 45| }\\n 46| readonly l: readonly [\\n 47| 'hi',\\n 48| {\\n 49| readonly m: readonly ['hey']\\n 50| },\\n 51| ]\\n 52| }\\n 53| }\\n 54| }\\n 55| \\n 56| type Expected2 = { readonly a: string } | { readonly b: number }\\n```\\n\\n### FILE: questions/00599-medium-merge/test-cases.ts (18 lines)\\n\\n```\\n 1| import type { Equal, Expect } from '@type-challenges/utils'\\n 2| \\n 3| type Foo = {\\n 4| a: number\\n 5| b: string\\n 6| }\\n 7| type Bar = {\\n 8| b: number\\n 9| c: boolean\\n 10| }\\n 11| \\n 12| type cases = [\\n 13| Expect<Equal<Merge<Foo, Bar>, {\\n 14| a: number\\n 15| b: number\\n 16| c: boolean\\n 17| }>>,\\n 18| ]\\n```\\n\\n### FILE: scripts/actions/utils/formatToCode.ts (26 lines)\\n\\n```\\n 1| import type { Quiz } from '../../types'\\n 2| import type { SupportedLocale } from '../../locales'\\n 3| import { defaultLocale, t } from '../../locales'\\n 4| import { toCommentBlock } from './toCommentBlock'\\n 5| import { toInfoHeader } from './toInfoHeader'\\n 6| import { toLinks } from './toLinks'\\n 7| import { toDivider } from './toDivider'\\n 8| import { toFooter } from './toFooter'\\n 9| \\n 10| export function formatToCode(quiz: Quiz, locale: SupportedLocale) {\\n 11| return `${toCommentBlock(\\n 12| toInfoHeader(quiz, locale)\\n 13| + (quiz.readme[locale] || quiz.readme[defaultLocale])\\n 14| + toLinks(quiz, locale),\\n 15| )\\n 16| + toDivider(t(locale, 'divider.code-start'))\\n 17| }\\\\n${\\n 18| (quiz.template || '').trim()\\n 19| }\\\\n${\\n 20| toDivider(t(locale, 'divider.test-cases'))\\n 21| }${\\n 22| (quiz.tests || '').trim()\\n 23| }\\\\n${\\n 24| toDivider(t(locale, 'divider.further-steps'))\\n 25| }${toCommentBlock(toFooter(quiz, locale))}`\\n 26| }\\n```\\n\\n### FILE: scripts/actions/utils/toInfoHeader.ts (15 lines)\\n\\n```\\n 1| import type { Quiz } from '../../types'\\n 2| import type { SupportedLocale } from '../../locales'\\n 3| import { t } from '../../locales'\\n 4| import { resolveInfo } from '../../loader'\\n 5| \\n 6| export const toInfoHeader = function toInfoHeader(quiz: Quiz, locale: SupportedLocale) {\\n 7| const info = resolveInfo(quiz, locale)\\n 8| \\n 9| const author = `${info.author?.name} (@${info?.author?.github})`\\n 10| \\n 11| return `${quiz.no} - ${info.title || ''}\\\\n`\\n 12| + '-------\\\\n'\\n 13| + `by ${author} #${t(locale, `difficulty.${quiz.difficulty}`)} ${info?.tags?.map(i => `#${i}`).join(' ') || ''}\\\\n\\\\n`\\n 14| + `### ${t(locale, 'title.question')}\\\\n\\\\n`\\n 15| }\\n```\\n\\n### FILE: scripts/build.ts (54 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import { loadQuizzes, resolveInfo } from './loader'\\n 4| import { REPO, toPlaygroundUrl, toQuestionsRawREADME, toQuizREADME, toRawREADME, toShareAnswerFull, toSolutionsFull } from './toUrl'\\n 5| import { defaultLocale, supportedLocales } from './locales'\\n 6| import { formatToCode } from './actions/utils/formatToCode'\\n 7| \\n 8| export async function build() {\\n 9| const quizzes = await loadQuizzes()\\n 10| const redirects: [string, string, number][] = []\\n 11| \\n 12| // redirect homepage to github repo\\n 13| supportedLocales.filter(locale => locale !== defaultLocale).forEach((locale) => {\\n 14| redirects.push([`/${locale}`, `${REPO}/blob/main/README.${locale}.md`, 302])\\n 15| })\\n 16| \\n 17| supportedLocales.forEach((locale) => {\\n 18| redirects.push([`/raw/${locale}`, toQuestionsRawREADME(locale), 302])\\n 19| })\\n 20| \\n 21| for (const quiz of quizzes) {\\n 22| for (const locale of supportedLocales) {\\n 23| const info = resolveInfo(quiz, locale)\\n 24| \\n 25| const code = formatToCode(quiz, locale)\\n 26| \\n 27| const url = toPlaygroundUrl(code, info.tsconfig || {})\\n 28| \\n 29| if (locale === defaultLocale) {\\n 30| redirects.push([`/${quiz.no}`, toQuizREADME(quiz, locale, true), 302])\\n 31| redirects.push([`/${quiz.no}/raw`, toRawREADME(quiz, locale), 302])\\n 32| redirects.push([`/${quiz.no}/play`, url, 302])\\n 33| redirects.push([`/${quiz.no}/answer`, toShareAnswerFull(quiz), 302])\\n 34| }\\n 35| else {\\n 36| redirects.push([`/${quiz.no}/${locale}`, toQuizREADME(quiz, locale, true), 302])\\n 37| redirects.push([`/${quiz.no}/raw/${locale}`, toRawREADME(quiz, locale), 302])\\n 38| redirects.push([`/${quiz.no}/play/${locale}`, url, 302])\\n 39| redirects.push([`/${quiz.no}/answer/${locale}`, toShareAnswerFull(quiz, locale), 302])\\n 40| }\\n 41| }\\n 42| \\n 43| redirects.push([`/${quiz.no}/solutions`, toSolutionsFull(quiz.no), 302])\\n 44| }\\n 45| \\n 46| const dist = path.resolve(__dirname, 'dist')\\n 47| \\n 48| await fs.remove(dist)\\n 49| await fs.ensureDir(dist)\\n 50| \\n 51| await fs.writeFileSync(path.join(dist, '_redirects'), redirects.map(i => i.join('\\\\t')).join('\\\\n'), 'utf-8')\\n 52| }\\n 53| \\n 54| build()\\n```\\n\\n### FILE: scripts/generate-play.ts (180 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import process from 'node:process'\\n 3| import crypto from 'node:crypto'\\n 4| import fs from 'fs-extra'\\n 5| import c from 'ansis'\\n 6| import prompts from 'prompts'\\n 7| import { formatToCode } from './actions/utils/formatToCode'\\n 8| import { loadQuizzes, resolveInfo } from './loader'\\n 9| import { supportedLocales } from './locales'\\n 10| import { getQuestionFullName } from './actions/issue-pr'\\n 11| import type { QuizMetaInfo } from './types'\\n 12| \\n 13| type Snapshot = Record<string, string>\\n 14| \\n 15| function calculateFileHash(filePathFull: string): Promise<string> {\\n 16| return new Promise((resolve, reject) => {\\n 17| const hash = crypto.createHash('sha1')\\n 18| const fileStream = fs.createReadStream(filePathFull)\\n 19| \\n 20| fileStream.on('data', (data) => {\\n 21| hash.update(data)\\n 22| })\\n 23| \\n 24| fileStream.on('end', () => {\\n 25| hash.update(filePathFull)\\n 26| resolve(hash.digest('hex'))\\n 27| })\\n 28| \\n 29| fileStream.on('error', (err) => {\\n 30| reject(err)\\n 31| })\\n 32| })\\n 33| }\\n 34| \\n 35| async function takeSnapshot(quizzesPath: string) {\\n 36| let snapshot: Snapshot = {}\\n 37| \\n 38| const files = fs.readdirSync(quizzesPath)\\n 39| \\n 40| for (const file of files) {\\n 41| // Might be a file, or a folder\\n 42| const fPath = path.join(quizzesPath, file)\\n 43| const fStats = fs.statSync(fPath)\\n 44| \\n 45| if (fStats.isDirectory()) {\\n 46| snapshot = {\\n 47| ...snapshot,\\n 48| ...(await takeSnapshot(fPath)),\\n 49| }\\n 50| }\\n 51| else {\\n 52| snapshot[file] = await calculateFileHash(fPath)\\n 53| }\\n 54| }\\n 55| \\n 56| return snapshot\\n 57| }\\n 58| \\n 59| function readPlaygroundCache(playgroundCachePath: string): Snapshot {\\n 60| if (!fs.existsSync(playgroundCachePath))\\n 61| return {}\\n 62| \\n 63| try {\\n 64| const rawCacheContent = fs.readFileSync(playgroundCachePath)\\n 65| return JSON.parse(rawCacheContent.toString())\\n 66| }\\n 67| catch (err) {\\n 68| console.log(c.red('Playground cache corrupted. '\\n 69| + 'Cannot generate playground without keeping your changes intact'))\\n 70| console.log(c.cyan('Please ensure you have run this: \\\"pnpm generate\\\"'))\\n 71| process.exit(1)\\n 72| }\\n 73| }\\n 74| \\n 75| function calculateOverridableFiles(cache: Snapshot, snapshot: Snapshot) {\\n 76| const result: Snapshot = {}\\n 77| \\n 78| for (const quizName in snapshot) {\\n 79| if (snapshot[quizName] === cache[quizName])\\n 80| result[quizName] = snapshot[quizName]\\n 81| }\\n 82| \\n 83| return result\\n 84| }\\n 85| \\n 86| function isQuizWritable(quizFileName: string, overridableFiles: Snapshot, playgroundSnapshot: Snapshot): boolean {\\n 87| return !!(\\n 88| overridableFiles[quizFileName]\\n 89| || (!overridableFiles[quizFileName] && !playgroundSnapshot[quizFileName])\\n 90| )\\n 91| }\\n 92| \\n 93| async function generatePlayground() {\\n 94| const playgroundPath = path.join(__dirname, '../playground')\\n 95| const playgroundCachePath = path.join(__dirname, '../.playgroundcache')\\n 96| \\n 97| let locale = supportedLocales.find(locale => locale === process.argv[2])!\\n 98| \\n 99| console.log(c.bold.cyan('Generating local playground...\\\\n'))\\n 100| \\n 101| let overridableFiles: Snapshot\\n 102| let keepChanges = false\\n 103| const currentPlaygroundCache = readPlaygroundCache(playgroundCachePath)\\n 104| let playgroundSnapshot: Snapshot\\n 105| \\n 106| if (process.argv.length === 3 && (process.argv[2] === '--keep-changes' || process.argv[2] === '-K')) {\\n 107| console.log(c.bold.cyan('We will keep your changes while generating.\\\\n'))\\n 108| keepChanges = true\\n 109| \\n 110| playgroundSnapshot = await takeSnapshot(playgroundPath)\\n 111| \\n 112| overridableFiles = calculateOverridableFiles(currentPlaygroundCache, playgroundSnapshot)\\n 113| }\\n 114| else if (fs.existsSync(playgroundPath)) {\\n 115| const result = await prompts([{\\n 116| name: 'confirm',\\n 117| type: 'confirm',\\n 118| initial: false,\\n 119| message: 'The playground directory already exists, it may contains the answers you did. Do you want to override it?',\\n 120| }])\\n 121| if (!result?.confirm)\\n 122| return console.log(c.yellow('Skipped.'))\\n 123| }\\n 124| \\n 125| if (!locale) {\\n 126| const result = await prompts([{\\n 127| name: 'locale',\\n 128| type: 'select',\\n 129| message: 'Select language:',\\n 130| choices: supportedLocales.map(i => ({\\n 131| title: i,\\n 132| value: i,\\n 133| })),\\n 134| }])\\n 135| if (!result)\\n 136| return console.log(c.yellow('Skipped.'))\\n 137| locale = result.locale\\n 138| }\\n 139| \\n 140| if (!keepChanges) {\\n 141| await fs.remove(playgroundPath)\\n 142| await fs.ensureDir(playgroundPath)\\n 143| }\\n 144| \\n 145| const quizzes = await loadQuizzes()\\n 146| const incomingQuizzesCache: Snapshot = {}\\n 147| \\n 148| for (const quiz of quizzes) {\\n 149| const { difficulty, title } = resolveInfo(quiz, locale) as QuizMetaInfo & { difficulty: string }\\n 150| const code = formatToCode(quiz, locale)\\n 151| \\n 152| if (difficulty === undefined || title === undefined) {\\n 153| console.log(c.yellow`${quiz.no} has no ${locale.toUpperCase()} version. Skipping`)\\n 154| continue\\n 155| }\\n 156| \\n 157| const quizzesPathByDifficulty = path.join(playgroundPath, difficulty)\\n 158| \\n 159| const quizFileName = `${getQuestionFullName(quiz.no, difficulty, title)}.ts`\\n 160| const quizPathFull = path.join(quizzesPathByDifficulty, quizFileName)\\n 161| \\n 162| if (!keepChanges || (keepChanges && isQuizWritable(quizFileName, overridableFiles!, playgroundSnapshot!))) {\\n 163| if (!fs.existsSync(quizzesPathByDifficulty))\\n 164| fs.mkdirSync(quizzesPathByDifficulty)\\n 165| await fs.writeFile(quizPathFull, code, 'utf-8')\\n 166| incomingQuizzesCache[quizFileName] = await calculateFileHash(quizPathFull)\\n 167| }\\n 168| }\\n 169| \\n 170| fs.writeFile(playgroundCachePath, JSON.stringify({\\n 171| ...currentPlaygroundCache,\\n 172| ...incomingQuizzesCache,\\n 173| }))\\n 174| \\n 175| console.log()\\n 176| console.log(c.bold.green('Local playground generated at: ') + c.dim(playgroundPath))\\n 177| console.log()\\n 178| }\\n 179| \\n 180| generatePlayground()\\n```\\n\\n### FILE: scripts/loader.ts (117 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import fg from 'fast-glob'\\n 4| import YAML from 'js-yaml'\\n 5| import type { Quiz, QuizMetaInfo } from './types'\\n 6| import { defaultLocale, supportedLocales } from './locales'\\n 7| \\n 8| export async function loadFile(filepath: string) {\\n 9| if (fs.existsSync(filepath))\\n 10| return await fs.readFile(filepath, 'utf-8')\\n 11| return undefined\\n 12| }\\n 13| \\n 14| export async function loadLocaleVariations<T = string>(\\n 15| filepath: string,\\n 16| preprocessor: (s: string) => T = s => s as any as T,\\n 17| ) {\\n 18| const { ext, dir, name } = path.parse(filepath)\\n 19| const data: Record<string, T> = {}\\n 20| \\n 21| for (const locale of supportedLocales) {\\n 22| const file = preprocessor(await loadFile(path.join(dir, `${name}.${locale}${ext}`)) || '')\\n 23| \\n 24| if (file)\\n 25| data[locale] = file\\n 26| }\\n 27| \\n 28| if (!data[defaultLocale]) {\\n 29| // default version\\n 30| const file = preprocessor(await loadFile(filepath) || '')\\n 31| if (file)\\n 32| data[defaultLocale] = file\\n 33| }\\n 34| \\n 35| return data\\n 36| }\\n 37| \\n 38| export function readmeCleanUp(text: string) {\\n 39| return text\\n 40| .replace(/<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/, '')\\n 41| .replace(/<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/, '')\\n 42| .trim()\\n 43| }\\n 44| \\n 45| export function loadInfo(s: string): Partial<QuizMetaInfo> | undefined {\\n 46| const object = YAML.load(s) as any\\n 47| if (!object)\\n 48| return undefined\\n 49| \\n 50| const arrayKeys = ['tags', 'related']\\n 51| \\n 52| for (const key of arrayKeys) {\\n 53| if (object[key]) {\\n 54| object[key] = (object[key] || '')\\n 55| .toString()\\n 56| .split(',')\\n 57| .map((i: string) => i.trim())\\n 58| .filter(Boolean)\\n 59| }\\n 60| else {\\n 61| object[key] = undefined\\n 62| }\\n 63| }\\n 64| \\n 65| return object\\n 66| }\\n 67| \\n 68| export const QUIZ_ROOT = path.resolve(__dirname, '../questions')\\n 69| \\n 70| export async function loadQuizzes(): Promise<Quiz[]> {\\n 71| const folders = await fg('{0..9}*-*', {\\n 72| onlyDirectories: true,\\n 73| cwd: QUIZ_ROOT,\\n 74| })\\n 75| \\n 76| const quizzes = await Promise.all(\\n 77| folders.map(async dir => loadQuiz(dir)),\\n 78| )\\n 79| \\n 80| return quizzes\\n 81| }\\n 82| \\n 83| export async function loadQuiz(dir: string): Promise<Quiz> {\\n 84| return {\\n 85| no: Number(dir.replace(/^(\\\\d+)-.*/, '$1')),\\n 86| difficulty: dir.replace(/^\\\\d+-(.+?)-.*$/, '$1') as any,\\n 87| path: dir,\\n 88| info: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'info.yml'), loadInfo),\\n 89| readme: await loadLocaleVariations(path.join(QUIZ_ROOT, dir, 'README.md'), readmeCleanUp),\\n 90| template: await loadFile(path.join(QUIZ_ROOT, dir, 'template.ts')) || '',\\n 91| tests: await loadFile(path.join(QUIZ_ROOT, dir, 'test-cases.ts')),\\n 92| }\\n 93| }\\n 94| \\n 95| export async function loadQuizByNo(no: number | string) {\\n 96| const folders = await fg(`${no}-*`, {\\n 97| onlyDirectories: true,\\n 98| cwd: QUIZ_ROOT,\\n 99| })\\n 100| \\n 101| if (folders.length)\\n 102| return await loadQuiz(folders[0])\\n 103| \\n 104| return undefined\\n 105| }\\n 106| \\n 107| export function resolveInfo(quiz: Quiz, locale: string = defaultLocale) {\\n 108| const info = { ...quiz.info[defaultLocale], ...quiz.info[locale] }\\n 109| info.tags = quiz.info[locale]?.tags || quiz.info[defaultLocale]?.tags || []\\n 110| info.related = quiz.info[locale]?.related || quiz.info[defaultLocale]?.related || []\\n 111| \\n 112| if (typeof info.tags === 'string')\\n 113| // @ts-expect-error\\n 114| info.tags = info.tags.split(',').map(i => i.trim()).filter(Boolean)\\n 115| \\n 116| return info as QuizMetaInfo\\n 117| }\\n```\\n\\n### FILE: scripts/locales.ts (26 lines)\\n\\n```\\n 1| export const defaultLocale = 'en'\\n 2| \\n 3| export const supportedLocales = ['en', 'zh-CN', 'ja', 'ko', 'pt-BR'] as const\\n 4| \\n 5| export const messages = {\\n 6| 'en': require('./locales/en.json'),\\n 7| 'zh-CN': require('./locales/zh-CN.json'),\\n 8| 'ja': require('./locales/ja.json'),\\n 9| 'ko': require('./locales/ko.json'),\\n 10| 'pt-BR': require('./locales/pt-BR.json'),\\n 11| }\\n 12| \\n 13| export type SupportedLocale = keyof typeof messages\\n 14| \\n 15| export function t(locale: SupportedLocale, key: string): string {\\n 16| const result = (messages[locale] && messages[locale][key]) || messages[defaultLocale][key]\\n 17| if (!result)\\n 18| throw new Error(`Missing message for key \\\"${key}\\\"`)\\n 19| return result\\n 20| }\\n 21| \\n 22| export function f(name: string, locale: string, ext: string) {\\n 23| if (locale === defaultLocale)\\n 24| return `${name}.${ext}`\\n 25| return `${name}.${locale}.${ext}`\\n 26| }\\n```\\n\\n### FILE: scripts/readme.ts (240 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import process from 'node:process'\\n 3| import fs from 'fs-extra'\\n 4| import type { SupportedLocale } from './locales'\\n 5| import { defaultLocale, f, supportedLocales, t } from './locales'\\n 6| import { loadQuizzes, resolveInfo } from './loader'\\n 7| import { toAnswerShort, toNearborREADME, toPlayShort, toQuizREADME, toSolutionsShort } from './toUrl'\\n 8| import type { Quiz, QuizMetaInfo } from './types'\\n 9| \\n 10| const DifficultyColors: Record<string, string> = {\\n 11| warm: 'teal',\\n 12| easy: '7aad0c',\\n 13| medium: 'd9901a',\\n 14| hard: 'de3d37',\\n 15| extreme: 'b11b8d',\\n 16| }\\n 17| \\n 18| const DifficultyRank = [\\n 19| 'warm',\\n 20| 'easy',\\n 21| 'medium',\\n 22| 'hard',\\n 23| 'extreme',\\n 24| ]\\n 25| \\n 26| function escapeHtml(unsafe: string) {\\n 27| return unsafe\\n 28| .replace(/&/g, '&')\\n 29| .replace(/</g, '<')\\n 30| .replace(/>/g, '>')\\n 31| .replace(/\\\"/g, '"')\\n 32| .replace(/'/g, ''')\\n 33| }\\n 34| \\n 35| function toBadgeURL(label: string, text: string, color: string, args = '') {\\n 36| return `https://img.shields.io/badge/${encodeURIComponent(label.replace(/-/g, '--'))}-${encodeURIComponent(text.replace(/-/g, '--'))}-${color}${args}`\\n 37| }\\n 38| \\n 39| function toBadge(label: string, text: string, color: string, args = '') {\\n 40| return `<img src=\\\"${toBadgeURL(label, text, color, args)}\\\" alt=\\\"${text}\\\"/>`\\n 41| }\\n 42| \\n 43| export function toBadgeLink(url: string, label: string, text: string, color: string, args = '') {\\n 44| return `<a href=\\\"${url}\\\" target=\\\"_blank\\\">${toBadge(label, text, color, args)}</a> `\\n 45| }\\n 46| \\n 47| export function toPlanTextLink(url: string, _label: string, text: string, _color: string, _args = '') {\\n 48| return `<a href=\\\"${url}\\\" target=\\\"_blank\\\">${text}</a> `\\n 49| }\\n 50| \\n 51| function toAuthorInfo(author: Partial<QuizMetaInfo['author']> = {}) {\\n 52| return `by ${author.name}${author.github ? ` <a href=\\\"https://github.com/${author.github}\\\" target=\\\"_blank\\\">@${author.github}</a>` : ''}`\\n 53| }\\n 54| \\n 55| function toDifficultyBadge(difficulty: string, locale: SupportedLocale) {\\n 56| return toBadge('', t(locale, `difficulty.${difficulty}`), DifficultyColors[difficulty])\\n 57| }\\n 58| \\n 59| function toDifficultyBadgeInverted(difficulty: string, locale: SupportedLocale, count: number) {\\n 60| return toBadge(t(locale, `difficulty.${difficulty}`), count.toString(), DifficultyColors[difficulty])\\n 61| }\\n 62| \\n 63| function toDifficultyPlainText(difficulty: string, locale: SupportedLocale, count: number) {\\n 64| return `${t(locale, `difficulty.${difficulty}`)} (${count.toString()})`\\n 65| }\\n 66| \\n 67| function toDetailsInnerText(text: string, locale: SupportedLocale) {\\n 68| return `${t(locale, `details.${text}`)}`\\n 69| }\\n 70| \\n 71| function quizToBadge(quiz: Quiz, locale: string, absolute = false, badge = true) {\\n 72| const fn = badge ? toBadgeLink : toPlanTextLink\\n 73| return fn(\\n 74| toQuizREADME(quiz, locale, absolute),\\n 75| '',\\n 76| `${quiz.no}・${quiz.info[locale]?.title || quiz.info[defaultLocale]?.title}`,\\n 77| DifficultyColors[quiz.difficulty],\\n 78| )\\n 79| }\\n 80| \\n 81| function quizNoToBadges(ids: (string | number)[], quizzes: Quiz[], locale: string, absolute = false) {\\n 82| return ids\\n 83| .map(i => quizzes.find(q => q.no === Number(i)))\\n 84| .filter(Boolean)\\n 85| .map(i => quizToBadge(i!, locale, absolute))\\n 86| .join(' ')\\n 87| }\\n 88| \\n 89| function getAllTags(quizzes: Quiz[], locale: string) {\\n 90| const set = new Set<string>()\\n 91| for (const quiz of quizzes) {\\n 92| const info = resolveInfo(quiz, locale)\\n 93| for (const tag of (info?.tags || []))\\n 94| set.add(tag)\\n 95| }\\n 96| return Array.from(set).sort()\\n 97| }\\n 98| \\n 99| function getQuizzesByTag(quizzes: Quiz[], locale: string, tag: string) {\\n 100| return quizzes.filter((quiz) => {\\n 101| const info = resolveInfo(quiz, locale)\\n 102| return !!info.tags?.includes(tag)\\n 103| })\\n 104| }\\n 105| \\n 106| async function insertInfoReadme(filepath: string, quiz: Quiz, locale: SupportedLocale, quizzes: Quiz[]) {\\n 107| if (!fs.existsSync(filepath))\\n 108| return\\n 109| let text = await fs.readFile(filepath, 'utf-8')\\n 110| /* eslint-disable prefer-template */\\n 111| \\n 112| if (!text.match(/<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/))\\n 113| text = `<!--info-header-start--><!--info-header-end-->\\\\n\\\\n${text}`\\n 114| if (!text.match(/<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/))\\n 115| text = `${text}\\\\n\\\\n<!--info-footer-start--><!--info-footer-end-->`\\n 116| \\n 117| const info = resolveInfo(quiz, locale)\\n 118| \\n 119| const availableLocales = supportedLocales.filter(l => l !== locale).filter(l => !!quiz.readme[l])\\n 120| \\n 121| text = text\\n 122| .replace(\\n 123| /<!--info-header-start-->[\\\\s\\\\S]*<!--info-header-end-->/,\\n 124| '<!--info-header-start-->'\\n 125| + `<h1>${escapeHtml(info.title || '')} ${toDifficultyBadge(quiz.difficulty, locale)} ${(info.tags || []).map(i => toBadge('', `#${i}`, '999')).join(' ')}</h1>`\\n 126| + `<blockquote><p>${toAuthorInfo(info.author)}</p></blockquote>`\\n 127| + '<p>'\\n 128| + toBadgeLink(toPlayShort(quiz.no, locale), '', t(locale, 'badge.take-the-challenge'), '3178c6', '?logo=typescript&logoColor=white')\\n 129| + (availableLocales.length ? (' ' + availableLocales.map(l => toBadgeLink(toNearborREADME(quiz, l), '', t(l, 'display'), 'gray')).join(' ')) : '')\\n 130| + '</p>'\\n 131| + '<!--info-header-end-->',\\n 132| )\\n 133| .replace(\\n 134| /<!--info-footer-start-->[\\\\s\\\\S]*<!--info-footer-end-->/,\\n 135| '<!--info-footer-start--><br>'\\n 136| + toBadgeLink(`../../${f('README', locale, 'md')}`, '', t(locale, 'badge.back'), 'grey')\\n 137| + toBadgeLink(toAnswerShort(quiz.no, locale), '', t(locale, 'badge.share-your-solutions'), 'teal')\\n 138| + toBadgeLink(toSolutionsShort(quiz.no), '', t(locale, 'badge.checkout-solutions'), 'de5a77', '?logo=awesome-lists&logoColor=white')\\n 139| + (Array.isArray(info.related) && info.related.length ? `<hr><h3>${t(locale, 'readme.related-challenges')}</h3>${quizNoToBadges(info.related, quizzes, locale, true)}` : '')\\n 140| + '<!--info-footer-end-->',\\n 141| )\\n 142| \\n 143| /* eslint-enable prefer-template */\\n 144| \\n 145| await fs.writeFile(filepath, text, 'utf-8')\\n 146| }\\n 147| \\n 148| async function updateIndexREADME(quizzes: Quiz[]) {\\n 149| // update index README\\n 150| for (const locale of supportedLocales) {\\n 151| const filepath = path.resolve(__dirname, '..', f('README', locale, 'md'))\\n 152| \\n 153| let challengesREADME = ''\\n 154| let prev = ''\\n 155| \\n 156| // difficulty\\n 157| const quizzesByDifficulty = [...quizzes].sort((a, b) => DifficultyRank.indexOf(a.difficulty) - DifficultyRank.indexOf(b.difficulty))\\n 158| \\n 159| for (const quiz of quizzesByDifficulty) {\\n 160| if (prev !== quiz.difficulty)\\n 161| challengesREADME += `${prev ? '<br><br>' : ''}${toDifficultyBadgeInverted(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}<br>`\\n 162| \\n 163| challengesREADME += quizToBadge(quiz, locale)\\n 164| \\n 165| prev = quiz.difficulty\\n 166| }\\n 167| \\n 168| // by tags\\n 169| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-tags', locale)}</summary><br><table><tbody>`\\n 170| const tags = getAllTags(quizzes, locale)\\n 171| for (const tag of tags) {\\n 172| challengesREADME += `<tr><td>${toBadge('', `#${tag}`, '999')}</td><td>`\\n 173| getQuizzesByTag(quizzesByDifficulty, locale, tag)\\n 174| .forEach((quiz) => {\\n 175| challengesREADME += quizToBadge(quiz, locale)\\n 176| })\\n 177| challengesREADME += '</td></tr>'\\n 178| }\\n 179| challengesREADME += '<tr><td><code> </code></td><td></td></tr>'\\n 180| challengesREADME += '</tbody></table></details>'\\n 181| \\n 182| // by plain text\\n 183| prev = ''\\n 184| challengesREADME += `<br><details><summary>${toDetailsInnerText('by-plain-text', locale)}</summary><br>`\\n 185| for (const quiz of quizzesByDifficulty) {\\n 186| if (prev !== quiz.difficulty)\\n 187| challengesREADME += `${prev ? '</ul>' : ''}<h3>${toDifficultyPlainText(quiz.difficulty, locale, quizzesByDifficulty.filter(q => q.difficulty === quiz.difficulty).length)}</h3><ul>`\\n 188| challengesREADME += `<li>${quizToBadge(quiz, locale, false, false)}</li>`\\n 189| prev = quiz.difficulty\\n 190| }\\n 191| challengesREADME += '</ul></details><br>'\\n 192| \\n 193| let readme = await fs.readFile(filepath, 'utf-8')\\n 194| readme = readme.replace(\\n 195| /<!--challenges-start-->[\\\\s\\\\S]*<!--challenges-end-->/m,\\n 196| `<!--challenges-start-->\\\\n${challengesREADME}\\\\n<!--challenges-end-->`,\\n 197| )\\n 198| await fs.writeFile(filepath, readme, 'utf-8')\\n 199| }\\n 200| }\\n 201| \\n 202| async function updateQuestionsREADME(quizzes: Quiz[]) {\\n 203| const questionsDir = path.resolve(__dirname, '../questions')\\n 204| \\n 205| // update each questions' readme\\n 206| for (const quiz of quizzes) {\\n 207| for (const locale of supportedLocales) {\\n 208| await insertInfoReadme(\\n 209| path.join(\\n 210| questionsDir,\\n 211| quiz.path,\\n 212| f('README', locale, 'md'),\\n 213| ),\\n 214| quiz,\\n 215| locale,\\n 216| quizzes,\\n 217| )\\n 218| }\\n 219| }\\n 220| }\\n 221| \\n 222| export async function updateREADMEs(type?: 'quiz' | 'index') {\\n 223| const quizzes = await loadQuizzes()\\n 224| quizzes.sort((a, b) => a.no - b.no)\\n 225| \\n 226| if (type === 'quiz') {\\n 227| await updateQuestionsREADME(quizzes)\\n 228| }\\n 229| else if (type === 'index') {\\n 230| await updateIndexREADME(quizzes)\\n 231| }\\n 232| else {\\n 233| await Promise.all([\\n 234| updateIndexREADME(quizzes),\\n 235| updateQuestionsREADME(quizzes),\\n 236| ])\\n 237| }\\n 238| }\\n 239| \\n 240| updateREADMEs(process.argv.slice(2)[0] as any)\\n```\\n\\n### FILE: scripts/toUrl.ts (85 lines)\\n\\n```\\n 1| import lzs from 'lz-string'\\n 2| import type { Quiz } from './types'\\n 3| import { defaultLocale } from './locales'\\n 4| import { resolveInfo } from './loader'\\n 5| \\n 6| export const REPO = 'https://github.com/type-challenges/type-challenges'\\n 7| export const DOMAIN = 'https://tsch.js.org'\\n 8| export const TYPESCRIPT_PLAYGROUND = 'https://www.typescriptlang.org/play'\\n 9| \\n 10| // https://github.com/microsoft/TypeScript-Website/tree/v2/packages/playground\\n 11| export function toPlaygroundUrl(\\n 12| code: string,\\n 13| config: Object = {},\\n 14| site = TYPESCRIPT_PLAYGROUND,\\n 15| ) {\\n 16| return `${site}?${Object.entries(config).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}#code/${lzs.compressToEncodedURIComponent(code)}`\\n 17| }\\n 18| \\n 19| export function toSolutionsFull(no: number) {\\n 20| return `${REPO}/issues?q=label%3A${no}+label%3Aanswer+sort%3Areactions-%2B1-desc`\\n 21| }\\n 22| \\n 23| export function toQuizREADME(quiz: Quiz, locale?: string, absolute = false) {\\n 24| const prefix = absolute ? `${REPO}/blob/main` : '.'\\n 25| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 26| ? `${prefix}/questions/${quiz.path}/README.${locale}.md`\\n 27| : `${prefix}/questions/${quiz.path}/README.md`\\n 28| }\\n 29| \\n 30| export function toRawREADME(quiz: Quiz, locale?: string) {\\n 31| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\\n 32| // const provider = 'https://raw.githubusercontent.com/type-challenges/type-challenges/main'\\n 33| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 34| ? `${provider}/questions/${quiz.path}/README.${locale}.md`\\n 35| : `${provider}/questions/${quiz.path}/README.md`\\n 36| }\\n 37| \\n 38| export function toQuestionsRawREADME(locale?: string) {\\n 39| const provider = 'https://cdn.jsdelivr.net/gh/type-challenges/type-challenges'\\n 40| return locale && locale !== defaultLocale ? `${provider}/README.${locale}.md` : `${provider}/README.md`\\n 41| }\\n 42| \\n 43| export function toNearborREADME(quiz: Quiz, locale?: string) {\\n 44| return locale && locale !== defaultLocale && quiz.readme[locale]\\n 45| ? `./README.${locale}.md`\\n 46| : './README.md'\\n 47| }\\n 48| \\n 49| export function toShareAnswerFull(quiz: Quiz, locale: string = defaultLocale) {\\n 50| const info = resolveInfo(quiz, locale)\\n 51| if (locale === defaultLocale)\\n 52| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=0-answer.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\\n 53| else\\n 54| return `https://github.com/type-challenges/type-challenges/issues/new?labels=answer,${encodeURIComponent(locale)}&template=1-answer.${locale}.md&title=${encodeURIComponent(`${quiz.no} - ${info.title}`)}`\\n 55| }\\n 56| \\n 57| // Short\\n 58| \\n 59| export function toReadmeShort(no: number, locale?: string) {\\n 60| return locale !== defaultLocale\\n 61| ? `${DOMAIN}/${no}/${locale}`\\n 62| : `${DOMAIN}/${no}`\\n 63| }\\n 64| \\n 65| export function toSolutionsShort(no: number) {\\n 66| return `${DOMAIN}/${no}/solutions`\\n 67| }\\n 68| \\n 69| export function toPlayShort(no: number, locale?: string) {\\n 70| return locale !== defaultLocale\\n 71| ? `${DOMAIN}/${no}/play/${locale}`\\n 72| : `${DOMAIN}/${no}/play`\\n 73| }\\n 74| \\n 75| export function toAnswerShort(no: number, locale?: string) {\\n 76| return locale !== defaultLocale\\n 77| ? `${DOMAIN}/${no}/answer/${locale}`\\n 78| : `${DOMAIN}/${no}/answer`\\n 79| }\\n 80| \\n 81| export function toHomepageShort(locale?: string) {\\n 82| return locale !== defaultLocale\\n 83| ? `${DOMAIN}/${locale}`\\n 84| : `${DOMAIN}`\\n 85| }\\n```\\n\\n### FILE: scripts/translate.ts (73 lines)\\n\\n```\\n 1| import path from 'node:path'\\n 2| import fs from 'fs-extra'\\n 3| import { translate } from '@vitalets/google-translate-api'\\n 4| import { QUIZ_ROOT, loadQuizByNo, loadQuizzes } from './loader'\\n 5| import { resolveFilePath } from './utils/resolve'\\n 6| import type { Quiz } from './types'\\n 7| import type { SupportedLocale } from './locales'\\n 8| import { t } from './locales'\\n 9| \\n 10| export async function translateQuizByNo(no: number, from: SupportedLocale, to: SupportedLocale) {\\n 11| const quiz = await loadQuizByNo(no)\\n 12| if (!quiz)\\n 13| throw new Error(`Quiz #${no} not founded`)\\n 14| return await translateQuiz(quiz, from, to)\\n 15| }\\n 16| \\n 17| export async function translateQuiz(quiz: Quiz, from: SupportedLocale, to: SupportedLocale) {\\n 18| let translatedReadme = await translateMarkdown(quiz.readme[from], from, to)\\n 19| \\n 20| if (!translatedReadme)\\n 21| throw new Error(`Quiz #${quiz.no} empty translation`)\\n 22| \\n 23| translatedReadme = `> ${t(to, 'readme.google-translated')}\\\\n\\\\n${translatedReadme.trim()}`\\n 24| \\n 25| const readmePath = resolveFilePath(path.join(QUIZ_ROOT, quiz.path), 'README', 'md', to)\\n 26| await fs.writeFile(readmePath, translatedReadme, 'utf-8')\\n 27| \\n 28| console.log(`Translated [${quiz.no}] ${from} → ${to} | saved to ${readmePath}`)\\n 29| }\\n 30| \\n 31| export async function translateMarkdown(code: string, from: SupportedLocale, to: SupportedLocale) {\\n 32| // to replace the code blocks intro a placeholder then feed it into translator\\n 33| // then replace back for the results\\n 34| const codeBlocks: string[] = []\\n 35| \\n 36| const source = code\\n 37| .replace(/```[\\\\s\\\\S\\\\n]+?```/g, (v) => {\\n 38| const placeholder = `__${codeBlocks.length}__`\\n 39| codeBlocks.push(v)\\n 40| return placeholder\\n 41| })\\n 42| .replace(/`[\\\\s\\\\S\\\\n]+?`/g, (v) => {\\n 43| const placeholder = `__${codeBlocks.length}__`\\n 44| codeBlocks.push(v)\\n 45| return placeholder\\n 46| })\\n 47| \\n 48| const { text } = await translate(source, {\\n 49| from,\\n 50| to,\\n 51| })\\n 52| \\n 53| if (!text)\\n 54| return\\n 55| \\n 56| const result = text.replace(/__\\\\s*?(\\\\d+?)\\\\s*?__/g, (_, i) => codeBlocks[+i])\\n 57| \\n 58| return result\\n 59| }\\n 60| \\n 61| export async function translateAllQuizzes(from: SupportedLocale, to: SupportedLocale) {\\n 62| const quizzes = await loadQuizzes()\\n 63| \\n 64| for (const quiz of quizzes) {\\n 65| if (quiz.readme[to] || !quiz.readme[from]) {\\n 66| console.log(`Skipped #${quiz.no}`)\\n 67| continue\\n 68| }\\n 69| \\n 70| console.log(`Translating #${quiz.no} to ${to}`)\\n 71| await translateQuiz(quiz, from, to)\\n 72| }\\n 73| }\\n```\\n\\n### FILE: scripts/types.ts (38 lines)\\n\\n```\\n 1| import type { DeepPartial } from 'utility-types'\\n 2| import type { context, getOctokit } from '@actions/github'\\n 3| import type Core from '@actions/core'\\n 4| import type IO from '@actions/io'\\n 5| \\n 6| export type Github = ReturnType<typeof getOctokit>\\n 7| export type Context = typeof context\\n 8| export type Action = (github: Github, context: Context, core: typeof Core, io: typeof IO) => Promise<void>\\n 9| \\n 10| export interface QuizMetaInfo {\\n 11| title: string\\n 12| author: {\\n 13| name: string\\n 14| email: string\\n 15| github: string\\n 16| }\\n 17| tsconfig?: Record<string, any>\\n 18| original_issues: number[]\\n 19| recommended_solutions: number[]\\n 20| tags: string[]\\n 21| related?: string[]\\n 22| }\\n 23| \\n 24| export type Difficulty = 'warm' | 'easy' | 'medium' | 'hard' | 'extreme' | 'pending'\\n 25| \\n 26| export interface Quiz {\\n 27| no: number\\n 28| difficulty: Difficulty\\n 29| path: string\\n 30| readme: Record<string, string>\\n 31| template: string\\n 32| info: Record<string, DeepPartial<QuizMetaInfo> | undefined>\\n 33| tests?: string\\n 34| solutions?: {\\n 35| code?: string\\n 36| readme?: Record<string, string>\\n 37| }\\n 38| }\\n```\\n\\n### FILE: utils/index.d.test.ts (35 lines)\\n\\n```\\n 1| import type { Alike, Equal, Expect, ExpectFalse, IsAny, NotEqual } from './index'\\n 2| \\n 3| type cases = [\\n 4| /* Expect */\\n 5| Expect<true>,\\n 6| // @ts-expect-error\\n 7| Expect<false>,\\n 8| \\n 9| /* ExpectFalse */\\n 10| ExpectFalse<false>,\\n 11| // @ts-expect-error\\n 12| ExpectFalse<true>,\\n 13| \\n 14| /* Equal */\\n 15| Expect<Equal<true, true>>,\\n 16| ExpectFalse<Equal<false, true>>,\\n 17| Expect<Equal<'123', '123'>>,\\n 18| ExpectFalse<Equal<'123', string>>,\\n 19| Expect<Equal<{ a: number }, { a: number }>>,\\n 20| ExpectFalse<Equal<{ a: number }, { b: number }>>,\\n 21| ExpectFalse<Equal<any, '123'>>,\\n 22| ExpectFalse<Equal<any, unknown>>,\\n 23| \\n 24| /* Not Equal */\\n 25| Expect<NotEqual<false, true>>,\\n 26| ExpectFalse<NotEqual<true, true>>,\\n 27| \\n 28| /* IsAny */\\n 29| Expect<IsAny<any>>,\\n 30| ExpectFalse<IsAny<1>>,\\n 31| \\n 32| /* Alike */\\n 33| Expect<Alike<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\\n 34| ExpectFalse<Equal<{ a: 1 } & { b: 2 }, { a: 1, b: 2 }>>,\\n 35| ]\\n```\\n\\n### FILE: utils/index.d.ts (29 lines)\\n\\n```\\n 1| export type Expect<T extends true> = T\\n 2| export type ExpectTrue<T extends true> = T\\n 3| export type ExpectFalse<T extends false> = T\\n 4| export type IsTrue<T extends true> = T\\n 5| export type IsFalse<T extends false> = T\\n 6| \\n 7| export type Equal<X, Y> =\\n 8| (<T>() => T extends X ? 1 : 2) extends\\n 9| (<T>() => T extends Y ? 1 : 2) ? true : false\\n 10| export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true\\n 11| \\n 12| // https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\\n 13| export type IsAny<T> = 0 extends (1 & T) ? true : false\\n 14| export type NotAny<T> = true extends IsAny<T> ? false : true\\n 15| \\n 16| export type Debug<T> = { [K in keyof T]: T[K] }\\n 17| export type MergeInsertions<T> =\\n 18| T extends object\\n 19| ? { [K in keyof T]: MergeInsertions<T[K]> }\\n 20| : T\\n 21| \\n 22| export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>\\n 23| \\n 24| export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE ? true : false\\n 25| export type ExpectValidArgs<FUNC extends (...args: any[]) => any, ARGS extends any[]> = ARGS extends Parameters<FUNC>\\n 26| ? true\\n 27| : false\\n 28| \\n 29| export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never\\n```\\n<END_OF_CONTEXT>\\n\\n<query>\\nGenerate a wiki page explaining WHY this codebase is designed the way it is: the constraints it balances, the patterns it uses and what problems they solve, and the trade-offs visible in the code.\\n</query>\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"# Type Challenges Codebase Design Analysis\\n\\n## Overview\\n\\nThe type-challenges repository is a TypeScript learning platform that presents type manipulation challenges with automated testing. The codebase balances several constraints: developer experience, internationalization, maintainability, and performance. It uses a modular architecture with clear separation of concerns between challenge definition, generation, and presentation layers.\\n\\n## Detailed Analysis\\n\\n### Architecture and Design Patterns\\n\\nThe codebase follows a **modular monolith pattern** with distinct responsibilities:\\n\\n1. **Challenge Definition Layer** (`questions/` directory structure)\\n2. **Generation/Build Layer** (`scripts/` directory)\\n3. **Presentation Layer** (README generation, URL routing)\\n\\nThe core design decision is to store challenges as **directory-based structures** with metadata files. Each challenge is organized in a folder named with a pattern like `00002-medium-return-type`, where:\\n- `00002` is the challenge number\\n- `medium` is the difficulty level\\n- `return-type` is the challenge topic\\n\\nThis structure allows for **scalable organization** of challenges while maintaining a clear hierarchy. The `scripts/loader.ts` file demonstrates this pattern by using `fast-glob` to discover and load challenges based on directory naming conventions (`{0..9}*-*`).\\n\\n### Internationalization Strategy\\n\\nThe codebase implements **locale-aware content management** through the `scripts/locales.ts` module, which supports multiple languages including English, Chinese, Japanese, Korean, and Portuguese. The internationalization strategy is:\\n\\n1. **File-based localization**: Each challenge has localized README files (`README.zh-CN.md`, `README.ja.md`, etc.)\\n2. **Metadata localization**: `info.yml` files contain localized metadata\\n3. **Dynamic fallback**: The `resolveInfo` function in `scripts/loader.ts` implements a fallback mechanism that prioritizes locale-specific content over default content\\n\\nThis approach ensures that challenges can be easily translated while maintaining a consistent structure. The `loadLocaleVariations` function in `scripts/loader.ts:14` handles the loading of localized files with appropriate fallbacks.\\n\\n### Build and Generation Process\\n\\nThe build process in `scripts/build.ts` demonstrates a **static site generation approach** with URL routing:\\n\\n1. **Code Generation**: `formatToCode` in `scripts/actions/utils/formatToCode.ts` combines challenge metadata, templates, and test cases into a single TypeScript file\\n2. **URL Generation**: Functions in `scripts/toUrl.ts` create both short URLs and playground links\\n3. **Redirect Management**: The build process generates `_redirects` file for Netlify deployment\\n\\nThe `build()` function in `scripts/build.ts:8` orchestrates this process by:\\n- Loading all quizzes using `loadQuizzes()` \\n- Generating code snippets for each locale\\n- Creating playground URLs for TypeScript Playground integration\\n- Setting up redirects for web navigation\\n\\n### Challenge Structure and Testing\\n\\nEach challenge follows a consistent structure:\\n1. **Metadata** in `info.yml` (title, author, tags, difficulty)\\n2. **Template** in `template.ts` (the starting point for the challenge)\\n3. **Test cases** in `test-cases.ts` (the validation logic)\\n4. **Documentation** in `README.md` (the challenge description)\\n\\nThe test cases use a custom utility type system in `utils/index.d.ts` that provides strong type checking for challenge solutions. The `Equal` type alias in `utils/index.d.ts:7-9` implements a sophisticated type equality check using conditional types and function signatures, ensuring that challenge solutions must match expected types exactly.\\n\\n### Trade-offs and Constraints\\n\\n#### Performance vs. Developer Experience\\nThe codebase makes trade-offs between performance and developer experience:\\n- **Large test suite**: The `utils/index.d.test.ts` file contains 35 test cases that validate the utility types, ensuring robustness but potentially slowing down compilation\\n- **Code generation**: The build process generates code snippets for playground use, which adds build time but improves user experience\\n\\n#### Flexibility vs. Consistency\\nThe directory structure provides consistency across challenges but limits flexibility:\\n- All challenges must follow the same naming convention (`{number}-{difficulty}-{topic}`)\\n- All challenges must have the same file structure (README, template, test-cases)\\n- This constraint makes it easy to generate and maintain challenges but reduces customization options\\n\\n#### Localization vs. Maintenance Overhead\\nThe internationalization system adds significant maintenance overhead:\\n- Each challenge requires multiple localized files\\n- The `loadLocaleVariations` function in `scripts/loader.ts:14` must handle multiple file loading scenarios\\n- The `resolveInfo` function in `scripts/loader.ts:107` handles complex fallback logic for metadata\\n\\n### Key Design Decisions\\n\\n#### 1. TypeScript Playground Integration\\nThe decision to integrate with TypeScript Playground (`scripts/toUrl.ts:11-17`) was made to provide an immediate coding environment. The `toPlaygroundUrl` function uses LZ compression to encode challenge code, making it suitable for URL sharing.\\n\\n#### 2. Test Case Validation System\\nThe custom utility types in `utils/index.d.ts` were designed to provide clear feedback to challenge participants. The `Equal` type implementation (lines 7-9) uses a technique called \\\"conditional type inference\\\" to determine type equality, which is more reliable than simple type comparison.\\n\\n#### 3. Modular File Structure\\nThe separation of concerns between:\\n- `scripts/loader.ts` (challenge loading and parsing)\\n- `scripts/generate-play.ts` (local playground generation)\\n- `scripts/build.ts` (production build and redirects)\\n- `scripts/readme.ts` (README generation)\\n\\nThis modular approach makes it easier to maintain and extend specific functionality without affecting others.\\n\\n## Mermaid Flow Diagram\\n\\n```mermaid\\nflowchart TD\\n A[Challenge Definition] --> B[Directory Structure]\\n B --> C[info.yml]\\n B --> D[README.md]\\n B --> E[template.ts]\\n B --> F[test-cases.ts]\\n \\n A --> G[Build Process]\\n G --> H[scripts/loader.ts]\\n G --> I[scripts/build.ts]\\n G --> J[scripts/readme.ts]\\n G --> K[scripts/generate-play.ts]\\n \\n H --> L[Challenge Metadata Loading]\\n I --> M[Static Site Generation]\\n J --> N[README Updates]\\n K --> O[Local Playground Generation]\\n \\n L --> P[scripts/toUrl.ts]\\n M --> P\\n N --> P\\n O --> P\\n \\n P --> Q[TypeScript Playground]\\n P --> R[GitHub Issues]\\n P --> S[Netlify Redirects]\\n P --> T[Local File System]\\n \\n style A fill:#e1f5fe\\n style G fill:#f3e5f5\\n style P fill:#e8f5e9\\n```\\n\\n## Conclusion\\n\\nThe type-challenges codebase demonstrates a well-thought-out approach to building a scalable TypeScript learning platform. The design balances multiple constraints:\\n\\n1. **Scalability**: Directory-based organization allows for easy addition of new challenges\\n2. **Maintainability**: Clear separation of concerns makes the codebase easy to understand and modify\\n3. **Internationalization**: Robust locale support enables global reach\\n4. **Developer Experience**: Integration with TypeScript Playground and clear test validation provide immediate feedback\\n\\nThe architecture shows that the team prioritized consistency and automation over flexibility, which is appropriate for a learning platform where predictable behavior and clear expectations are important. The trade-offs made—such as the maintenance overhead of localization and the performance cost of comprehensive testing—reflect the project's primary goal of being an educational tool rather than a high-performance application.\"\n }\n]","isConversational":true},"source":{"kind":"string","value":"type-challenges/type-challenges"},"category":{"kind":"string","value":"design_rationale"},"quality_score":{"kind":"number","value":100,"string":"100"},"citation_stats":{"kind":"string","value":"{\n \"total_citations\": 5,\n \"validity_rate\": 1,\n \"invalid\": []\n}"},"license":{"kind":"string","value":"MIT"},"language":{"kind":"string","value":"typescript"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":0,"numItemsPerPage":100,"numTotalItems":313,"offset":0,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sInJlcG9JZHMiOlsiNmFjNDRkMzc1YjNkMTc0YWY5MmE4NjkyIl0sImlhdCI6MTc5MjA0ODU2MCwianRpIjoiMjRiMmM4NWUtYzY3Zi00NmM3LWI3MTItNWYxOTIzMzIzMTM0Iiwic3ViIjoiL2RhdGFzZXRzL0dob3N0U2NpZW50aXN0L3NlbWFudGljd2lraS1kYXRhLXYzIiwiZXhwIjoxNzkyMDUyMTYwLCJpc3MiOiJodHRwczovL2h1Z2dpbmdmYWNlLmNvIn0.EZxnouKroWKVzGiy3kDVPHBaE6X1ZY8y3xJsUmdIsA92dWwTAkJCX7q79TIinbIBElb70fdopwlIe4O8kbN3DA","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":313,"numBytesParquet":16308038}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
messages listlengths 3 3 | source stringlengths 9 49 | category stringclasses 4
values | quality_score int64 80 100 | citation_stats dict | license stringclasses 3
values | language stringclasses 7
values |
|---|---|---|---|---|---|---|
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | nvbn/thefuck | module_deep_dive | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | nvbn/thefuck | design_rationale | 100 | {
"total_citations": 2,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | sherlock-project/sherlock | architecture_overview | 100 | {
"total_citations": 8,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | sherlock-project/sherlock | module_deep_dive | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | sherlock-project/sherlock | data_flow | 100 | {
"total_citations": 6,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | sherlock-project/sherlock | design_rationale | 100 | {
"total_citations": 12,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | Panniantong/Agent-Reach | architecture_overview | 100 | {
"total_citations": 3,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | Panniantong/Agent-Reach | module_deep_dive | 100 | {
"total_citations": 1,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | Panniantong/Agent-Reach | data_flow | 100 | {
"total_citations": 4,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | Panniantong/Agent-Reach | design_rationale | 100 | {
"total_citations": 1,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | D4Vinci/Scrapling | architecture_overview | 100 | {
"total_citations": 3,
"validity_rate": 1,
"invalid": []
} | BSD-3-Clause | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | D4Vinci/Scrapling | module_deep_dive | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | BSD-3-Clause | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | D4Vinci/Scrapling | design_rationale | 100 | {
"total_citations": 4,
"validity_rate": 1,
"invalid": []
} | BSD-3-Clause | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | Z4nzu/hackingtool | module_deep_dive | 100 | {
"total_citations": 13,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | Z4nzu/hackingtool | data_flow | 100 | {
"total_citations": 13,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | Z4nzu/hackingtool | design_rationale | 100 | {
"total_citations": 15,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | abi/screenshot-to-code | architecture_overview | 100 | {
"total_citations": 13,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | abi/screenshot-to-code | module_deep_dive | 100 | {
"total_citations": 7,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | abi/screenshot-to-code | data_flow | 100 | {
"total_citations": 15,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | abi/screenshot-to-code | design_rationale | 100 | {
"total_citations": 7,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | shareAI-lab/learn-claude-code | architecture_overview | 100 | {
"total_citations": 16,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | shareAI-lab/learn-claude-code | module_deep_dive | 100 | {
"total_citations": 12,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | shareAI-lab/learn-claude-code | data_flow | 100 | {
"total_citations": 1,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | shareAI-lab/learn-claude-code | design_rationale | 100 | {
"total_citations": 2,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | hiyouga/LlamaFactory | architecture_overview | 100 | {
"total_citations": 11,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | hiyouga/LlamaFactory | module_deep_dive | 100 | {
"total_citations": 4,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | hiyouga/LlamaFactory | data_flow | 100 | {
"total_citations": 7,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | hiyouga/LlamaFactory | design_rationale | 100 | {
"total_citations": 19,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | pallets/flask | architecture_overview | 88 | {
"total_citations": 8,
"validity_rate": 0.875,
"invalid": [
{
"file": "src/flask/ctx.py",
"start": 1,
"end": 1000,
"error": "line-out-of-bounds(540)"
}
]
} | BSD-3-Clause | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | pallets/flask | data_flow | 100 | {
"total_citations": 6,
"validity_rate": 1,
"invalid": []
} | BSD-3-Clause | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | pallets/flask | design_rationale | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | BSD-3-Clause | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | usestrix/strix | architecture_overview | 100 | {
"total_citations": 2,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | usestrix/strix | data_flow | 100 | {
"total_citations": 9,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | usestrix/strix | design_rationale | 100 | {
"total_citations": 1,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | virattt/ai-hedge-fund | architecture_overview | 100 | {
"total_citations": 10,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | virattt/ai-hedge-fund | module_deep_dive | 100 | {
"total_citations": 6,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | virattt/ai-hedge-fund | design_rationale | 100 | {
"total_citations": 7,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | karpathy/nanoGPT | architecture_overview | 100 | {
"total_citations": 14,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | karpathy/nanoGPT | module_deep_dive | 100 | {
"total_citations": 32,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | karpathy/nanoGPT | data_flow | 97 | {
"total_citations": 38,
"validity_rate": 0.974,
"invalid": [
{
"file": "model.py",
"start": 183,
"end": 183,
"error": "empty-cited-lines"
}
]
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | karpathy/nanoGPT | design_rationale | 100 | {
"total_citations": 6,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | RVC-Boss/GPT-SoVITS | architecture_overview | 100 | {
"total_citations": 15,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | RVC-Boss/GPT-SoVITS | module_deep_dive | 100 | {
"total_citations": 6,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | RVC-Boss/GPT-SoVITS | data_flow | 100 | {
"total_citations": 1,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | MemPalace/mempalace | architecture_overview | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | MemPalace/mempalace | data_flow | 90 | {
"total_citations": 10,
"validity_rate": 0.9,
"invalid": [
{
"file": "mempalace/backends/chroma.py",
"start": 455,
"end": 434,
"error": "line-out-of-bounds(4460)"
}
]
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | MemPalace/mempalace | design_rationale | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | FoundationAgents/OpenManus | architecture_overview | 100 | {
"total_citations": 7,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | FoundationAgents/OpenManus | module_deep_dive | 100 | {
"total_citations": 19,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | FoundationAgents/OpenManus | data_flow | 100 | {
"total_citations": 1,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | FoundationAgents/OpenManus | design_rationale | 100 | {
"total_citations": 13,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | karpathy/nanochat | architecture_overview | 100 | {
"total_citations": 14,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | karpathy/nanochat | module_deep_dive | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | karpathy/nanochat | data_flow | 100 | {
"total_citations": 20,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | karpathy/nanochat | design_rationale | 100 | {
"total_citations": 11,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | psf/requests | architecture_overview | 100 | {
"total_citations": 6,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | psf/requests | module_deep_dive | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | psf/requests | data_flow | 100 | {
"total_citations": 6,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | xai-org/grok-1 | architecture_overview | 100 | {
"total_citations": 22,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | xai-org/grok-1 | module_deep_dive | 100 | {
"total_citations": 17,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | xai-org/grok-1 | data_flow | 100 | {
"total_citations": 24,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | xai-org/grok-1 | design_rationale | 100 | {
"total_citations": 8,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | charlax/professional-programming | module_deep_dive | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | charlax/professional-programming | design_rationale | 100 | {
"total_citations": 2,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | microsoft/qlib | architecture_overview | 100 | {
"total_citations": 12,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | microsoft/qlib | design_rationale | 100 | {
"total_citations": 8,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | zhayujie/CowAgent | architecture_overview | 100 | {
"total_citations": 1,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | 9001/copyparty | architecture_overview | 100 | {
"total_citations": 4,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | 9001/copyparty | module_deep_dive | 91 | {
"total_citations": 11,
"validity_rate": 0.909,
"invalid": [
{
"file": "authsrv.py",
"start": 125,
"end": 125,
"error": "file-not-found"
}
]
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | 9001/copyparty | data_flow | 100 | {
"total_citations": 4,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | 9001/copyparty | design_rationale | 96 | {
"total_citations": 27,
"validity_rate": 0.963,
"invalid": [
{
"file": "copyparty/util.py",
"start": 36,
"end": 36,
"error": "empty-cited-lines"
}
]
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | MadsLorentzen/ai-job-search | architecture_overview | 100 | {
"total_citations": 13,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | MadsLorentzen/ai-job-search | module_deep_dive | 100 | {
"total_citations": 1,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | MadsLorentzen/ai-job-search | data_flow | 100 | {
"total_citations": 23,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | MadsLorentzen/ai-job-search | design_rationale | 100 | {
"total_citations": 3,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | psf/black | architecture_overview | 100 | {
"total_citations": 7,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | psf/black | module_deep_dive | 100 | {
"total_citations": 21,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | psf/black | data_flow | 100 | {
"total_citations": 12,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | psf/black | design_rationale | 100 | {
"total_citations": 8,
"validity_rate": 1,
"invalid": []
} | MIT | python |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | OpenCut-app/OpenCut | architecture_overview | 100 | {
"total_citations": 8,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | OpenCut-app/OpenCut | module_deep_dive | 100 | {
"total_citations": 11,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | OpenCut-app/OpenCut | data_flow | 86 | {
"total_citations": 7,
"validity_rate": 0.857,
"invalid": [
{
"file": "shell.rs",
"start": 6,
"end": 8,
"error": "file-not-found"
}
]
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | OpenCut-app/OpenCut | design_rationale | 100 | {
"total_citations": 19,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | ChatGPTNextWeb/NextChat | architecture_overview | 100 | {
"total_citations": 4,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | ChatGPTNextWeb/NextChat | module_deep_dive | 100 | {
"total_citations": 22,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | ChatGPTNextWeb/NextChat | data_flow | 100 | {
"total_citations": 6,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | Fission-AI/OpenSpec | architecture_overview | 100 | {
"total_citations": 4,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | Fission-AI/OpenSpec | design_rationale | 100 | {
"total_citations": 8,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | pmndrs/zustand | architecture_overview | 100 | {
"total_citations": 8,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | pmndrs/zustand | module_deep_dive | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | pmndrs/zustand | data_flow | 100 | {
"total_citations": 8,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | pmndrs/zustand | design_rationale | 100 | {
"total_citations": 8,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | ChromeDevTools/chrome-devtools-mcp | architecture_overview | 100 | {
"total_citations": 12,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | ChromeDevTools/chrome-devtools-mcp | module_deep_dive | 100 | {
"total_citations": 3,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | ChromeDevTools/chrome-devtools-mcp | data_flow | 100 | {
"total_citations": 4,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | ChromeDevTools/chrome-devtools-mcp | design_rationale | 100 | {
"total_citations": 7,
"validity_rate": 1,
"invalid": []
} | Apache-2.0 | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | type-challenges/type-challenges | architecture_overview | 100 | {
"total_citations": 6,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | type-challenges/type-challenges | module_deep_dive | 100 | {
"total_citations": 16,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | type-challenges/type-challenges | data_flow | 91 | {
"total_citations": 11,
"validity_rate": 0.909,
"invalid": [
{
"file": "scripts/loader.ts",
"start": 145,
"end": 145,
"error": "line-out-of-bounds(117)"
}
]
} | MIT | typescript |
[
{
"role": "system",
"content": [
"You are an expert software architect writing wiki documentation for codebases.\nRequirements:\n1. Every factual claim about the code must carry a source citation in the form `path:line` or `path:start-end` referencing the provided source files.\n2. Include at least on... | type-challenges/type-challenges | design_rationale | 100 | {
"total_citations": 5,
"validity_rate": 1,
"invalid": []
} | MIT | typescript |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.