Enforce code style and linting to eliminate Studio indentation warnings (#321)

* Add foreman.toml that adds selene, stylua, and rojo. Run them in CI.
* Update contribution document. Eliminate luacheck from CI
* Fix a few Studio analysis warnings. Pin a few simple files for strict and nonstrict analysis. I think this is good enough for now.
* Fix selene lints and format codebase using StyLua.

Co-authored-by: Paul Doyle <[email protected]>

Author: matthargett

.github/workflows/ci.yml

@@ -24,21 +24,41 @@ jobs:
 
     - uses: leafo/gh-actions-luarocks@v4
 
+    - name: get foreman and run foreman install
+      uses: rojo-rbx/setup-foreman@v1
+      with:
+        version: "^1.0.1"
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    # useful for debugging differences between CI and local environment
+    - name: check versions
+      shell: bash
+      run: |
+        foreman list
+
+    - name: use rojo to build project
+      shell: bash
+      run: rojo build default.project.json --output model.rbxmx
+
+    - name: Linting and Style Checking
+      shell: bash
+      run: |
+        selene src benchmarks examples
+        stylua -c src benchmarks examples
+
     - name: Install dependencies
       run: |
         luarocks install luafilesystem
         luarocks install luacov
         luarocks install luacov-reporter-lcov
-        luarocks install luacheck
 
     - name: Test
       run: |
         lua -lluacov bin/spec.lua
-        luacheck src benchmarks examples
         luacov -r lcov
 
     - name: Report to Coveralls
       uses: coverallsapp/[email protected]
       with:
         github-token: ${{ secrets.GITHUB_TOKEN }}
-        path-to-lcov: luacov.report.out
+        path-to-lcov: luacov.report.out

.gitignore

@@ -3,4 +3,6 @@
 /*.rbxlx
 /*.rbxmx
 /*.rbxm
-/*.rbxl
+/*.rbxl
+# let selene re-generate roblox.toml so it updates automatically with selene
+roblox.toml

.luacheckrc

@@ -22,9 +22,20 @@ To get started working on Roact, you'll need:
 * Lua 5.1
 * Lemur's dependencies:
 	* [LuaFileSystem](https://keplerproject.github.io/luafilesystem/) (`luarocks install luafilesystem`)
-* [Luacheck](https://github.com/mpeterv/luacheck) (`luarocks install luacheck`)
 * [LuaCov](https://keplerproject.github.io/luacov) (`luarocks install luacov`)
 
+Foreman is an un-package manager that retrieves code directly from GitHub repositories. We'll use this to get a lua code analysis tool and other utilities. The Foreman packages are listed in `foreman.toml`.
+
+You can install `foreman` from its [releases page](https://github.com/rojo-rbx/foreman/releases). If you have the Rust tool `cargo` installed, you can also do `cargo install foreman`. Either way, be sure the foreman binary location is in your `PATH` environment variable.
+
+```
+foreman github-auth <[your GitHub API token](https://github.com/settings/tokens)>
+foreman install
+export PATH=$PATH:~/.foreman/bin/ # you might want to add this to your .bash_profile (or similarly appropriate shell configuration) file as well
+```
+
+After running `foreman install`, you should be able to run `stylua src` and `selene src` commands -- just like this repository's continuous integration steps do! This helps ensure that our code and your contributions are consistently formatted and are free of trivial bugs.
+
 Make sure you have all of the Git submodules for Roact downloaded, which include a couple extra dependencies used for testing.
 
 Finally, you can run all of Roact's tests with:
@@ -44,10 +55,10 @@ luacov
 Before starting a pull request, open an issue about the feature or bug. This helps us prevent duplicated and wasted effort. These issues are a great place to ask for help if you run into problems!
 
 Before you submit a new pull request, check:
-* Code Style: Match the [official Roblox Lua style guide](https://roblox.github.io/lua-style-guide) and the local code style
-* Changelog: Add an entry to [CHANGELOG.md](CHANGELOG.md)
-* Luacheck: Run [Luacheck](https://github.com/mpeterv/luacheck) on your code, no warnings allowed!
+* Code Style: Run [StyLua](https://github.com/JohnnyMorganz/StyLua) to ensure your code changes follow the [official Roblox Lua style guide](https://roblox.github.io/lua-style-guide) and the local code style
+* selene: Run [Selene](https://github.com/kampfkarren/selene) on your code, no warnings allowed!
 * Tests: They all need to pass!
+* Changelog: Add an entry to [CHANGELOG.md](CHANGELOG.md)
 
 ### Code Style
 Roblox has an [official Lua style guide](https://roblox.github.io/lua-style-guide) which should be the general guidelines for all new code. When modifying code, follow the existing style!
@@ -58,7 +69,7 @@ In short:
 * Double quotes
 * One statement per line
 
-Eventually we'll have a tool to check these things automatically.
+Use `StyLua` (instructions below) to automatically format the code to follow the coding style
 
 ### Changelog
 Adding an entry to [CHANGELOG.md](CHANGELOG.md) alongside your commit makes it easier for everyone to keep track of what's been changed.
@@ -67,10 +78,10 @@ Add a line under the "Current master" heading. When we make a new release, all o
 
 Add a link to your pull request in the entry. We don't need to link to the related GitHub issue, since pull requests will also link to them.
 
-### Luacheck
-We use [Luacheck](https://github.com/mpeterv/luacheck) for static analysis of Lua on all of our projects.
+### Selene and StyLua
+We use [Selene](https://github.com/kampfkarren/selene) and [StyLua](https://github.com/JohnnyMorganz/StyLua) for static analysis of Lua on all of our projects.
 
-From the command line, just run `luacheck src` to check the Roact source.
+From the command line, just run `selene src` and `stylua -c src` to check the Roact source. You'll need to install `foreman` and run `foreman install` first, which will make both the `selene` and `stylua` tools available.
 
 You should get it working on your system, and then get a plugin for the editor you use. There are plugins available for most popular editors!
 
@@ -97,4 +108,4 @@ When releasing a new version of Roact, do these things:
 7. Write a release on GitHub:
 	- Use the same format as the previous release
 	- Copy the release notes from `CHANGELOG.md`
-	- Attach the `Roact.rbxm` built with Rojo
+	- Attach the `Roact.rbxm` built with Rojo

CONTRIBUTING.md

@@ -11,4 +11,4 @@ return {
 		local handle = Roact.mount(hello)
 		Roact.unmount(handle)
 	end,
-}
+}

benchmarks/hello.bench.lua

@@ -11,8 +11,7 @@ local function findBenchmarkModules(root, moduleList)
 	end
 end
 
-local function noop()
-end
+local function noop() end
 
 local emptyTimes = {}
 local function getEmptyTime(iterations)
@@ -42,11 +41,7 @@ table.sort(benchmarkModules, function(a, b)
 	return a.Name < b.Name
 end)
 
-local startMessage = (
-	"Starting %d benchmarks..."
-):format(
-	#benchmarkModules
-)
+local startMessage = ("Starting %d benchmarks..."):format(#benchmarkModules)
 print(startMessage)
 print()
 
@@ -70,9 +65,7 @@ for _, module in ipairs(benchmarkModules) do
 
 	local totalTime = (endTime - startTime) - getEmptyTime(benchmark.iterations)
 
-	local message = (
-		"Benchmark %s:\n\t(%d iterations) took %f s (%f ns/iteration)"
-	):format(
+	local message = ("Benchmark %s:\n\t(%d iterations) took %f s (%f ns/iteration)"):format(
 		module.Name,
 		benchmark.iterations,
 		totalTime,
@@ -83,4 +76,4 @@ for _, module in ipairs(benchmarkModules) do
 	print()
 end
 
-print("Benchmarks complete!")
+print("Benchmarks complete!")

benchmarks/init.server.lua

@@ -14,8 +14,11 @@ return {
 		Roact.unmount(tree)
 	end,
 	step = function(i)
-		Roact.update(tree, Roact.createElement("StringValue", {
-			Value = tostring(i),
-		}))
+		Roact.update(
+			tree,
+			Roact.createElement("StringValue", {
+				Value = tostring(i),
+			})
+		)
 	end,
-}
+}

benchmarks/update.bench.lua

@@ -1,5 +1,3 @@
--- luacheck: globals __LEMUR__
-
 local ReplicatedStorage = game:GetService("ReplicatedStorage")
 local isRobloxCli, ProcessService = pcall(game.GetService, game, "ProcessService")
 
@@ -19,8 +17,8 @@ local results = TestEZ.TestBootstrap:run(
 
 local statusCode = (results.failureCount == 0 and #results.errors == 0) and 0 or 1
 
-if __LEMUR__ then
+if _G.__LEMUR__ then
 	os.exit(statusCode)
 elseif isRobloxCli then
 	ProcessService:ExitAsync(statusCode)
-end
+end

bin/run-tests.server.lua

@@ -48,4 +48,4 @@ return function()
 	end
 
 	return stop
-end
+end

examples/binding/init.lua

@@ -18,17 +18,23 @@ return function()
 
 	local running = true
 	local currentTime = 0
-	local handle = Roact.mount(Roact.createElement(ClockApp, {
-		time = currentTime,
-	}), PlayerGui)
+	local handle = Roact.mount(
+		Roact.createElement(ClockApp, {
+			time = currentTime,
+		}),
+		PlayerGui
+	)
 
 	spawn(function()
 		while running do
 			currentTime = currentTime + 1
 
-			handle = Roact.reconcile(handle, Roact.createElement(ClockApp, {
-				time = currentTime,
-			}))
+			handle = Roact.reconcile(
+				handle,
+				Roact.createElement(ClockApp, {
+					time = currentTime,
+				})
+			)
 
 			wait(1)
 		end
@@ -40,4 +46,4 @@ return function()
 	end
 
 	return stop
-end
+end