trigger workflows

prettier

few changes

Author: qeffects

docs/advanced/automated-testing.md

@@ -1,9 +1,8 @@
 ---
-title: Automated Testing
+title: Unit Testing
 ---
 
-import { SideBySide } from "@site/src/components/SideBySide";
-import { DeprecatedInVersion } from "@site/src/components/DeprecatedInVersion";
+## Getting started
 
 This guide is going to explore unit testing, it’s assuming some familiarity with the subject, but it’s not required.
 
@@ -15,29 +14,31 @@ Our code is very simple for this example.
 
 ```typescript title=index.ts
 export const libraryFunction = (param: number[], reverse: boolean) => {
-    let reversed: number[] = [];
+  let reversed: number[] = [];
 
-    if (reverse) {
-        param.forEach((n) => table.insert(reversed, 1, n));
-    } else {
-        reversed = param;
-    }
+  if (reverse) {
+    param.forEach((n) => table.insert(reversed, 1, n));
+  } else {
+    reversed = param;
+  }
 
-    return table.concat(reversed, ',');
-}
+  return table.concat(reversed, ",");
+};
 ```
 
-So our function takes an array of numbers like “[1,2,3,4]” and returns a string like “1,2,3,4” or “4,3,2,1”This is where unit testing comes in, say a piece of code depends on this function working like it does, and for it to keep working exactly like it does right now, obviously you could use the tried and true method of doing the testing yourself, but unit testing provides an alternative to the manual work.
+So our function takes an array of numbers like “[1,2,3,4]” and returns a string like “1,2,3,4” or “4,3,2,1”.
 
-So, automated testing, where do we begin?
+This is where unit testing comes in, say a piece of code depends on this function working like it does, and for it to keep working exactly like it does right now, obviously you could use the tried and true method of doing the testing yourself, but unit testing provides an alternative to the manual work.
+
+So, unit testing, where do we begin?
 
 To start off we’re going to need these tools installed:
 
 https://luarocks.org/
 &
 https://olivinelabs.com/busted/
 
-*Luarocks is known to be hard to impossible to install on Windows systems sucessfully, if that’s the case for you, definitely keep reading on, we’re gonna explore a (free) option to do away with running tests locally entirely.*
+_Luarocks is known to be hard to impossible to install on Windows systems sucessfully, if that’s the case for you, definitely keep reading on, we’re gonna explore a (free) option to do away with running tests locally entirely._
 
 Now that we have busted installed and the `busted` command runs in your terminal of choice successfully we can proceed.
 
@@ -51,6 +52,7 @@ And we need to add busted-tstl types to our tsconfig.json, you should already ha
   "lua-types/jit",
 ]
 ```
+
 Simply add `"busted-tstl"` :
 
 ```json title=tsconfig.json
@@ -62,7 +64,7 @@ Simply add `"busted-tstl"` :
 ```
 
 Now let’s set up a folder for our tests, by default busted takes a folder named `spec` and runs the files in there, now
-this is personal preference, but usually I name my tests `[filename to be tested]_spec.ts`, the _spec suffix is once again what busted searches for by default, so we’ll stick to that.
+this is personal preference, but usually I name my tests `[filename to be tested]_spec.ts`, the \_spec suffix is once again what busted searches for by default, so we’ll stick to that.
 
 Now our project should look something like this:
 
@@ -73,31 +75,33 @@ Alright, we can start writing our first test. Let’s explore the following exam
 ```typescript title=index_spec.ts
 import { libraryFunction } from "..";
 
-describe('Library Function',() => {
-    it('Returns unreversed string correctly',() => {
-        assert.is_equal('1,2,3,4', libraryFunction([1, 2, 3, 4], false));
-    });
-})
+describe("Library Function", () => {
+  it("Returns unreversed string correctly", () => {
+    assert.is_equal("1,2,3,4", libraryFunction([1, 2, 3, 4], false));
+  });
+});
 ```
 
-So the short version of what’s happening there is the ‘describe’ block is our named collection of tests, this block pertains to the library function and library function alone, next we call it(‘’,()=>{}) in there to name and describe the behaviour of a single test, it’s a regular function so you can call and do anything in there. Right here, we’re just using a function in the assert namespace which passes the test if the 2 parameters are exactly equal, and fails if they’re different.
+So the short version of what’s happening there is the ‘describe’ block is our named collection of tests, this collection tests the library function, so we've named it `"Library Function"`
+
+Next we call it(‘’,()=>{}) in there to name and describe the behaviour of a single test, it’s a regular function, so you can call and do anything in there. Here, we’re just using a function in the assert namespace which passes the test if the 2 parameters are exactly equal, and fails if they’re different.
 
 Alright, so we call our libraryFunction with a set of parameters, and get back some return, then we assert that the return value is equal to a known (correct) value. For illustration let’s add another test, since we have a second signature of the function that returns a reversed string, we can try that:
 
 ```typescript title=index_spec.ts
 import { libraryFunction } from "..";
 
-describe('Library Function',() => {
-    it('Returns unreversed string correctly',() => {
-        assert.is_equal('1,2,3,4', libraryFunction([1, 2, 3, 4], false));
-    });
-    it('Returns unreversed string correctly',() => {
-        assert.is_equal('4,3,2,1', libraryFunction([1, 2, 3, 4], true));
-    });
-})
+describe("Library Function", () => {
+  it("Returns unreversed string correctly", () => {
+    assert.is_equal("1,2,3,4", libraryFunction([1, 2, 3, 4], false));
+  });
+  it("Returns reversed string correctly", () => {
+    assert.is_equal("4,3,2,1", libraryFunction([1, 2, 3, 4], true));
+  });
+});
 ```
 
-Now hit compile and change your terminal’s directory in to your tstl output folder, for me it’s the `dist` folder.
+Now hit compile and change your terminals directory in to your tstl output folder, for me it’s the `dist` folder.
 We can now just simply run `busted`, and you should see something like this:
 
 ![Project setup](/images/busted-output.png)
@@ -119,6 +123,7 @@ https://docs.github.com/en/actions
 So, first we’re going to create a workflow file
 
 Set up a folder structure like so:
+
 ```
 Root project folder/
   .github/
@@ -131,34 +136,34 @@ name: TSTL Testing
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   build_tests:
     name: Busted Tests
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js [16.x]
-      uses: actions/setup-node@v2
-      with:
-        node-version: 16.x
-        cache: 'npm'
-    - name: Npm Install && Build with Testing preset
-      run: npm install && npm run-script build
-    - name: Install Lua
-      uses: leafo/gh-actions-lua@v8
-      with:
-        luaVersion: "luajit-2.1.0-beta3"
-    - name: Install LuaRocks
-      uses: leafo/gh-actions-luarocks@v4.0.0
-    - name: Install Busted
-      run: luarocks install busted
-    - name: Running Tests
-      run: cd dist && busted
+      - uses: actions/checkout@v2
+      - name: Use Node.js [16.x]
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+          cache: "npm"
+      - name: Npm Install && Build with Testing preset
+        run: npm install && npm run-script build
+      - name: Install Lua
+        uses: leafo/gh-actions-lua@v8
+        with:
+          luaVersion: "luajit-2.1.0-beta3"
+      - name: Install LuaRocks
+        uses: leafo/gh-actions-luarocks@v4.0.0
+      - name: Install Busted
+        run: luarocks install busted
+      - name: Running Tests
+        run: cd dist && busted
 ```
 
 Without going in to much detail, this workflow triggers whenever you push a commit to your github repository, installs Node.js, Lua, Luarocks and Busted installs all of your project dependencies and compiles a fresh version of the project, at the very end it moves in to the dist folder and runs your busted tests exactly like you would. Now, if you commit and push these changes to your GitHub repository you should be able to see, Under the Actions tab at the top, something like this:
@@ -196,9 +201,10 @@ This section applies to projects described in [Publishing Modules](publishing-mo
   }
 }
 ```
-*(arrows are to indicate the changes, don't include them in the actual code)*
 
-Now you can use this new tsconfig like: `tstl —project tsconfig.test.json`
+_(arrows are to indicate the changes, don't include them in the actual code)_
+
+Now you can use this new tsconfig like: `tstl —-project tsconfig.test.json`
 
 It will output the new build in to the testing folder and you can move your terminal in to the folder and run busted
 
@@ -219,34 +225,34 @@ name: TSTL Testing
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   build_tests:
     name: Busted Tests
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js [16.x]
-      uses: actions/setup-node@v2
-      with:
-        node-version: 16.x
-        cache: 'npm'
-    - name: Npm Install && Build with Testing preset
-      run: npm install && npm run-script test-build
-    - name: Install Lua
-      uses: leafo/gh-actions-lua@v8
-      with:
-        luaVersion: "luajit-2.1.0-beta3"
-    - name: Install LuaRocks
-      uses: leafo/gh-actions-luarocks@v4.0.0
-    - name: Install Busted
-      run: luarocks install busted
-    - name: Running Tests
-      run: cd testing && busted
+      - uses: actions/checkout@v2
+      - name: Use Node.js [16.x]
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+          cache: "npm"
+      - name: Npm Install && Build with Testing preset
+        run: npm install && npm run-script test-build
+      - name: Install Lua
+        uses: leafo/gh-actions-lua@v8
+        with:
+          luaVersion: "luajit-2.1.0-beta3"
+      - name: Install LuaRocks
+        uses: leafo/gh-actions-luarocks@v4.0.0
+      - name: Install Busted
+        run: luarocks install busted
+      - name: Running Tests
+        run: cd testing && busted
 ```
 
 Now your build should include all the Lua libraries you installed with npm/yarn, include the lualib bundle file and the GitHub action should work.