rokucommunity · TwitchBronBron · Aug 19, 2024 · Aug 19, 2024 · Aug 19, 2024 · Aug 19, 2024
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,201 @@
+module.exports = {
+    root: true,
+    parser: '@typescript-eslint/parser',
+    env: {
+        node: true,
+        mocha: true,
+        es6: true
+    },
+    parserOptions: {
+        project: ['./tsconfig.json'],
+        createDefaultProgram: true
+    },
+    plugins: [
+        '@typescript-eslint',
+        'no-only-tests',
+        'jsdoc'
+    ],
+    extends: [
+        'eslint:all',
+        'plugin:@typescript-eslint/all',
+        'plugin:jsdoc/recommended',
+        'plugin:import/typescript'
+    ],
+    rules: {
+        '@typescript-eslint/array-type': 'off',
+        '@typescript-eslint/consistent-type-assertions': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-member-accessibility': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/indent': ['error', 4],
+        '@typescript-eslint/init-declarations': 'off',
+        '@typescript-eslint/parameter-properties': 'off',
+        '@typescript-eslint/lines-between-class-members': 'off',
+        '@typescript-eslint/member-ordering': 'off',
+        '@typescript-eslint/method-signature-style': 'off',
+        '@typescript-eslint/naming-convention': 'off',
+        '@typescript-eslint/no-base-to-string': 'off',
+        '@typescript-eslint/no-confusing-void-expression': 'off',
+        '@typescript-eslint/no-dynamic-delete': 'off',
+        '@typescript-eslint/no-empty-function': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-extra-parens': 'off',
+        '@typescript-eslint/no-floating-promises': 'error',
+        '@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', {}],
+        //mitigating this sometimes results in undesirably verbose code. Should investigate enabling again in the future.
+        '@typescript-eslint/no-unsafe-argument': 'off',
+        'object-curly-spacing': 'off',
+        '@typescript-eslint/object-curly-spacing': [
+            'error',
+            'always'
+        ],
+        '@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',
+        '@typescript-eslint/no-unsafe-return': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-unused-vars-experimental': 'off',
+        '@typescript-eslint/no-use-before-define': 'off',
+        '@typescript-eslint/prefer-for-of': 'error',
+        '@typescript-eslint/prefer-readonly': 'off',
+        '@typescript-eslint/prefer-readonly-parameter-types': 'off',
+        '@typescript-eslint/promise-function-async': 'off',
+        '@typescript-eslint/quotes': [
+            'error',
+            'single',
+            {
+                'allowTemplateLiterals': true
+            }
+        ],
+        '@typescript-eslint/require-array-sort-compare': 'off',
+        '@typescript-eslint/restrict-plus-operands': 'off',
+        '@typescript-eslint/restrict-template-expressions': 'off',
+        '@typescript-eslint/sort-type-union-intersection-members': 'off',
+        '@typescript-eslint/space-before-function-paren': 'off',
+        '@typescript-eslint/space-infix-ops': 'off',
+        '@typescript-eslint/strict-boolean-expressions': 'off',
+        '@typescript-eslint/typedef': 'off',
+        '@typescript-eslint/unbound-method': 'off',
+        '@typescript-eslint/unified-signatures': 'off',
+        'jsdoc/require-param': 'off',
+        'jsdoc/require-returns': 'off',
+        'jsdoc/require-param-type': 'off',
+        'jsdoc/newline-after-description': 'off',
+        'jsdoc/require-jsdoc': 'off',
+        'jsdoc/require-returns-type': 'off',
+        'array-bracket-newline': 'off',
+        'array-element-newline': 'off',
+        'array-type': 'off',
+        'arrow-body-style': 'off',
+        'arrow-parens': 'off',
+        'callback-return': 'off',
+        'capitalized-comments': 'off',
+        'class-methods-use-this': 'off',
+        'complexity': 'off',
+        'consistent-return': 'off',
+        'consistent-this': 'off',
+        'curly': 'error',
+        'default-case': 'off',
+        'dot-location': 'off',
+        'dot-notation': 'off',
+        'func-style': 'off',
+        'function-call-argument-newline': 'off',
+        'function-paren-newline': 'off',
+        'getter-return': 'off',
+        'guard-for-in': 'off',
+        'id-length': 'off',
+        'indent': 'off',
+        'init-declarations': 'off',
+        'line-comment-position': 'off',
+        'linebreak-style': 'off',
+        'lines-around-comment': 'off',
+        'lines-between-class-members': 'off',
+        'max-classes-per-file': 'off',
+        'max-depth': 'off',
+        'max-len': 'off',
+        'max-lines': 'off',
+        'max-lines-per-function': 'off',
+        'max-params': 'off',
+        'max-statements': 'off',
+        'no-only-tests/no-only-tests': 'error',
+        'multiline-comment-style': 'off',
+        'multiline-ternary': 'off',
+        'new-cap': 'off',
+        'newline-per-chained-call': 'off',
+        'no-await-in-loop': 'off',
+        'no-case-declarations': 'off',
+        'no-constant-condition': 'off',
+        'no-console': 'off',
+        'no-continue': 'off',
+        'no-else-return': 'off',
+        'no-empty': 'off',
+        'no-implicit-coercion': 'off',
+        'no-inline-comments': 'off',
+        'no-invalid-this': 'off',
+        'no-labels': 'off',
+        'no-lonely-if': 'off',
+        'no-negated-condition': 'off',
+        'no-param-reassign': 'off',
+        'no-plusplus': 'off',
+        'no-process-exit': 'off',
+        'no-prototype-builtins': 'off',
+        'no-shadow': 'off',
+        'no-sync': 'off',
+        'no-ternary': 'off',
+        'no-undefined': 'off',
+        'no-underscore-dangle': 'off',
+        'no-unneeded-ternary': 'off',
+        'no-useless-escape': 'off',
+        'no-void': 'off',
+        'no-warning-comments': 'off',
+        'object-property-newline': 'off',
+        'object-shorthand': [
+            'error',
+            'never'
+        ],
+        'one-var': [
+            'error',
+            'never'
+        ],
+        'padded-blocks': 'off',
+        'prefer-const': 'off',
+        'prefer-destructuring': 'off',
+        'prefer-named-capture-group': 'off',
+        'prefer-template': 'off',
+        'quote-props': 'off',
+        'radix': 'off',
+        'require-atomic-updates': 'off',
+        'require-unicode-regexp': 'off',
+        'sort-imports': 'off',
+        'sort-keys': 'off',
+        'spaced-comment': 'off',
+        'space-infix-ops': 'off',
+        'vars-on-top': 'off',
+        'wrap-regex': 'off'
+    },
+    //disable some rules for certain files
+    overrides: [
+        {
+            files: ['*.spec.ts'],
+            rules: {
+                '@typescript-eslint/no-unsafe-assignment': 'off'
+            }
+        }
+    ]
+};
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,72 @@
+name: build
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+  pull_request:
+
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+    env:
+      #hardcode the coveralls token...it's not overly important to protect, and github actions won't allow forks to work with coveralls otherwise
+      COVERALLS_REPO_TOKEN: "cWbYQOzb44Bw7mbPuoYVY6W9qJIpZBQCJ"
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@master
+        with:
+          node-version: "14.18.1"
+          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
+  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"
+          architecture: 'x64' # fix for macos-latest
+      - run: echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ./.npmrc
+      - run: npm ci
+      - run: npm run build
+      #create npm package
+      - run: npm pack
+
+      #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}}
diff --git a/.github/workflows/create-package.yml b/.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: "14.19.0"
+      # 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```"
+              });
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,13 @@
+node_modules*
+dist
+out
+.tmp
+.history
+.DS_Store
+.roku-deploy-staging
+coverage
+.nyc_output
+*.zip
+isolate-*
+v8*.log
+*.cpuprofile
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,28 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Tests",
+            "type": "pwa-node",
+            "request": "launch",
+            "smartStep": true,
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "sourceMaps": true,
+            "args": [
+                "--timeout",
+                "987654"
+            ],
+            "skipFiles": [
+                "${workspaceFolder}/node_modules/**/*.js",
+                "<node_internals>/**/*.js"
+            ],
+            "cwd": "${workspaceRoot}",
+            "internalConsoleOptions": "openOnSessionStart",
+            "resolveSourceMapLocations": [
+                "${workspaceFolder}/**",
+                "!**/node_modules/typescript/**",
+                "!**/node_modules/vscode-languageserver*/**"
+            ]
+        }
+    ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,10 @@
+{
+    "editor.tabSize": 4,
+    "editor.insertSpaces": true,
+    "editor.detectIndentation": false,
+    "cSpell.words": [
+        "brighterscript",
+        "findnode",
+        "findnodes"
+    ]
+}