Add index.d.ts generation. Change core types to use tsbindOptions

Author: bensku

.github/workflows/build.yml

@@ -18,15 +18,10 @@ jobs:
           sudo apt-get install -y openjdk-11-source
       - name: Generate java.base types
         run: >-
-          java -jar build/libs/java-ts-bind-all.jar
-          --in /usr/lib/jvm/openjdk-11/src.zip --out java-core-types --offset java.base
-          --include java.lang,java.util,java.io,java.nio
-          --exclude java.lang.Math,java.lang.StrictMath,java.util.concurrent,java.util.spi
+          java -jar build/libs/java-ts-bind-all.jar --packageJson java-core-types/package.json
       - name: Generate java.net.http types
         run: >-
-          java -jar build/libs/java-ts-bind-all.jar
-          --in /usr/lib/jvm/openjdk-11/src.zip --out httpclient-types --offset java.net.http
-          --exclude jdk
+          java -jar build/libs/java-ts-bind-all.jar --packageJson httpclient-types/package.json
       - uses: actions/setup-node@master
         with:
           registry-url: 'https://registry.npmjs.org'

.gitignore

@@ -115,3 +115,4 @@ gradle-app.setting
 # End of https://www.toptal.com/developers/gitignore/api/eclipse,java,gradle
 
 .classpath
+*.d.ts

README.md

@@ -33,6 +33,7 @@ This is a command-line application.
   * The options should be placed under `tsbindOptions` object
   * Names of options lack -- prefixes but are otherwise same
   * Handy when you already have package.json for publishing
+* --index: generate index.d.ts that references other generated files
 
 ## Limitations
 java-ts-bind does not necessarily generate *valid* TypeScript declarations.

httpclient-types/index.d.ts

@@ -7,5 +7,12 @@
     "url": "git+ssh://[email protected]/bensku/java-ts-bind.git",
     "directory": "httpclient-types"
   },
-  "author": "bensku"
+  "author": "bensku",
+  "tsbindOptions": {
+    "in": "/usr/lib/jvm/openjdk-11/src.zip",
+    "out": "httpclient-types",
+    "offset": "java.net.http",
+    "exclude": ["jdk"],
+    "index": true
+  }
 }

httpclient-types/package.json

@@ -7,5 +7,18 @@
     "url": "git+ssh://[email protected]/bensku/java-ts-bind.git",
     "directory": "java-core-types"
   },
-  "author": "bensku"
+  "author": "bensku",
+  "tsbindOptions": {
+    "in": "/usr/lib/jvm/openjdk-11/src.zip",
+    "out": "java-core-types",
+    "offset": "java.base",
+    "include": ["java.lang", "java.util", "java.io", "java.nio"],
+    "exclude": ["java.lang.Math",
+      "java.lang.StrictMath",
+      "java.util.concurrent",
+      "java.util.jar.Pack200",
+      "java.util.spi"
+    ],
+    "index": true
+  }
 }

java-core-types/index.d.ts

@@ -31,6 +31,15 @@ public class BindingGenerator implements AstConsumer<String> {
 		EXCLUDED_TYPES.add(TypeRef.OBJECT);
 	}
 
+	/**
+	 * Whether or not index.d.ts should be generated.
+	 */
+	private final boolean buildIndex;
+	
+	public BindingGenerator(boolean buildIndex) {
+		this.buildIndex = buildIndex;
+	}
+	
 	@Override
 	public Stream<Result<String>> consume(Map<String, TypeDefinition> types) {
 		Map<String, TsModule> modules = new HashMap<>();
@@ -44,6 +53,16 @@ public Stream<Result<String>> consume(Map<String, TypeDefinition> types) {
 			StringBuilder out = outputs.computeIfAbsent(basePkg, key -> new StringBuilder());
 			module.write(types, out);
 		}
+		
+		// If requested, generate index.d.ts that references other files
+		if (buildIndex) {
+			StringBuilder index = new StringBuilder("// auto-generated references to packages\n");
+			for (String pkg : outputs.keySet()) {
+				index.append("/// <reference path='").append(pkg).append(".d.ts").append("' />\n");
+			}
+			outputs.put("index", index);
+		}
+		
 		return outputs.entrySet().stream().map(entry
 				-> new Result<>(entry.getKey() + ".d.ts", entry.getValue().toString()));
 	}

java-core-types/package.json

@@ -4,6 +4,7 @@
 import java.util.List;
 
 import com.beust.jcommander.Parameter;
+import com.google.common.base.Function;
 
 import io.github.bensku.tsbind.AstConsumer;
 import io.github.bensku.tsbind.JsonEmitter;
@@ -12,21 +13,21 @@
 public class Args {
 
 	public enum OutputFormat {
-		JSON(new JsonEmitter()),
-		TS_TYPES(new BindingGenerator());
+		JSON((args) -> new JsonEmitter()),
+		TS_TYPES((args) -> new BindingGenerator(args.index));
 
-		public final AstConsumer<String> consumer;
+		public final Function<Args, AstConsumer<String>> consumerSource;
 
-		OutputFormat(AstConsumer<String> consumer) {
-			this.consumer = consumer;
+		OutputFormat(Function<Args, AstConsumer<String>> consumer) {
+			this.consumerSource = consumer;
 		}
 	}
 
 	@Parameter(names = "--format")
 	public OutputFormat format = OutputFormat.TS_TYPES;
 
 	@Parameter(names = "--in")
-	public Path inputPath;
+	public Path in;
 
 	@Parameter(names = "--symbols")
 	public List<Path> symbols = List.of();
@@ -50,8 +51,11 @@ public enum OutputFormat {
 	public List<String> blacklist = List.of();
 
 	@Parameter(names = "--out")
-	public Path outDir = Path.of("");
+	public Path out = Path.of("");
 
 	@Parameter(names = "--packageJson")
 	public Path packageJson;
+	
+	@Parameter(names = "--index")
+	public boolean index;
 }

src/main/java/io/github/bensku/tsbind/binding/BindingGenerator.java

@@ -61,7 +61,7 @@ public Path read(JsonReader in) throws IOException {
 			MavenResolver resolver = new MavenResolver(args.repo);
 			inputPath = resolver.downloadSources(args.artifact);
 		} else {
-			inputPath = args.inputPath;
+			inputPath = args.in;
 		}
 
 		// Create path to root of input files we have
@@ -79,7 +79,7 @@ public Path read(JsonReader in) throws IOException {
 		// Walk over input Java source files
 		List<String> include = args.include;
 		List<String> exclude = args.exclude;
-		Path outDir = args.outDir;
+		Path outDir = args.out;
 		try (Stream<Path> files = Files.walk(inputDir)
 				.filter(Files::isRegularFile)
 				.filter(f -> f.getFileName().toString().endsWith(".java"))
@@ -99,7 +99,8 @@ public Path read(JsonReader in) throws IOException {
 			}).map(astGenerator::parseType)
 			.flatMap(Optional::stream).forEach(type -> types.put(type.name(), type));
 
-			Stream<Result<String>> results = args.format.consumer.consume(types);
+			Stream<Result<String>> results = args.format.consumerSource.apply(args)
+					.consume(types);
 			results.forEach(result -> {
 				try {
 					Files.writeString(outDir.resolve(result.name), result.result);