Convert LDoc to lua-language-server

.github/workflows/generate-lua-library.yml

@@ -0,0 +1,39 @@
+name: Generate Lua library
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+    paths:
+      - 'rts/Lua/**'
+jobs:
+  generate-library:
+    name: Regenerate library
+    runs-on: ubuntu-latest
+    steps:
+      - name: Configure git
+        run: |
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+
+      - name: Checkout Lua CPP files
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: rts/Lua
+          path: recoil
+
+      - name: Install extractor tool
+        run: |
+          npm install rhys-vdw/lua-doc-extractor
+
+      - name: Regenerate docs
+        working-directory: ./recoil/rts/Lua/
+        run: |
+          rm -rf library/generated
+          npx lua-doc-extractor *.cpp --dest library/generated
+
+      - name: Commit and push Recoil repo
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          repository: ./recoil
+          commit_message: Update LuaLS library

.github/workflows/publish-site.yml

@@ -13,23 +13,37 @@ jobs:
       - name: Install Dependencies
         run: |
           sudo apt-get update -y
-          sudo apt-get install --fix-missing -y lua-ldoc lua-markdown jq p7zip-full libsdl2-2.0-0 libopenal1
+          sudo apt-get install --fix-missing -y jq p7zip-full libsdl2-2.0-0 libopenal1
+      - name: Set up Homebrew
+        id: set-up-homebrew
+        uses: Homebrew/actions/setup-homebrew@master
+      - name: Install Lua Language Server
+        run: |
+          brew install lua-language-server
       - name: Checkout Source Repository
         uses: actions/checkout@v2
-        with:
-          ref: master
       - name: Generate Dynamic Content
         run: |
           bash doc/site/_scripts/get_release_data.sh
           bash doc/site/_scripts/get_engine_data.sh
           git add -f doc/site/_data
-      - name: Run LDoc
+      # This step should be removed when https://github.com/LuaLS/lua-language-server/issues/2977 is resolved.
+      - name: Disable global libaries from Lua config
+        run: |
+          cp doc/site/.luarc.doc.json .luarc.json
+      - name: Export Lua data using Lua Language Server
         run: |
-          ldoc -c doc/LDoc/config.ld .
-          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          git config user.name "github-actions[bot]"
-          git add -f doc/site/ldoc
+          lua-language-server --doc . --doc_out_path doc/site/_data
+          git add -f doc/site/_data
+      - name: Commit changes
+        run: |
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
           git commit -m "Update doc/site"
+      # This step should be removed when https://github.com/LuaLS/lua-language-server/issues/2977 is resolved.
+      - name: Discard changes to Lua config
+        run: |
+          git checkout -- .luarc.json
       - name: Check if gh-pages exists
         id: check-ghpages
         run: |
@@ -39,8 +53,8 @@ jobs:
         id: site-changes
         if: steps.check-ghpages.outputs.exists == 'true'
         run: |
-          git diff --stat origin/gh-pages master:doc/site
-          git diff --quiet origin/gh-pages master:doc/site && (echo "modified=false" > $GITHUB_OUTPUT) || (echo "modified=true" > $GITHUB_OUTPUT)
+          git diff --stat origin/gh-pages ${{ github.ref_name }}:doc/site
+          git diff --quiet origin/gh-pages ${{ github.ref_name }}:doc/site && (echo "modified=false" > $GITHUB_OUTPUT) || (echo "modified=true" > $GITHUB_OUTPUT)
       - name: Push gh-pages # Only push gh-pages if doc/site/ was changed or ldoc did changes
         if: steps.check-ghpages.outputs.exists == 'false' || steps.site-changes.outputs.modified == 'true'
         run: |

.luarc.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
+  "runtime.version": "Lua 5.1",
+  "completion.requireSeparator": "/",
+  "runtime.builtin": {
+    "basic": "disable",
+    "bit": "disable",
+    "bit32": "disable",
+    "builtin": "disable",
+    "coroutine": "disable",
+    "debug": "disable",
+    "ffi": "disable",
+    "io": "disable",
+    "jit": "disable",
+    "math": "disable",
+    "os": "disable",
+    "package": "disable",
+    "string": "disable",
+    "table": "disable",
+    "table.clear": "disable",
+    "table.new": "disable",
+    "utf8": "disable"
+  },
+  "runtime.path": [
+    "?",
+    "?.lua"
+  ],
+  "workspace.ignoreDir": [
+    "cont",
+    "lib",
+    "tools"
+  ],
+  "workspace.library": [
+    // Only add the generator output as "library" to prevent it from being
+    // modified by refactor commands.
+    //
+    // Refactoring is valid on the hand-written library files.
+    "rts/Lua/library/generated"
+	],
+  "runtime.special": {
+    "VFS.Include": "require",
+    "include": "require",
+    "shard_include": "require"
+  }
+}