wesl-plugin 0.6.0-pre3

package/README.md

@@ -0,0 +1,92 @@
+# wesl plugin
+
+The wesl-plugin handles `.wesl` and `.wgsl` files
+in JavaScript bundlers to make using webgpu shaders more convenient.
+Plugin features are accessed from JavaScript and TypeScript with `import` statements:
+
+```ts
+import linkConfig from "./shaders/app.wesl?link";
+```
+
+Each plugin features is enabled by its own wesl-plugin [extension](#extensions).
+
+## Getting started
+
+### Vite
+
+Add the wesl-plugin along with any selected extensions to `vite.config.ts`:
+
+```ts
+import { UserConfig } from "vite";
+import weslPlugin from "wesl-plugin/vite";
+import { linkBuildPlugin } from "wesl-plugin";
+
+const config: UserConfig = {
+  plugins: [ weslPlugin({ extensions: [linkBuildPlugin] }) ],
+};
+
+export default config;
+```
+
+In your JavaScript or TypeScript program you can then import
+wesl or wgsl shaders with a `?link` suffix and link them into WGSL at runtime.
+
+```ts
+import linkConfig from "./shaders/app.wesl?link";
+
+function makeShaders() {
+  const vertShader = await link({
+    ...linkConfig, 
+    rootModuleName: "myVerts.wesl",
+    conditions: {mobileGPU: true}
+  });
+  const computeShader = await link({
+    ...linkConfig, 
+    rootModuleName: "myCompute.wesl",
+    constants: {num_lights: 1}
+  });
+}
+
+```
+
+### Other Bundlers
+
+The wesl-plugin is available for many popular bundlers:
+
+``` ts
+import weslPlugin from "wesl-plugin/esbuild"; 
+import weslPlugin from "wesl-plugin/rollup"; 
+import weslPlugin from "wesl-plugin/webpack"; 
+import weslPlugin from "wesl-plugin/nuxt"; 
+import weslPlugin from "wesl-plugin/farm"; 
+import weslPlugin from "wesl-plugin/rpack"; 
+// etc.
+```
+
+## Extensions
+
+- **LinkExtension** - import `?link` in JavaScript/TypeScript programs to conveniently assemble shader files and libraries for linking at runtime.
+Reads the `wesl.toml` file to find local shader files, partially parses the local
+shader files to find shader libraries, and returns a `LinkParams` object
+ready to use for runtime linking.
+
+### Prototype Extensions
+
+- **SimpleReReflectExtension** - (_demo for extension writers_) import `?simple_reflect` to
+translate some wgsl `struct` elements into JavaScript and TypeScript.
+Demonstrates to wesl-plugin extension authors how to connect
+to the wesl-plugin, how to produce JavaScript, and how to produce TypeScript.
+- **BindingLayoutExtension** - (_prototype_) import `?bindingLayout` to collect JavaScript
+`BindingGroupLayout` objects.
+Works in concert with the `bindingStructsPlugin` to translate a proposed new WGSL
+feature for defining binding group layouts in shaders [#4957](https://github.com/gpuweb/gpuweb/issues/4957).
+
+## Developing a wesl-plugin extension
+
+To add a new extension to the wesl-plugin:
+
+- Pick an import suffix (e.g. `?myExtension`).
+- Implement a function that returns a JavaScript string.
+  - Extensions have access to wgsl/wesl sources, a parsed abstract syntax tree for the sources, etc.
+
+See [PluginExtension.ts](https://github.com/wgsl-tooling-wg/wesl-js/blob/master/tools/packages/wesl-plugin/src/PluginExtension.ts) for details.

package/dist/PluginExtension-BPBKs2pN.d.ts

@@ -0,0 +1,41 @@
+import { WeslJsPlugin, ParsedRegistry } from 'wesl';
+
+/** loaded (or synthesized) info from .toml */
+interface WeslToml {
+    /** glob search strings to find .wesl/.wgsl files. Relative to the toml directory! */
+    weslFiles: string[];
+    /** base directory for wesl files. Relative to the toml directory! */
+    weslRoot: string;
+}
+interface WeslTomlInfo {
+    /** The path to the toml file, relative to the cwd */
+    tomlFile: string;
+    /** The path to the directory that contains the toml. Relative to the cwd. Paths inside the toml are relative to this. */
+    tomlDir: string;
+    /**
+     * The wesl root, relative to the cwd. This lets us correctly do `path.resolve(resolvedWeslRoot, someShaderFile)`
+     */
+    resolvedWeslRoot: string;
+    /** The underlying toml file */
+    toml: WeslToml;
+}
+
+/** function type required for for emit extensions */
+type ExtensionEmitFn = (id: string, pluginApi: PluginExtensionApi) => Promise<string>;
+/** an extension that runs inside the wesl-js build plugin */
+interface PluginExtension extends WeslJsPlugin {
+    /** javascript imports with this suffix will trigger the plugin */
+    extensionName: string;
+    /** generate javascript text for js/ts importers to use.
+     *   e.g. import myPluginJs from "./foo.wesl?myPlugin"; */
+    emitFn: ExtensionEmitFn;
+}
+/** api supplied to plugin extensions */
+interface PluginExtensionApi {
+    weslToml: () => Promise<WeslTomlInfo>;
+    weslSrc: () => Promise<Record<string, string>>;
+    weslRegistry: () => Promise<ParsedRegistry>;
+    weslMain: (baseId: string) => Promise<string>;
+}
+
+export type { ExtensionEmitFn as E, PluginExtension as P, PluginExtensionApi as a };

package/dist/chunk-JSBRDJBE.js

@@ -0,0 +1,30 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+export {
+  __commonJS,
+  __toESM
+};

package/dist/chunk-USWZ2CIV.js

@@ -0,0 +1,11 @@
+import {
+  weslPlugin
+} from "./chunk-WRYP67OK.js";
+
+// src/plugins/webpack.ts
+import { createWebpackPlugin } from "unplugin";
+var webpack_default = createWebpackPlugin(weslPlugin);
+
+export {
+  webpack_default
+};