Initial commit

.eslintrc.json

@@ -0,0 +1,23 @@
+{
+	"env": {
+		"browser": false,
+		"commonjs": true,
+		"es6": true,
+		"node": true
+	},
+	"parserOptions": {
+		"ecmaFeatures": {
+			"jsx": true
+		},
+		"sourceType": "module"
+	},
+	"rules": {
+		"no-const-assign": "warn",
+		"no-this-before-super": "warn",
+		"no-undef": "warn",
+		"no-unreachable": "warn",
+		"no-unused-vars": "warn",
+		"constructor-super": "warn",
+		"valid-typeof": "warn"
+	}
+}

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+.vscode-test/
+.vscode/
+test/
+*.vsix

.vscodeignore

@@ -0,0 +1,8 @@
+.vscode/**
+.vscode-test/**
+test/**
+.gitignore
+vsc-extension-quickstart.md
+**/jsconfig.json
+**/*.map
+**/.eslintrc.json

CHANGELOG.md

@@ -0,0 +1,2 @@
+### 1.0.0: January 10, 2020
+- Initial release

README.md

@@ -0,0 +1,20 @@
+# Minetest Tools
+[Repository](https://github.com/GreenXenith/minetest-tools/) | [Issues](https://github.com/GreenXenith/minetest-tools/issues/)
+
+## Features
+
+- Minetest (5.1.0) Lua API code snippets
+- Mod and game folder structure boilerplates
+- `.luacheckrc` generator (globals only)
+
+**Note:** Code snippets were generated from `lua_api.txt` using a Lua script. Quality of descriptions and amount of available snippets may be sub-par. `snippets.json` is __not__ pretty-printed.
+
+## Extension Settings
+
+* `minetest-tools.workspaceOnly`: Code snippets will only be shown if certain files/folders (`init.lua`, `mods`, `modpack.txt`) are detected in the main workspace folder (default: `true`).
+
+## Release Notes
+
+### 1.0.0: January 10, 2020
+
+Initial release.

extension.js

@@ -0,0 +1,171 @@
+const vscode = require("vscode");
+const fs = require("fs");
+const path = require("path");
+const snippets = require("./snippets.json");
+
+const rootPath = vscode.workspace.workspaceFolders[0].uri.fsPath;
+const luacheckrc = `read_globals = {
+	"DIR_DELIM",
+	"minetest", "core",
+	"dump", "dump2",
+	"vector",
+	"VoxelManip", "VoxelArea",
+	"PseudoRandom", "PcgRandom",
+	"ItemStack",
+	"Settings",
+	"unpack",
+
+	table = {
+		fields = {
+			"copy",
+			"indexof",
+			"insert_all",
+			"key_value_swap",
+		}
+	},
+
+	string = {
+		fields = {
+			"split",
+			"trim",
+		}
+	},
+
+	math = {
+		fields = {
+			"hypot",
+			"sign",
+			"factorial"
+		}
+	},
+}`;
+
+function makeFiles(files, folders) {
+	for (const folder of folders) {
+		const fullpath = path.join(rootPath, folder);
+		if (!fs.existsSync(fullpath)) {
+			fs.mkdirSync(fullpath);
+		}
+	}
+	for (const file of files) {
+		const fullpath = path.join(rootPath, file.name);
+		if (!fs.existsSync(fullpath)) {
+			fs.writeFileSync(fullpath, file.content);
+		}
+	}
+}
+
+function activate(context) {
+	console.log("Minetest Tools extension is active.");
+
+	// Intellisense
+	let provider = vscode.languages.registerCompletionItemProvider({language: "lua", scheme: "file"}, {
+		provideCompletionItems() {
+			// Only show snippets if in a Minetest workspace
+			if (vscode.workspace.getConfiguration("minetest-tools").get("workspaceOnly") &&
+					!(fs.existsSync(path.join(rootPath, "init.lua")) ||
+					fs.existsSync(path.join(rootPath, "mods")) ||
+					fs.existsSync(path.join(rootPath, "modpack.txt")))
+				) return [];
+
+			let items = [];
+
+			for (const snippet of snippets) {
+				const item = new vscode.CompletionItem(snippet.prefix);
+				item.insertText = new vscode.SnippetString(snippet.body);
+				item.documentation = new vscode.MarkdownString(snippet.desc);
+
+				items.push(item);
+			}
+
+			// Extra snippets (TODO: Move to snippets object)
+			const vec = new vscode.CompletionItem("vector");
+			vec.insertText = new vscode.SnippetString("{x = ${1:0}, y = ${2:0}, z = ${3:0}}");
+			vec.documentation = new vscode.MarkdownString("`{x = 0, y = 0, z = 0}`");
+			items.push(vec);
+
+			return items;
+		}
+	});
+
+	// Mod boilerplate
+	let modproject = vscode.commands.registerCommand("extension.modProject", () => {
+		const name = vscode.workspace.name;
+		const files = [
+			{
+				"name": "init.lua",
+				"content": ""
+			},
+			{
+				"name": "mod.conf",
+				"content": `name = ${name}\ndescription = \ndepends = \noptional_depends = `
+			},
+			{
+				"name": "README.md",
+				"content": ""
+			},
+			{
+				"name": "LICENSE.txt",
+				"content": ""
+			},
+			{
+				"name": ".luacheckrc",
+				"content": luacheckrc
+			}
+		];
+		const folders = ["textures", "models", "sounds"];
+		makeFiles(files, folders);
+	});
+
+	// Game boilerplate
+	let gameproject = vscode.commands.registerCommand("extension.gameProject", () => {
+		const name = vscode.workspace.name;
+		const files = [
+			{
+				"name": "game.conf",
+				"content": `name = ${name.replace(/[_-]/g, " ").replace(/(^| )(\w)/g, function(m) {
+					return m.toUpperCase();
+				})}\nauthor = \ndescription = `
+			},
+			{
+				"name": "README.md",
+				"content": ""
+			},
+			{
+				"name": "LICENSE.txt",
+				"content": ""
+			},
+			{
+				"name": ".luacheckrc",
+				"content": luacheckrc
+			}
+		];
+		const folders = ["menu", "mods"];
+		makeFiles(files, folders);
+	});
+
+	// .luacheckrc generator
+	let luacheck = vscode.commands.registerCommand("extension.luacheckrc", () => {
+		makeFiles([
+			{
+				"name": ".luacheckrc",
+				"content": luacheckrc
+			}
+		], []);
+	})
+
+	// Toggle workspace-only snippets
+	let toggle = vscode.commands.registerCommand("extension.workspaceToggle", () => {
+		const conf = vscode.workspace.getConfiguration("minetest-tools");
+		const newVal = conf.get("workspaceOnly") ? false : true;
+		conf.update("workspaceOnly", newVal, true);
+		vscode.window.showInformationMessage(newVal ? "Minetest Intellisense active in workspace only." : "Minetest Intellisense active for all Lua files.");
+	})
+
+	context.subscriptions.push(provider, modproject, gameproject, luacheck, toggle);
+}
+exports.activate = activate;
+
+module.exports = {
+	activate
+}

jsconfig.json

@@ -0,0 +1,13 @@
+{
+	"compilerOptions": {
+		"module": "commonjs",
+		"target": "es6",
+		"checkJs": false,  /* Typecheck .js files. */
+		"lib": [
+			"es6"
+		]
+	},
+	"exclude": [
+		"node_modules"
+	]
+}

lua/json.lua

@@ -0,0 +1,400 @@
+--
+-- json.lua
+--
+-- Copyright (c) 2019 rxi
+--
+-- Permission is hereby granted, free of charge, to any person obtaining a copy of
+-- this software and associated documentation files (the "Software"), to deal in
+-- the Software without restriction, including without limitation the rights to
+-- use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+-- of the Software, and to permit persons to whom the Software is furnished to do
+-- so, subject to the following conditions:
+--
+-- The above copyright notice and this permission notice shall be included in all
+-- copies or substantial portions of the Software.
+--
+-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+-- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+-- SOFTWARE.
+--
+
+local json = { _version = "0.1.2" }
+
+-------------------------------------------------------------------------------
+-- Encode
+-------------------------------------------------------------------------------
+
+local encode
+
+local escape_char_map = {
+  [ "\\" ] = "\\\\",
+  [ "\"" ] = "\\\"",
+  [ "\b" ] = "\\b",
+  [ "\f" ] = "\\f",
+  [ "\n" ] = "\\n",
+  [ "\r" ] = "\\r",
+  [ "\t" ] = "\\t",
+}
+
+local escape_char_map_inv = { [ "\\/" ] = "/" }
+for k, v in pairs(escape_char_map) do
+  escape_char_map_inv[v] = k
+end
+
+
+local function escape_char(c)
+  return escape_char_map[c] or string.format("\\u%04x", c:byte())
+end
+
+
+local function encode_nil(val)
+  return "null"
+end
+
+
+local function encode_table(val, stack)
+  local res = {}
+  stack = stack or {}
+
+  -- Circular reference?
+  if stack[val] then error("circular reference") end
+
+  stack[val] = true
+
+  if rawget(val, 1) ~= nil or next(val) == nil then
+    -- Treat as array -- check keys are valid and it is not sparse
+    local n = 0
+    for k in pairs(val) do
+      if type(k) ~= "number" then
+        error("invalid table: mixed or invalid key types")
+      end
+      n = n + 1
+    end
+    if n ~= #val then
+      error("invalid table: sparse array")
+    end
+    -- Encode
+    for i, v in ipairs(val) do
+      table.insert(res, encode(v, stack))
+    end
+    stack[val] = nil
+    return "[" .. table.concat(res, ",") .. "]"
+
+  else
+    -- Treat as an object
+    for k, v in pairs(val) do
+      if type(k) ~= "string" then
+        error("invalid table: mixed or invalid key types")
+      end
+      table.insert(res, encode(k, stack) .. ":" .. encode(v, stack))
+    end
+    stack[val] = nil
+    return "{" .. table.concat(res, ",") .. "}"
+  end
+end
+
+
+local function encode_string(val)
+  return '"' .. val:gsub('[%z\1-\31\\"]', escape_char) .. '"'
+end
+
+
+local function encode_number(val)
+  -- Check for NaN, -inf and inf
+  if val ~= val or val <= -math.huge or val >= math.huge then
+    error("unexpected number value '" .. tostring(val) .. "'")
+  end
+  return string.format("%.14g", val)
+end
+
+
+local type_func_map = {
+  [ "nil"     ] = encode_nil,
+  [ "table"   ] = encode_table,
+  [ "string"  ] = encode_string,
+  [ "number"  ] = encode_number,
+  [ "boolean" ] = tostring,
+}
+
+
+encode = function(val, stack)
+  local t = type(val)
+  local f = type_func_map[t]
+  if f then
+    return f(val, stack)
+  end
+  error("unexpected type '" .. t .. "'")
+end
+
+
+function json.encode(val)
+  return ( encode(val) )
+end
+
+
+-------------------------------------------------------------------------------
+-- Decode
+-------------------------------------------------------------------------------
+
+local parse
+
+local function create_set(...)
+  local res = {}
+  for i = 1, select("#", ...) do
+    res[ select(i, ...) ] = true
+  end
+  return res
+end
+
+local space_chars   = create_set(" ", "\t", "\r", "\n")
+local delim_chars   = create_set(" ", "\t", "\r", "\n", "]", "}", ",")
+local escape_chars  = create_set("\\", "/", '"', "b", "f", "n", "r", "t", "u")
+local literals      = create_set("true", "false", "null")
+
+local literal_map = {
+  [ "true"  ] = true,
+  [ "false" ] = false,
+  [ "null"  ] = nil,
+}
+
+
+local function next_char(str, idx, set, negate)
+  for i = idx, #str do
+    if set[str:sub(i, i)] ~= negate then
+      return i
+    end
+  end
+  return #str + 1
+end
+
+
+local function decode_error(str, idx, msg)
+  local line_count = 1
+  local col_count = 1
+  for i = 1, idx - 1 do
+    col_count = col_count + 1
+    if str:sub(i, i) == "\n" then
+      line_count = line_count + 1
+      col_count = 1
+    end
+  end
+  error( string.format("%s at line %d col %d", msg, line_count, col_count) )
+end
+
+
+local function codepoint_to_utf8(n)
+  -- http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=iws-appendixa
+  local f = math.floor
+  if n <= 0x7f then
+    return string.char(n)
+  elseif n <= 0x7ff then
+    return string.char(f(n / 64) + 192, n % 64 + 128)
+  elseif n <= 0xffff then
+    return string.char(f(n / 4096) + 224, f(n % 4096 / 64) + 128, n % 64 + 128)
+  elseif n <= 0x10ffff then
+    return string.char(f(n / 262144) + 240, f(n % 262144 / 4096) + 128,
+                       f(n % 4096 / 64) + 128, n % 64 + 128)
+  end
+  error( string.format("invalid unicode codepoint '%x'", n) )
+end
+
+
+local function parse_unicode_escape(s)
+  local n1 = tonumber( s:sub(3, 6),  16 )
+  local n2 = tonumber( s:sub(9, 12), 16 )
+  -- Surrogate pair?
+  if n2 then
+    return codepoint_to_utf8((n1 - 0xd800) * 0x400 + (n2 - 0xdc00) + 0x10000)
+  else
+    return codepoint_to_utf8(n1)
+  end
+end
+
+
+local function parse_string(str, i)
+  local has_unicode_escape = false
+  local has_surrogate_escape = false
+  local has_escape = false
+  local last
+  for j = i + 1, #str do
+    local x = str:byte(j)
+
+    if x < 32 then
+      decode_error(str, j, "control character in string")
+    end
+
+    if last == 92 then -- "\\" (escape char)
+      if x == 117 then -- "u" (unicode escape sequence)
+        local hex = str:sub(j + 1, j + 5)
+        if not hex:find("%x%x%x%x") then
+          decode_error(str, j, "invalid unicode escape in string")
+        end
+        if hex:find("^[dD][89aAbB]") then
+          has_surrogate_escape = true
+        else
+          has_unicode_escape = true
+        end
+      else
+        local c = string.char(x)
+        if not escape_chars[c] then
+          decode_error(str, j, "invalid escape char '" .. c .. "' in string")
+        end
+        has_escape = true
+      end
+      last = nil
+
+    elseif x == 34 then -- '"' (end of string)
+      local s = str:sub(i + 1, j - 1)
+      if has_surrogate_escape then
+        s = s:gsub("\\u[dD][89aAbB]..\\u....", parse_unicode_escape)
+      end
+      if has_unicode_escape then
+        s = s:gsub("\\u....", parse_unicode_escape)
+      end
+      if has_escape then
+        s = s:gsub("\\.", escape_char_map_inv)
+      end
+      return s, j + 1
+
+    else
+      last = x
+    end
+  end
+  decode_error(str, i, "expected closing quote for string")
+end
+
+
+local function parse_number(str, i)
+  local x = next_char(str, i, delim_chars)
+  local s = str:sub(i, x - 1)
+  local n = tonumber(s)
+  if not n then
+    decode_error(str, i, "invalid number '" .. s .. "'")
+  end
+  return n, x
+end
+
+
+local function parse_literal(str, i)
+  local x = next_char(str, i, delim_chars)
+  local word = str:sub(i, x - 1)
+  if not literals[word] then
+    decode_error(str, i, "invalid literal '" .. word .. "'")
+  end
+  return literal_map[word], x
+end
+
+
+local function parse_array(str, i)
+  local res = {}
+  local n = 1
+  i = i + 1
+  while 1 do
+    local x
+    i = next_char(str, i, space_chars, true)
+    -- Empty / end of array?
+    if str:sub(i, i) == "]" then
+      i = i + 1
+      break
+    end
+    -- Read token
+    x, i = parse(str, i)
+    res[n] = x
+    n = n + 1
+    -- Next token
+    i = next_char(str, i, space_chars, true)
+    local chr = str:sub(i, i)
+    i = i + 1
+    if chr == "]" then break end
+    if chr ~= "," then decode_error(str, i, "expected ']' or ','") end
+  end
+  return res, i
+end
+
+
+local function parse_object(str, i)
+  local res = {}
+  i = i + 1
+  while 1 do
+    local key, val
+    i = next_char(str, i, space_chars, true)
+    -- Empty / end of object?
+    if str:sub(i, i) == "}" then
+      i = i + 1
+      break
+    end
+    -- Read key
+    if str:sub(i, i) ~= '"' then
+      decode_error(str, i, "expected string for key")
+    end
+    key, i = parse(str, i)
+    -- Read ':' delimiter
+    i = next_char(str, i, space_chars, true)
+    if str:sub(i, i) ~= ":" then
+      decode_error(str, i, "expected ':' after key")
+    end
+    i = next_char(str, i + 1, space_chars, true)
+    -- Read value
+    val, i = parse(str, i)
+    -- Set
+    res[key] = val
+    -- Next token
+    i = next_char(str, i, space_chars, true)
+    local chr = str:sub(i, i)
+    i = i + 1
+    if chr == "}" then break end
+    if chr ~= "," then decode_error(str, i, "expected '}' or ','") end
+  end
+  return res, i
+end
+
+
+local char_func_map = {
+  [ '"' ] = parse_string,
+  [ "0" ] = parse_number,
+  [ "1" ] = parse_number,
+  [ "2" ] = parse_number,
+  [ "3" ] = parse_number,
+  [ "4" ] = parse_number,
+  [ "5" ] = parse_number,
+  [ "6" ] = parse_number,
+  [ "7" ] = parse_number,
+  [ "8" ] = parse_number,
+  [ "9" ] = parse_number,
+  [ "-" ] = parse_number,
+  [ "t" ] = parse_literal,
+  [ "f" ] = parse_literal,
+  [ "n" ] = parse_literal,
+  [ "[" ] = parse_array,
+  [ "{" ] = parse_object,
+}
+
+
+parse = function(str, idx)
+  local chr = str:sub(idx, idx)
+  local f = char_func_map[chr]
+  if f then
+    return f(str, idx)
+  end
+  decode_error(str, idx, "unexpected character '" .. chr .. "'")
+end
+
+
+function json.decode(str)
+  if type(str) ~= "string" then
+    error("expected argument of type string, got " .. type(str))
+  end
+  local res, idx = parse(str, next_char(str, 1, space_chars, true))
+  idx = next_char(str, idx, space_chars, true)
+  if idx <= #str then
+    decode_error(str, idx, "trailing garbage")
+  end
+  return res
+end
+
+
+return json

lua/parse.lua

@@ -0,0 +1,34 @@
+-- This is the script used to generate the snippets.json file.
+-- Its generally useless
+
+local json = require("json")
+local snippets = {}
+
+current = 0
+for line in io.lines("lua_api.txt") do
+	if line:match("%* `.-%(.-%)`") then
+		snippets[#snippets + 1] = {
+			prefix = line:match("`(.-)%("),
+			body = line:match("`(.-)`"):gsub("(%(.*%))", function(args)
+				local a = 0
+				return args:gsub("[%w%s]+", function(arg)
+					a = a + 1
+					return ("${%s:%s}"):format(a, arg:gsub("^ ", ""))
+				end):gsub(",", ", ")
+			end),
+			desc = (line:match("`:? (.*)") or ""):gsub("\"", "\\\""),
+		}
+		current = #snippets
+	elseif not line:match("^%s$") and current > 0 then
+		if snippets[#snippets].desc ~= "" then
+			line = "\n" .. line
+		end
+		snippets[#snippets].desc = snippets[#snippets].desc .. line
+	else
+		current = 0
+	end
+end
+
+local file = io.open("../snippets.json", "w")
+file:write(json.encode(snippets))
+file:close()

package.json

@@ -0,0 +1,59 @@
+{
+	"name": "minetest-tools",
+	"displayName": "Minetest Tools",
+	"description": "",
+	"version": "1.0.0",
+	"engines": {
+		"vscode": "^1.41.0"
+	},
+	"categories": [
+		"Other"
+	],
+	"activationEvents": [
+		"*"
+	],
+	"main": "./extension.js",
+	"contributes": {
+		"commands": [
+			{
+				"command": "extension.modProject",
+				"title": "Minetest Tools: New Mod Project"
+			},
+			{
+				"command": "extension.gameProject",
+				"title": "Minetest Tools: New Game Project"
+			},
+			{
+				"command": "extension.luacheckrc",
+				"title": "Minetest Tools: Create .luacheckrc"
+			},
+			{
+				"command": "extension.workspaceToggle",
+				"title": "Minetest Tools: Toggle Workspace Intellisense"
+			}
+		],
+		"configuration": [
+			{
+				"title": "Minetest Tools",
+				"properties": {
+					"minetest-tools.workspaceOnly": {
+						"type": "boolean",
+						"default": true,
+						"description": "Code snippets will only be shown if certain files (init.lua, mods, modpack.txt) are detected in the main workspace folder."
+					}
+				}
+			}
+		]
+	},
+	"devDependencies": {
+		"@types/glob": "^7.1.1",
+		"@types/mocha": "^5.2.7",
+		"@types/node": "^12.11.7",
+		"@types/vscode": "^1.41.0",
+		"eslint": "^6.6.0",
+		"glob": "^7.1.5",
+		"mocha": "^6.2.2",
+		"typescript": "^3.6.4",
+		"vscode-test": "^1.2.2"
+	}
+}