wesl 0.7.26 → 0.7.27

package/README.md

@@ -41,5 +41,5 @@ fn random_color(uv: vec2u) -> vec3f {
 </pre>
 
 [wesl plugin]: https://www.npmjs.com/package/wesl-plugin
-[examples]: https://github.com/wgsl-tooling-wg/wesl-js/tree/main/examples 
+[examples]: https://github.com/webgpu-tools/wesl-js/tree/main/examples 
 [wesl]: https://www.npmjs.com/package/wesl

package/dist/index.d.ts

@@ -279,7 +279,7 @@ type ElemKindMap = {
   type: TypeRefElem;
   var: VarElem;
 };
-/** Inspired by https://github.com/wgsl-tooling-wg/wesl-rs/blob/3b2434eac1b2ebda9eb8bfb25f43d8600d819872/crates/wgsl-parse/src/syntax.rs#L364 */
+/** Inspired by https://github.com/webgpu-tools/wesl-rs/blob/3b2434eac1b2ebda9eb8bfb25f43d8600d819872/crates/wgsl-parse/src/syntax.rs#L364 */
 type ExpressionElem = Literal | RefIdentElem | TypeRefElem | ParenthesizedExpression | ComponentExpression | ComponentMemberExpression | UnaryExpression | BinaryExpression | FunctionCallExpression;
 type TerminalElem = DirectiveElem | DeclIdentElem | NameElem | RefIdentElem | TextElem | ImportElem;
 type GlobalDeclarationElem = AliasElem | ConstElem | FnElem | GlobalVarElem | OverrideElem | StructElem;
@@ -737,7 +737,7 @@ globalNames: Set<string>) => string;
 /**
  * Construct a globally unique name based on the declaration
  * module path separated by underscores.
- * Corresponds to "Underscore-count mangling" from [NameMangling.md](https://github.com/wgsl-tooling-wg/wesl-spec/blob/main/NameMangling.md)
+ * Corresponds to "Underscore-count mangling" from [NameMangling.md](https://github.com/webgpu-tools/wesl-spec/blob/main/NameMangling.md)
  */
 declare function underscoreMangle(decl: DeclIdent, srcModule: SrcModule): string;
 /**
@@ -844,27 +844,15 @@ interface LinkConfig {
   plugins?: WeslJsPlugin[];
 }
 interface LinkParams {
-  /** Module resolver for lazy loading (NEW API - preferred)
-   * Replaces weslSrc for lazy module loading.
-   * If provided, weslSrc will be ignored. */
+  /** Module resolver for lazy loading. If provided, weslSrc is ignored. */
   resolver?: ModuleResolver;
-  /** record of file paths and wesl text for modules (LEGACY API - still supported).
-   *   key is module path or file path
-   *     `package::foo::bar`, or './foo/bar.wesl', or './foo/bar'
-   *   value is wesl src
-   *
-   *
-   * Only accepts unix-style, relative filesystem paths that are valid WGSL identifiers
-   * - Unix-style: Slashes as separators.
-   * - Valid WGSL identifiers: No backslashes, no `..`, or other non-identifier symbols.
-   * - Relative paths: They have to be relative to the wesl root.
-   */
+  /** Record of module sources keyed by module path (`package::foo::bar`)
+   * or relative file path (`./foo/bar.wesl`). Paths must be unix-style,
+   * relative to the wesl root, and valid WGSL identifiers. */
   weslSrc?: Record<string, string>;
-  /** name of root wesl module
-   *    for an app, the root module normally contains the '@compute', '@vertex' or '@fragment' entry points
-   *    for a library, the root module defines the public api fo the library
-   *  can be specified as file path (./main.wesl), a module path (package::main), or just a module name (main)
-   */
+  /** Root module name: file path (`./main.wesl`), module path (`package::main`), or bare name (`main`).
+   * For apps, the root module contains entry points (`@compute`, `@vertex`, `@fragment`).
+   * For libraries, it defines the public API. */
   rootModuleName?: string;
   /** For debug logging. Will be prepended to file paths. */
   debugWeslRoot?: string;
@@ -888,7 +876,9 @@ interface LinkParams {
   mangler?: ManglerFn;
 }
 /** Project config for web components and tools. */
-type WeslProject = Pick<LinkParams, "weslSrc" | "rootModuleName" | "conditions" | "constants" | "libs" | "packageName">;
+type WeslProject = Pick<LinkParams, "weslSrc" | "rootModuleName" | "conditions" | "constants" | "libs" | "packageName"> & {
+  /** Shader directory relative to project root (set by ?link from wesl.toml). */shaderRoot?: string;
+};
 /** Context passed to virtual library generators. */
 interface VirtualLibContext {
   conditions: Conditions;

package/dist/index.js

@@ -283,12 +283,13 @@ const isBrowser = "document" in globalThis;
 /** Throw an error with an embedded source map so that browser users can
 *  click on the error in the browser debug console and see the wesl source code.  */
 function throwClickableError(params) {
-	const { url, text, lineNumber, lineColumn, length, error } = params;
+	const { url, text, lineNumber, lineColumn, length, offset, error } = params;
 	const weslLocation = {
 		file: url,
 		line: lineNumber,
 		column: lineColumn,
-		length
+		length,
+		offset
 	};
 	error.weslLocation = weslLocation;
 	if (!isBrowser) throw error;
@@ -349,6 +350,7 @@ function failIdentElem(identElem, msg = "") {
 		lineNumber,
 		lineColumn,
 		length: end - start,
+		offset: start,
 		error: new Error(detailedMessage)
 	});
 }
@@ -656,7 +658,7 @@ function lowerAndEmitElem(e, ctx) {
 		case "let":
 		case "statement":
 		case "continuing":
-			emitStatement$1(e, ctx);
+			emitStatement(e, ctx);
 			return;
 		case "override":
 		case "const":
@@ -694,7 +696,7 @@ function emitModule(e, ctx) {
 		lowerAndEmitElem(child, ctx);
 	}
 }
-function emitStatement$1(e, ctx) {
+function emitStatement(e, ctx) {
 	if (!(e.contents.length > 0 && e.contents[0].kind === "attribute")) emitAttributes(e.attributes, ctx);
 	emitContents(e, ctx);
 }
@@ -1257,7 +1259,7 @@ function liveDeclsToString(liveDecls) {
 /**
 * Construct a globally unique name based on the declaration
 * module path separated by underscores.
-* Corresponds to "Underscore-count mangling" from [NameMangling.md](https://github.com/wgsl-tooling-wg/wesl-spec/blob/main/NameMangling.md)
+* Corresponds to "Underscore-count mangling" from [NameMangling.md](https://github.com/webgpu-tools/wesl-spec/blob/main/NameMangling.md)
 */
 function underscoreMangle(decl, srcModule) {
 	const { modulePath } = srcModule;
@@ -4468,20 +4470,13 @@ async function link(params) {
 }
 /** linker api for benchmarking */
 function _linkSync(params) {
-	const { weslSrc, libs = [], packageName, debugWeslRoot } = params;
-	const { resolver } = params;
-	const resolvers = [];
-	if (resolver) resolvers.push(resolver);
-	else if (weslSrc) resolvers.push(new RecordResolver(weslSrc, {
+	const { weslSrc, libs = [], packageName, debugWeslRoot, resolver } = params;
+	if (!resolver && !weslSrc) throw new Error("Either resolver or weslSrc must be provided");
+	const allResolvers = [resolver ?? new RecordResolver(weslSrc, {
 		packageName,
 		debugWeslRoot
-	}));
-	else throw new Error("Either resolver or weslSrc must be provided");
-	if (libs.length > 0) {
-		const libResolvers = createLibraryResolvers(libs, debugWeslRoot);
-		resolvers.push(...libResolvers);
-	}
-	const finalResolver = resolvers.length === 1 ? resolvers[0] : new CompositeResolver(resolvers);
+	}), ...createLibraryResolvers(libs, debugWeslRoot)];
+	const finalResolver = allResolvers.length === 1 ? allResolvers[0] : new CompositeResolver(allResolvers);
 	return linkRegistry({
 		...params,
 		resolver: finalResolver
@@ -4565,6 +4560,7 @@ function setupVirtualLibs(virtualLibs, constants) {
 	}
 	return libs && mapValues(libs, (fn) => ({ fn }));
 }
+/** Run registered transform plugins over the bound AST. */
 function applyTransformPlugins(rootModule, globalNames, config) {
 	const { moduleElem, srcModule } = rootModule;
 	const startAst = {
@@ -4577,53 +4573,38 @@ function applyTransformPlugins(rootModule, globalNames, config) {
 }
 /** Assemble WGSL output from prologue statements, root module, and imported declarations. */
 function emitWgsl(rootModuleElem, srcModule, newDecls, newStatements, conditions = {}) {
-	const prologueBuilders = newStatements.map((s) => emitStatement(s, conditions));
-	const rootBuilder = new SrcMapBuilder({
-		text: srcModule.src,
-		path: srcModule.debugFilePath
-	});
+	const prologueBuilders = newStatements.map((s) => emitElem(s.srcModule, s.elem, conditions, { addNl: true }));
+	const rootBuilder = builderFromModule(srcModule);
 	lowerAndEmit({
 		srcBuilder: rootBuilder,
 		rootElems: [rootModuleElem],
 		conditions,
 		extracting: false
 	});
-	const declBuilders = newDecls.map((decl) => emitDecl(decl, conditions));
+	const declBuilders = newDecls.map((decl) => emitElem(decl.srcModule, decl.declElem, conditions, { skipConditionalFiltering: true }));
 	return [
 		...prologueBuilders,
 		rootBuilder,
 		...declBuilders
 	];
 }
-function emitStatement(s, conditions) {
-	const { elem, srcModule } = s;
-	const { src: text, debugFilePath: path } = srcModule;
-	const builder = new SrcMapBuilder({
-		text,
-		path
-	});
+/** Emit a single element (prologue statement or imported declaration) into a SrcMapBuilder. */
+function emitElem(srcModule, elem, conditions, opts = {}) {
+	const builder = builderFromModule(srcModule);
 	lowerAndEmit({
 		srcBuilder: builder,
 		rootElems: [elem],
-		conditions
+		conditions,
+		skipConditionalFiltering: opts.skipConditionalFiltering
 	});
-	builder.addNl();
+	if (opts.addNl) builder.addNl();
 	return builder;
 }
-/** Skip conditional filtering because findValidRootDecls already validated these declarations */
-function emitDecl(decl, conditions) {
-	const { src: text, debugFilePath: path } = decl.srcModule;
-	const builder = new SrcMapBuilder({
-		text,
-		path
-	});
-	lowerAndEmit({
-		srcBuilder: builder,
-		rootElems: [decl.declElem],
-		conditions,
-		skipConditionalFiltering: true
+function builderFromModule(srcModule) {
+	return new SrcMapBuilder({
+		text: srcModule.src,
+		path: srcModule.debugFilePath
 	});
-	return builder;
 }
 //#endregion
 //#region src/LinkerUtil.ts
@@ -4924,6 +4905,7 @@ function makeWeslDevice(device) {
 					lineNumber: message.lineNum,
 					lineColumn: message.linePos,
 					length: message.length,
+					offset: message.offset,
 					error: /* @__PURE__ */ new Error(message.type + ": " + message.message)
 				});
 				else console.error(ev.error.message);

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "wesl",
-  "version": "0.7.26",
+  "version": "0.7.27",
   "type": "module",
   "files": [
     "dist",
     "src"
   ],
-  "repository": "github:wgsl-tooling-wg/wesl-js",
+  "repository": "github:webgpu-tools/wesl-js",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",

package/src/AbstractElems.ts

@@ -52,7 +52,7 @@ export type ElemKindMap = {
   var: VarElem;
 };
 
-/** Inspired by https://github.com/wgsl-tooling-wg/wesl-rs/blob/3b2434eac1b2ebda9eb8bfb25f43d8600d819872/crates/wgsl-parse/src/syntax.rs#L364 */
+/** Inspired by https://github.com/webgpu-tools/wesl-rs/blob/3b2434eac1b2ebda9eb8bfb25f43d8600d819872/crates/wgsl-parse/src/syntax.rs#L364 */
 export type ExpressionElem =
   | Literal
   | RefIdentElem

package/src/ClickableError.ts

@@ -9,6 +9,8 @@ export interface WeslErrorLocation {
   line: number;
   column: number;
   length: number;
+  /** byte offset into the source file */
+  offset: number;
 }
 
 export interface ClickableErrorParams {
@@ -27,6 +29,9 @@ export interface ClickableErrorParams {
   /** number of characters in the error section */
   length: number;
 
+  /** byte offset of the error section within the source text */
+  offset: number;
+
   /** the original error */
   error: Error;
 }
@@ -36,12 +41,13 @@ const isBrowser = "document" in globalThis;
 /** Throw an error with an embedded source map so that browser users can
  *  click on the error in the browser debug console and see the wesl source code.  */
 export function throwClickableError(params: ClickableErrorParams): void {
-  const { url, text, lineNumber, lineColumn, length, error } = params;
+  const { url, text, lineNumber, lineColumn, length, offset, error } = params;
   const weslLocation: WeslErrorLocation = {
     file: url,
     line: lineNumber,
     column: lineColumn,
     length,
+    offset,
   };
   (error as any).weslLocation = weslLocation;
   if (!debug || !isBrowser) throw error;
@@ -142,6 +148,7 @@ export function failIdentElem(
     lineNumber,
     lineColumn,
     length,
+    offset: start,
     error: new Error(detailedMessage),
   });
 }

package/src/Linker.ts

@@ -37,29 +37,17 @@ export interface LinkConfig {
 }
 
 export interface LinkParams {
-  /** Module resolver for lazy loading (NEW API - preferred)
-   * Replaces weslSrc for lazy module loading.
-   * If provided, weslSrc will be ignored. */
+  /** Module resolver for lazy loading. If provided, weslSrc is ignored. */
   resolver?: ModuleResolver;
 
-  /** record of file paths and wesl text for modules (LEGACY API - still supported).
-   *   key is module path or file path
-   *     `package::foo::bar`, or './foo/bar.wesl', or './foo/bar'
-   *   value is wesl src
-   *
-   *
-   * Only accepts unix-style, relative filesystem paths that are valid WGSL identifiers
-   * - Unix-style: Slashes as separators.
-   * - Valid WGSL identifiers: No backslashes, no `..`, or other non-identifier symbols.
-   * - Relative paths: They have to be relative to the wesl root.
-   */
+  /** Record of module sources keyed by module path (`package::foo::bar`)
+   * or relative file path (`./foo/bar.wesl`). Paths must be unix-style,
+   * relative to the wesl root, and valid WGSL identifiers. */
   weslSrc?: Record<string, string>;
 
-  /** name of root wesl module
-   *    for an app, the root module normally contains the '@compute', '@vertex' or '@fragment' entry points
-   *    for a library, the root module defines the public api fo the library
-   *  can be specified as file path (./main.wesl), a module path (package::main), or just a module name (main)
-   */
+  /** Root module name: file path (`./main.wesl`), module path (`package::main`), or bare name (`main`).
+   * For apps, the root module contains entry points (`@compute`, `@vertex`, `@fragment`).
+   * For libraries, it defines the public API. */
   rootModuleName?: string;
 
   /** For debug logging. Will be prepended to file paths. */
@@ -100,7 +88,10 @@ export type WeslProject = Pick<
   | "constants"
   | "libs"
   | "packageName"
->;
+> & {
+  /** Shader directory relative to project root (set by ?link from wesl.toml). */
+  shaderRoot?: string;
+};
 
 /** Context passed to virtual library generators. */
 export interface VirtualLibContext {
@@ -127,26 +118,20 @@ export async function link(params: LinkParams): Promise<LinkedWesl> {
 
 /** linker api for benchmarking */
 export function _linkSync(params: LinkParams): SrcMap {
-  const { weslSrc, libs = [], packageName, debugWeslRoot } = params;
-  const { resolver } = params;
+  const { weslSrc, libs = [], packageName, debugWeslRoot, resolver } = params;
 
-  const resolvers: ModuleResolver[] = [];
-
-  if (resolver) {
-    resolvers.push(resolver);
-  } else if (weslSrc) {
-    resolvers.push(new RecordResolver(weslSrc, { packageName, debugWeslRoot }));
-  } else {
+  if (!resolver && !weslSrc) {
     throw new Error("Either resolver or weslSrc must be provided");
   }
+  const primaryResolver =
+    resolver ?? new RecordResolver(weslSrc!, { packageName, debugWeslRoot });
 
-  if (libs.length > 0) {
-    const libResolvers = createLibraryResolvers(libs, debugWeslRoot);
-    resolvers.push(...libResolvers);
-  }
-
+  const libResolvers = createLibraryResolvers(libs, debugWeslRoot);
+  const allResolvers = [primaryResolver, ...libResolvers];
   const finalResolver =
-    resolvers.length === 1 ? resolvers[0] : new CompositeResolver(resolvers);
+    allResolvers.length === 1
+      ? allResolvers[0]
+      : new CompositeResolver(allResolvers);
 
   return linkRegistry({ ...params, resolver: finalResolver });
 }
@@ -200,11 +185,8 @@ export interface LinkRegistryParams
  * that share some sources.)
  */
 export function linkRegistry(params: LinkRegistryParams): SrcMap {
-  const {
-    transformedAst: ast,
-    newDecls,
-    newStatements,
-  } = bindAndTransform(params);
+  const bound = bindAndTransform(params);
+  const { transformedAst: ast, newDecls, newStatements } = bound;
   const builders = emitWgsl(
     ast.moduleElem,
     ast.srcModule,
@@ -230,7 +212,6 @@ export function bindAndTransform(
 
   const modulePath = normalizeModuleName(rootModuleName);
   const rootAst = getRootModule(resolver, modulePath, rootModuleName);
-
   const virtuals = setupVirtualLibs(params.virtualLibs, constants);
 
   const bound = bindIdents({
@@ -291,14 +272,14 @@ function setupVirtualLibs(
   return libs && mapValues(libs, fn => ({ fn }));
 }
 
+/** Run registered transform plugins over the bound AST. */
 function applyTransformPlugins(
   rootModule: WeslAST,
   globalNames: Set<string>,
   config?: LinkConfig,
 ): TransformedAST {
-  const { moduleElem, srcModule } = rootModule;
-
   // for now only transform the root module
+  const { moduleElem, srcModule } = rootModule;
   const startAst = { moduleElem, srcModule, globalNames, notableElems: {} };
   const plugins = config?.plugins ?? [];
   const transforms = filterMap(plugins, plugin => plugin.transform);
@@ -313,12 +294,11 @@ function emitWgsl(
   newStatements: EmittableElem[],
   conditions: Conditions = {},
 ): SrcMapBuilder[] {
-  const prologueBuilders = newStatements.map(s => emitStatement(s, conditions));
+  const prologueBuilders = newStatements.map(s =>
+    emitElem(s.srcModule, s.elem, conditions, { addNl: true }),
+  );
 
-  const rootBuilder = new SrcMapBuilder({
-    text: srcModule.src,
-    path: srcModule.debugFilePath,
-  });
+  const rootBuilder = builderFromModule(srcModule);
   lowerAndEmit({
     srcBuilder: rootBuilder,
     rootElems: [rootModuleElem],
@@ -326,36 +306,40 @@ function emitWgsl(
     extracting: false,
   });
 
-  const declBuilders = newDecls.map(decl => emitDecl(decl, conditions));
+  const declBuilders = newDecls.map(decl =>
+    emitElem(decl.srcModule, decl.declElem!, conditions, {
+      skipConditionalFiltering: true,
+    }),
+  );
 
   return [...prologueBuilders, rootBuilder, ...declBuilders];
 }
 
-function emitStatement(
-  s: EmittableElem,
+/** Emit a single element (prologue statement or imported declaration) into a SrcMapBuilder. */
+function emitElem(
+  srcModule: SrcModule,
+  elem: AbstractElem,
   conditions: Conditions,
+  opts: { addNl?: boolean; skipConditionalFiltering?: boolean } = {},
 ): SrcMapBuilder {
-  const { elem, srcModule } = s;
-  const { src: text, debugFilePath: path } = srcModule;
-  const builder = new SrcMapBuilder({ text, path });
-  lowerAndEmit({ srcBuilder: builder, rootElems: [elem], conditions });
-  builder.addNl();
-  return builder;
-}
-
-/** Skip conditional filtering because findValidRootDecls already validated these declarations */
-function emitDecl(decl: DeclIdent, conditions: Conditions): SrcMapBuilder {
-  const { src: text, debugFilePath: path } = decl.srcModule;
-  const builder = new SrcMapBuilder({ text, path });
+  const builder = builderFromModule(srcModule);
   lowerAndEmit({
     srcBuilder: builder,
-    rootElems: [decl.declElem!],
+    rootElems: [elem],
     conditions,
-    skipConditionalFiltering: true,
+    skipConditionalFiltering: opts.skipConditionalFiltering,
   });
+  if (opts.addNl) builder.addNl();
   return builder;
 }
 
+function builderFromModule(srcModule: SrcModule): SrcMapBuilder {
+  return new SrcMapBuilder({
+    text: srcModule.src,
+    path: srcModule.debugFilePath,
+  });
+}
+
 /*
 
 LATER

package/src/Mangler.ts

@@ -25,7 +25,7 @@ export type ManglerFn = (
 /**
  * Construct a globally unique name based on the declaration
  * module path separated by underscores.
- * Corresponds to "Underscore-count mangling" from [NameMangling.md](https://github.com/wgsl-tooling-wg/wesl-spec/blob/main/NameMangling.md)
+ * Corresponds to "Underscore-count mangling" from [NameMangling.md](https://github.com/webgpu-tools/wesl-spec/blob/main/NameMangling.md)
  */
 export function underscoreMangle(
   decl: DeclIdent,

package/src/StandardTypes.ts

@@ -1,5 +1,5 @@
 // From https://www.w3.org/TR/WGSL/#predeclared
-// Use https://github.com/wgsl-tooling-wg/wgsl-spec to regenerate these list in the future
+// Use https://github.com/webgpu-tools/wgsl-spec to regenerate these list in the future
 
 export const stdFns = `bitcast all any select arrayLength 
   abs acos acosh asin asinh atan atanh atan2 ceil clamp cos cosh 

package/src/WeslDevice.ts

@@ -89,6 +89,7 @@ export function makeWeslDevice(device: GPUDevice): WeslDevice {
                   lineNumber: message.lineNum,
                   lineColumn: message.linePos,
                   length: message.length,
+                  offset: message.offset,
                   error: new Error(message.type + ": " + message.message),
                 });
               }

package/src/parse/Keywords.ts

@@ -1,4 +1,4 @@
-// Use https://github.com/wgsl-tooling-wg/wgsl-spec to check this list in the future
+// Use https://github.com/webgpu-tools/wgsl-spec to check this list in the future
 // I recommend checking whether a new list and the current list are equal
 
 /** https://www.w3.org/TR/WGSL/#keyword-summary */

package/src/parse/ParseStatement.ts

@@ -39,7 +39,7 @@ interface CompoundOptions {
 
 // Experimental: declarations in conditional blocks visible in outer scope.
 // e.g. @if(X) { let y = 1; } makes y visible outside the block.
-// see https://github.com/wgsl-tooling-wg/wesl-spec/issues/158
+// see https://github.com/webgpu-tools/wesl-spec/issues/158
 const conditionalBlockFeature = true;
 
 /** Function bodies share scope with parameters (per WGSL spec). */

package/src/test/BevyLink.test.ts

@@ -11,7 +11,7 @@ const bevyBulkTest = {
   name: "Bevy",
   baseDir: "bevy-wgsl",
   git: {
-    url: "https://github.com/wgsl-tooling-wg/bevy-wgsl.git",
+    url: "https://github.com/webgpu-tools/bevy-wgsl.git",
     revision: "84977ff025eaf8d92e56a9c35b815fae70eb4af0",
   },
 };