@run-slicer/jdc 0.1.0

package/README.md

@@ -0,0 +1,35 @@
+# jdc
+
+A JavaScript port of the [JD-Core](https://github.com/java-decompiler/jd-core) decompiler.
+
+## Example
+
+```js
+const fs = require("fs");
+const { decompile } = require("./jdc.js"); // get it from the dist/ directory or jsDelivr
+
+const data = fs.readFileSync("./your/package/HelloWorld.class"); // read a class file
+console.log(await decompile("your/package/HelloWorld", {
+    source: async (name) => {
+        /* provide classes for analysis here, including the one you want to decompile */
+
+        console.log(name); /* internal name, e.g. java/lang/Object */
+        return name === "your/package/HelloWorld" ? data : null /* class not available */;
+    },
+    resources: [
+        /* class names of supporting resources (libraries), which `source` can load */
+        // "java/lang/Object",
+    ],
+    indent: "    ", // indentation string
+}));
+```
+
+Or see the browser-based proof-of-concept in the [docs](./docs) directory.
+
+## Licensing
+
+The supporting code for this project is licensed under the MIT License
+([supporting code](./LICENSE). The JD-Core decompiler is licensed under the
+[GNU General Public License, Version 3](./LICENSE-JDC).
+
+_This project is not affiliated with, maintained or endorsed by the JD-Core project in any way. Do NOT report issues with this project to the JD-Core issue trackers._

package/jdc.d.ts

@@ -0,0 +1,9 @@
+declare module "@run-slicer/jdc" {
+    export interface Config {
+        source?: (name: string) => Promise<Uint8Array | null>;
+        resources?: string[];
+        indent?: string;
+    }
+
+    export function decompile(name: string, config?: Config): Promise<string>;
+}