Use Darklua for string requires (#239)

flipbook-labs · Apr 23, 2024 · d3d90a3 · d3d90a3
1 parent 536fe99
commit d3d90a3
Show file tree

Hide file tree

Showing 110 changed files with 446 additions and 520 deletions.
diff --git a/.darklua.json b/.darklua.json
@@ -0,0 +1,25 @@
+{
+  "process": [
+    {
+      "rule": "convert_require",
+      "current": {
+        "name": "path",
+        "sources": {
+          "@pkg": "./Packages",
+          "@root": "./src"
+        }
+      },
+      "target": {
+        "name": "roblox",
+        "rojo_sourcemap": "./sourcemap-darklua.json",
+        "indexing_style": "property"
+      }
+    },
+    "compute_expression",
+    "remove_unused_if_branch",
+    "remove_unused_while",
+    "filter_after_early_return",
+    "remove_nil_declaration",
+    "remove_empty_do"
+  ]
+}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -30,8 +30,11 @@ jobs:
           sha=${GITHUB_SHA:0:7}
           echo "MODEL_FILE=$name-$sha.rbxm" >> $GITHUB_ENV
 
+      - name: Initialize the project
+        run: just init
+
       - name: Build
-        run: rojo build -o ${{ env.MODEL_FILE }}
+        run: just build-here prod  ${{ env.MODEL_FILE }}
 
       - uses: actions/upload-artifact@v3
         with:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -11,23 +11,22 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
+      - uses: extractions/setup-just@v1
+
       - uses: Roblox/setup-foreman@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Remove spec files
-        run: rm -rf **/*.spec.luau
-
-      - name: Install packages
-        run: wally install
-
       - name: Get model file name
         run: |
           name=$(jq -r .name default.project.json)
           echo "MODEL_FILE=$name.rbxm" >> $GITHUB_ENV
 
+      - name: Initialize the project
+        run: just init
+
       - name: Build
-        run: rojo build -o ${{ env.MODEL_FILE }}
+        run: just build-here prod ${{ env.MODEL_FILE }}
 
       - uses: softprops/action-gh-release@v1
         if: ${{ github.event.release }}

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+# Darklua
+build
+
 # Rojo
 /*.rbxl*
 /*.rbxm*

diff --git a/.luaurc b/.luaurc
@@ -0,0 +1,6 @@
+{
+	"aliases": {
+		"pkg": "./Packages",
+		"root": "./src"
+	}
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,18 @@
 {
-  "luau-lsp.sourcemap.rojoProjectFile": "tests.project.json"
+  "luau-lsp.sourcemap.rojoProjectFile": "analysis.project.json",
+  "luau-lsp.types.definitionFiles": [
+    "testez.d.lua"
+  ],
+  "luau-lsp.require.mode": "relativeToFile",
+  "luau-lsp.ignoreGlobs": [
+    "**/_Index/**",
+    "**/build/**"
+  ],
+  "luau-lsp.require.directoryAliases": {
+    "@pkg": "./Packages",
+    "@root": "./src"
+  },
+  "files.associations": {
+    "*.luau": "lua"
+  }
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -7,18 +7,20 @@
       "label": "Install packages",
       "type": "shell",
       "problemMatcher": [],
-      "command": "./bin/wally-install.sh"
+      "command": "just",
+      "args": [
+        "wally-install"
+      ]
     },
     {
       "label": "Build (Development)",
       "type": "shell",
       "problemMatcher": [],
-      "windows": {
-        "command": "rojo build dev.project.json -o $LOCALAPPDATA/Roblox/Plugins/flipbook.rbxm"
-      },
-      "osx": {
-        "command": "rojo build dev.project.json -o ~/Documents/Roblox/Plugins/flipbook.rbxm"
-      },
+      "command": "just",
+      "args": [
+        "build",
+        "dev"
+      ],
       "group": {
         "kind": "build",
         "isDefault": true
@@ -28,12 +30,11 @@
       "label": "Build (Production)",
       "type": "shell",
       "problemMatcher": [],
-      "windows": {
-        "command": "rojo build -o $LOCALAPPDATA/Roblox/Plugins/flipbook.rbxm"
-      },
-      "osx": {
-        "command": "rojo build -o ~/Documents/Roblox/Plugins/flipbook.rbxm"
-      },
+      "command": "just",
+      "args": [
+        "build",
+        "prod"
+      ],
       "group": {
         "kind": "build",
       }
@@ -42,12 +43,10 @@
       "label": "Build and watch",
       "type": "shell",
       "problemMatcher": [],
-      "windows": {
-        "command": "rojo build dev.project.json -o $LOCALAPPDATA/Roblox/Plugins/flipbook.rbxm --watch"
-      },
-      "osx": {
-        "command": "rojo build dev.project.json -o ~/Documents/Roblox/Plugins/flipbook.rbxm --watch",
-      }
+      "command": "just",
+      "args": [
+        "build-watch",
+      ]
     },
     {
       "label": "Serve docs",

diff --git a/analysis.project.json b/analysis.project.json
@@ -0,0 +1,12 @@
+{
+  "name": "flipbook",
+  "tree": {
+    "TestRunner": {
+      "$path": "tests"
+    },
+    "Example": {
+      "$path": "example"
+    },
+    "$path": "build.project.json"
+  }
+}
diff --git a/dev.project.json → build.project.json b/dev.project.json → build.project.json
@@ -1,9 +1,12 @@
 {
   "name": "flipbook",
   "tree": {
+    "Packages": {
+      "$path": "Packages"
+    },
     "Example": {
       "$path": "example"
     },
-    "$path": "default.project.json"
+    "$path": "src"
   }
 }
diff --git a/default.project.json b/default.project.json
@@ -4,6 +4,6 @@
     "Packages": {
       "$path": "Packages"
     },
-    "$path": "src"
+    "$path": "build"
   }
-}
+}
diff --git a/example/ArrayControls.story.luau b/example/ArrayControls.story.luau
@@ -1,8 +1,6 @@
-local Example = script:FindFirstAncestor("Example")
-
-local React = require(Example.Parent.Packages.React)
-local ReactRoblox = require(Example.Parent.Packages.ReactRoblox)
-local Sift = require(Example.Parent.Packages.Sift)
+local React = require("@pkg/React")
+local ReactRoblox = require("@pkg/ReactRoblox")
+local Sift = require("@pkg/Sift")
 
 local fonts = Sift.Array.sort(Enum.Font:GetEnumItems(), function(a: Enum.Font, z: Enum.Font)
 	return a.Name < z.Name

diff --git a/example/Button.luau b/example/Button.luau
@@ -1,6 +1,4 @@
-local Example = script:FindFirstAncestor("Example")
-
-local Roact = require(Example.Parent.Packages.Roact)
+local Roact = require("@pkg/Roact")
 
 export type Props = {
 	text: string,

diff --git a/example/Button.story.luau b/example/Button.story.luau
@@ -1,7 +1,5 @@
-local Example = script:FindFirstAncestor("Example")
-
-local Button = require(script.Parent.Button)
-local Roact = require(Example.Parent.Packages.Roact)
+local Button = require("./Button")
+local Roact = require("@pkg/Roact")
 
 return {
 	summary = "A generic button component that can be used anywhere",

diff --git a/example/ButtonWithControls.luau b/example/ButtonWithControls.luau
@@ -1,6 +1,4 @@
-local Example = script:FindFirstAncestor("Example")
-
-local Roact = require(Example.Parent.Packages.Roact)
+local Roact = require("@pkg/Roact")
 
 export type Props = {
 	text: string,

diff --git a/example/ButtonWithControls.story.luau b/example/ButtonWithControls.story.luau
@@ -1,7 +1,5 @@
-local Example = script:FindFirstAncestor("Example")
-
-local ButtonWithControls = require(script.Parent.ButtonWithControls)
-local Roact = require(Example.Parent.Packages.Roact)
+local ButtonWithControls = require("./ButtonWithControls")
+local Roact = require("@pkg/Roact")
 
 local controls = {
 	isDisabled = false,

diff --git a/example/CanvasTests/AutomaticSize.story.luau b/example/CanvasTests/AutomaticSize.story.luau
@@ -1,7 +1,5 @@
-local Example = script:FindFirstAncestor("Example")
-
-local React = require(Example.Parent.Packages.React)
-local ReactRoblox = require(Example.Parent.Packages.ReactRoblox)
+local React = require("@pkg/React")
+local ReactRoblox = require("@pkg/ReactRoblox")
 
 return {
 	summary = "AutoamticSize test for the story preview",

diff --git a/example/CanvasTests/AutomaticSizeExceedsBounds.story.luau b/example/CanvasTests/AutomaticSizeExceedsBounds.story.luau
@@ -1,7 +1,5 @@
-local Example = script:FindFirstAncestor("Example")
-
-local React = require(Example.Parent.Packages.React)
-local ReactRoblox = require(Example.Parent.Packages.ReactRoblox)
+local React = require("@pkg/React")
+local ReactRoblox = require("@pkg/ReactRoblox")
 
 return {
 	summary = "AutoamticSize test using a height that exceeds the story preview",

diff --git a/example/CanvasTests/Offset.story.luau b/example/CanvasTests/Offset.story.luau
@@ -1,7 +1,5 @@
-local Example = script:FindFirstAncestor("Example")
-
-local React = require(Example.Parent.Packages.React)
-local ReactRoblox = require(Example.Parent.Packages.ReactRoblox)
+local React = require("@pkg/React")
+local ReactRoblox = require("@pkg/ReactRoblox")
 
 return {
 	summary = "Offset test for the story preview",

diff --git a/example/CanvasTests/Resizing.story.luau b/example/CanvasTests/Resizing.story.luau
@@ -1,9 +1,7 @@
-local Example = script:FindFirstAncestor("Example")
-
 local RunService = game:GetService("RunService")
 
-local React = require(Example.Parent.Packages.React)
-local ReactRoblox = require(Example.Parent.Packages.ReactRoblox)
+local React = require("@pkg/React")
+local ReactRoblox = require("@pkg/ReactRoblox")
 
 local RESIZE_DURATIOn = 3 -- seconds
 local MAX_SIZE = 2000 -- px

diff --git a/example/CanvasTests/Scale.story.luau b/example/CanvasTests/Scale.story.luau
@@ -1,7 +1,5 @@
-local Example = script:FindFirstAncestor("Example")
-
-local React = require(Example.Parent.Packages.React)
-local ReactRoblox = require(Example.Parent.Packages.ReactRoblox)
+local React = require("@pkg/React")
+local ReactRoblox = require("@pkg/ReactRoblox")
 
 return {
 	summary = "Scale test for the story preview",

diff --git a/example/CanvasTests/ScrollingFrame.story.luau b/example/CanvasTests/ScrollingFrame.story.luau
@@ -1,7 +1,5 @@
-local Example = script:FindFirstAncestor("Example")
-
-local React = require(Example.Parent.Packages.React)
-local ReactRoblox = require(Example.Parent.Packages.ReactRoblox)
+local React = require("@pkg/React")
+local ReactRoblox = require("@pkg/ReactRoblox")
 
 return {
 	summary = "ScrollingFrame test for the story preview",

diff --git a/example/Counter.luau b/example/Counter.luau
@@ -1,6 +1,4 @@
-local Example = script:FindFirstAncestor("Example")
-
-local Roact = require(Example.Parent.Packages.Roact)
+local Roact = require("@pkg/Roact")
 
 local Counter = Roact.Component:extend("Counter")
 

diff --git a/example/Counter.story.luau b/example/Counter.story.luau
@@ -1,7 +1,5 @@
-local Example = script:FindFirstAncestor("Example")
-
-local Counter = require(script.Parent.Counter)
-local Roact = require(Example.Parent.Packages.Roact)
+local Counter = require("./Counter")
+local Roact = require("@pkg/Roact")
 
 local controls = {
 	increment = 1,

diff --git a/example/Hoarcekat.story.luau b/example/Hoarcekat.story.luau
@@ -1,6 +1,4 @@
-local Example = script:FindFirstAncestor("Example")
-
-local Roact = require(Example.Parent.Packages.Roact)
+local Roact = require("@pkg/Roact")
 
 return function(target: Instance)
 	local root = Roact.createElement("TextLabel", {

diff --git a/example/ReactCounter.luau b/example/ReactCounter.luau
@@ -1,6 +1,4 @@
-local Example = script:FindFirstAncestor("Example")
-
-local React = require(Example.Parent.Packages.React)
+local React = require("@pkg/React")
 
 export type Props = {
 	increment: number,

diff --git a/example/ReactCounter.story.luau b/example/ReactCounter.story.luau
@@ -1,8 +1,6 @@
-local Example = script:FindFirstAncestor("Example")
-
-local React = require(Example.Parent.Packages.React)
-local ReactCounter = require(script.Parent.ReactCounter)
-local ReactRoblox = require(Example.Parent.Packages.ReactRoblox)
+local React = require("@pkg/React")
+local ReactCounter = require("./ReactCounter")
+local ReactRoblox = require("@pkg/ReactRoblox")
 
 local controls = {
 	increment = 1,

diff --git a/foreman.toml b/foreman.toml
@@ -1,5 +1,6 @@
 [tools]
 rojo = { source = "rojo-rbx/rojo", version = "7.2.1" }
+darklua = { source = "seaofvoices/darklua", version = "0.12.1" }
 run-in-roblox = { source = "rojo-rbx/run-in-roblox", version = "0.3.0" }
 selene = { source = "kampfkarren/selene", version = "0.25.0" }
 stylua = { source = "JohnnyMorganz/StyLua", version = "0.17.1" }