brighterscript-xml-plugin 0.3.0 → 1.0.0-alpha.2

package/README.md

@@ -1,19 +1,27 @@
 # brighterscript-xml-plugin
+
 ## BrighterScript plugin for SceneGraph XML completions
 
 ### It Does:
+
 - suggest components
 - suggest component fields
+- validate field values
+- validate field names
+- validate child components
 
 ### It Does Not:
-- validate field values
+
 - suggest interface elements like `field` and `function`
 
 ### Installation
+
 ```
 npm i brighterscript-xml-plugin
 ```
+
 `bsconfig.json`
+
 ```
 {
     ...
@@ -24,12 +32,13 @@ npm i brighterscript-xml-plugin
 ```
 
 ### Usage
+
 SceneGraph Component completions
 ![usage gif](./bsc-xml.gif)
 
-
+- validates children components
 - provides both built-in Roku SceneGraph components and custom project components
 - provides built-in fields and custom fields
 - auto suggestions for fields when typing inside an element tag
 - use completions shortcut to trigger manually
-- component completions on `<` do not fill automatically, pretty sure this is something that needs to be configured at the vscode extension level.
+- component completions on `<` do not fill automatically, pretty sure this is something that needs to be configured at the vscode extension level.

package/dist/SGXmlCompletionProvider.js

@@ -31,7 +31,7 @@ class SGXmlCompletionProvider {
         let result = [];
         if (projectComponent) {
             result.push(...this.getCompletionsFromXmlFile(projectComponent.file));
-            const extendsName = (_b = (_a = projectComponent.file.ast.component) === null || _a === void 0 ? void 0 : _a.extends) !== null && _b !== void 0 ? _b : 'Node';
+            const extendsName = (_b = (_a = projectComponent.file.ast.componentElement) === null || _a === void 0 ? void 0 : _a.extends) !== null && _b !== void 0 ? _b : 'Node';
             if (extendsName) {
                 result.push(...this.getAllAvailableFields(extendsName));
             }
@@ -50,7 +50,7 @@ class SGXmlCompletionProvider {
     }
     getCompletionsFromXmlFile(xmlFile) {
         var _a, _b, _c;
-        return ((_c = (_b = (_a = xmlFile.ast.component) === null || _a === void 0 ? void 0 : _a.api) === null || _b === void 0 ? void 0 : _b.fields.map((f) => {
+        return ((_c = (_b = (_a = xmlFile.ast.componentElement) === null || _a === void 0 ? void 0 : _a.interfaceElement) === null || _b === void 0 ? void 0 : _b.fields.map((f) => {
             return {
                 label: f.id,
                 detail: `${f.type}${f.value ? `: ${f.value}` : ''}`,
@@ -90,14 +90,14 @@ class SGXmlCompletionProvider {
         let result = [];
         if (component) {
             result = [
-                ...((_c = (_b = (_a = component.file.ast.component) === null || _a === void 0 ? void 0 : _a.api) === null || _b === void 0 ? void 0 : _b.fields.map((f) => {
+                ...((_c = (_b = (_a = component.file.ast.componentElement) === null || _a === void 0 ? void 0 : _a.interfaceElement) === null || _b === void 0 ? void 0 : _b.fields.map((f) => {
                     return {
                         name: f.id,
                         type: f.type,
                         sortText: '0_' + f.id,
                     };
                 })) !== null && _c !== void 0 ? _c : []),
-                ...this.getAllAvailableFields((_e = (_d = component.file.ast.component) === null || _d === void 0 ? void 0 : _d.extends) !== null && _e !== void 0 ? _e : '').map((f) => {
+                ...this.getAllAvailableFields((_e = (_d = component.file.ast.componentElement) === null || _d === void 0 ? void 0 : _d.extends) !== null && _e !== void 0 ? _e : '').map((f) => {
                     return Object.assign(Object.assign({}, f), { sortText: '1_' + f.sortText });
                 }),
             ];

package/dist/SGXmlDiagnostics.js

@@ -7,24 +7,27 @@ exports.SGXmlDiagnostics = {
         message: `Unknown component: ${componentName}`,
         severity: brighterscript_1.DiagnosticSeverity.Error,
         code: 'SG1001',
-        range: element.tag.range
+        location: element.tokens.startTagName.location
     }),
     InvalidSystemAttribute: (attributeName, component, attr) => ({
         message: `Field "${attributeName}" not found on component "${component}"`,
         severity: brighterscript_1.DiagnosticSeverity.Error,
         code: 'SG1002',
-        range: attr.key.range
-    }),
-    InvalidAttributeValue: (attributeName, expectedType, attr) => ({
-        message: `Field value "${attributeName}" does not match type ${expectedType}`,
-        severity: brighterscript_1.DiagnosticSeverity.Error,
-        code: 'SG1003',
-        range: attr.value.range
+        location: attr.tokens.key.location
     }),
+    InvalidAttributeValue: (attributeName, expectedType, attr) => {
+        var _a;
+        return ({
+            message: `Field value "${attributeName}" does not match type ${expectedType}`,
+            severity: brighterscript_1.DiagnosticSeverity.Error,
+            code: 'SG1003',
+            location: (_a = attr.tokens.value) === null || _a === void 0 ? void 0 : _a.location
+        });
+    },
     AttributeNameCaseMismatch: (attributeName, expectedName, attr) => ({
         message: `Field "${attributeName}" should match case for "${expectedName}"`,
         severity: brighterscript_1.DiagnosticSeverity.Warning,
         code: 'SG2001',
-        range: attr.key.range
+        location: attr.tokens.key.location
     })
 };

package/dist/SGXmlValidator.js

@@ -13,64 +13,65 @@ class SGXmlValidator {
         this.program = program;
     }
     validateXmlFile(event) {
-        var _a, _b;
+        var _a, _b, _c, _d;
         const file = event.file;
-        const diags = (_b = (_a = file === null || file === void 0 ? void 0 : file.ast) === null || _a === void 0 ? void 0 : _a.component) === null || _b === void 0 ? void 0 : _b.children.children.flatMap((child) => {
-            return this.validateComponent(child).map(diag => {
-                return Object.assign(Object.assign({}, diag), { file: file });
-            });
-        });
-        event.program.addDiagnostics(diags || []);
+        const diags = (_d = (_c = (_b = (_a = file === null || file === void 0 ? void 0 : file.ast) === null || _a === void 0 ? void 0 : _a.componentElement) === null || _b === void 0 ? void 0 : _b.childrenElement) === null || _c === void 0 ? void 0 : _c.elements.flatMap((child) => {
+            return this.validateComponent(child);
+        })) !== null && _d !== void 0 ? _d : [];
+        event.program.diagnostics.register(diags);
     }
     validateComponent(element) {
         const diags = [];
+        if (!element.tagName) {
+            return diags;
+        }
         if (this.validateComponentExists(element)) {
             diags.push(...this.validateNodeElement(element));
-            element.children.forEach((child) => {
+            element.elements.forEach((child) => {
                 diags.push(...this.validateComponent(child));
             });
         }
         else {
-            this.program.logger.error(`Unknown component: ${element.tag.text}`, element);
-            const diag = SGXmlDiagnostics_1.SGXmlDiagnostics.UnknownComponent(element.tag.text, element);
+            this.program.logger.error(`Unknown component: ${element.tagName}`, element);
+            const diag = SGXmlDiagnostics_1.SGXmlDiagnostics.UnknownComponent(element.tagName, element);
             diags.push(diag);
         }
         return diags;
     }
     validateNodeElement(element) {
         const diags = [];
-        const fields = this.findAllFields(element.tag.text);
+        const fields = this.findAllFields(element.tagName);
         element.attributes.forEach((attr) => {
             const field = fields.find(a => {
-                return a.id.toLowerCase() === attr.key.text.toLowerCase();
+                return a.id.toLowerCase() === attr.key.toLowerCase();
             });
             if (!field) {
-                this.program.logger.error(`Invalid system attribute: ${attr.key.text}`, attr);
-                diags.push(SGXmlDiagnostics_1.SGXmlDiagnostics.InvalidSystemAttribute(attr.key.text, element.tag.text, attr));
+                this.program.logger.error(`Invalid system attribute: ${attr.key}`, attr);
+                diags.push(SGXmlDiagnostics_1.SGXmlDiagnostics.InvalidSystemAttribute(attr.key, element.tagName, attr));
                 return;
             }
-            if (field.type && !FieldTypeValidator_1.default.validateFieldType(attr.value.text, field.type)) {
-                this.program.logger.error(`Invalid value for attribute: ${attr.key.text}`, attr);
-                diags.push(SGXmlDiagnostics_1.SGXmlDiagnostics.InvalidAttributeValue(attr.key.text, field.type, attr));
+            if (field.type && !FieldTypeValidator_1.default.validateFieldType(attr.value, field.type)) {
+                this.program.logger.error(`Invalid value for attribute: ${attr.key}`, attr);
+                diags.push(SGXmlDiagnostics_1.SGXmlDiagnostics.InvalidAttributeValue(attr.key, field.type, attr));
             }
-            if (field.id !== attr.key.text) {
-                this.program.logger.warn(`Field "${attr.key.text}" should be "${field.id}"`, attr);
-                diags.push(SGXmlDiagnostics_1.SGXmlDiagnostics.AttributeNameCaseMismatch(attr.key.text, field.id, attr));
+            if (field.id !== attr.key) {
+                this.program.logger.warn(`Field "${attr.key}" should be "${field.id}"`, attr);
+                diags.push(SGXmlDiagnostics_1.SGXmlDiagnostics.AttributeNameCaseMismatch(attr.key, field.id, attr));
             }
         });
         return diags;
     }
     validateComponentExists(element) {
-        let component = this.program.getComponent(element.tag.text) || systemNodes[element.tag.text.toLocaleLowerCase()];
+        let component = this.program.getComponent(element.tagName) || systemNodes[element.tagName.toLocaleLowerCase()];
         return !!component;
     }
     findAllFields(name) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e;
         const fields = [];
         let component = (_a = this.program.getComponent(name)) === null || _a === void 0 ? void 0 : _a.file;
         if (component) {
-            if ((_c = (_b = component.ast.component) === null || _b === void 0 ? void 0 : _b.api) === null || _c === void 0 ? void 0 : _c.fields) {
-                fields.push(...component.ast.component.api.fields.map(f => {
+            if ((_c = (_b = component.ast.componentElement) === null || _b === void 0 ? void 0 : _b.interfaceElement) === null || _c === void 0 ? void 0 : _c.fields) {
+                fields.push(...component.ast.componentElement.interfaceElement.fields.map(f => {
                     return {
                         id: f.id,
                         type: f.type,
@@ -78,13 +79,13 @@ class SGXmlValidator {
                     };
                 }) || []);
             }
-            if ((_d = component.ast.component) === null || _d === void 0 ? void 0 : _d.extends) {
-                fields.push(...this.findAllFields((_e = component.ast.component) === null || _e === void 0 ? void 0 : _e.extends));
+            if ((_d = component.ast.componentElement) === null || _d === void 0 ? void 0 : _d.extends) {
+                fields.push(...this.findAllFields(component.ast.componentElement.extends));
             }
         }
         component = systemNodes[name.toLocaleLowerCase()];
         if (component) {
-            fields.push(...((_f = component.fields) === null || _f === void 0 ? void 0 : _f.map(f => {
+            fields.push(...((_e = component.fields) === null || _e === void 0 ? void 0 : _e.map(f => {
                 return {
                     id: f.name,
                     type: f.type

package/dist/index.js

@@ -1,9 +1,23 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BscXmlPlugin = void 0;
 const brighterscript_1 = require("brighterscript");
 const SGXmlCompletionProvider_1 = require("./SGXmlCompletionProvider");
 const SGXmlValidator_1 = require("./SGXmlValidator");
+const SGParser_1 = __importDefault(require("brighterscript/dist/parser/SGParser"));
+//@ts-ignore
+SGParser_1.default.prototype._mapNode = SGParser_1.default.prototype.mapNode;
+//@ts-ignore
+SGParser_1.default.prototype.mapNode = function (node) {
+    if (!node.children.Name) {
+        node.children.Name = [];
+    }
+    //@ts-ignore
+    return this._mapNode(node);
+};
 class BscXmlPlugin {
     constructor() {
         this.name = 'bsc-xml-plugin';
@@ -20,13 +34,13 @@ class BscXmlPlugin {
         }
         return this.provider;
     }
-    beforeProvideCompletions(event) {
+    provideCompletions(event) {
+        console.log('provideCompletions', event.file.constructor.name);
         if ((0, brighterscript_1.isXmlFile)(event.file)) {
-            console.log(event.completions);
             this.getProvider(event.program).process(event);
         }
     }
-    onFileValidate(event) {
+    validateFile(event) {
         if ((0, brighterscript_1.isXmlFile)(event.file)) {
             this.getValidator(event).validateXmlFile(event);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brighterscript-xml-plugin",
-  "version": "0.3.0",
+  "version": "1.0.0-alpha.2",
   "description": "BrighterScript plugin for SceneGraph XML completions",
   "main": "dist/index.js",
   "repository": {
@@ -37,7 +37,7 @@
     "@types/chai": "^4.3.4",
     "@types/mocha": "^10.0.1",
     "@types/node": "^18.15.3",
-    "brighterscript": "0.65.x",
+    "brighterscript": "^1.0.0-alpha.50",
     "chai": "^4.3.7",
     "mocha": "^10.2.0",
     "rimraf": "^5.0.5",
@@ -47,7 +47,7 @@
     "vscode-languageserver-types": "^3.17.3"
   },
   "peerDependencies": {
-    "brighterscript": ">= 0.65.0 < 1"
+    "brighterscript": ">= 1 < 2"
   },
   "peerDependenciesMeta": {
     "brighterscript": {
@@ -58,4 +58,4 @@
     "dist/*.js",
     "!dist/*.spec.js"
   ]
-}
+}