Merge branch 'master' into lsp-refactor

rokucommunity · Sep 23, 2024 · 373852d · 373852d
2 parents d763dbe + 56dcaaa
commit 373852d
Show file tree

Hide file tree

Showing 11 changed files with 131 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+## [0.67.6](https://github.com/rokucommunity/brighterscript/compare/v0.67.5...v0.67.6) - 2024-09-05
+### Added
+ - support for `roIntrinsicDouble` ([#1291](https://github.com/rokucommunity/brighterscript/pull/1291))
+ - support for resolving `sourceRoot` at time of config load ([#1290](https://github.com/rokucommunity/brighterscript/pull/1290))
+### Changed
+ - document plugin naming convention ([#1284](https://github.com/rokucommunity/brighterscript/pull/1284))
+
+
+
 ## [0.67.5](https://github.com/rokucommunity/brighterscript/compare/v0.67.4...v0.67.5) - 2024-07-31
 ### Fixed
  - templatestring support for `annotation.getArguments()` ([#1264](https://github.com/rokucommunity/brighterscript/pull/1264))

diff --git a/benchmarks/package-lock.json b/benchmarks/package-lock.json
diff --git a/bsconfig.schema.json b/bsconfig.schema.json
@@ -30,7 +30,10 @@
                     "type": "object",
                     "patternProperties": {
                         "^.+$": {
-                            "type": ["boolean", "null"]
+                            "type": [
+                                "boolean",
+                                "null"
+                            ]
                         }
                     }
                 }
@@ -161,8 +164,16 @@
             "type": "object",
             "patternProperties": {
                 ".{1,}": {
-                    "type": ["number", "string"],
-                    "enum": ["error", "warn", "info", "hint"]
+                    "type": [
+                        "number",
+                        "string"
+                    ],
+                    "enum": [
+                        "error",
+                        "warn",
+                        "info",
+                        "hint"
+                    ]
                 }
             }
         },
@@ -268,6 +279,11 @@
             "description": "Override the root directory path where debugger should locate the source files. The location will be embedded in the source map to help debuggers locate the original source files. This only applies to files found within rootDir. This is useful when you want to preprocess files before passing them to BrighterScript, and want a debugger to open the original files. This option also affects the `SOURCE_FILE_PATH` and `SOURCE_LOCATION` source literals.",
             "type": "string"
         },
+        "resolveSourceRoot": {
+            "description": "Should the `sourceRoot` property be resolve to an absolute path (relative to the bsconfig it's defined in)",
+            "type": "boolean",
+            "default": false
+        },
         "diagnosticLevel": {
             "description": "Specify what diagnostic levels are printed to the console. This has no effect on what diagnostics are reported in the LanguageServer. Defaults to 'warn'",
             "type": "string",

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "brighterscript",
-  "version": "0.67.5",
+  "version": "0.67.6",
   "description": "A superset of Roku's BrightScript language.",
   "scripts": {
     "preversion": "npm run build && npm run lint && npm run test",

diff --git a/scripts/scrape-roku-docs.ts b/scripts/scrape-roku-docs.ts
@@ -1,3 +1,4 @@
+/* eslint-disable import/no-extraneous-dependencies */
 /* eslint-disable @typescript-eslint/dot-notation */
 /* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable @typescript-eslint/no-require-imports */
@@ -298,7 +299,7 @@ class Runner {
                                 const arg = call.args[i];
                                 let paramName = `param${i}`;
                                 if (isVariableExpression(arg)) {
-                                    paramName = arg.getName(ParseMode.BrightScript)
+                                    paramName = arg.getName(ParseMode.BrightScript);
                                 }
                                 signature.params.push({
                                     name: paramName,
@@ -311,7 +312,7 @@ class Runner {
                             component.constructors.push(signature);
                         }
                     } else if (match[1]) {
-                        const signature = this.getConstructorSignature(name, match[1])
+                        const signature = this.getConstructorSignature(name, match[1]);
 
                         if (signature) {
                             component.constructors.push(signature);
@@ -329,10 +330,30 @@ class Runner {
 
             this.result.components[component?.name?.toLowerCase()] = component;
         }
+        if (!this.result.components['rointrinsicdouble']) {
+            this.result.components['rointrinsicdouble'] = {
+                availableSince: undefined,
+                constructors: [],
+                description: 'roIntrinsicDouble is the object equivalent for type \'Double\'.\n\nIt is a legacy object name, corresponding to the intrinsic Double object. Applications should use Double literal values and/or Double-typed variables directly.',
+                events: [],
+                interfaces: [
+                    {
+                        name: 'ifDouble',
+                        url: 'https://developer.roku.com/docs/references/brightscript/interfaces/ifdouble.md'
+                    },
+                    {
+                        name: 'ifToStr',
+                        url: 'https://developer.roku.com/docs/references/brightscript/interfaces/iftostr.md'
+                    }
+                ],
+                name: 'roIntrinsicDouble',
+                url: 'https://developer.roku.com/docs/references/brightscript/components/rodouble.md'
+            };
+        }
     }
 
     private getConstructorSignature(componentName: string, sourceCode: string) {
-        const foundParamTexts = this.findParamTexts(sourceCode)
+        const foundParamTexts = this.findParamTexts(sourceCode);
 
         if (foundParamTexts && foundParamTexts[0].toLowerCase() === componentName.toLowerCase()) {
             const signature = {
@@ -797,6 +818,7 @@ function deepSearch<T = any>(object, key, predicate): T {
         return object;
     }
 
+    // eslint-disable-next-line @typescript-eslint/prefer-for-of
     for (let i = 0; i < Object.keys(object).length; i++) {
         let value = object[Object.keys(object)[i]];
         if (typeof value === 'object' && value) {
@@ -1235,4 +1257,3 @@ interface ElementFilter {
 
 //run the builder
 new Runner().run().catch((e) => console.error(e));
-
diff --git a/src/BsConfig.ts b/src/BsConfig.ts
@@ -181,6 +181,11 @@ export interface BsConfig {
      * have their source maps changed. This option also affects the `SOURCE_FILE_PATH` and `SOURCE_LOCATION` source literals.
      */
     sourceRoot?: string;
+    /**
+     * Should the `sourceRoot` property be resolve to an absolute path (relative to the bsconfig it's defined in)
+     * @default false
+     */
+    resolveSourceRoot?: boolean;
     /**
      * Enables generating sourcemap files, which allow debugging tools to show the original source code while running the emitted files.
      * @default true

diff --git a/src/Scope.spec.ts b/src/Scope.spec.ts
@@ -709,6 +709,16 @@ describe('Scope', () => {
                 expectZeroDiagnostics(program);
             });
 
+            it('recognizes roIntrinsicDouble', () => {
+                program.setFile(`source/file.brs`, `
+                    sub main()
+                        intrinsicDouble = CreateObject("roIntrinsicDouble")
+                    end sub
+                `);
+                program.validate();
+                expectZeroDiagnostics(program);
+            });
+
             it('catches invalid BrightScript components', () => {
                 program.setFile(`source/file.brs`, `
                     sub main()

diff --git a/src/roku-types/data.json b/src/roku-types/data.json
@@ -1,5 +1,5 @@
 {
-    "generatedDate": "2022-11-02T15:29:46.390Z",
+    "generatedDate": "2024-08-23T13:39:25.188Z",
     "nodes": {
         "animation": {
             "description": "Extends [**AnimationBase**](https://developer.roku.com/docs/references/scenegraph/abstract-nodes/animationbase.md\n\nThe Animation node class provides animations of renderable nodes, by applying interpolator functions to the values in specified renderable node fields. For an animation to take effect, an Animation node definition must include a child field interpolator node ([FloatFieldInterpolator](https://developer.roku.com/docs/references/scenegraph/animation-nodes/floatfieldinterpolator.md\"FloatFieldInterpolator\"), [Vector2DFieldInterpolator](https://developer.roku.com/docs/references/scenegraph/animation-nodes/vector2dfieldinterpolator.md\"Vector2DFieldInterpolator\"), [ColorFieldInterpolator](https://developer.roku.com/docs/references/scenegraph/animation-nodes/colorfieldinterpolator.md\"ColorFieldInterpolator\")) definition for each renderable node field that is animated.\n\nThe Animation node class provides a simple linear interpolator function, where the animation takes place smoothly and simply from beginning to end. The Animation node class also provides several more complex interpolator functions to allow custom animation effects. For example, you can move a graphic image around the screen at differing speeds and curved trajectories at different times in the animation by specifying the appropriate function in the easeFunction field (quadratic and exponential are two examples of functions that can be specified). The interpolator functions are divided into two parts: the beginning of the animation (ease-in), and the end of the animation (ease-out). You can apply a specified interpolator function to either or both ease-in and ease-out, or specify no function for either or both (which is the linear function). You can also change the portion of the animation that is ease-in and ease-out to arbitrary fractional values for a quadratic interpolator function applied to both ease-in and ease-out.",
@@ -6682,6 +6682,23 @@
             "name": "roInt",
             "url": "https://developer.roku.com/docs/references/brightscript/components/roint.md"
         },
+        "rointrinsicdouble": {
+            "constructors": [],
+            "description": "roIntrinsicDouble is the object equivalent for type 'Double'.\n\nIt is a legacy object name, corresponding to the intrinsic Double object. Applications should use Double literal values and/or Double-typed variables directly.",
+            "events": [],
+            "interfaces": [
+                {
+                    "name": "ifDouble",
+                    "url": "https://developer.roku.com/docs/references/brightscript/interfaces/ifdouble.md"
+                },
+                {
+                    "name": "ifToStr",
+                    "url": "https://developer.roku.com/docs/references/brightscript/interfaces/iftostr.md"
+                }
+            ],
+            "name": "roIntrinsicDouble",
+            "url": "https://developer.roku.com/docs/references/brightscript/components/rodouble.md"
+        },
         "roinvalid": {
             "constructors": [],
             "description": "roInvalid is the object equivalent for intrinsic type 'Invalid'.",

diff --git a/src/util.spec.ts b/src/util.spec.ts
@@ -95,6 +95,26 @@ describe('util', () => {
             ]);
         });
 
+        it('resolves sourceRoot relative to the bsconfig file', () => {
+            fsExtra.outputJsonSync(s`${rootDir}/folder1/parent.json`, { sourceRoot: './alpha/beta', resolveSourceRoot: true });
+            fsExtra.outputJsonSync(s`${rootDir}/child.json`, { extends: 'folder1/parent.json' });
+            expect(
+                util.loadConfigFile(s`${rootDir}/child.json`).sourceRoot
+            ).to.eql(
+                s`${rootDir}/folder1/alpha/beta`
+            );
+        });
+
+        it('leaves sourceRoot relative when defaulted to', () => {
+            fsExtra.outputJsonSync(s`${rootDir}/folder1/parent.json`, { sourceRoot: './alpha/beta' });
+            fsExtra.outputJsonSync(s`${rootDir}/child.json`, { extends: 'folder1/parent.json' });
+            expect(
+                util.loadConfigFile(s`${rootDir}/child.json`).sourceRoot
+            ).to.eql(
+                `./alpha/beta`
+            );
+        });
+
         it('returns empty ancestors list for non-extends files', () => {
             fsExtra.outputFileSync(s`${rootDir}/child.json`, `{}`);
             let config = util.loadConfigFile(s`${rootDir}/child.json`);

diff --git a/src/util.ts b/src/util.ts
@@ -254,6 +254,9 @@ export class Util {
             if (result.stagingDir) {
                 result.stagingDir = path.resolve(projectFileCwd, result.stagingDir);
             }
+            if (result.sourceRoot && result.resolveSourceRoot) {
+                result.sourceRoot = path.resolve(projectFileCwd, result.sourceRoot);
+            }
             return result;
         }
     }
@@ -384,6 +387,7 @@ export class Util {
             autoImportComponentScript: config.autoImportComponentScript === true ? true : false,
             showDiagnosticsInConsole: config.showDiagnosticsInConsole === false ? false : true,
             sourceRoot: config.sourceRoot ? standardizePath(config.sourceRoot) : undefined,
+            resolveSourceRoot: config.resolveSourceRoot === true ? true: false,
             allowBrighterScriptInBrightScript: config.allowBrighterScriptInBrightScript === true ? true : false,
             emitDefinitions: config.emitDefinitions === true ? true : false,
             removeParameterTypes: config.removeParameterTypes === true ? true : false,