@playcanvas/attribute-parser 1.8.0 → 1.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playcanvas/attribute-parser",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "author": "PlayCanvas <support@playcanvas.com>",
   "homepage": "https://github.com/playcanvas/attribute-parser#readme",
   "description": "The PlayCanvas Attribute Parser",
@@ -44,11 +44,11 @@
     "@rollup/plugin-commonjs": "28.0.6",
     "@rollup/plugin-node-resolve": "16.0.1",
     "@rollup/plugin-swc": "0.4.0",
-    "@swc/core": "1.12.1",
-    "chai": "5.2.0",
-    "globals": "16.2.0",
-    "mocha": "11.6.0",
-    "rollup": "4.43.0",
+    "@swc/core": "1.13.3",
+    "chai": "5.2.1",
+    "globals": "16.3.0",
+    "mocha": "11.7.1",
+    "rollup": "4.46.2",
     "publint": "0.3.12"
   },
   "scripts": {

package/types/index.d.ts

@@ -34,9 +34,10 @@ export class JSDocParser {
     /**
      * Returns all the valid ESM Scripts within a file
      * @param {string} fileName - The file name in the program to check
+     * @param {ParsingError[]} errors - An array to store any parsing errors
      * @returns {Map<string, import('typescript').Node>} - A map of valid ESM Script <names, nodes> within the file
      */
-    getAllEsmScripts(fileName: string): Map<string, import("typescript").Node>;
+    getAllEsmScripts(fileName: string, errors?: ParsingError[]): Map<string, import("typescript").Node>;
     /**
      * Analyzes the specified TypeScript file and extracts metadata from JSDoc comments.
      *
@@ -53,3 +54,4 @@ export class JSDocParser {
 }
 import { ScriptParser } from './parsers/script-parser.js';
 import * as ts from 'typescript';
+import { ParsingError } from './parsers/parsing-error.js';

package/types/parsers/attribute-parser.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @typedef {Object} TagDefinition
+ * @property {string} type - The type of the tag
+ * @property {() => string} supportMessage - A function to generate a support message for the tag
+ * @property {string} fix - A function to fix the tag
+ */
 /**
  * A class to parse JSDoc comments and extract attribute metadata.
  */
@@ -5,13 +11,13 @@ export class AttributeParser {
     /**
      * Creates a new instance of the ScriptParser class.
      *
-     * @param {Map<string, string>} tags - An set of tag definitions and their validators to add to the parser
+     * @param {Map<string, TagDefinition>} tags - An set of tag definitions and their validators to add to the parser
      * @param {object} env - The TypeScript environment to use
      * @param {Map<string, Function>} typeSerializerMap - A map of custom serializers
      */
-    constructor(tags: Map<string, string>, env: object, typeSerializerMap: Map<string, Function>);
+    constructor(tags: Map<string, TagDefinition>, env: object, typeSerializerMap: Map<string, Function>);
     env: any;
-    tagTypeAnnotations: Map<string, string>;
+    tagTypeAnnotations: Map<string, TagDefinition>;
     typeSerializerMap: Map<string, Function>;
     program: any;
     typeChecker: any;
@@ -51,5 +57,19 @@ export class AttributeParser {
      */
     getMembers(node: ts.Node): any[];
 }
+export type TagDefinition = {
+    /**
+     * - The type of the tag
+     */
+    type: string;
+    /**
+     * - A function to generate a support message for the tag
+     */
+    supportMessage: () => string;
+    /**
+     * - A function to fix the tag
+     */
+    fix: string;
+};
 import * as ts from 'typescript';
 import { ParsingError } from './parsing-error.js';

package/types/parsers/parsing-error.d.ts

@@ -1,6 +1,40 @@
+/**
+ * @typedef {Object} Fix
+ * @property {string} text - The text to insert at the fix location
+ * @property {string} title - The title of the fix
+ * @property {{ startLineNumber: number, startColumn: number, endLineNumber: number, endColumn: number }} range - The range of the fix
+ */
+/**
+ * A class representing a parsing error.
+ * @param {import('typescript').Node} node - The AST node which caused the error
+ * @param {string} type - The type of the error
+ * @param {string} message - The description of the error
+ * @param {Fix} [fix] - The fix for the error
+ */
 export class ParsingError {
-    constructor(node: any, message: any);
+    constructor(node: any, type: any, message: any, fix: any);
     node: any;
+    type: any;
     message: any;
+    fix: any;
     toString(): string;
 }
+export type Fix = {
+    /**
+     * - The text to insert at the fix location
+     */
+    text: string;
+    /**
+     * - The title of the fix
+     */
+    title: string;
+    /**
+     * - The range of the fix
+     */
+    range: {
+        startLineNumber: number;
+        startColumn: number;
+        endLineNumber: number;
+        endColumn: number;
+    };
+};

package/types/utils/attribute-utils.d.ts

@@ -1,5 +1,4 @@
-export function getTagFromJsdoc(tag: string, doc: import("typescript").Node): import("typescript").Node;
-export function getTag(tag: string, node: import("typescript").Node): import("typescript").Node;
+export function getTag(tag: string, node: import("typescript").Node): import("typescript").JSDocTag | null;
 export function hasTag(tag: string, node: import("typescript").Node): boolean;
 export function isInterface(node: import("typescript").Node): boolean;
 export function isStaticMember(member: import("typescript").Node): boolean;