Rename ECMAScript to JavaScript for godot 4

README.md

@@ -1,6 +1,6 @@
 ## JavaScript language binding for godot game engine
 
-This module implements JavaScript/TypeScript language support for the godot game engine. [QuickJS](https://bellard.org/quickjs/) is used as the ECMAScript engine.
+This module implements JavaScript/TypeScript language support for the godot game engine. [QuickJS](https://bellard.org/quickjs/) is used as the JavaScript engine.
 
 -----
 
@@ -20,15 +20,15 @@ You can also get the binaries with lastest commits from the [github build action
 
 ### Compilation
 * Clone the source code of [godot](https://github.com/godotengine/godot)
-* Clone this module and put it into `godot/modules/` and make sure the folder name of this module is `ECMAScript`
+* Clone this module and put it into `godot/modules/` and make sure the folder name of this module is `javascript`
 * [Recompile the godot engine](https://docs.godotengine.org/en/3.3/development/compiling/index.html) <b>(Only MinGW is supported on Windows for now!)</b>
 
 ![Build Godot with ECMAScript](https://github.com/GodotExplorer/ECMAScript/workflows/Build%20Godot%20with%20ECMAScript/badge.svg)
 
 ### Usage
 
 ##### How to export script class to godot
-1. Define your ECMAScript class and inherit from a godot class then export it as the **default** entry
+1. Define your JavaScript class and inherit from a godot class then export it as the **default** entry
 ```js
 // The default export entry is treated as an exported class to godot
 export default class MySprite extends godot.Sprite {
@@ -94,15 +94,15 @@ godot.register_property(MyClass, 'number_value',  {
 });
 ```
 
-For more detail on how to use it, [click here](https://github.com/GodotExplorer/ECMAScript/issues/24#issuecomment-655584829).
+For more detail on how to use it, [click here](https://github.com/Geequlim/ECMAScript/issues/24#issuecomment-655584829).
 
 #### About the API
 
 All of godots api's are defined within the `godot` namespace.
 
 No API names have been renamed or changed so you shouldn't need to change your habits.
 
-GDScript | ECMAScript
+GDScript | JavaScript
 ---- | ---
 null | null
 int | number
@@ -180,7 +180,7 @@ Label.Align.ALIGN_LEFT | godot.Label.Align.ALIGN_LEFT
 		```
 
 ### TypeScript support and JSX code completion
-- Run the menu command `Project > Tools > ECMAScript > Generate TypeScript Project` from the godot editor to generate a TypeScript project
+- 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
@@ -269,6 +269,6 @@ You can try demos in the [ECMAScriptDemos](https://github.com/Geequlim/ECMAScrip
 * The script also build the `on_tag.yml` script which automates the github release publishing.
 ** The `on_tag.yml` functionality tries to sleep until all jobs with the same `sha` are completed.  It should be fine to run whenever, but depending on how github actions culls long running jobs you might want to make sure that all/(most of) the builds look good before tagging.
 * Linux ubsan asan build woes:
-** The godot repo has ubsan and asan builds that we can't build from.  Currently we skip them (get removed via the `build_github_actions.py` script).
-** They should definitely be fixed & enabled at some point, **so please submit a PR if you have any ideas of how to do that!**
+* The godot repo has ubsan and asan builds that we can't build from.  Currently we skip them (get removed via the `build_github_actions.py` script).
+* They should definitely be fixed & enabled at some point, **so please submit a PR if you have any ideas of how to do that!**
 

SCsub

@@ -49,19 +49,19 @@ if JS_ENGINE == 'quickjs':
 
 # Binding script to run at engine initializing
 with open("misc/godot.binding_script.gen.cpp", "w") as f:
-	text = '/* THIS FILE IS GENERATED DO NOT EDIT */\n#include "../ecmascript_binder.h"\nString ECMAScriptBinder::BINDING_SCRIPT_CONTENT = \n${source};'
+	text = '/* THIS FILE IS GENERATED DO NOT EDIT */\n#include "../javascript_binder.h"\nString JavaScriptBinder::BINDING_SCRIPT_CONTENT = \n${source};'
 	f.write(text.replace('${source}', dump_text_file_to_cpp("misc/binding_script.js")))
 
 sources = [
 	'register_types.cpp',
-	'ecmascript_language.cpp',
-	'ecmascript_instance.cpp',
-	'ecmascript.cpp',
+	'javascript_language.cpp',
+	'javascript_instance.cpp',
+	'javascript.cpp',
 	'misc/godot.binding_script.gen.cpp',
 ]
 
 if env['tools']:
-	base_text = '/* THIS FILE IS GENERATED DO NOT EDIT */\n#include "editor_tools.h"\nString ECMAScriptPlugin::{} = \n{};'
+	base_text = '/* THIS FILE IS GENERATED DO NOT EDIT */\n#include "editor_tools.h"\nString JavaScriptPlugin::{} = \n{};'
 	tool_fns = {"tools/godot.d.ts.gen.cpp": ("BUILTIN_DECLARATION_TEXT", dump_text_file_to_cpp("misc/godot.d.ts")),
 		"tools/tsconfig.json.gen.cpp": ("TSCONFIG_CONTENT", dump_text_file_to_cpp("misc/tsconfig.json")),
 		"tools/decorators.ts.gen.cpp": ("TS_DECORATORS_CONTENT", dump_text_file_to_cpp("misc/decorators.ts")),
@@ -73,5 +73,5 @@ if env['tools']:
 		env_module.add_source_files(env.modules_sources, fn)
 
 
-env_module.Append(CPPPATH=["#modules/ECMAScript"])
+env_module.Append(CPPPATH=["#modules/javascript"])
 env_module.add_source_files(env.modules_sources, sources)

build_github_actions.py

@@ -4,7 +4,7 @@
 You must be in this directory, and in the modules subfolder of godot (just as if you would install this project into godot)
 
 usage:
-python build_github_actions.py --godot-version "3.5-stable" --godot-github-folder ../../.github --ECMAS-github-folder .github
+python build_github_actions.py --godot-version "3.5-stable" --godot-github-folder ../../.github --js-github-folder .github
 
 """
 
@@ -53,7 +53,7 @@ def parseargs():
     parser = argparse.ArgumentParser()
     parser.add_argument("--godot-version", required=True)
     parser.add_argument("--godot-github-folder", required=True)
-    parser.add_argument("--ECMAS-github-folder", required=True)
+    parser.add_argument("--js-github-folder", required=True)
     return parser.parse_args()
 
 
@@ -83,17 +83,17 @@ def get_windows_mingw_checkout_steps() -> List[Dict[str, Any]]:
     return out
 
 
-def get_ECMAScript_checkout_steps() -> List[Dict[str, Any]]:
+def get_js_checkout_steps() -> List[Dict[str, Any]]:
     out = [
         {
             "name": "Checkout Godot",
             "uses": "actions/checkout@v2",
             "with": {"repository": "godotengine/godot", "ref": "${{ env.GODOT_BASE_BRANCH }}"},
         },
         {
-            "name": "Checkout ECMAScript",
+            "name": "Checkout javascript",
             "uses": "actions/checkout@v2",
-            "with": {"path": "${{github.workspace}}/modules/ECMAScript/"},
+            "with": {"path": "${{github.workspace}}/modules/javascript/"},
         },
     ]
     return out
@@ -107,11 +107,11 @@ def get_rid_of_ubsan_asan_linux(matrix_step: Dict[str, Any]) -> Dict[str, Any]:
 
 
 def fix_all_workflows(
-    ECMAS_github_folder: str, workflows: Dict[str, BuildOpts], wf_actions_that_require_shell: List[str]
+    js_github_folder: str, workflows: Dict[str, BuildOpts], wf_actions_that_require_shell: List[str]
 ) -> List[str]:
     wf_names: List[str] = []
     for wf_base_fn, build_opts in workflows.items():
-        full_fn = os.path.join(ECMAS_github_folder, "workflows", wf_base_fn)
+        full_fn = os.path.join(js_github_folder, "workflows", wf_base_fn)
         data = yaml.safe_load(open(full_fn))
         wf_names.append(data["name"])
 
@@ -148,13 +148,13 @@ def fix_all_workflows(
         for step in data["jobs"][only_template_name]["steps"]:
             # replace godot checkout routine with this checkout routine
             if "uses" in step and "checkout" in step["uses"]:
-                new_steps += get_ECMAScript_checkout_steps()
+                new_steps += get_js_checkout_steps()
             elif (
                 "uses" in step
                 and base_github_string in step["uses"]
                 and any(x in step["uses"] for x in wf_actions_that_require_shell)
             ):
-                step["uses"] = step["uses"].replace(base_github_string, "./modules/ECMAScript/.github/")
+                step["uses"] = step["uses"].replace(base_github_string, "./modules/javascript/.github/")
                 to_add = {"shell": "msys2 {0}" if "windows" in wf_base_fn else "sh"}
                 if "with" not in step:
                     step["with"] = to_add
@@ -170,15 +170,15 @@ def fix_all_workflows(
     return wf_names
 
 
-def fix_all_actions(ECMAS_github_folder: str, actions: List[str]) -> List[str]:
+def fix_all_actions(js_github_folder: str, actions: List[str]) -> List[str]:
     """
     This can be simplified once:
     https://github.com/actions/runner/pull/1767
     is completed
     """
     actions_that_require_shell_set = set()
     for action_base_fn in actions:
-        full_action_fn = os.path.join(ECMAS_github_folder, action_base_fn)
+        full_action_fn = os.path.join(js_github_folder, action_base_fn)
         data = yaml.safe_load(open(full_action_fn))
         new_steps = []
         for step in data["runs"]["steps"]:
@@ -308,13 +308,13 @@ def add_publish_workflow(out_fn: str, wf_name_list: List[str]):
 def main():
     args = parseargs()
     assert os.path.isdir(args.godot_github_folder)
-    assert os.path.isdir(args.ECMAS_github_folder)
+    assert os.path.isdir(args.js_github_folder)
     checkout_local_godot_install(args.godot_version)
 
     for x in ["actions", "workflows"]:
-        subprocess.call(["rm", "-rf", os.path.join(args.ECMAS_github_folder, x)])
+        subprocess.call(["rm", "-rf", os.path.join(args.js_github_folder, x)])
         subprocess.call(
-            ["cp", "-r", os.path.join(args.godot_github_folder, x), os.path.join(args.ECMAS_github_folder, x)]
+            ["cp", "-r", os.path.join(args.godot_github_folder, x), os.path.join(args.js_github_folder, x)]
         )
 
     basic_flags = " "
@@ -324,7 +324,7 @@ def main():
         "actions/godot-deps/action.yml",
         "actions/upload-artifact/action.yml",
     ]
-    wf_actions_that_require_shell = fix_all_actions(args.ECMAS_github_folder, actions)
+    wf_actions_that_require_shell = fix_all_actions(args.js_github_folder, actions)
     workflows = {
         "android_builds.yml": BuildOpts(basic_flags, args.godot_version),
         "ios_builds.yml": BuildOpts(basic_flags, args.godot_version),
@@ -334,10 +334,10 @@ def main():
         "server_builds.yml": BuildOpts(basic_flags, args.godot_version),
         "windows_builds.yml": BuildOpts(f"{basic_flags} use_mingw=yes", args.godot_version),
     }
-    wf_names = fix_all_workflows(args.ECMAS_github_folder, workflows, wf_actions_that_require_shell)
-    subprocess.call(["rm", os.path.join(args.ECMAS_github_folder, "workflows", "static_checks.yml")])
+    wf_names = fix_all_workflows(args.js_github_folder, workflows, wf_actions_that_require_shell)
+    subprocess.call(["rm", os.path.join(args.js_github_folder, "workflows", "static_checks.yml")])
 
-    out_publish_fn = os.path.join(args.ECMAS_github_folder, "workflows", "on_tag.yml")
+    out_publish_fn = os.path.join(args.js_github_folder, "workflows", "on_tag.yml")
     add_publish_workflow(out_publish_fn, wf_names)