factoriomod-debug 1.1.37 → 1.1.39

package/doc/debugadapter.md

@@ -8,10 +8,6 @@
 * Adjust the paths and launch settings as required. Check Intellisense for additional launch options.
 * Press the green 'play' button or F5 to start debugging.
 
-## Steam
-
-If you use a Steam install, a file `steam_appid.txt` with content `427520` in the same folder as the factorio binary (there will also be one of `steam_api64.dll`, `libsteam_api.dylib` or `libsteam_api.so` here) is required. If the Debug Adapter has write access to this folder, it will create this automatically. On macs, you may need to "Show Package Contents" to locate the correct folder.
-
 ## Runtime Lua Diagnostics
 
 The debugger also injects runtime diagnostics into all hooked mods:

package/doc/language-lua.md

@@ -1,12 +1,12 @@
-# Sumneko Lua LSP integration
+# LuaLS (Sumneko) LSP integration
 
 FMTK provides a third party library package for the [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) language server which provides various adaptations to Factorio's Lua environment. The VS Code extension will automatically install this when a Factorio version is selected, or it can be generated manually with `fmtk sumneko-3rd`.
 
-In addition to the runtime-api docs (generated from [`runtime-api.json`](https://lua-api.factorio.com/latest/json-docs.html)), this package includes several static library files, configuration settings and a sumneko plugin that enables enhanced handling of `require`, `global`, event handlers, and `remote` interfaces.
+In addition to the docs (generated from [`runtime-api.json`](https://lua-api.factorio.com/latest/auxiliary/json-docs-runtime.html) and [`prototype-api.json`](https://lua-api.factorio.com/latest/auxiliary/json-docs-prototype.html)), this package includes several static library files, configuration settings and a luals plugin that enables enhanced handling of `require`, `global`, event handlers, and `remote` interfaces.
 
 ## API Type Definitions
 
-Factorio's [`runtime-api.json`](https://lua-api.factorio.com/latest/json-docs.html) and [`prototype-api.json`](https://lua-api.factorio.com/latest/auxiliary/json-docs-prototype.html) are used to generate type definitions for most of the API.
+Factorio's [`runtime-api.json`](https://lua-api.factorio.com/latest/auxiliary/json-docs-runtime.html) and [`prototype-api.json`](https://lua-api.factorio.com/latest/auxiliary/json-docs-prototype.html) are used to generate type definitions for most of the API.
 
 Event payload types are generated as subclasses of the generic event payload `EventData`, named like `EventData.on_event_name`. A library definition for `event_handler` is also generated.
 
@@ -20,7 +20,7 @@ In addition to the types listed in the json, a few extra related types are defin
 
 ## Libraries
 
-Factorio [modifies some builtin libraries](https://lua-api.factorio.com/latest/Libraries.html), and this package includes corresponding modified definitions for those libraries.
+Factorio [modifies some builtin libraries](https://lua-api.factorio.com/latest/auxiliary/libraries.html), and this package includes corresponding modified definitions for those libraries.
 
 Type definitions are also included for some of the libraries included in `__core__/lualib`, such as `util` and `mod-gui`.
 
@@ -30,7 +30,7 @@ The VS Code extension will automatically configure `"Lua.workspace.userThirdPart
 
 ## Plugin Features
 
-Because Factorio mods run in [several Lua VMs](https://lua-api.factorio.com/latest/Data-Lifecycle.html), some functions have cross-VM behavior that cannot be described fully with type definitions. We handle these by providing a plugin which transforms them into a more easily understood form before the Language Server sees them.
+Because Factorio mods run in [several Lua VMs](https://lua-api.factorio.com/latest/auxiliary/data-lifecycle.html), some functions have cross-VM behavior that cannot be described fully with type definitions. We handle these by providing a plugin which transforms them into a more easily understood form before the Language Server sees them.
 
 ### `require()`
 
@@ -45,7 +45,7 @@ Additionally, in require paths with slashes, Factorio replaces any file extensio
 
 ### `global`
 
-Each mod has its own private version of [the global named `global`](https://lua-api.factorio.com/latest/Global.html). To allow the Language Server to see this separation, `global` is renamed to `__modname__global` when used as the base variable in indexing or the target of assignment.
+Each mod has its own private version of [the global named `global`](https://lua-api.factorio.com/latest/auxiliary/global.html). To allow the Language Server to see this separation, `global` is renamed to `__modname__global` when used as the base variable in indexing or the target of assignment.
 
 ### Event Handlers
 

package/doc/lsptutorial.md

@@ -0,0 +1,36 @@
+# Setting up sumneko-3rd  in other editors
+
+If you want better LSP support outside of vscode, you can't just use the extension. You will need to generate the lua ls plugin and set the path to it in your editor. 
+
+# Generating files
+
+Get [fmtk from npm](https://www.npmjs.com/package/factoriomod-debug), which is the commandline tool.
+
+Find the docs that came with your game install (recommended) or download them. On Windows the default directory is ```C:\Program Files (x86)\Steam\steamapps\common\Factorio\doc-html```
+
+If for some reason you need to, download the docs([direct link](https://lua-api.factorio.com/latest/static/archive.zip)) or go to the [API docs](https://lua-api.factorio.com/latest/) and download from the link in the bottom (same thing as the direct link).
+
+Open that folder in a terminal and  run the following command to generate the files:
+
+```fmtk sumneko-3rd -d runtime-api.json -p prototype-api.json```
+
+This will make a folder called factorio in the directory you opened the terminal in. You can copy paste this anywhere at all, I put it in C:/libraries (luals will look in the entire folder for any libraries you put there).
+
+  
+# Inluding it in your LSP (Neovim)
+
+Make sure you already have your LSP server working - add the following to your lspconfig:
+
+```lua
+lspconfig.lua_ls.setup {
+  settings = {
+    Lua = {
+      workspace = {
+        library = {
+          [vim.fn.expand "C:/libraries"] = true,
+        },
+      },
+    },
+  },
+}
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "factoriomod-debug",
   "displayName": "Factorio Modding Tool Kit",
-  "version": "1.1.37",
+  "version": "1.1.39",
   "publisher": "justarandomgeek",
   "description": "Debug Tools for developing Factorio Mods",
   "author": {
@@ -13,7 +13,7 @@
     "multi-root ready"
   ],
   "engines": {
-    "vscode": "^1.83.0",
+    "vscode": "^1.84.0",
     "node": ">=18"
   },
   "icon": "images/factoriomod-debug-icon.png",
@@ -44,28 +44,28 @@
     "test": "c8 mocha"
   },
   "devDependencies": {
-    "@types/archiver": "^5.3.3",
-    "@types/buffers": "^0.1.32",
-    "@types/chai": "^4.3.6",
-    "@types/chai-as-promised": "^7.1.6",
-    "@types/d3": "^7.4.1",
-    "@types/dot-object": "^2.1.3",
-    "@types/ini": "^1.3.31",
-    "@types/inquirer": "^9.0.3",
-    "@types/mocha": "^10.0.2",
-    "@types/node": "^18.18.3",
-    "@types/node-fetch": "^2.6.6",
-    "@types/request": "^2.48.9",
-    "@types/semver": "^7.5.3",
-    "@types/vscode": "^1.83.0",
-    "@types/vscode-webview": "^1.57.2",
+    "@types/archiver": "^5.3.4",
+    "@types/buffers": "^0.1.34",
+    "@types/chai": "^4.3.11",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/d3": "^7.4.3",
+    "@types/dot-object": "^2.1.6",
+    "@types/ini": "^1.3.33",
+    "@types/inquirer": "^9.0.7",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^18.18.13",
+    "@types/node-fetch": "^2.6.9",
+    "@types/request": "^2.48.12",
+    "@types/semver": "^7.5.6",
+    "@types/vscode": "^1.84.2",
+    "@types/vscode-webview": "^1.57.4",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "@vscode/codicons": "^0.0.32",
-    "@vscode/debugadapter": "^1.63.0",
-    "@vscode/debugadapter-testsupport": "^1.63.0",
-    "@vscode/vsce": "^2.21.1",
-    "@vscode/webview-ui-toolkit": "^1.2.2",
+    "@vscode/debugadapter": "^1.64.0",
+    "@vscode/debugadapter-testsupport": "^1.64.0",
+    "@vscode/vsce": "^2.22.0",
+    "@vscode/webview-ui-toolkit": "^1.3.1",
     "archiver": "^5.3.2",
     "c8": "^7.14.0",
     "chai": "^4.3.10",
@@ -77,9 +77,9 @@
     "esbuild": "^0.17.19",
     "esbuild-plugin-import-glob": "^0.1.1",
     "esbuild-visualizer": "^0.4.1",
-    "eslint": "^8.50.0",
+    "eslint": "^8.54.0",
     "ini": "^3.0.1",
-    "inquirer": "^9.2.11",
+    "inquirer": "^9.2.12",
     "jsonc-parser": "^3.2.0",
     "mimer": "^2.0.2",
     "mocha": "^10.2.0",
@@ -476,6 +476,26 @@
         "command": "factorio.setApiKey",
         "category": "Factorio",
         "title": "Set API Key"
+      },
+      {
+        "command": "factorio.selectVersion",
+        "category": "Factorio",
+        "title": "Select Version"
+      },
+      {
+        "command": "factorio.checkConfig",
+        "category": "Factorio",
+        "title": "Check Config"
+      },
+      {
+        "command": "factorio.disablePrototypeCache",
+        "category": "Factorio",
+        "title": "Disable Prototype Cache"
+      },
+      {
+        "command": "factorio.disableMouseAutoCapture",
+        "category": "Factorio",
+        "title": "Disable Mouse Auto Capture"
       }
     ],
     "views": {
@@ -750,16 +770,6 @@
                 "type": "boolean",
                 "description": "Add --check-unused-prototype-data to factorioArgs."
               },
-              "checkGlobals": {
-                "type": [
-                  "boolean",
-                  "array"
-                ],
-                "description": "Check for assignment to undefined globals. Boolean to enable/disable for all mods, or array of mod names (`#settings` and `#data` for settings/data stage).",
-                "items": {
-                  "type": "string"
-                }
-              },
               "factorioArgs": {
                 "type": "array",
                 "items": {

package/readme.md

@@ -9,6 +9,8 @@ A collection of tools for developing Factorio mods. This package is both [an npm
  * [Language Server integration for Lua](doc/language-lua.md) via [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
  * [Packaging and Publishing](doc/package.md)
 
+ * [Getting LSP on text editors other than vscode](doc/lsptutorial.md)
+
 ## Support FMTK
 
 [<img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi2.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com'/>](https://ko-fi.com/X8X41IE4T)