ci: Add luau-lsp type checking github action and integration

Quenty · Quenty · commit 24b5fbb5664a · 2025-03-31T19:45:57.000-07:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -4,8 +4,11 @@ jobs:
   lint:
     uses: ./.github/workflows/lint.yml
 
+  luau:
+    uses: ./.github/workflows/luau.yml
+
   release:
-    needs: lint
+    needs: [lint, luau]
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
     steps:
diff --git a/.github/workflows/lint-external-prs.yml b/.github/workflows/lint-external-prs.yml
@@ -6,3 +6,6 @@ jobs:
   lint:
     if: "github.event.pull_request.head.repo.fork"
     uses: ./.github/workflows/lint.yml
+  luau:
+    if: "github.event.pull_request.head.repo.fork"
+    uses: ./.github/workflows/luau.yml
diff --git a/.github/workflows/luau.yml b/.github/workflows/luau.yml
@@ -0,0 +1,22 @@
+# Reusable workflow that analyzes the repository!
+name: luau
+on:
+  workflow_call
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Setup Aftman
+        uses: ok-nick/setup-aftman@v0.4.2
+        with:
+          version: 'v0.3.0'
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Generate Sourcemap
+        run: npm run build:sourcemap
+
+      - name: Luau-lsp analyze
+        run: npm run lint:luau
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,7 @@ sourcemap.json
 dist
 *.tsbuildinfo
 .DS_Store
+globalTypes.d.lua
 
 # Normally it's a good idea to commit this. However, in this mono-repo scenario with linking
 # it adds a ton of noise and no real gain. Also we have seen no gains from reproducing
diff --git a/.luaurc b/.luaurc
@@ -1,7 +1,7 @@
 {
-	"languageMode": "strict",
-	"lint": { "*": true },
-	"lintErrors": true,
-	"typeErrors": true,
-	"globals": []
+  "languageMode": "nocheck",
+  "lintErrors": true,
+  "lint": {
+    "*": true
+  }
 }
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,7 +1,9 @@
 {
     "recommendations": [
-        "kampfkarren.selene-vscode",
-        "nightrains.robloxlsp",
-        "shardulm94.trailing-spaces"
+      "kampfkarren.selene-vscode",
+      "johnnymorganz.luau-lsp",
+      "johnnymorganz.stylua",
+      "shardulm94.trailing-spaces",
+      "esbenp.prettier-vscode"
     ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,10 +1,22 @@
 {
-    "files.exclude": {
-        "*.sublime-workspace": true,
-        "node_modules": true,
-        "out": true,
-        "roblox.toml": true
-    },
-    "Lua.diagnostics.enable": false,
-    "files.trimTrailingWhitespace": true
+  "files.exclude": {
+    "*.sublime-workspace": true,
+    "node_modules": true,
+    "out": true,
+    "roblox.toml": true
+  },
+  "luau-lsp.server.path": "/Users/jonnen/.aftman/bin/luau-lsp",
+  "luau-lsp.ignoreGlobs": ["**/node_modules/**"],
+  "luau-lsp.fflags.enableNewSolver": true,
+  "[lua]": {
+    "editor.defaultFormatter": "JohnnyMorganz.stylua",
+    "editor.formatOnSave": true,
+    "editor.formatOnSaveMode": "file"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.formatOnSaveMode": "file"
+  },
+  "files.trimTrailingWhitespace": true
 }
diff --git a/aftman.toml b/aftman.toml
@@ -9,4 +9,4 @@ selene = "Kampfkarren/selene@0.28.0"
 moonwave-extractor = "UpliftGames/moonwave@1.3.0"
 mantle = "blake-mealey/mantle@0.10.7"
 remodel = "rojo-rbx/remodel@0.9.1"
-luau-lsp = "JohnnyMorganz/luau-lsp@1.27.1"
+luau-lsp = "Quenty/luau-lsp@1.41.0-quenty"
diff --git a/package.json b/package.json
@@ -16,6 +16,13 @@
     "moonwave": "^1.1.2"
   },
   "scripts": {
+    "build:sourcemap": "rojo sourcemap default.project.json --output sourcemap.json",
+    "build:link": "npx lerna exec --parallel -- npm install --no-package-lock --no-audit --no-fund",
+    "lint:luau": "luau-lsp analyze --sourcemap=sourcemap.json --base-luaurc=.luaurc --defs=globalTypes.d.lua --flag:LuauSolverV2=true --ignore=**/node_modules/** --ignore=**/*.spec.lua --ignore=**/*.story.lua src",
+    "lint:moonwave": "npx lerna exec --parallel -- moonwave-extractor extract src",
+    "lint:selene": "npx lerna exec -- selene --config=../../selene.toml src",
+    "postinstall": "npm run build:link",
+    "prelint:luau": "npm run build:sourcemap && node tools/scripts/download-roblox-types.js",
     "release": "auto shipit"
   },
   "author": "James Onnen <rbxquenty@gmail.com>",
diff --git a/selene.toml b/selene.toml
@@ -1,6 +1,6 @@
 # This file specifies selene linting rules
-
 std = "roblox+testez"
+exclude = ["**/node_modules/**" ]
 
 [rules]
 if_same_then_else = "allow" # This actually makes code less clear sometimes
diff --git a/tools/nevermore-template-helpers/src/templateHelpers.ts b/tools/nevermore-template-helpers/src/templateHelpers.ts
@@ -19,7 +19,7 @@ export class TemplateHelper {
    */
   public static camelize(str: string): string {
     return str
-      .replace(/-./g, x=>x[1].toUpperCase())
+      .replace(/-./g, (x) => x[1].toUpperCase())
       .replace(/(?:^\w|[A-Z]|\b\w)/g, function (word: string, index: number) {
         return word.toUpperCase();
       })
diff --git a/tools/scripts/download-roblox-types.js b/tools/scripts/download-roblox-types.js
@@ -0,0 +1,15 @@
+var https = require('https');
+var fs = require('fs');
+
+function download(filename, url) {
+  if (fs.existsSync(filename)) {
+    return;
+  }
+
+  var file = fs.createWriteStream(filename);
+  var request = https.get(url, function(response) {
+    response.pipe(file);
+  });
+}
+
+download('globalTypes.d.lua', 'https://raw.githubusercontent.com/JohnnyMorganz/luau-lsp/main/scripts/globalTypes.d.lua');

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`		`- "languageMode": "strict",`
`3`		`- "lint": { "*": true },`
`4`		`- "lintErrors": true,`
`5`		`- "typeErrors": true,`
`6`		`- "globals": []`
	`2`	`+ "languageMode": "nocheck",`
	`3`	`+ "lintErrors": true,`
	`4`	`+ "lint": {`
	`5`	`+ "*": true`
	`6`	`+ }`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"recommendations": [`
`3`		`- "kampfkarren.selene-vscode",`
`4`		`- "nightrains.robloxlsp",`
`5`		`- "shardulm94.trailing-spaces"`
	`3`	`+ "kampfkarren.selene-vscode",`
	`4`	`+ "johnnymorganz.luau-lsp",`
	`5`	`+ "johnnymorganz.stylua",`
	`6`	`+ "shardulm94.trailing-spaces",`
	`7`	`+ "esbenp.prettier-vscode"`
`6`	`8`	`]`
`7`	`9`	`}`