factoriomod-debug 1.1.26 → 1.1.28

package/doc/debugadapter.md

@@ -2,7 +2,7 @@
 
 ## Using Factorio Mod Debug
 
-* Install the **Factorio Mod Debug** extension in VS Code.
+* Install the **Factorio Mod Tool Kit** extension in VS Code.
 * Switch to the run/debug view (View->Run) and select "create a launch.json file"
 * Select the debug environment "Factorio Mod Debug".
 * Adjust the paths and launch settings as required. Check Intellisense for additional launch options.
@@ -14,7 +14,7 @@ If [Zip File Explorer](https://marketplace.visualstudio.com/items?itemName=sleve
 
 ## Steam
 
-If you use a Steam install, a file `steam_appid.txt` with content `427520` in the same dir as the factorio binary is required. If the Debug Adapter has write access to the dir, it will create this automatically.
+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
 
@@ -25,5 +25,5 @@ The debugger also injects runtime diagnostics into all hooked mods:
 
 ## Advanced Features
 
-  * [Debugger Mod API](doc/debugapi.md)
-  * [Custom Debug Views](doc/variables.md)
+  * [Debugger Mod API](debugapi.md)
+  * [Custom Debug Views](variables.md)

package/doc/language-lua.md

@@ -79,4 +79,8 @@ remote.__typed_interfaces.foo.bar("arg 1", "arg 2")
 
 ### LuaObject Type Tests
 
-To allow the Language Server to see that `LuaObject.object_name` is "like `type()`" for type tests, such as `if obj.object_name == "LuaPlayer" then end`, the plugin rewrites it to appear as an internal function `if __object_name(obj) == "LuaPlayer" then end`, and this function is marked as "like `type()`" in the configuration.
+To allow the Language Server to see that `LuaObject.object_name` is "like `type()`" for type tests, such as `if obj.object_name == "LuaPlayer" then end`, the plugin rewrites it to appear as an internal function `if __object_name(obj) == "LuaPlayer" then end`, and this function is marked as "like `type()`" in the configuration.
+
+### Commands
+
+In-game lua commands `/c`, `/command`, `/silent-command`, `/sc`, and `/measured-command` will be ignored at teh start of any line.

package/doc/package.md

@@ -4,7 +4,11 @@ Mods can be automatically Packaged and Published from the "Factorio Mod Packages
 
 ## API Key
 
-Uploading to the mod portal requires an API key with the `ModPortal: Upload Mods` usage, which can be created on https://factorio.com/profile. You will be prompted for this key when it is first required.
+Interacting with the Mod Portal requires an API key, which you can create at https://factorio.com/profile. You will be prompted for this key when it is required by tasks, and then it will be stored in the OS keychain (Windows Credential Manager, macOS  Keychain, Linux Secret Service API/libsecret) if available. You can also provide the API key as an environment variable `FACTORIO_UPLOAD_API_KEY` to the cli tool `fmtk`, which will take precedence over the keychain.
+
+Uploading new releases (`upload`, `publish` commands) requires a key with the `ModPortal: Upload Mods` permission.
+
+Updating mod details (`details`, `publish` commands) requires a key with the `ModPortal: Edit Mods` permission.
 
 ## Tasks
 
@@ -31,6 +35,15 @@ These tasks can also be accessed in VSCode's Tasks system. Custom scripts will r
   * select a package in mod directory
   * upload to mod portal
 
+### Details
+  * update mod portal information:
+    * title, homepage, summary from `info.json#/title`, `info.json#/homepage`, `info.json#/description`
+    * upload readme.md (or file named in `info.json#/package/readme`) to mod portal long description
+    * upload faq.md (or file named in `info.json#/package/faq`) to mod portal long description
+  * sync gallery:
+    * images listed in `info.json#/package/gallery` if set
+    * any local images used by readme/faq will be added to the end of the gallery
+
 ### Publish
 
 All-in-one command.
@@ -43,6 +56,7 @@ All-in-one command.
   * git tag, unless `info.json#/package/no_git_tag` is set
   * run `info.json#/package/scripts/publish` if set
   * upload to mod portal, unless `info.json#/package/no_portal_upload` is set
+    * also run **Details** if `info.json#/package/sync_portal_details` is set
   * run `info.json#/package/scripts/postpublish` if set, with extra environment variable `FACTORIO_MODPACKAGE` with the filename of the built zip in a temporary folder.
   * run **Increment Version**
   * commit "moved to version x.y.z"

package/doc/workspace.md

@@ -24,7 +24,7 @@ I open the Factorio `mods` directory as the root of my workspace in VSCode, and
 
 I use [VScode](https://code.visualstudio.com/) (imagine that!), but it needs a few extensions to really shine in this context:
 
- * [Factorio Mod Debugger](https://marketplace.visualstudio.com/items?itemName=justarandomgeek.factoriomod-debug) - You are here
+ * [Factorio Modding Tool Kit](https://marketplace.visualstudio.com/items?itemName=justarandomgeek.factoriomod-debug) - You are here
  * A Lua language server. I like to use [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua), and the Factorio Mod Debugger has some extended support for it.
  * Optional: [Zip File Explorer](https://marketplace.visualstudio.com/items?itemName=slevesque.vscode-zipexplorer). Enables viewing files inside zips, which allows breakpoints/stepping inside them as well.
  * Optional: [indent-rainbow](https://marketplace.visualstudio.com/items?itemName=oderwat.indent-rainbow)

package/language/factorio-locale.tmLanguage.json

@@ -14,7 +14,7 @@
 				},
 				{
 					"name": "meta.plural.factorio-locale",
-					"match": "(__)(plural_for_parameter)(_)([0-9]+)(_\\{)([^}]*)(\\}__)",
+					"match": "(__)(plural_for_parameter)(_)([0-9]+)(_\\{)(.*?)(\\}__)",
 					"captures": {
 						"1": {"name": "punctuation.definition.tag.begin.factorio-locale"},
 						"2": {"name": "support.function.plural.factorio-locale"},
@@ -179,14 +179,6 @@
 						},
 						"5":{"name": "punctuation.definition.tag.end.factorio-locale"}
 					}
-				},
-				{
-					"match": "(__)(.+?)(__)",
-					"captures": {
-						"1":{"name":"punctuation.definition.tag.begin.factorio-locale"},
-						"2":{"name":"invalid.variable.factorio-locale"},
-						"3":{"name":"punctuation.definition.tag.end.factorio-locale"}
-					}
 				}
 			]
 		}
@@ -209,7 +201,7 @@
 			"name": "comment.line.factorio-locale"
 		},
 		{
-			"match": "^[ \t\r]*([^=.]+)(=)(.+)$",
+			"match": "^[ \t\r]*(.*?)(=)(.*)$",
 			"name": "meta.record.factorio-locale",
 			"captures": {
 				"1": {"name": "variable.factorio-locale"},

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "factoriomod-debug",
   "displayName": "Factorio Modding Tool Kit",
-  "version": "1.1.26",
+  "version": "1.1.28",
   "publisher": "justarandomgeek",
   "description": "Debug Tools for developing Factorio Mods",
   "author": {
@@ -14,7 +14,7 @@
   ],
   "engines": {
     "vscode": "^1.66.0",
-    "node": ">=16"
+    "node": ">=18"
   },
   "icon": "images/factoriomod-debug-icon.png",
   "categories": [
@@ -35,20 +35,22 @@
     "typecheck-watch": "tsc -p tsconfig.json --noEmit --watch",
     "esbuild": "ts-node ./build.ts",
     "watch": "npm run esbuild -- --watch",
-    "stats": "npm run esbuild -- --meta && esbuild-visualizer --metadata ./out/meta.json --filename ./out/stats.html",
+    "stats": "npm run esbuild -- --minify --meta && esbuild-visualizer --metadata ./out/meta.json --filename ./out/stats.html",
     "vscode:prepublish": "npm run prepare",
-    "prepare": "rimraf dist && npm run esbuild",
+    "prepare": "rimraf dist && npm run esbuild -- --minify",
     "package": "vsce package",
     "publish-vscode": "vsce publish",
     "publish-vscode-prerelease": "vsce publish --pre-release",
     "test": "npm run typecheck && npm run lint"
   },
   "devDependencies": {
-    "@types/archiver": "^3.1.1",
+    "@types/archiver": "^5.3.1",
     "@types/buffers": "^0.1.31",
     "@types/d3": "^7.4.0",
+    "@types/dot-object": "^2.1.2",
     "@types/ini": "^1.3.31",
-    "@types/node": "^17.0.23",
+    "@types/inquirer": "^9.0.3",
+    "@types/node": "^18.11.18",
     "@types/node-fetch": "^2.6.1",
     "@types/request": "^2.48.8",
     "@types/semver": "^7.3.9",
@@ -61,27 +63,33 @@
     "@vscode/vsce": "^2.7.0",
     "archiver": "^5.3.0",
     "commander": "^9.4.0",
-    "d3": "^7.6.1",
+    "d3": "^7.8.1",
     "d3-flame-graph": "^4.1.3",
-    "esbuild": "^0.14.49",
+    "dot-object": "^2.1.4",
+    "esbuild": "^0.16.17",
     "esbuild-plugin-import-glob": "^0.1.1",
-    "esbuild-visualizer": "^0.3.1",
+    "esbuild-visualizer": "^0.4.0",
     "eslint": "^8.12.0",
-    "form-data": "^4.0.0",
-    "ini": "^1.3.8",
+    "ini": "^3.0.1",
+    "inquirer": "^9.1.4",
     "jsonc-parser": "^3.1.0",
-    "node-fetch": "^2.6.7",
+    "mimer": "^2.0.2",
+    "node-fetch": "^3.3.0",
     "readdir-glob": "^1.1.2",
-    "rimraf": "^3.0.2",
+    "remark": "^14.0.2",
+    "rimraf": "^4.0.4",
     "semver": "^7.3.7",
     "tree-kill": "^1.2.2",
     "ts-node": "^10.9.1",
     "typescript": "^4.7.4",
     "vscode-languageclient": "^8.0.2",
     "vscode-languageserver": "^8.0.2",
-    "vscode-languageserver-textdocument": "^1.0.5",
+    "vscode-languageserver-textdocument": "^1.0.8",
     "vscode-uri": "^3.0.3"
   },
+  "dependencies": {
+    "keytar": "^7.9.0"
+  },
   "main": "./dist/fmtk.js",
   "bin": {
     "fmtk": "./dist/fmtk.js"
@@ -435,7 +443,7 @@
             "description": "Use lua `integer` type for specialized integer types",
             "default": true
           },
-          "factorio.docs.docLinksVerion": {
+          "factorio.docs.docLinksVersion": {
             "description": "What version to use when generating docs links",
             "enumDescriptions": [
               "Always link to the `latest` docs available online",
@@ -484,6 +492,7 @@
               "package",
               "version",
               "upload",
+              "details",
               "publish",
               "run",
               "adjustMods"

package/readme.md

@@ -1,6 +1,6 @@
 # Factorio Modding Tool Kit
 
-A collection of tools for developing Factorio mods. This package is both an npm package providing the command line tool `fmtk`, and a VS Code Extension providing additional editor integration.
+A collection of tools for developing Factorio mods. This package is both [an npm package](https://www.npmjs.com/package/factoriomod-debug) providing the command line tool `fmtk`, and a [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=justarandomgeek.factoriomod-debug) providing additional editor integration.
 
  * [Debug Adapter](doc/debugadapter.md)
  * [Mod Profiling](doc/profile.md)

package/schema/datainfo.json

@@ -7,7 +7,8 @@
       "type":"string",
       "title": "Internal name of the mod",
       "pattern": "[a-zA-Z0-9_-]+",
-      "maxLength": 100
+      "maxLength": 100,
+      "minLength": 1
     },
     "version": {
       "type":"string",
@@ -31,12 +32,14 @@
     "homepage": {
       "type": "string",
       "title": "Homepage for the mod",
-      "description": "Please don't put \"None\" here, just leave it empty if none"
+      "description": "Please don't put \"None\" here, just leave it empty if none",
+      "pattern": "^($|http(s?):)"
     },
     "description": {
       "type": "string",
       "title": "A short description of the mod to show in-game",
-      "description": "Can be overwritten by locale entry in the `mod-description` category"
+      "description": "Can be overwritten by locale entry in the `mod-description` category",
+      "maxLength": 500
     },
     "factorio_version": {
       "type":"string",

package/schema/modinfo.json

@@ -29,7 +29,7 @@
         },
         "package": {
           "type":"object",
-          "description": "Configuration for automatically packaging and publishing this mod [VSCode Extension]",
+          "description": "Configuration for automatically packaging and publishing this mod [FMTK]",
           "properties": {
             "ignore":{
               "type":"array",
@@ -66,6 +66,56 @@
                 }
               }
             },
+            "gallery":{
+              "type":"array",
+              "description": "Globs to sync to gallery",
+              "items": {
+                "type":"string",
+                "format": "glob"
+              }
+            },
+            "prune_gallery": {
+              "type":"boolean",
+              "description": "Remove unreferenced images from gallery"
+            },
+            "readme": {
+              "type":"string",
+              "description": "Markdown file to be uploaded to the portal as long description"
+            },
+            "faq": {
+              "type":"string",
+              "description": "Markdown file to be uploaded to the portal as faq"
+            },
+            "markdown": {
+              "type": "object",
+              "description": "Options for transforming markdown files uploaded to the portal",
+              "properties":{
+                "strip_first_header": {
+                  "type": "boolean",
+                  "description": "Strip the first header",
+                  "default": true
+                },
+                "images": {
+                  "default": "gallery",
+                  "enum": ["gallery", "url"]
+                },
+                "links": {
+                  "default": "url",
+                  "enum": ["url"]
+                },
+                "base_url": {
+                  "type":"string",
+                  "format": "uri",
+                  "description": "Base url for `url` rewrites. If not set, links will not be rewritten."
+                },
+                "url_match": {
+                  "type": "string",
+                  "format": "regex",
+                  "default": "^((http(s?)|data):|#)",
+                  "description": "Urls matching this regex will *not* be rewritten"
+                }
+              }
+            },
             "no_git_push": {
               "type":"boolean",
               "description": "Don't automatically `git push` in Publish"
@@ -82,6 +132,10 @@
               "type":"boolean",
               "description": "Don't automatically upload to the mod portal in Publish"
             },
+            "sync_portal_details": {
+              "type":"boolean",
+              "description": "Automatically update mod details and gallery in Publish"
+            },
             "scripts":{
               "type":"object",
               "description": "Additional scripts to run while packaging/publishing mods",