@playcanvas/attribute-parser 1.0.0 → 1.0.2

package/README.md

@@ -1,6 +1,10 @@
 # PlayCanvas Attribute Parser
 
-This the JSDoc attribute parser used in the PlayCanvas editor. It's used to collect metadata from a script via it's jsdoc tags.
+This the official JSDoc attribute parser used in the PlayCanvas editor. 
+
+It's used in the PlayCanvas Editor to collect metadata from jsdoc annotated users scripts. This allows special `@attribute` members which can surface contextual data about class members.
+
+## A quick examples
 
 It takes a script like this...
 
@@ -22,7 +26,7 @@ class Rotator extends ScriptType {
 }
 ```
 
-and turns it into this...
+and turns it into the following data ...
 
 
 ```json
@@ -53,7 +57,7 @@ and turns it into this...
 }
 ```
 
-It takes the JSDocs and values and outputs the metadata in a serializable format.
+JSDocs tags are parsed and values and outputs the metadata in a serializable format.
 
 ### Usage 
 
@@ -65,8 +69,11 @@ await parser.init();
 // fetch your program source {[filename: string, contents: string][]}
 const scripts = await fetchScripts([...paths, './playcanvas.d.ts']);
 
+// update the progam
+parser.updateProgram(scripts)
+
 // Parse the program, starting from the first path
-const [attribute, errors] parser.parseAttributes(paths[0], scripts);
+const [attribute, errors] parser.parseAttributes("./index.js");
 ```
 
 ### Attribute structure
@@ -74,3 +81,8 @@ const [attribute, errors] parser.parseAttributes(paths[0], scripts);
 You can learn more about the special tags [available here ](https://github.com/playcanvas/attribute-parser/tree/main/test/fixtures)
 
 
+### Tests
+
+We provide good coverage
+
+

package/package.json

@@ -5,7 +5,7 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "version": "1.0.0",
+  "version": "1.0.2",
   "dependencies": {
     "@microsoft/tsdoc": "^0.15.0",
     "@typescript/vfs": "^1.6.0",

package/src/index.js

@@ -1,4 +1,4 @@
-import ts from 'typescript';
+import * as ts from 'typescript';
 import { createSystem, createDefaultMapFromNodeModules, createVirtualTypeScriptEnvironment } from '@typescript/vfs';
 
 import { ScriptParser } from './parsers/script-parser.js';

package/src/parsers/attribute-parser.js

@@ -1,4 +1,4 @@
-import ts from 'typescript';
+import * as ts from 'typescript';
 import { TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind, TextRange, TSDocParser } from "@microsoft/tsdoc";
 import { extractTextFromDocNode, getLeadingBlockCommentRanges, getType } from '../utils/ts-utils.js';
 

package/src/parsers/script-parser.js

@@ -1,4 +1,4 @@
-import ts from 'typescript';
+import * as ts from 'typescript';
 import { TextRange } from '@microsoft/tsdoc';
 
 import { AttributeParser } from './attribute-parser.js';

package/src/utils/ts-utils.js

@@ -1,12 +1,11 @@
 import { DocNodeKind } from '@microsoft/tsdoc';
 import { knownLibFilesForCompilerOptions } from '@typescript/vfs';
-import ts from 'typescript';
+import * as ts from 'typescript';
 import { ParsingError } from '../parsers/parsing-error.js';
 
-export function createDefaultMapFromCDN(options, basePath, ts) {
+export function createDefaultMapFromCDN(options, prefix, ts) {
     var fsMap = new Map();
     var files = knownLibFilesForCompilerOptions(options, ts);
-    var prefix = `${basePath}js/jsdoc-parser/types/`;
 
     async function uncached() {
         const contentPromises = files.map((lib) => {