Modernize the repository (#3)

* lib -> src

* Foreman

* Wally

* Remove roblox.toml

* Remove use of submodules

* Update LICENSE

* Setup unit test runner again

* Add workflows

* Add TestEZ globals

* Remove old test runner

* Filter out mocks

* Fix Selene errors

* StyLua pass

* Update README

* Mount the example

* Tidy up the example

* Rename example

.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  schedule:
+    # Every day at 8pm UTC (12am PST)
+    - cron: "0 20 * * *"
+
+jobs:
+  code-quality:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install Foreman dependencies
+        uses: Roblox/setup-foreman@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Lint
+        run: |
+          selene generate-roblox-std
+          selene src/
+
+      - name: Format
+        run: stylua --check src/
+
+  tests:
+    runs-on: windows-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install toolchain
+        uses: Roblox/setup-foreman@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install dependencies
+        run: wally install
+
+      - name: Build place file
+        run: rojo build dev.project.json -o studio-tests.rbxlx
+
+      - name: Install Roblox Studio
+        uses: OrbitalOwen/[email protected]
+        with:
+          cookie: ${{ secrets.ROBLOSECURITY }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run tests
+        run: run-in-roblox --place studio-tests.rbxlx --script tests/spec.lua

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+env:
+  OUTPUT_NAME: "ContextControls.rbxm"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install toolchain
+        uses: Roblox/setup-foreman@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Remove spec files
+        run: rm -rf **/*.spec.lua
+
+      - name: Build
+        run: rojo build -o ${{ env.OUTPUT_NAME }}
+
+      - name: Add model file to release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: ${{ env.OUTPUT_NAME }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,5 +1,11 @@
-/*.rbxlx
-/*.rbxmx
+# Rojo
+/*.rbxl*
+/*.rbxm*
 
-# This is where you can store custom configuration settings for the game.
-src/shared/configLocal.lua
+# Selene
+roblox.toml
+
+# Wally
+/Packages
+/DevPackages
+wally.lock

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 David Minnerly
+Copyright 2021 David Minnerly
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -3,7 +3,23 @@
 Wrapper around ContextActionService that provides a clean API for creating and
 binding actions, along with flexible mobile button support.
 
-## Getting Started
+## Installation
+
+### Wally
+
+Add the following to your `wally.toml`:
+
+```
+[dependencies]
+ContextControls = "vocksel/[email protected]
+```
+
+### Model File
+
+* Download a copy of the rbxm from the [releases page](https://github.com/vocksel/context-controls/releases/latest) under the Assets section. 
+* Drag and drop the file into Roblox Studio to add it to your experience.
+
+## Usage
 
 ```lua
 local ContextControls = require(game.ReplicatedStorage.ContextControls)
@@ -251,3 +267,7 @@ take control of binding and unbinding it.
 
 If you use this method, it is recommended that you do not manually bind and
 unbind the action, as this could lead to unexpected results.
+
+## License
+
+[MIT License](LICENSE)

default.project.json

@@ -1,44 +1,6 @@
 {
-	"name": "ContextControls",
-	"tree": {
-		"$className": "DataModel",
-
-		"HttpService": {
-			"$className": "HttpService",
-			"$properties": {
-				"HttpEnabled": true
-			}
-		},
-
-		"Players": {
-			"$className": "Players",
-			"$properties": {
-				"CharacterAutoLoads": false
-			}
-		},
-
-		"ReplicatedStorage": {
-            "$className": "ReplicatedStorage",
-            "ContextControls": {
-                "$path": "lib/"
-            }
-		},
-
-		"StarterPlayer": {
-			"$className": "StarterPlayer",
-			"StarterPlayerScripts": {
-				"$className": "StarterPlayerScripts",
-				"TestEz": {
-					"$path": "modules/TestEz/lib"
-				},
-				"TestRunner": {
-					"$path": "tests.client.lua"
-				},
-
-				"Examples": {
-					"$path": "examples"
-				}
-			}
-		}
-	}
-}
+  "name": "context-controls",
+  "tree": {
+    "$path": "src"
+  }
+}

dev.project.json

@@ -0,0 +1,27 @@
+{
+  "name": "context-controls (dev)",
+  "tree": {
+    "$className": "DataModel",
+    "ReplicatedStorage": {
+      "DevPackages": {
+        "$path": "DevPackages"
+      },
+      "ContextControls": {
+        "$path": "src"
+      }
+    },
+    "ServerScriptService": {
+      "Tests": {
+        "$path": "tests"
+      }
+    },
+    "StarterPlayer": {
+      "StarterPlayerScripts": {
+        "$className": "StarterPlayerScripts",
+        "Example": {
+          "$path": "example"
+        }
+      }
+    }
+  }
+}

examples/main.client.lua → example/init.client.lua

@@ -6,10 +6,10 @@ local interact = ContextControls.createAction({
 	name = "interact",
 	inputTypes = {
 		Enum.KeyCode.E,
-		Enum.KeyCode.ButtonX
+		Enum.KeyCode.ButtonX,
 	},
 	inputState = Enum.UserInputState.Begin,
-	callback = function(input)
+	callback = function(_input: InputObject)
 		print("attempting to interact...")
 	end,
 })
@@ -18,10 +18,10 @@ while true do
 	print("bound")
 	interact:bind()
 
-	wait(2)
+	task.wait(2)
 
 	print("unbound")
 	interact:unbind()
 
-	wait(2)
+	task.wait(2)
 end

foreman.toml

@@ -0,0 +1,6 @@
+[tools]
+rojo = { source = "rojo-rbx/rojo", version = "7.0.0" }
+selene = { source = "kampfkarren/selene", version = "0.15.0" }
+stylua = { source = "JohnnyMorganz/StyLua", version = "0.11.2" }
+wally = { source = "UpliftGames/wally", version = "0.3.1" }
+run-in-roblox = { source = "rojo-rbx/run-in-roblox", version = "0.3.0" }