Check Your Lua 🔎

Check Your Lua simplifies testing and refining your Lua code. Run scripts quickly and see results to improve your skills with test-driven development!

Supported Versions:

App Version 0.0.1: Initial framework release.

About this App

Check Your Lua is a minimal testing framework designed to help developers easily test and refine their Lua code. This app supports quick script execution, making it ideal for developers at any level.

Technology

This app is built with Lua and utilizes various modern technologies for a seamless user experience, ensuring easy integration and quick access to testing functionalities.

Getting Started

Follow these steps to set up your environment and run your first test:

Install the App

To install Check Your Lua:

1. Clone the repository from GitHub to your local machine:

git clone https://github.com/Sieep-Coding/Check-Your-Lua.git

2. Navigate to the project directory in your terminal:

cd Check-Your-Lua

3. Run the setup script:

lua setup.lua

Opening the App

To open Check Your Lua:

1. Navigate to the app directory:

cd Check-Your-Lua

2. Run the main app script:

lua main.lua

3. Follow the on-screen prompts to begin testing your scripts.

Basic Features

Check Your Lua offers several features:

Feature 1: Simple Script Execution

Quickly run Lua scripts and view the output in the console:

lua main.lua my_script.lua

Feature 2: Colored Output

Test results are displayed with colors for easy identification:

• Green: Test passed
• Red: Test failed

Feature 3: Zero Dependencies

Runs natively with Lua without requiring additional libraries.

Feature 4: Intuitive Interface

Clear instructions guide you through setting up and running tests.

Feature 5: Test-Driven Development

Write and run tests for your Lua code with the following structure:

-- my_test.lua
local function add(a, b)
    return a + b
end

assert(add(1, 2) == 3, "Test failed: 1 + 2 should be 3")
print("All tests passed!")

Run this test:

lua main.lua my_test.lua

Examples

Example 1: Simple Addition Test

-- test_addition.lua
local function add(a, b)
    return a + b
end

assert(add(5, 7) == 12, "Test failed: 5 + 7 should be 12")
print("Test passed!")

Run the test:

lua main.lua test_addition.lua

Example 2: String Test

-- test_strings.lua
local function concat(a, b)
    return a .. b
end

assert(concat("Hello", " World") == "Hello World", "Test failed: Strings not concatenated correctly")
print("Test passed!")

Run the test:

lua main.lua test_strings.lua

More Info

For further details, refer to the official GitHub repository.