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

Author: Quenty

.github/workflows/build.yml

@@ -5,7 +5,7 @@ jobs:
     uses: ./.github/workflows/lint.yml
 
   release:
-    needs: lint
+    needs: [lint]
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
     steps:

.github/workflows/lint-external-prs.yml

@@ -5,4 +5,4 @@ on: [pull_request_target]
 jobs:
   lint:
     if: "github.event.pull_request.head.repo.fork"
-    uses: ./.github/workflows/lint.yml
+    uses: ./.github/workflows/lint.yml

.github/workflows/lint.yml

@@ -1,9 +1,26 @@
-# Reusable workflow that lints the repository!
 name: lint
 on:
   workflow_call
 jobs:
-  lint:
+  luau-lsp:
+    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
+
+  selene:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -21,6 +38,17 @@ jobs:
       - name: Run Selene
         run: selene src
 
+  moonwave:
+    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: Run moonwave-extractor
-        if: success() || failure()
         run: moonwave-extractor extract src

.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

.luaurc

@@ -1,7 +1,7 @@
 {
-	"languageMode": "strict",
-	"lint": { "*": true },
-	"lintErrors": true,
-	"typeErrors": true,
-	"globals": []
+  "languageMode": "nocheck",
+  "lintErrors": true,
+  "lint": {
+    "*": true
+  }
 }

.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"
     ]
 }

.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": false,
+  "[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
 }

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"

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=false --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>",

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