Implement script workflow

Godot call javascript is working
[ci skip]

Author: Geequlim

README.md

@@ -47,7 +47,7 @@ export default class MySprite extends godot.Sprite {
 	}
 }
 ```
-2. Save the script with extension `.jsx`
+2. Save the script with extension `.msx`
 3. Attach the script file to the node or resource object like you do with GDScript
 
 ##### How to export signals
@@ -179,17 +179,17 @@ Label.Align.ALIGN_LEFT | godot.Label.Align.ALIGN_LEFT
 		}
 		```
 
-### TypeScript support and JSX code completion
+### TypeScript support
 - Run the menu command `Project > Tools > JavaScript > Generate TypeScript Project` from the godot editor to generate a TypeScript project
 - Run `tsc -w -p .` under your project folder in the terminal to compile scripts
 
 #### Code completion
-- Code completion in TSX will automatically work once the TypeScript project is generated by the above steps.
-- Code completion in JSX in VS Code is achieved by the property `"types": "./godot.d.ts"` in the generated package.json file of the TypeScript project. The `godot.d.ts` file can be generated alone via the `Project > Tools > ECMAScript > Generate TypeScript Declaration File` editor menu option and added to a `package.json` file manually to achieve this without a full TypeScript project.
+- Code completion in TS will automatically work once the TypeScript project is generated by the above steps.
+- Code completion in VSCode is achieved by the property `"types": "./godot.d.ts"` in the generated package.json file of the TypeScript project. The `godot.d.ts` file can be generated alone via the `Project > Tools > ECMAScript > Generate TypeScript Declaration File` editor menu option and added to a `package.json` file manually to achieve this without a full TypeScript project.
 
 #### Example TypeScript Usage
 
-Make sure the file with extension '.tsx' so it can be compiled to a `.jsx` file then we can attach it to a node in godot editor.
+Compile your `ts` script to a `.mjs` file then we can attach it to a node in godot editor.
 
 Most of the `register` functions are available as various decorators as seen below.
 

javascript.cpp

@@ -231,18 +231,20 @@ bool JavaScript::is_valid() const {
 void JavaScript::_bind_methods() {
 }
 
-Ref<Resource> ResourceFormatLoaderJavaScript::load(const String &p_path, const String &p_original_path, Error *r_error) {
+Ref<Resource> ResourceFormatLoaderJavaScript::load(const String &p_path, const String &p_original_path, Error *r_error, bool p_use_sub_threads, float *r_progress, CacheMode p_cache_mode) {
 	Error err = OK;
 	Ref<JavaScriptModule> module = ResourceFormatLoaderJavaScriptModule::load_static(p_path, p_original_path, &err);
-	if (r_error) *r_error = err;
+	if (r_error)
+		*r_error = err;
 	ERR_FAIL_COND_V_MSG(err != OK, Ref<Resource>(), "Cannot load script file '" + p_path + "'.");
 	Ref<JavaScript> script;
 	script.instantiate();
 	script->set_script_path(p_path);
 	script->bytecode = module->get_bytecode();
 	script->set_source_code(module->get_source_code());
 	err = script->reload();
-	if (r_error) *r_error = err;
+	if (r_error)
+		*r_error = err;
 	ERR_FAIL_COND_V_MSG(err != OK, Ref<Resource>(), "Parse source code from file '" + p_path + "' failed.");
 #ifdef TOOLS_ENABLED
 	JavaScriptLanguage::get_singleton()->get_scripts().insert(script);
@@ -252,8 +254,6 @@ Ref<Resource> ResourceFormatLoaderJavaScript::load(const String &p_path, const S
 
 void ResourceFormatLoaderJavaScript::get_recognized_extensions(List<String> *p_extensions) const {
 	p_extensions->push_front(EXT_JSCLASS);
-	p_extensions->push_front(EXT_JSCLASS_BYTECODE);
-	p_extensions->push_front(EXT_JSCLASS_ENCRYPTED);
 }
 
 void ResourceFormatLoaderJavaScript::get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const {
@@ -266,11 +266,16 @@ bool ResourceFormatLoaderJavaScript::handles_type(const String &p_type) const {
 
 String ResourceFormatLoaderJavaScript::get_resource_type(const String &p_path) const {
 	String el = p_path.get_extension().to_lower();
-	if (el == EXT_JSCLASS || el == EXT_JSCLASS_BYTECODE || el == EXT_JSCLASS_ENCRYPTED) return JavaScript::get_class_static();
+	if (el == EXT_JSCLASS)
+		return JavaScript::get_class_static();
 	return "";
 }
 
-Error ResourceFormatSaverJavaScript::save(const String &p_path, const Ref<Resource> &p_resource, uint32_t p_flags) {
+bool ResourceFormatLoaderJavaScript::recognize_path(const String &p_path, const String &p_for_type) const {
+	return p_path.get_extension() == EXT_JSCLASS;
+}
+
+Error ResourceFormatSaverJavaScript::save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags) {
 	Ref<JavaScript> script = p_resource;
 	ERR_FAIL_COND_V(script.is_null(), ERR_INVALID_PARAMETER);
 
@@ -321,8 +326,6 @@ Ref<Resource> ResourceFormatLoaderJavaScriptModule::load(const String &p_path, c
 
 void ResourceFormatLoaderJavaScriptModule::get_recognized_extensions(List<String> *p_extensions) const {
 	p_extensions->push_front(EXT_JSMODULE);
-	p_extensions->push_front(EXT_JSMODULE_BYTECODE);
-	p_extensions->push_front(EXT_JSMODULE_ENCRYPTED);
 }
 
 void ResourceFormatLoaderJavaScriptModule::get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const {
@@ -335,7 +338,7 @@ bool ResourceFormatLoaderJavaScriptModule::handles_type(const String &p_type) co
 
 String ResourceFormatLoaderJavaScriptModule::get_resource_type(const String &p_path) const {
 	String el = p_path.get_extension().to_lower();
-	if (el == EXT_JSMODULE || el == EXT_JSMODULE_BYTECODE || el == EXT_JSMODULE_ENCRYPTED)
+	if (el == EXT_JSMODULE)
 		return JavaScriptModule::get_class_static();
 	return "";
 }
@@ -350,7 +353,10 @@ Ref<Resource> ResourceFormatLoaderJavaScriptModule::load_static(const String &p_
 		if (r_error) *r_error = err;
 		ERR_FAIL_COND_V_MSG(err != OK, Ref<Resource>(), "Cannot load source code from file '" + p_path + "'.");
 		module->set_source_code(code);
-	} else if (p_path.ends_with("." EXT_JSMODULE_BYTECODE) || p_path.ends_with("." EXT_JSCLASS_BYTECODE)) {
+	}
+
+#if 0
+	else if (p_path.ends_with("." EXT_JSMODULE_BYTECODE) || p_path.ends_with("." EXT_JSCLASS_BYTECODE)) {
 		module->set_bytecode(FileAccess::get_file_as_array(p_path, &err));
 		if (r_error) *r_error = err;
 		ERR_FAIL_COND_V_MSG(err != OK, Ref<Resource>(), "Cannot load bytecode from file '" + p_path + "'.");
@@ -380,6 +386,8 @@ Ref<Resource> ResourceFormatLoaderJavaScriptModule::load_static(const String &p_
 			err = ERR_CANT_OPEN;
 		}
 	}
+#endif
+
 	if (r_error) *r_error = err;
 	ERR_FAIL_COND_V(err != OK, Ref<Resource>());
 	return module;

javascript.h

@@ -7,12 +7,8 @@
 #include "javascript_binder.h"
 #include "scene/resources/text_file.h"
 
-#define EXT_JSCLASS "jsx"
-#define EXT_JSCLASS_BYTECODE EXT_JSCLASS "b"
-#define EXT_JSCLASS_ENCRYPTED EXT_JSCLASS "e"
+#define EXT_JSCLASS "mjs"
 #define EXT_JSMODULE "js"
-#define EXT_JSMODULE_BYTECODE EXT_JSMODULE "b"
-#define EXT_JSMODULE_ENCRYPTED EXT_JSMODULE "e"
 #define EXT_JSON "json"
 
 class JavaScript : public Script {
@@ -90,17 +86,19 @@ class JavaScript : public Script {
 class ResourceFormatLoaderJavaScript : public ResourceFormatLoader {
 	GDCLASS(ResourceFormatLoaderJavaScript, ResourceFormatLoader)
 public:
-	virtual Ref<Resource> load(const String &p_path, const String &p_original_path = "", Error *r_error = NULL);
+	virtual Ref<Resource> load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_use_sub_threads = false, float *r_progress = nullptr, CacheMode p_cache_mode = CACHE_MODE_REUSE) override;
 	virtual void get_recognized_extensions(List<String> *p_extensions) const override;
-	virtual void get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const override;
 	virtual bool handles_type(const String &p_type) const override;
+	virtual void get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const override;
 	virtual String get_resource_type(const String &p_path) const override;
+
+	virtual bool recognize_path(const String &p_path, const String &p_for_type = String()) const override;
 };
 
 class ResourceFormatSaverJavaScript : public ResourceFormatSaver {
 	GDCLASS(ResourceFormatSaverJavaScript, ResourceFormatSaver)
 public:
-	virtual Error save(const String &p_path, const Ref<Resource> &p_resource, uint32_t p_flags = 0);
+	virtual Error save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags = 0) override;
 	virtual void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const override;
 	virtual bool recognize(const Ref<Resource> &p_resource) const override;
 };

javascript_instance.cpp

@@ -56,7 +56,10 @@ Variant JavaScriptInstance::callp(const StringName &p_method, const Variant **p_
 		r_error.error = Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL;
 		ERR_FAIL_V(Variant());
 	}
-	return binder->call_method(javascript_object, p_method, p_args, p_argcount, r_error);
+	if (binder->has_method(javascript_object, p_method)) {
+		return binder->call_method(javascript_object, p_method, p_args, p_argcount, r_error);
+	}
+	return Variant();
 }
 
 ScriptLanguage *JavaScriptInstance::get_language() {

javascript_language.cpp

@@ -105,6 +105,7 @@ void JavaScriptLanguage::get_reserved_words(List<String> *p_words) const {
 		"const",
 		"enum",
 		"export",
+		"default",
 		"extends",
 		"import",
 		"super",
@@ -204,7 +205,6 @@ bool JavaScriptLanguage::is_control_flow_keyword(String p_keyword) const {
 		   p_keyword == "continue" ||
 		   p_keyword == "switch" ||
 		   p_keyword == "case" ||
-		   p_keyword == "default" ||
 		   p_keyword == "throw" ||
 		   p_keyword == "try" ||
 		   p_keyword == "catch" ||
@@ -222,46 +222,64 @@ void JavaScriptLanguage::get_string_delimiters(List<String> *p_delimiters) const
 	p_delimiters->push_back("` `");
 }
 
-Ref<Script> JavaScriptLanguage::get_template(const String &p_class_name, const String &p_base_class_name) const {
-	String script_template = "export default class %CLASS% extends " GODOT_OBJECT_NAME ".%BASE% {\n"
-							 "    \n"
-							 "    // Declare member variables here. Examples:\n"
-							 "    a = 2;\n"
-							 "    b = \"text\";\n"
-							 "    \n"
-							 "    constructor() {\n"
-							 "        super();\n"
-							 "    }\n"
-							 "    \n"
-							 "    // Called when the node enters the scene tree for the first time.\n"
-							 "    _ready() {\n"
-							 "        \n"
-							 "    }\n"
-							 "    \n"
-							 "    // Called every frame. 'delta' is the elapsed time since the previous frame.\n"
-							 "    _process(delta) {\n"
-							 "        \n"
-							 "    }\n"
-							 "}\n";
-	script_template = script_template.replace("%BASE%", p_base_class_name).replace("%CLASS%", p_class_name);
-
-	Ref<JavaScript> script;
-	script.instantiate();
-	script->set_source_code(script_template);
-	script->set_name(p_class_name);
-	script->set_script_path(p_class_name);
-	return script;
-}
-
 Ref<Script> JavaScriptLanguage::make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const {
 	Ref<JavaScript> script;
 	script.instantiate();
-	String src = script->get_source_code();
-	src = src.replace("%BASE%", p_base_class_name).replace("%CLASS%", p_class_name);
+	String src = p_template.replace("%BASE%", p_base_class_name).replace("%CLASS%", p_class_name);
 	script->set_source_code(src);
 	return script;
 }
 
+Vector<ScriptLanguage::ScriptTemplate> JavaScriptLanguage::get_built_in_templates(StringName p_object) {
+	Vector<ScriptLanguage::ScriptTemplate> templates;
+#ifdef TOOLS_ENABLED
+	constexpr size_t len = 2;
+	static const struct ScriptLanguage::ScriptTemplate TEMPLATES[len] = {
+		{ "Node",
+			"Default",
+			"Base template for Node with default Godot cycle methods",
+			"export default class %CLASS% extends " GODOT_OBJECT_NAME ".%BASE% {\n"
+			"    \n"
+			"    constructor() {\n"
+			"        super();\n"
+			"    }\n"
+			"    \n"
+			"    // Called when the node enters the scene tree for the first time.\n"
+			"    _ready() {\n"
+			"        \n"
+			"    }\n"
+			"    \n"
+			"    // Called every frame. 'delta' is the elapsed time since the previous frame.\n"
+			"    _process(delta) {\n"
+			"        \n"
+			"    }\n"
+			"}\n" },
+		{ "Object",
+			"Empty",
+			"Empty template suitable for all Objects",
+			"export default class %CLASS% extends " GODOT_OBJECT_NAME ".%BASE% {\n"
+			"    \n"
+			"    // Declare member variables here. Examples:\n"
+			"    a = 2;\n"
+			"    b = \"text\";\n"
+			"    \n"
+			"    constructor() {\n"
+			"        super();\n"
+			"    }\n"
+			"    \n"
+			"}\n" },
+	};
+
+	for (int i = 0; i < len; i++) {
+		if (TEMPLATES[i].inherit == p_object) {
+			templates.append(TEMPLATES[i]);
+		}
+	}
+#endif
+
+	return templates;
+}
+
 bool JavaScriptLanguage::validate(const String &p_script, const String &p_path, List<String> *r_functions, List<ScriptError> *r_errors, List<Warning> *r_warnings, HashSet<int> *r_safe_lines) const {
 	JavaScriptError script_error;
 	bool ret = main_binder->validate(p_script, p_path, &script_error);
@@ -303,10 +321,6 @@ void JavaScriptLanguage::get_recognized_extensions(List<String> *p_extensions) c
 	p_extensions->push_back(EXT_JSMODULE);
 	p_extensions->push_back(EXT_JSCLASS);
 	p_extensions->push_back(EXT_JSON);
-	p_extensions->push_back(EXT_JSMODULE_ENCRYPTED);
-	p_extensions->push_back(EXT_JSMODULE_BYTECODE);
-	p_extensions->push_back(EXT_JSCLASS_ENCRYPTED);
-	p_extensions->push_back(EXT_JSCLASS_BYTECODE);
 }
 
 void JavaScriptLanguage::frame() {

javascript_language.h

@@ -61,13 +61,13 @@ class JavaScriptLanguage : public ScriptLanguage {
 	virtual void get_comment_delimiters(List<String> *p_delimiters) const override;
 	virtual void get_string_delimiters(List<String> *p_delimiters) const override;
 
-	Ref<Script> get_template(const String &p_class_name, const String &p_base_class_name) const;
 	virtual Ref<Script> make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const override;
+	virtual Vector<ScriptTemplate> get_built_in_templates(StringName p_object) override;
+	virtual bool is_using_templates() override { return true; }
 
 	virtual Script *create_script() const override;
 	_FORCE_INLINE_ virtual bool has_named_classes() const override { return true; }
 	_FORCE_INLINE_ virtual bool supports_builtin_mode() const override { return false; }
-	_FORCE_INLINE_ virtual bool is_using_templates() override { return true; }
 
 	virtual bool validate(const String &p_script, const String &p_path = "", List<String> *r_functions = nullptr, List<ScriptError> *r_errors = nullptr, List<Warning> *r_warnings = nullptr, HashSet<int> *r_safe_lines = nullptr) const override;
 

quickjs/quickjs_binder.cpp

@@ -97,7 +97,7 @@ JSValue QuickJSBinder::console_functions(JSContext *ctx, JSValue this_val, int a
 	String message = "";
 	for (int i = 0; i < argc; ++i) {
 		message += args[i];
-		if (i > 0 && i < argc - 1) {
+		if (i < argc - 1) {
 			message += " ";
 		}
 	}

quickjs/quickjs_callable.cpp

@@ -17,7 +17,7 @@ bool QuickJSCallable::compare_less(const CallableCustom *p_a, const CallableCust
 }
 
 QuickJSCallable::QuickJSCallable(JSContext *ctx, const JSValue &p_value) {
-	ERR_FAIL_COND(JS_IsFunction(ctx, p_value));
+	ERR_FAIL_COND(!JS_IsFunction(ctx, p_value));
 	JSValue v = JS_DupValue(ctx, p_value);
 	js_function.context = ctx;
 	js_function.javascript_object = JS_VALUE_GET_PTR(v);

tests/UnitTest.js

@@ -32,7 +32,7 @@ test('Object.prototype.connect', () => {
 		console.log(`signal 'script_changed' emited with:`, ...args);
 		ok = true;
 	});
-	obj.emit_signal('script_changed');
+	obj.emit_signal('script_changed', 123, 'hello');
 	obj.free();
 	return ok;
 }, 'core')