@francisdb/vpin-wasm 0.35.0 → 0.36.0

package/README.md

@@ -84,15 +84,16 @@ for (const finding of findings) {
 ```
 
 `code` names the check and is stable, so findings can be grouped or
-suppressed by it; `line` and `column` (both from 1) are set for findings
-about one place in the script.
+suppressed by it; `item` is the name of the game item a finding is about,
+to select it in an editor; `line` and `column` (both from 1) are set for
+findings about one place in the script.
 
 **Parameters:**
 
 - `files: VpxFileMap` (`Record<string, Uint8Array>`) - file paths to contents
 - `callback?: (message: string) => void` - Optional progress callback
 
-**Returns:** `{severity: "error" | "warning" | "suggestion" | "info", code: string, message: string, line?: number, column?: number}[]` - empty when the table is clean
+**Returns:** `{severity: "error" | "warning" | "suggestion" | "info", code: string, message: string, item?: string, line?: number, column?: number}[]` - empty when the table is clean
 
 ### export_glb(files, options?, callback?)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@francisdb/vpin-wasm",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "description": "WASM bindings for vpin, a rust library for the visual/virtual pinball ecosystem.",
   "homepage": "https://github.com/francisdb/vpin",
   "bugs": {

package/vpin.d.ts

@@ -23,6 +23,11 @@ export type AuditFinding = {
     code: string;
     /** What is wrong, without the location */
     message: string;
+    /**
+     * Name of the game item the finding is about, as the table spells it,
+     * for findings about one game item that exists
+     */
+    item?: string;
     /** Script line the finding is about, from 1, when it points at one */
     line?: number;
     /** Script column of the first character, from 1, when known */
@@ -332,7 +337,7 @@ export function assemble(files: VpxFileMap, callback?: ProgressCallback | null):
  * Checks the expanded table files for consistency problems: references to
  * images, materials, surfaces or collection items that do not exist,
  * duplicate or over-long names, storage suggestions and script checks.
- * Returns an array of `{severity, code, message, line?, column?}` objects,
+ * Returns an array of `{severity, code, message, item?, line?, column?}` objects,
  * empty when the table is clean.
  */
 export function audit(files: VpxFileMap, callback?: ProgressCallback | null): AuditFinding[];

package/vpin.js

@@ -224,7 +224,7 @@ export function assemble(files, callback) {
  * Checks the expanded table files for consistency problems: references to
  * images, materials, surfaces or collection items that do not exist,
  * duplicate or over-long names, storage suggestions and script checks.
- * Returns an array of `{severity, code, message, line?, column?}` objects,
+ * Returns an array of `{severity, code, message, item?, line?, column?}` objects,
  * empty when the table is clean.
  * @param {VpxFileMap} files
  * @param {ProgressCallback | null} [callback]