From 2187a1806d450cc5b3352b0e333bad7e98654c19 Mon Sep 17 00:00:00 2001 From: Lucien Greathouse Date: Tue, 21 Jan 2020 14:58:10 -0800 Subject: [PATCH] Rename lib/ folder to src/ (#58) --- .travis.yml | 2 +- CONTRIBUTING.md | 2 +- default.project.json | 2 +- docs/getting-started/installation.md | 2 +- docs/getting-started/running-tests.md | 2 +- rotriever.toml | 2 +- spec.lua | 2 +- {lib => src}/Expectation.lua | 0 {lib => src}/LifecycleHooks.lua | 0 {lib => src}/Reporters/TeamCityReporter.lua | 0 {lib => src}/Reporters/TextReporter.lua | 0 {lib => src}/Reporters/TextReporterQuiet.lua | 0 {lib => src}/Stack.lua | 0 {lib => src}/TestBootstrap.lua | 0 {lib => src}/TestEnum.lua | 0 {lib => src}/TestPlan.lua | 0 {lib => src}/TestPlanBuilder.lua | 0 {lib => src}/TestPlanner.lua | 0 {lib => src}/TestResults.lua | 0 {lib => src}/TestRunner.lua | 0 {lib => src}/TestSession.lua | 0 {lib => src}/init.lua | 0 22 files changed, 7 insertions(+), 7 deletions(-) rename {lib => src}/Expectation.lua (100%) rename {lib => src}/LifecycleHooks.lua (100%) rename {lib => src}/Reporters/TeamCityReporter.lua (100%) rename {lib => src}/Reporters/TextReporter.lua (100%) rename {lib => src}/Reporters/TextReporterQuiet.lua (100%) rename {lib => src}/Stack.lua (100%) rename {lib => src}/TestBootstrap.lua (100%) rename {lib => src}/TestEnum.lua (100%) rename {lib => src}/TestPlan.lua (100%) rename {lib => src}/TestPlanBuilder.lua (100%) rename {lib => src}/TestPlanner.lua (100%) rename {lib => src}/TestResults.lua (100%) rename {lib => src}/TestRunner.lua (100%) rename {lib => src}/TestSession.lua (100%) rename {lib => src}/init.lua (100%) diff --git a/.travis.yml b/.travis.yml index 53a10b9..80522da 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,5 +22,5 @@ install: - luarocks install luacheck script: - - luacheck lib tests + - luacheck src tests - lua spec.lua \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b05ab1f..7aab26d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ Add a line under the "Current master" heading. When we make a new release, all o ### Luacheck We use [Luacheck](https://github.com/mpeterv/luacheck) for static analysis of Lua on all of our projects. -From the command line, just run `luacheck lib` to check the TestEZ source. +From the command line, just run `luacheck src` to check the TestEZ source. 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! diff --git a/default.project.json b/default.project.json index 4ecd2a3..8ff491e 100644 --- a/default.project.json +++ b/default.project.json @@ -1,6 +1,6 @@ { "name": "TestEZ", "tree": { - "$path": "lib" + "$path": "src" } } \ No newline at end of file diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 74f05ff..3311572 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -1,7 +1,7 @@ *In the future, TestEZ will have pre-built model files for use within Roblox without other tools.* ### Method 1: Rojo (Roblox) -* Copy the `lib` directory into your codebase +* Copy the `src` directory into your codebase * Rename the folder to `TestEZ` * Use [Rojo](https://github.com/LPGhatguy/rojo) to sync the files into a place diff --git a/docs/getting-started/running-tests.md b/docs/getting-started/running-tests.md index 228e409..342466b 100644 --- a/docs/getting-started/running-tests.md +++ b/docs/getting-started/running-tests.md @@ -3,7 +3,7 @@ TestEZ provides a convenient method to run tests in a single pass: ```lua local TestEZ = require() -TestEZ.TestBootstrap:run(MY_TESTS) +TestEZ.TestBootstrap:run({ MY_TESTS }) ``` The method also returns information about the test run that can be used to take further action! diff --git a/rotriever.toml b/rotriever.toml index 467f112..86e5867 100644 --- a/rotriever.toml +++ b/rotriever.toml @@ -2,5 +2,5 @@ name = "roblox/testez" author = "Roblox" license = "Apache2" -content_root = "lib" +content_root = "src" version = "0.1.0" diff --git a/spec.lua b/spec.lua index 8e640ce..95d1bd9 100644 --- a/spec.lua +++ b/spec.lua @@ -1,5 +1,5 @@ local LOAD_MODULES = { - {"lib", "TestEZ"}, + {"src", "TestEZ"}, {"tests", "TestEZTests"}, } diff --git a/lib/Expectation.lua b/src/Expectation.lua similarity index 100% rename from lib/Expectation.lua rename to src/Expectation.lua diff --git a/lib/LifecycleHooks.lua b/src/LifecycleHooks.lua similarity index 100% rename from lib/LifecycleHooks.lua rename to src/LifecycleHooks.lua diff --git a/lib/Reporters/TeamCityReporter.lua b/src/Reporters/TeamCityReporter.lua similarity index 100% rename from lib/Reporters/TeamCityReporter.lua rename to src/Reporters/TeamCityReporter.lua diff --git a/lib/Reporters/TextReporter.lua b/src/Reporters/TextReporter.lua similarity index 100% rename from lib/Reporters/TextReporter.lua rename to src/Reporters/TextReporter.lua diff --git a/lib/Reporters/TextReporterQuiet.lua b/src/Reporters/TextReporterQuiet.lua similarity index 100% rename from lib/Reporters/TextReporterQuiet.lua rename to src/Reporters/TextReporterQuiet.lua diff --git a/lib/Stack.lua b/src/Stack.lua similarity index 100% rename from lib/Stack.lua rename to src/Stack.lua diff --git a/lib/TestBootstrap.lua b/src/TestBootstrap.lua similarity index 100% rename from lib/TestBootstrap.lua rename to src/TestBootstrap.lua diff --git a/lib/TestEnum.lua b/src/TestEnum.lua similarity index 100% rename from lib/TestEnum.lua rename to src/TestEnum.lua diff --git a/lib/TestPlan.lua b/src/TestPlan.lua similarity index 100% rename from lib/TestPlan.lua rename to src/TestPlan.lua diff --git a/lib/TestPlanBuilder.lua b/src/TestPlanBuilder.lua similarity index 100% rename from lib/TestPlanBuilder.lua rename to src/TestPlanBuilder.lua diff --git a/lib/TestPlanner.lua b/src/TestPlanner.lua similarity index 100% rename from lib/TestPlanner.lua rename to src/TestPlanner.lua diff --git a/lib/TestResults.lua b/src/TestResults.lua similarity index 100% rename from lib/TestResults.lua rename to src/TestResults.lua diff --git a/lib/TestRunner.lua b/src/TestRunner.lua similarity index 100% rename from lib/TestRunner.lua rename to src/TestRunner.lua diff --git a/lib/TestSession.lua b/src/TestSession.lua similarity index 100% rename from lib/TestSession.lua rename to src/TestSession.lua diff --git a/lib/init.lua b/src/init.lua similarity index 100% rename from lib/init.lua rename to src/init.lua