wip

Author: kainino0x

.gitignore

@@ -1,5 +1,4 @@
 /dist/
 /out/
-/generated/webgpu.ts
 node_modules
 .DS_Store

dist/index.d.ts

@@ -0,0 +1,39 @@
+import fs from 'fs';
+
+async function main() {
+  let ts = fs.readFileSync('generated/index.d.ts', { encoding: 'utf-8' });
+  ts = ts
+    // convert [[#anchor]] to {@link spec_url}
+    // convert [[#anchor|text]] to {@link spec_url|text}
+    .replace(/([^#])\[\[([^\[].*?)\]\]/g, '$1{@link https://www.w3.org/TR/webgpu/$2}')
+
+    // convert {{ref}} to {@link ref}
+    // convert {{ref|text}} to {@link ref|text}
+    .replace(/\{\{(.*?)\}\}/g, '{@link $1}')
+
+    // convert {@link foo/method(...)} to {@link foo#method}
+    .replace(/\{@link ([^[}]+)\/(.*?)\(.*?\)}/g, '{@link $1#$2}')
+
+    // convert {@link foo#[[bar]]} to {@link foo}.`[[bar]]`
+    .replace(/\{@link ([^[}]+)#\[\[(.*?)]]}/g, '{@link $1}.`[[$2]]`')
+
+    // convert {@link foo#"bar"} to {@link foo} `"bar"`
+    .replace(/\{@link ([^[}]+)#"(.*?)"}/g, '{@link $1} `"$2"`')
+
+    // fix links of the form {@link foo|text} -> {@link foo | text}
+    .replace(/\{@link ([^}|]+)\|([^}|]+)\}/g, '{@link $1 | $2}')
+
+    // remove items that are known not to be linkable
+    .replace(/{@link Promise}/g, 'Promise')
+    .replace(/{@link ArrayBuffer}/g, 'ArrayBuffer')
+    .replace(/{@link Uint32Array}/g, 'Uint32Array')
+    .replace(/{@link RenderState}/g, 'RenderState')
+    .replace(/{@link double}/g, '`double`')
+
+    .replace(/<pre highlight=['"]?(.*)['"]?>/g, '```$1')
+    .replace(/<\/pre>/g, '```');
+
+  fs.writeFileSync('generated/index.d.ts', ts);
+}
+
+main();

fix-generated-comments.mjs

@@ -13,7 +13,7 @@
   "scripts": {
     "test": "for t in tests/*/ ; do (cd \"$t\" && npm i && npm test); done",
     "build-docs": "cd tsdoc-src && npm ci && npm run build",
-    "generate": "bikeshed-to-ts --in ./gpuweb/spec/index.bs --out ./generated/index.d.ts --forceGlobal --nominal && prettier -w generated/index.d.ts",
+    "generate": "bikeshed-to-ts --in ./gpuweb/spec/index.bs --out ./generated/index.d.ts --forceGlobal --nominal && node fix-generated-comments.mjs && prettier -w generated/index.d.ts",
     "format": "prettier -w dist/index.d.ts"
   },
   "devDependencies": {

generated/index.d.ts

@@ -1,2 +1 @@
 /out
-/webgpu.ts

package.json

@@ -1,6 +1,6 @@
 {
   "scripts": {
-    "build": "node generate-webgpu-ts.mjs && typedoc --treatWarningsAsErrors ./webgpu.ts"
+    "build": "typedoc --treatWarningsAsErrors ../dist/index.d.ts"
   },
   "devDependencies": {
     "@types/dom-webcodecs": "0.1.3",

tsdoc-src/.gitignore

@@ -19,7 +19,7 @@
     ],
   },
   "include": [
-    "./webgpu.ts"
+    "../dist/index.d.ts"
   ],
   "exclude": [
     "node_modules",