Merge pull request #1 from rokucommunity/adoption

refactor in preparation for adoption the project

Author: TwitchBronBron

.github/workflows/build.yml

@@ -0,0 +1,70 @@
+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: 83xyW4IxLCtIw0LxM8NoMeRDGWj8bYYq5
+      CI: true
+    strategy:
+      matrix:
+        os: [ubuntu-latest] #, macos-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@master
+        with:
+          node-version: "12.22.7"
+      - run: npm ci
+      - run: npm run build
+      - run: npm run lint
+      - run: npm run prettier
+      - 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: "12.22.7"
+      - 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"]'
+
+      #upload to npm
+      - run: npm publish

.github/workflows/nightly-build.yaml

@@ -3,3 +3,4 @@ lib/
 types/
 node_modules/
 .vscode/
+coverage/

.github/workflows/pull-request.yaml

@@ -15,7 +15,7 @@ Since this project is still maturing, many of its initial contributions will tak
 
 ## Submitting Issues
 
-If you find something wrong with `brs`, or something doesn't seem right, feel free to [open a new issue](https://github.com/sjbarag/brs/issues/new). Please try to avoid "how do I X in BrightScript" questions however — those are best suited for [StackOverflow](https://stackoverflow.com) or similar Q&A sites.
+If you find something wrong with `brs`, or something doesn't seem right, feel free to [open a new issue](https://github.com/rokucommunity/brs/issues/new). Please try to avoid "how do I X in BrightScript" questions however — those are best suited for [StackOverflow](https://stackoverflow.com) or similar Q&A sites.
 
 ### Bug Reports
 
@@ -43,7 +43,7 @@ Regardless of whether you're fixing bugs or implementing new features, there's a
 
 1. Comment on the issue and tell us that you're intereseted in working on it. This should lower the (admittedly rare) chances of someone stealing your that bug/feature from you :smile:.
 1. Create a fork of this repo if you haven't already
-1. Send us a [pull request](https://github.com/sjbarag/brs/pulls)!
+1. Send us a [pull request](https://github.com/rokucommunity/brs/pulls)!
 
 ### Adding a component
 
@@ -53,6 +53,6 @@ For guidelines on adding a component to `brs`, see [this doc](docs/AddingCompone
 
 There aren't to many mandatory things for pull requests, besides what you'd expect from any open-source project (e.g. "don't delete all the code", "don't delete a user's home directory at runtime"). The most important project-specific "must-haves" that we'll look for that are:
 
-1. Pull requests should be based on a pretty recent version of the `main` branch, to minimize merge conflicts.
+1. Pull requests should be based on a pretty recent version of the `master` branch, to minimize merge conflicts.
 1. All tests should pass (Travis CI will let us know if any fail).
 1. End to end tests written in BrightScript should be present to exercise the bug or new feature. These don't need to be exhaustive — just enough to ensure that the major use-cases are covered. More in-depth testing can happen via unit test.

.github/workflows/release.yaml

@@ -24,8 +24,13 @@
 # BRS: Off-Roku BrightScript
 An interpreter for the BrightScript language that runs on non-Roku platforms.
 
-[![CircleCI](https://circleci.com/gh/sjbarag/brs.svg?style=svg)](https://circleci.com/gh/sjbarag/brs)
-[![NPM Version](https://badge.fury.io/js/brs.svg?style=flat)](https://npmjs.org/package/brs)
+[![build status](https://img.shields.io/github/actions/workflow/status/rokucommunity/brs/build.yml?branch=master&logo=github)](https://github.com/rokucommunity/brs/actions?query=branch%3Amaster+workflow%3Abuild)
+[![coverage status](https://img.shields.io/coveralls/github/rokucommunity/brs?logo=coveralls)](https://coveralls.io/github/rokucommunity/brs?branch=master)
+[![monthly downloads](https://img.shields.io/npm/dm/@rokucommunity/brs.svg?sanitize=true&logo=npm&logoColor=)](https://npmcharts.com/compare/@rokucommunity/brs?minimal=true)
+[![npm version](https://img.shields.io/npm/v/@rokucommunity/brs.svg?logo=npm)](https://www.npmjs.com/package/@rokucommunity/brs)
+[![license](https://img.shields.io/github/license/rokucommunity/brs.svg)](LICENSE)
+[![Slack](https://img.shields.io/badge/Slack-RokuCommunity-4A154B?logo=slack)](https://join.slack.com/t/rokudevelopers/shared_invite/zt-4vw7rg6v-NH46oY7hTktpRIBM_zGvwA)
+
 
 ## Installation
 The BRS project is published as a `node` package, so use `npm`:
@@ -34,12 +39,6 @@ The BRS project is published as a `node` package, so use `npm`:
 $ npm install -g brs
 ```
 
-or `yarn` if that's your preference:
-
-```shell
-$ yarn global add brs
-```
-
 ## Usage
 This repo provides the `brs` executable, which operates in two ways.
 
@@ -77,32 +76,23 @@ The BRS project follows pretty standard `node` development patterns, with the ca
 ### Prerequisites
 BRS builds (and runs) in `node`, so you'll need to [install that first](https://nodejs.org).
 
-Once that's ready, install [yarn](https://yarnpkg.com).  Installing it with `npm` is probably the simplest:
-
-```shell
-$ npm install -g yarn
-```
 ### Setup
 1. Clone this repo:
    ```
-   $ git clone https://github.com/sjbarag/brs.git
+   $ git clone https://github.com/rokucommunity/brs.git
    ```
 
 2. Install dependencies:
     ```shell
-    $ yarn install     # or just `yarn`
+    $ npm install
     ```
 
-3. Get `brs` onto your `PATH`:
-    ``` shell
-    $ yarn link
-    ```
 ### The build-test-clean dance
 #### Build
-This project is written in TypeScript, so it needs to be compiled before it can be executed.  `yarn build` compiles files in `src/` into JavaScript and TypeScript declarations, and puts them in `lib/` and `types/` respectively.
+This project is written in TypeScript, so it needs to be compiled before it can be executed.  `npm run build` compiles files in `src/` into JavaScript and TypeScript declarations, and puts them in `lib/` and `types/` respectively.
 
 ```shell
-$ yarn build
+$ npm run build
 
 $ ls lib/
 index.js (and friends)
@@ -111,17 +101,17 @@ $ ls types/
 index.d.ts (and friends)
 ```
 
-Alternatively, you can run the build step in "watch" mode. This will run `yarn build` for you automatically, every time it detects source file changes:
+Alternatively, you can run the build step in "watch" mode. This will run `npm run build` for you automatically, every time it detects source file changes:
 ```shell
-$ yarn watch
+$ npm run watch
 ```
-This is often useful for testing that local changes work in your BrightScript project, without having to run `yarn build` over and over.
+This is often useful for testing that local changes work in your BrightScript project, without having to run `npm run build` over and over.
 
 #### Testing
 Tests are written in plain-old JavaScript with [Facebook's Jest](http://facebook.github.io/jest/), and can be run with the `test` target:
 
 ```shell
-$ yarn test
+$ npm run test
 
 # tests start running
 ```

.gitignore

@@ -3,7 +3,7 @@
 This is aimed to be a quick guide for adding a component to `brs`. Note that this may not be comprehensive in all cases, but is a general plan of attack. Here are the steps you should take:
 
 1. Find the documentation for your component on [Roku's developer docs](https://developer.roku.com). For example, the documentation for the `Group` component can be found [here](https://developer.roku.com/en-gb/docs/references/scenegraph/layout-group-nodes/group.md).
-1. Create a file in the [components directory](https://github.com/sjbarag/brs/tree/main/src/brsTypes/components) called `<insert component name>.ts`.
+1. Create a file in the [components directory](https://github.com/rokucommunity/brs/tree/master/src/brsTypes/components) called `<insert component name>.ts`.
 1. Copy the following code and paste it into your new file:
 
     ```
@@ -26,9 +26,9 @@ This is aimed to be a quick guide for adding a component to `brs`. Note that thi
     ```
 
 1. Replace all `<insert component name>` and `<insert parent component>` from above with your component name. Add any built-in fields and/or class functions that the Roku docs specify.
-1. Add a constructor definition to the [component factory](https://github.com/sjbarag/brs/blob/main/src/brsTypes/components/ComponentFactory.ts). This will allow instances of your new component to be created dynamically when it is encountered in XML or BrightScript code.
-1. Add a test case for your Typescript class in [the components test directory](https://github.com/sjbarag/brs/tree/main/test/brsTypes/components). Use the existing component test files in that directory as a model for what your test should look like.
+1. Add a constructor definition to the [component factory](https://github.com/rokucommunity/brs/blob/main/src/brsTypes/components/ComponentFactory.ts). This will allow instances of your new component to be created dynamically when it is encountered in XML or BrightScript code.
+1. Add a test case for your Typescript class in [the components test directory](https://github.com/rokucommunity/brs/tree/master/test/brsTypes/components). Use the existing component test files in that directory as a model for what your test should look like.
 1. Add an end-to-end test case.
-    - Create a file in [the end-to-end directory](https://github.com/sjbarag/brs/tree/main/test/e2e) called `<insert component name>.brs`. In the file, write BrightScript code that exercises your component functionality.
-    - Add an XML file to the [the components test directory](https://github.com/sjbarag/brs/tree/main/test/brsTypes/components) that uses your component.
-    - Add a test block to [BrsComponents.test.js](https://github.com/sjbarag/brs/blob/main/test/e2e/BrsComponents.test.js). In this block, verify that the code from your XML and Brightscript files is behaving as expected.
+    - Create a file in [the end-to-end directory](https://github.com/rokucommunity/brs/tree/master/test/e2e) called `<insert component name>.brs`. In the file, write BrightScript code that exercises your component functionality.
+    - Add an XML file to the [the components test directory](https://github.com/rokucommunity/brs/tree/master/test/brsTypes/components) that uses your component.
+    - Add a test block to [BrsComponents.test.js](https://github.com/rokucommunity/brs/blob/main/test/e2e/BrsComponents.test.js). In this block, verify that the code from your XML and Brightscript files is behaving as expected.