Initial Release

Author: elMuso

.gitignore

@@ -0,0 +1,14 @@
+# System
+.DS_Store
+Thumbs.db
+
+# Temporary
+/doc
+info.json
+ref-doc.zip
+json_list.txt
+
+# Generated
+/api
+lock
+/node_modules

.vscode/default-snippets-manager.code-snippets

@@ -0,0 +1,16 @@
+{
+	"license": {
+		"prefix": "license",
+		"description": "license",
+		"scope": "typescript",
+		"body": [
+			"/*[[",
+			"    ${1}.ts",
+			"    https://github.com/elMuso/defold-annotations-typescript",
+			"    with some code from on github.com/astrochili/defold-annotations",
+			"    Copyright (c) 2024 elMuso",
+			"    MIT license. See LICENSE for details.",
+			"    --*/"
+		]
+	}
+}

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "tomblind.local-lua-debugger-vscode"
+    ]
+}

.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Lua Interpreter",
+            "type": "lua-local",
+            "request": "launch",
+            "program": {
+                "lua": "lua",
+                "file": "main.lua"
+            }
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "Lua.diagnostics.disable": [
+        "redefined-local"
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,9 @@
+{
+    "tasks": [
+        {
+            "label": "run_program",
+            "type": "shell",
+            "command": "npm run start",
+          },
+    ]
+}

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022 Roman Silin
+
+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.

README.md

@@ -0,0 +1,28 @@
+# Defold Annotations for Typescript
+
+Hugely based around the idea of [Defold annotations](https://github.com/astrochili/defold-annotations/), this repository aims to be the same, for typescript, but better.
+
+It parses the official documentation from [Defold](https://defold.com) and translates it to 2 typescript definition files.
+
+Node 20.15.1 was used for this. Might not run with other versions
+
+<!-- Generated annotations are available on the [Releases](https://github.com/astrochili/defold-annotations/releases) page. -->
+
+## Use case
+
+These annotations can be used by anyone just by dragging the file to your project
+
+-   index.d.ts contains the Defold API, constants and functions
+-   messages.d.ts contains a useful `dfld` object that can serve as a helper to avoid sending messages (prefix msg*) or to look up the documentation of something. It also contains the propertyes of each module (prefix p*) and the return messages to use on on*message (prefix msg_id*)
+
+## Manual Generation
+
+Install Node, run `npm install` and then `npm run start`. **_The output will be on the api folder_**
+
+### Issues
+
+If you find a typo in the annotations or outdated meta information, create an issue.
+
+### Settings
+
+By default it uses Defold version 1.9.1 , you can change this by editing the src_new/settings.ts file. There are other useful conditionals there to remove information from the final build

eslint.config.mjs

@@ -0,0 +1,16 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+
+export default [
+  {
+    rules: {
+        "@typescript-eslint/explicit-function-return-type": "error"
+    }
+},
+  {files: ["**/*.{js,mjs,cjs,ts}"]},
+  {languageOptions: { globals: globals.browser }},
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];

main.ts

@@ -0,0 +1,25 @@
+import config from "./src_new/config";
+import fetch_docs from "./src_new/fetcher";
+import { Generator } from "./src_new/generator";
+import { Parser } from "./src_new/parser";
+import settings from "./src_new/settings";
+import { Terminal } from "./src_new/terminal";
+import Utils from "./src_new/utils";
+
+// Parse .json files to namespace modules
+// const modules = parser.parse_json(json_paths)
+
+async function generate_documentation() {
+	const json_paths = await fetch_docs(settings.defold_version);
+	const api_path = config.api_folder + settings.folder_separator;
+	const modules = Parser.parse_json(json_paths);
+	const filtered = Parser.filter_json(modules);
+	Terminal.create_folder(api_path);
+	Utils.save_file(JSON.stringify(filtered), api_path + "raw_data.json");
+	const output = Generator.generate(filtered);
+	Utils.save_file(output.typedata, api_path + "index.d.ts");
+	Utils.save_file(output.optionaldata, api_path + "messages.d.ts");
+	console.log("Parsing done. Check the api folder");
+}
+
+generate_documentation();