Merge branch 'master' of https://github.com/rokucommunity/brighterscript into ast-to-string

Author: TwitchBronBron

.eslintrc.js

@@ -13,13 +13,21 @@ module.exports = {
     plugins: [
         '@typescript-eslint',
         'no-only-tests',
-        'jsdoc'
+        'jsdoc',
+        'import'
     ],
     extends: [
         'eslint:all',
         'plugin:@typescript-eslint/all',
-        'plugin:jsdoc/recommended'
+        'plugin:jsdoc/recommended',
+        'plugin:import/typescript'
     ],
+    settings: {
+        'import/resolver': {
+            typescript: true,
+            node: true
+        }
+    },
     rules: {
         '@typescript-eslint/array-type': 'off',
         '@typescript-eslint/consistent-type-assertions': 'off',
@@ -42,6 +50,7 @@ module.exports = {
         '@typescript-eslint/no-implicit-any-catch': 'off',
         '@typescript-eslint/no-invalid-this': 'off',
         '@typescript-eslint/no-magic-numbers': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
         '@typescript-eslint/no-parameter-properties': 'off',
         //had to add this rule to prevent eslint from crashing
         '@typescript-eslint/no-restricted-imports': ['off', {}],
@@ -55,12 +64,12 @@ module.exports = {
         '@typescript-eslint/no-shadow': 'off',
         '@typescript-eslint/no-this-alias': 'off',
         //possibly disable this once we have converted all throw statements to actual errors
-        '@typescript-eslint/no-throw-literal': 'off',
         '@typescript-eslint/no-invalid-void': 'off',
         '@typescript-eslint/no-invalid-void-type': 'off',
         '@typescript-eslint/no-type-alias': 'off',
         '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'off',
         '@typescript-eslint/no-unnecessary-condition': 'off',
+        '@typescript-eslint/no-unnecessary-type-assertion': 'off',
         '@typescript-eslint/no-unsafe-assignment': 'off',
         '@typescript-eslint/no-unsafe-call': 'off',
         '@typescript-eslint/no-unsafe-member-access': 'off',
@@ -116,6 +125,9 @@ module.exports = {
         'getter-return': 'off',
         'guard-for-in': 'off',
         'id-length': 'off',
+        'import/no-extraneous-dependencies': ['error', {
+            'devDependencies': ['**/*.spec.ts']
+        }],
         'indent': 'off',
         'init-declarations': 'off',
         'line-comment-position': 'off',
@@ -208,6 +220,8 @@ module.exports = {
             '@typescript-eslint/no-unused-vars-experimental': 'off',
             '@typescript-eslint/dot-notation': 'off',
             '@typescript-eslint/no-unsafe-argument': 'off',
+            'import/no-extraneous-dependencies': 'off',
+            'func-names': 'off',
             'new-cap': 'off',
             'no-shadow': 'off',
             'no-void': 'off'
@@ -227,12 +241,23 @@ module.exports = {
             'eol-last': 'off',
             '@typescript-eslint/semi': 'off'
         }
-    }, {
+    },
+    {
         files: ['scripts/**/*.ts'],
         rules: {
             '@typescript-eslint/no-var-requires': 'off',
             '@typescript-eslint/no-require-imports': 'off',
             'camelcase': 'off'
         }
+    },
+    {
+        files: ['benchmarks/**/*.ts'],
+        rules: {
+            '@typescript-eslint/dot-notation': 'off',
+            '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+            '@typescript-eslint/no-non-null-assertion': 'off',
+            'no-var': 'off',
+            'camelcase': 'off'
+        }
     }]
 };

.github/copilot-instructions.md

@@ -0,0 +1,37 @@
+# BrighterScript - Copilot Instructions
+
+Compiler (written in TypeScript) to transform BrighterScript (a superset of Roku's BrightScript) into valid BrightScript code.
+
+## Architecture
+- **Core**: Lexer → Parser → AST → Compiler
+- **Patterns**: Visitor pattern for AST traversal, plugin-based extensibility
+- **Key Classes**: `Program`, `Scope`, `Parser`, `Lexer`, `BrsFile`, `XmlFile`
+- **Language Server**: Implements LSP for IDE features like autocompletion, diagnostics, and code navigation
+
+## Code Style
+- TypeScript strict mode, PascalCase for classes, camelCase for variables
+- `.spec.ts` for tests adjacent to source files
+- Use `Diagnostic` class for errors/warnings with source locations
+
+## Key Directories
+- `src/parser/` - Parser and AST nodes
+- `src/lexer/` - Tokenization
+- `src/files/` - File handlers
+- `src/lsp/` - Language server
+- `src/astUtils/` - AST manipulation utilities
+
+## Common Patterns
+- Use `AstEditor` for safe AST modifications in plugins
+- Visitor pattern for AST traversal (`astUtils/visitors`)
+- Plugin system via `PluginInterface`
+- Error recovery in parser for IDE experience
+
+## Build Commands
+- `npm run build` - Build project
+- `npm run test:nocover` - Run tests without coverage but correct source maps
+- `npm run lint` - Run ESLint
+
+## Notes
+- Transpiled code must be valid BrightScript syntax that runs on Roku devices
+- BrighterScript is superset of BrightScript
+- Performance-critical: optimize AST traversal and caching

.github/workflows/build.yml

@@ -3,8 +3,6 @@ on:
   push:
     branches:
       - master
-    tags:
-      - v*
   pull_request:
 
 jobs:
@@ -20,53 +18,12 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: "14.18.1"
+          node-version: "16.20.2"
+          architecture: 'x64' # fix for macos-latest
       - run: npm ci
       - run: npm run build
       - run: npm run lint
       - run: npm run test
       - run: npm run publish-coverage
-      - run: npm run test-related-projects
-  npm-release:
-    #only run this task if a tag starting with 'v' was used to trigger this (i.e. a tagged release)
-    if: startsWith(github.ref, 'refs/tags/v')
-    needs: ci
-    runs-on: ubuntu-latest
-    env:
-      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-    steps:
-      - uses: actions/checkout@master
-      - uses: actions/setup-node@master
-        with:
-          node-version: "14.18.1"
-      - run: echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ./.npmrc
-      - run: npm ci
-      - run: npm run build
-      #create npm package
-      - run: npm pack
-      - run: npm run test-related-projects
-
-      #create GitHub release
-      - name: Create GitHub Release
-        id: create_release
-        uses: actions/create-release@latest
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: ${{ github.ref }}
-          draft: false
-          prerelease: false #contains(github.ref, '-beta.') == true
-
-      #upload package to GitHub release
-      - name: Upload GitHub Release Assets
-        uses: alexellis/upload-assets@0.2.3
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          asset_paths: '["./*.tgz"]'
-
-      #If there's a dash followed by an alpha character, this is a prerelease and should be tagged "next". Otherwise tag as "latest"
-      - run: if [[ "${{ github.ref }}" =~ -[a-zA-Z] ]]; then echo "DIST_TAG=next" >> $GITHUB_ENV; else echo "DIST_TAG=latest" >> $GITHUB_ENV; fi
-      #upload to npm
-      - run: npm publish --tag ${{env.DIST_TAG}}
+      # this is stalling out for some reason, so disable it for now
+      #- run: npm run test-related-projects

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,40 @@
+name: "Copilot Setup Steps"
+
+# Automatically run the setup steps when they are changed to allow for easy validation, and
+# allow manual testing through the repository's "Actions" tab
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # Set the permissions to the lowest permissions possible needed for your steps.
+    # Copilot will be given its own token for its operations.
+    permissions:
+      # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
+      contents: read
+
+    # You can define any steps you want, and they will run before the agent starts.
+    # If you do not check out your code, Copilot will do this for you.
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "16.20.2"
+          cache: "npm"
+
+      - name: Install JavaScript dependencies
+        run: npm install

.github/workflows/create-package.yml

@@ -0,0 +1,57 @@
+name: create-package
+on:
+  pull_request:
+    types: [labeled, unlabeled, synchronize]
+jobs:
+  create-package:
+    runs-on: ubuntu-latest
+    if: contains(github.event.pull_request.labels.*.name, 'create-package')
+    env:
+      GH_TOKEN: ${{ github.token }}
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@master
+        with:
+          node-version: "16.20.2"
+      # Get a bot token so the bot's name shows up on all our actions
+      - name: Get Token From roku-ci-token Application
+        uses: tibdex/github-app-token@v1
+        id: generate-token
+        with:
+          app_id: ${{ secrets.BOT_APP_ID }}
+          private_key: ${{ secrets.BOT_PRIVATE_KEY }}
+      - run: echo "TOKEN=${{ steps.generate-token.outputs.token }}" >> $GITHUB_ENV
+      - name: Compute variables
+        run: |
+          CURRENT_VERSION=$(grep -o '\"version\": *\"[^\"]*\"' package.json | awk -F'\"' '{print $4}')
+          SANITIZED_BRANCH_NAME=$(echo "$GITHUB_HEAD_REF" | sed 's/[^0-9a-zA-Z-]/-/g')
+          BUILD_VERSION="$CURRENT_VERSION-$SANITIZED_BRANCH_NAME.$(date +%Y%m%d%H%M%S)"
+          NPM_PACKAGE_NAME=$(grep -o '\"name\": *\"[^\"]*\"' package.json | awk -F'\"' '{print $4}' | sed -e 's/@//g' -e 's#/#-#g')
+          ARTIFACT_NAME=$(echo "$NPM_PACKAGE_NAME-$BUILD_VERSION.tgz" | tr '/' '-')
+          ARTIFACT_URL="${{ github.server_url }}/${{ github.repository }}/releases/download/v0.0.0-packages/${ARTIFACT_NAME}"
+
+          echo "BUILD_VERSION=$BUILD_VERSION" >> $GITHUB_ENV
+          echo "ARTIFACT_URL=$ARTIFACT_URL" >> $GITHUB_ENV
+
+      - run: npm ci
+      - run: npm version "$BUILD_VERSION" --no-git-tag-version
+      - run: npm pack
+
+      # create the release if not exist
+      - run: gh release create v0.0.0-packages --title "v0.0.0-packages" --latest=false --prerelease --notes "catchall release for temp packages" -R ${{ github.repository }}
+        continue-on-error: true
+
+      # upload this artifact to the "packages" github release
+      - run: gh release upload v0.0.0-packages *.tgz -R ${{ github.repository }}
+
+      - name: Fetch build artifact
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ env.TOKEN }}
+          script: |
+              return github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: "Hey there! I just built a new temporary npm package based on ${{ github.event.pull_request.head.sha }}. You can download it [here](${{ env.ARTIFACT_URL }}) or install it by running the following command: \n```bash\nnpm install ${{ env.ARTIFACT_URL }}\n```"
+              });

.github/workflows/initialize-release.yml

@@ -0,0 +1,40 @@
+name: Initialize Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      branch:
+        type: string
+        description: "Create release from this branch:"
+        default: "master"
+        required: true
+      releaseType:
+        type: choice
+        description: "Release type:"
+        required: true
+        default: "patch"
+        options:
+          - major
+          - minor
+          - patch
+          - prerelease
+      customVersion:
+        type: string
+        description: "Version override: (ignore release type)"
+        default: ""
+        required: false
+      installDependencies:
+        type: boolean
+        description: "Install latest RokuCommunity dependencies"
+        required: true
+        default: true
+
+jobs:
+  run:
+    uses: rokucommunity/workflows/.github/workflows/initialize-release.yml@master
+    with:
+      branch: ${{ github.event.inputs.branch }}
+      releaseType: ${{ github.event.inputs.releaseType }}
+      customVersion: ${{ github.event.inputs.customVersion }}
+      installDependencies: ${{ github.event.inputs.installDependencies }}
+    secrets: inherit

.github/workflows/make-release-artifacts.yml

@@ -0,0 +1,38 @@
+name: Make Release Artifacts
+
+on:
+  pull_request:
+    types:
+      - reopened
+      - opened
+      - synchronize
+  workflow_dispatch:
+    inputs:
+      tag:
+        type: string
+        description: 'The release tag that should be referenced (i.e. `v1.2.3`)'
+        required: true
+      force:
+        type: boolean
+        description: 'Force the release artifacts to be created and uploaded'
+        required: false
+        default: false
+
+jobs:
+  run:
+    if: github.event_name == 'workflow_dispatch' || startsWith( github.head_ref, 'release/')
+    uses: rokucommunity/workflows/.github/workflows/make-release-artifacts.yml@master
+    with:
+      branch: ${{ github.event.inputs.tag || github.event.pull_request.head.ref }}
+      node-version: "16.20.2"
+      artifact-paths: "./*.tgz" # "*.vsix"
+      force: ${{ github.event.inputs.force == 'true' }}
+    secrets: inherit
+
+  success-or-skip:
+    if: always()
+    needs: [run]
+    runs-on: ubuntu-latest
+    steps:
+      - run: if [ "${{ needs.run.result }}" = "failure" ]; then exit 1; fi
+