Refactoring lots of things

.vscode/settings.json

@@ -16,7 +16,7 @@
         "parameterNames": true,
         "parameterTypes": false,
         "functionReturnTypes": true,
-        "conditionals": false
+        "conditionals": true
     },
 	"haxe.importsSortOrder": "stdlib -> libs -> project"
 }

CHANGELOG.md

@@ -1,6 +1,34 @@
 # Version history
 
-## dev branch / next version (2.x.x)
+## dev branch / next version (3.x.x)
+
+## 3.0.0 (2024-12-23)
+
+- added ExtractType refactor module
+- added ExtractInterface refactor module
+- added ExtractMethod refactor module
+- added Extract Constructor Params refactor module as vars or finals
+- added Rewrite Vars to Finals and Rewrite Finals to Vars refactor module
+- added Wrap with Try…Catch refactor module
+- added invalidateFile / removeFile to allow rescan in case of file changes or deletion
+- added support for create and delete file operations as edits
+- added support for local function extraction
+- added indentation options for snippet formatting
+- changed Refactor class to Rename
+- changed getFullModulName call to fullModuleName property
+- changed order of type resolution to built-in then external typer
+- fixed type name renaming not changing in use locations
+- fixed discovery of arrow functions as type hints
+- fixed extracting from functions with type parameters
+- fixed discovery of identifiers in if conditions
+- fixed code gen for empty return or throw as last expressions of selection
+- fixed parameter collection from string interpolation
+- fixed importInsertPos for files with comment headers
+- fixed enum field rename eating dot separator
+- fixed abstract enum type resolution
+- fixed rename field with null-safe access operator
+- refactored typehint data structure
+- refactored identifier discovery
 
 ## 2.3.1 (2024-11-01)
 

build.hxml

@@ -4,6 +4,7 @@
 -lib tokentree
 -lib hxnodejs
 -lib hxargs
+-lib formatter
 
 -D js-es=6
 -js bin/rename.js

display.hxml

@@ -1,10 +1,12 @@
 -cp src
 -cp test
+-cp testcases
 
 -lib haxeparser
 -lib tokentree
 -lib hxnodejs
 -lib hxargs
+-lib formatter
 -lib utest
 -lib test-adapter
 

haxe_libraries/formatter.hxml

@@ -0,0 +1,3 @@
+# @install: lix --silent download "gh://github.com/HaxeCheckstyle/haxe-formatter#cad782a6571cea82c324fc97a83fb138b740b1bd" into formatter/1.17.1/github/cad782a6571cea82c324fc97a83fb138b740b1bd
+-cp ${HAXE_LIBCACHE}/formatter/1.17.1/github/cad782a6571cea82c324fc97a83fb138b740b1bd/src
+-D formatter=1.17.1

haxe_libraries/json2object.hxml

@@ -1,4 +1,4 @@
-# @install: lix --silent download "haxelib:/json2object#3.11.0" into json2object/3.11.0/haxelib
+# @install: lix --silent download "gh://github.com/elnabo/json2object#a75859de1e966c09e73591b6c9186086c143fe60" into json2object/3.11.0/github/a75859de1e966c09e73591b6c9186086c143fe60
 -lib hxjsonast
--cp ${HAXE_LIBCACHE}/json2object/3.11.0/haxelib/src
+-cp ${HAXE_LIBCACHE}/json2object/3.11.0/github/a75859de1e966c09e73591b6c9186086c143fe60/src
 -D json2object=3.11.0

haxelib.json

@@ -8,8 +8,8 @@
 		"refactor"
 	],
 	"description": "A code renaming tool for Haxe",
-	"version": "2.3.1",
-	"releasenote": "fixed discovery of vars in pattern extraction - see CHANGELOG",
+	"version": "3.0.0",
+	"releasenote": "added ExtractType, ExtractInterface and ExtracMethod refactoring and more + bugfixes - see CHANGELOG",
 	"contributors": [
 		"AlexHaxe"
 	],

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@haxecheckstyle/haxe-rename",
-    "version": "2.3.1",
+    "version": "3.0.0",
     "description": "Renaming tool for Haxe",
     "repository": {
         "type": "git",
@@ -16,7 +16,7 @@
         "email": "[email protected]"
     },
     "devDependencies": {
-        "lix": "^15.12.0"
+        "lix": "^15.12.4"
     },
     "bin": {
         "haxe-rename": "bin/rename.js"

src/refactor/CacheAndTyperContext.hx

@@ -0,0 +1,20 @@
+package refactor;
+
+import refactor.VerboseLogger;
+import refactor.discover.FileList;
+import refactor.discover.FileReaderFunc;
+import refactor.discover.NameMap;
+import refactor.discover.TypeList;
+import refactor.typing.ITyper;
+
+typedef CacheAndTyperContext = {
+	var nameMap:NameMap;
+	var fileList:FileList;
+	var typeList:TypeList;
+	var verboseLog:VerboseLogger;
+	var typer:Null<ITyper>;
+	var fileReader:FileReaderFunc;
+	var converter:ByteToCharConverterFunc;
+}
+
+typedef ByteToCharConverterFunc = (string:String, byteOffset:Int) -> Int;

src/refactor/Cli.hx

@@ -2,14 +2,14 @@ package refactor;
 
 import haxe.PosInfos;
 import haxe.Timer;
-import refactor.RefactorContext.VerboseLogger;
 import refactor.discover.FileList;
 import refactor.discover.NameMap;
 import refactor.discover.TraverseSources;
 import refactor.discover.TypeList;
 import refactor.discover.UsageCollector;
 import refactor.discover.UsageContext;
 import refactor.edits.EditableDocument;
+import refactor.rename.RenameWhat;
 
 class Cli {
 	var verbose:Bool = false;
@@ -88,7 +88,7 @@ class Cli {
 			printHelp();
 			Sys.exit(0);
 		}
-		var what:Null<RefactorWhat> = makeWhat(loc, toName);
+		var what:Null<RenameWhat> = makeWhat(loc, toName);
 		if (what == null) {
 			printHelp();
 			Sys.exit(1);
@@ -110,15 +110,17 @@ class Cli {
 		TraverseSources.traverseSources(paths, usageContext);
 		usageContext.usageCollector.updateImportHx(usageContext);
 
-		var result:Promise<RefactorResult> = Refactor.rename({
+		var result:Promise<RefactorResult> = Rename.rename({
 			nameMap: usageContext.nameMap,
 			fileList: usageContext.fileList,
 			typeList: usageContext.typeList,
 			what: what,
 			forRealExecute: execute && forReal,
 			docFactory: EditableDocument.new,
 			verboseLog: verboseLog,
-			typer: null
+			typer: null,
+			fileReader: null,
+			converter: null,
 		});
 		result.then(function(result:RefactorResult) {
 			switch (result) {
@@ -145,7 +147,7 @@ class Cli {
 		Sys.println(text);
 	}
 
-	function makeWhat(location:String, toName:String):Null<RefactorWhat> {
+	function makeWhat(location:String, toName:String):Null<RenameWhat> {
 		var parts:Array<String> = location.split("@");
 		if (parts.length != 2) {
 			return null;

src/refactor/PrintHelper.hx

@@ -1,7 +1,8 @@
 package refactor;
 
 import refactor.discover.IdentifierType;
-import refactor.rename.RenameHelper.TypeHintType;
+import refactor.typing.TypeHintType;
+import refactor.typing.TypingHelper.TypeParameterList;
 
 class PrintHelper {
 	public static function typeToString(identType:IdentifierType):String {
@@ -11,7 +12,15 @@ class PrintHelper {
 			case Method(isStatic):
 				'Method(${isStatic})';
 			case TypedefField(fields):
-				'TypedefField(${fields})';
+				final fieldnames = [
+					for (field in fields) {
+						return switch (field) {
+							case Required(identifier) | Optional(identifier):
+								identifier.name;
+						}
+					}
+				];
+				'TypedefField(${fieldnames.join(", ")})';
 			case StructureField(fieldNames):
 				'StructureField(${fieldNames})';
 			case EnumField(params):
@@ -36,16 +45,73 @@ class PrintHelper {
 		}
 	}
 
+	public static function typeHintToString(hintType:Null<TypeHintType>):String {
+		if (hintType == null) {
+			return "null";
+		}
+		return switch (hintType) {
+			case ClasspathType(type, paramList):
+				if (paramList.length > 0) {
+					final params = paramList.map(p -> typeHintToString(p));
+					return 'ClasspathType(${type.name.name}<${params.join(", ")}>)';
+				}
+				'ClasspathType(${type?.name.name}, <>)';
+			case LibType(name, fullName, paramList):
+				if (paramList.length > 0) {
+					final params = paramList.map(p -> typeHintToString(p));
+					return 'LibType($name, $fullName, <${params.join(", ")}>';
+				}
+				'LibType($name, $fullName, <>)';
+			case FunctionType(argTypes, retVal):
+				final args = argTypes.map(f -> typeHintToString(f));
+				if (argTypes == null) {
+					return 'FunctionType((${args.join(", ")}) -> Void)';
+				}
+				return 'FunctionType((${args.join(", ")}) -> ${typeHintToString(retVal)})';
+			case StructType(fieldTypes):
+				final fields = fieldTypes.map(f -> typeHintToString(f));
+				'StructType({${fields.join(";")}})';
+			case NamedType(name, namedHint):
+				'NamedType($name, ${typeHintToString(namedHint)})';
+			case UnknownType(name):
+				'UnknownType($name)';
+		}
+	}
+
 	public static function printTypeHint(hintType:TypeHintType):String {
 		return switch (hintType) {
-			case KnownType(type, params):
-				'KnownType(${type.name.name}, ${params.map((i) -> i.name)})';
-			case UnknownType(name, params):
-				'UnknownType($name, ${params.map((i) -> i.name)})';
+			case ClasspathType(type, paramList):
+				if (paramList.length > 0) {
+					final params = paramList.map(p -> printTypeHint(p));
+					return '${type.name.name}<${params.join(", ")}>';
+				}
+				'${type.name.name}';
+			case LibType(name, fullName, paramList):
+				if (paramList.length > 0) {
+					final params = paramList.map(p -> printTypeHint(p));
+					return '${name}<${params.join(", ")}>';
+				}
+				'$name';
+			case FunctionType(argTypes, retVal):
+				final args = argTypes.map(f -> printTypeHint(f));
+				if (argTypes == null) {
+					return '(${args.join(", ")}) -> Void';
+				}
+				if (argTypes.length == 1) {
+					return '${args.join(", ")} -> ${printTypeHint(retVal)}';
+				}
+				return '(${args.join(", ")}) -> ${printTypeHint(retVal)}';
+			case StructType(fieldTypes):
+				final fields = fieldTypes.map(f -> printTypeHint(f));
+				'{${fields.join(", ")}}';
+			case NamedType(name, namedHint):
+				'$name:${printTypeHint(namedHint)}';
+			case UnknownType(name):
+				'$name';
 		}
 	}
 
-	public static function printRefactorResult(result:RefactorResult):String {
+	public static function printRenameResult(result:RefactorResult):String {
 		return switch (result) {
 			case NoChange:
 				"nothing to do";
@@ -59,4 +125,19 @@ class PrintHelper {
 				"rename successful";
 		}
 	}
+
+	public static function printRefactorResult(result:RefactorResult):String {
+		return switch (result) {
+			case NoChange:
+				"nothing to do";
+			case NotFound:
+				"could not find identifier to refactor";
+			case Unsupported(name):
+				"refactor not supported for " + name;
+			case DryRun:
+				"dry run - no changes were made";
+			case Done:
+				"refactor successful";
+		}
+	}
 }